Help Center> ROMA Connect> API Reference> MQS APIs> Permission Management> Querying a Topic Permission
View PDF

Querying a Topic Permission

Function

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

URI

GET /v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/accesspolicy

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID.

instance_id

Yes

String

Instance ID.

topic_name

Yes

String

Topic name.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

String

Offset of the pagination query.

limit

No

String

Maximum number of records to be displayed on a page.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

Topic name.

policies

Array of policies objects

Policy list.

total

Integer

Total number of policies.

size

Integer

Number of policies queried.

operation

String

Topic name.
Table 4 policies

Parameter

Type

Description

owner

Boolean

Whether the application is the one selected during topic creation.

user_name

String

Application ID.

access_policy

String

Permission type.

  • all: publish+subscribe

  • pub: publish -sub: subscribe

app_name

String

Application name.

tag

String

Tag corresponding to the permission type.

Example Requests

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

Example Responses

Status code: 200

OK

{
  "name" : "topic-test",
  "policies" : [ {
    "owner" : true,
    "user_name" : "c5abd910-02b1-4bc4-b587-c3fe4c49dab9",
    "access_policy" : "pub",
    "app_name" : "topic test",
    "tag" : "11 || 22 || aa || bb"
  } ],
  "total" : 1,
  "size" : 1,
  "operation" : "topic-test"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Permission Management