查询用户的标签信息列表
更新时间:2021-05-07
描述
- 本接口标签与资源关联关系的双向查询
- 可根据标签键,标签值,资源ID等多种条件进行查询
请求
请求结构
POST /v{version}/tag?queryFullList&strongAssociation={strongAssociation} HTTP/1.1
Host: tag.baidubce.com
Authorization: authorization string
{
"regions": [
"bj"
],
"tagValue": "value1",
"serviceTypes": [
"BOS"
],
"tagKey": "key1",
"resourceIds": [
"v-13huIJEva"
]
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 | 示例值 |
---|---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 | 1 |
queryFullList | null | 必须 | Query参数 | 必须携带该key | - |
strongAssociation | boolean | 必须 | Query参数 | true表示仅列出有资源的标签,默认为false,如无必要强烈建议设置为true,减少数据传输量 | true |
regions | List<string> | 可选 | RequestBody参数 | 要查询的region,可填多个 | - |
tagValue | string | 可选 | RequestBody参数 | 要查询的标签值 | value1 |
serviceTypes | List<string> | 可选 | RequestBody参数 | 要查询的服务类型,可填多个 | - |
tagKey | string | 可选 | RequestBody参数 | 要查询的标签键 | key1 |
resourceIds | List<string> | 可选 | RequestBody参数 | 要查询的资源ID,可填多个 | - |
返回
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
tagAssociationFulls | List<FullTagAssociation> | 标签与资源完整关联关系 |
错误码
无特殊返回错误码
示例
请求示例
POST /v{version}/tag?queryFullList&strongAssociation={strongAssociation} HTTP/1.1
Host: tag.baidubce.com
Authorization: authorization string
{
"regions": [
"bj"
],
"tagValue": "value1",
"serviceTypes": [
"BOS"
],
"tagKey": "key1",
"resourceIds": [
"v-13huIJEva"
]
}
返回示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Bce-Request-Id: b45001e8-6957-44af-b93d-a4880e61398c
{
"tagAssociationFulls": [
{
"serviceType": "BCC",
"accountId": "0d809ffff1d24e53a457429b2a446c1d",
"resourceId": "i-LGzaQZWI",
"tagId": 606,
"tagValue": "pcloud",
"associationType": 0,
"region": "gz",
"tagKey": "bdp"
}
]
}
Model对象定义
FullTagAssociation
参数名称 | 类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
serviceType | string | 必须 | 服务类型 | BCC |
accountId | string | 必须 | 标签所属账户ID | 0d809ffff1d24e53a457429b2a446c1d |
resourceId | string | 必须 | 资源的ID | i-LGzaQZWI |
tagId | int | 必须 | 标签内部ID,无需关注此字段 | 606 |
tagValue | string | 必须 | 标签值 | pcloud |
associationType | int | 必须 | 关联类型 | 0 |
region | string | 必须 | 资源所在region | gz |
tagKey | string | 必须 | 标签键 | bdp |