Updating a Topic Permission

Function

This API is used to update the permission of a topic.

URI

POST /v2/{project_id}/mqs/instances/{instance_id}/topics/accesspolicy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
topics	Yes	Array of UpdateTopicAccessPolicyTopicsObject objects	Policy list.

**Table 4** UpdateTopicAccessPolicyTopicsObject
Parameter	Mandatory	Type	Description
name	Yes	String	Topic name.
policies	Yes	Array of UpdateTopicAccessPolicyPoliciesObject objects	Access policies.
description	No	String	Description.
sensitive_word	No	String	Sensitive field.

**Table 5** UpdateTopicAccessPolicyPoliciesObject
Parameter	Mandatory	Type	Description
app_id	Yes	String	Integrated application ID.
app_key	No	String	Integrated application key.
app_name	Yes	String	Application name.
access_policy	Yes	String	Permission type. all: publish+subscribe pub: publish sub: subscribe
owner	No	Boolean	Whether the application is the one selected during topic creation. The default value is false.
tag	No	String	Tag corresponding to the permission type. When the permission type is all, publish and subscribe tags are separated by ampersands (&). Multiple tags are separated by double vertical bars (\|\|).

Response Parameters

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/accesspolicy

{
  "topics" : [ {
    "name" : "topic-test-mqs",
    "policies" : [ {
      "owner" : true,
      "access_policy" : "pub",
      "app_name" : "app-dhytest",
      "tag" : "",
      "app_id" : "cd28a9d9-2184-42ce-9fbe-f3785b6caada"
    } ],
    "sensitive_word" : "",
    "description" : ""
  } ]
}

Example Responses

Status code: 400

Bad Request

{
  "error_code" : 400,
  "error_msg" : "Bad Request"
}

Status code: 403

Forbidden

{
  "error_code" : 403,
  "error_msg" : "Forbidden"
}

Status Codes

Status Code	Description
204	No Content
400	Bad Request
403	Forbidden

Error Codes

See Error Codes.

Parent topic: Application Permission Management

Previous topic: Application Permission Management

Next topic: Querying a Topic Permission

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot