Getting topic information
Getting topic information provides information about a specific topic, which can include endpoint information if it is provided.
Prerequisites
-
A running IBM Storage Ceph cluster.
-
Root-level access.
-
Installation of the Ceph Object Gateway.
-
User access key and secret key.
-
Endpoint parameters.
Procedure
-
Get topic information with the following request format:
Syntax
POST Action=GetTopic &TopicArn=TOPIC_ARNHere is an example of the response format:
<GetTopicResponse> <GetTopicRersult> <Topic> <User></User> <Name></Name> <EndPoint> <EndpointAddress></EndpointAddress> <EndpointArgs></EndpointArgs> <EndpointTopic></EndpointTopic> <HasStoredSecret></HasStoredSecret> <Persistent></Persistent> </EndPoint> <TopicArn></TopicArn> <OpaqueData></OpaqueData> </Topic> </GetTopicResult> <ResponseMetadata> <RequestId></RequestId> </ResponseMetadata> </GetTopicResponse>The following are the tags and definitions:
-
User: Name of the user that created the topic. -
Name: Name of the topic. -
JSON formatted endpoints include:
-
EndpointAddress: The endpoint URL. If the endpoint URL contains user and password information, the request must be made over HTTPS. Otheriwse, the topic get request is rejected.-
EndPointArgs: The endpoint arguments. -
EndpointTopic: The topic name that is be sent to the endpoint can be different than the example topic name. -
HasStoredSecret:truewhen the endpoint URL contains user and password information. -
Persistent:truewhen the topic is persistent.
-
-
-
TopicArn: Topic ARN. -
OpaqueData: This is an opaque data set on the topic.
-