查询Topic权限 - ShowMqsInstanceTopicAccessPolicy
功能介绍
查询Topic权限。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/accesspolicy
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
| instance_id | 是 | String | 实例ID。 |
| topic_name | 是 | String | Topic名称。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | String | 分页查询偏移量。 |
| limit | 否 | String | 分页查询大小。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | Topic名称。 |
| policies | Array of policies objects | 策略列表。 |
| total | Integer | 权限策略的总数。 |
| size | Integer | 查询权限策略的数量。 |
| operation | String | Topic名称。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| owner | Boolean | 是否为创建Topic时所选择的应用。 |
| user_name | String | 应用Key。 |
| access_policy | String | 权限类型。 |
| app_name | String | 应用名称。 |
| tag | String | 权限类型对应的标签。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息。 |
请求示例
GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/accesspolicy 响应示例
状态码: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"
} 状态码:400
Bad Request
{
"error_code" : 400,
"error_msg" : "Bad Request"
} 状态码:403
Forbidden
{
"error_code" : 403,
"error_msg" : "Forbidden"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Forbidden |
错误码
请参见错误码。