Help Center/ ROMA Connect/ API Reference/ Message Integration APIs/ Application Permission Management/ Adding Topic Permissions
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding Topic Permissions

Function

This API is used to add permissions of a topic.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/access-policies/batch-add

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document.

instance_id

Yes

String

Instance ID

topic_name

Yes

String

Topic name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

policies

Yes

Array of PolicyEntity objects

Topic Permissions
Table 4 PolicyEntity

Parameter

Mandatory

Type

Description

user_name

Yes

String

Application key (access key)

app_name

Yes

String

Application name.

access_policy

Yes

String

Permission type:

  • all: publish and subscribe

  • pub: publish

  • sub: subscribe

tag

No

String

Tags corresponding to the permission type.

When the access policy type is all, separate publish and subscribe tags by ampersands (&).

Separate multiple tags by double vertical bars (||).

Use only digits, letters, hyphens (-), and underscores (_) with a maximum of 48 characters.

Response Parameters

Status code: 204

No Content

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/access-policies/batch-add

{
  "policies" : [ {
    "user_name" : "62034763-c4aa-416f-975d-1452ba90fec2",
    "app_name" : "app-uve7",
    "access_policy" : "sub",
    "tag" : "123&abc"
  } ]
}

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.