查询一个或多个PolarDB集群已绑定的标签列表,或者查询一个或多个标签绑定的PolarDB集群列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
polardb:ListTagResources | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID,您可以通过接口 DescribeRegions 查看可用的地域 ID。 | cn-hangzhou |
ResourceType | string | 是 | 资源类型定义,取值固定为 cluster。 | cluster |
NextToken | string | 否 | 用来返回更多结果。第一次查询不需要提供这个参数,如果第一次查询没有返回全部结果,则可在后续查询中传入前一次返回的 token 继续查询。 | 212db86sca4384811e0b5e8707e****** |
ResourceId | array | 否 | 目标集群 ID。若您需要查询多个集群的标签情况,请单击添加来添加目标集群 ID。 说明
ResourceId.N 参数和Tag.N.Key 参数至少传入一个。ResourceId.N 参数,则每次最多添加 50 个集群 ID。 | |
string | 否 | 目标集群 ID。若您需要查询多个集群的标签情况,请单击添加来添加目标集群 ID。 说明
ResourceId.N 参数和Tag.N.Key 参数至少传入一个。ResourceId.N 参数,则每次最多添加 50 个集群 ID。 | pc-**************** | |
Tag | object [] | 否 | 标签列表。 | |
Key | string | 否 | 标签键。若您需要查询多个标签下的所有目标集群详情,请单击添加来添加标签。 说明
ResourceId.N 参数和Tag.N.Key 参数至少传入一个。Tag.N.Key 参数,则每次最多添加 20 对标签。 | type |
Value | string | 否 | 标签键对应的标签值,允许传入空字符串。 | test |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "212db86sca4384811e0b5e8707e******",
"RequestId": "688C04E4-23F8-409F-8A38-B954D5******",
"TagResources": {
"TagResource": [
{
"ResourceType": "cluster",
"TagValue": "test",
"ResourceId": "pc-****************",
"TagKey": "type"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NumberExceed.Tags | The Tags parameter`s number is exceed. | Tags参数的编号已超过 |
400 | MissParameter.TagOrResourceId | The parameter Tag.n or ResourceId.n is needed. | 需要参数Tag.n或ResourceId.n。 |
400 | NumberExceed.ResourceIds | The ResourceIds parameter's number is exceed. | ResourceIds参数的数目超过。 |
404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|