Querying a Topic Policy
Function
This API is used to query a topic policy.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
 - If you are using identity policy-based authorization, the following identity policy-based permissions are required. 
     
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
smn:topic:listAttributes
List
topic *
- 
            
g:EnterpriseProjectId
 - 
            
g:ResourceTag/<tag-key>
 
- smn:topic:list
 
-
 - 
            
 
URI
GET /v2/{project_id}/notifications/topics/{topic_urn}/attributes
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         Yes  | 
       
         String  | 
       
         Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.  | 
      
| 
         topic_urn  | 
       
         Yes  | 
       
         String  | 
       
         Specifies the resource identifier of the topic, which is unique. To obtain the resource identifier, see Querying Topics.  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         name  | 
       
         No  | 
       
         String  | 
       
         Specifies the topic policy name.Only specified policy names are supported. For details, see Topic Attribute List.  | 
      
Request Parameters
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         X-Auth-Token  | 
       
         Yes  | 
       
         String  | 
       
         Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.  | 
      
Response Parameters
Status code: 200
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         request_id  | 
       
         String  | 
       
         Specifies the request ID, which is unique.  | 
      
| 
         attributes  | 
       
         TopicAttribute object  | 
       
         Specifies the attribute. Its value can be: -access_policy: specifies the access policy of the topic. -introduction: specifies the introduction to the topic.  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         access_policy  | 
       
         String  | 
       
         Specifies the access policy of a topic.  | 
      
| 
         introduction  | 
       
         String  | 
       
         Specifies the introduction to a topic.  | 
      
Status code: 400
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         request_id  | 
       
         String  | 
       
         Specifies the request ID, which is unique.  | 
      
| 
         code  | 
       
         String  | 
       
         Specifies the error code.  | 
      
| 
         message  | 
       
         String  | 
       
         Describes the error message.  | 
      
Status code: 403
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         request_id  | 
       
         String  | 
       
         Specifies the request ID, which is unique.  | 
      
| 
         code  | 
       
         String  | 
       
         Specifies the error code.  | 
      
| 
         message  | 
       
         String  | 
       
         Describes the error message.  | 
      
Status code: 404
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         request_id  | 
       
         String  | 
       
         Specifies the request ID, which is unique.  | 
      
| 
         code  | 
       
         String  | 
       
         Specifies the error code.  | 
      
| 
         message  | 
       
         String  | 
       
         Describes the error message.  | 
      
Status code: 500
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         request_id  | 
       
         String  | 
       
         Specifies the request ID, which is unique.  | 
      
| 
         code  | 
       
         String  | 
       
         Specifies the error code.  | 
      
| 
         message  | 
       
         String  | 
       
         Describes the error message.  | 
      
Example Requests
Querying a topic policy
GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2/attributes?name=access_policy
null
  Example Responses
Status code: 200
OK
{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "attributes" : {
    "access_policy" : "{\"Version\":\"2016-09-07\",\"Id\":\"__default_policy_ID\",\"Statement\":[{\"Sid\":\"__user_pub_0\",\"Effect\":\"Allow\",\"Principal\":[{\"CSP\":[\"urn:csp:iam::93dc1b4697ac493d9b7d089569f86b32:root\"]}],\"Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa\"},{\"Sid\":\"__org_path_pub_0\",\"Effect\":\"Allow\",\"Principal\":{\"OrgPath\":[\"o-bf966fe82ebb4d35d68b791729228788/r-001ebf32880a13eabfc8e1c37eee3ae9/ou-0dbfffe92fd92ddb35feff9b4079459c\"]},\"Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa\"},{\"Sid\":\"__service_pub_0\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"obs\"]},\"Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa\"}]}"
  }
}
  Status Codes
| 
         Status Code  | 
       
         Description  | 
      
|---|---|
| 
         200  | 
       
         OK  | 
      
| 
         400  | 
       
         Bad Request  | 
      
| 
         403  | 
       
         Unauthorized  | 
      
| 
         404  | 
       
         Not Found  | 
      
| 
         500  | 
       
         Internal Server Error  | 
      
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot