链接复制成功!
根据标签信息查询实例列表 - ListResourceSharesByTags
功能介绍
根据标签信息查询资源共享实例列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ram:resourceShares:listResourceSharesByTag
List
-
g:TagKeys
-
-
URI
POST /v1/resource-shares/resource-instances/filter
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页页面的最大值。 约束限制: 不涉及 取值范围: 只支持数字,最小值为 1,最大值为 1000 默认取值: 1000 |
| offset | 否 | String | 参数解释: 分页标记。 约束限制: 不涉及 取值范围: 只支持数字组成。且长度为[1~1000]个字符。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为至少 1 个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| without_any_tag | 否 | Boolean | 不包含任意一个标签,该字段为true时查询所有不带标签的资源。 |
| tags | 否 | Array of TagFilter objects | 包含标签,最多包含20个key,每个key下面的value最多20个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是"与"的关系,key-value结构中value是"或"的关系。无tag过滤条件时返回全量数据。 |
| matches | 否 | Array of Match objects | 资源共享实例绑定标签列表的匹配字段。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签"键"的标识符或名称。 约束限制: 不涉及 取值范围: 只能由字母、数字、中文、下划线、点号、冒号、等号、加号、连字符、@符号及空格组成,不能以空格或"sys"开头,也不能以空格结尾。且长度为[1~128]个字符。 默认取值: 不涉及 |
| values | 否 | Array of strings | 参数解释: 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 约束限制: 不涉及 取值范围: 只能由字母、数字、中文、下划线、点号、冒号、斜杠、等号、加号、连字符、@符号及空格组成。且长度为[0~255]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resources | Array of ResourceDTO objects | 参数解释: 资源信息列表。 约束限制: 不涉及 |
| total_count | Integer | 参数解释: 总记录数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 无默认值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 参数解释: 资源ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| resource_name | String | 参数解释: 资源名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| tags | Array of Tag objects | 参数解释: 资源标签列表。 约束限制: 不涉及 |
| resource_detail | Object | 参数解释: 资源详情。 约束限制: 不涉及 |
请求示例
根据标签信息查询资源共享实例列表。
POST /v1/resource-shares/resource-instances/filter
{
"without_any_tag" : true,
"tags" : [ {
"key" : "string",
"values" : [ "string" ]
} ],
"matches" : [ {
"key" : "string",
"value" : "string"
} ]
} 响应示例
状态码:200
请求成功。
{
"resources" : [ {
"resource_id" : "string",
"resource_name" : "string",
"resource_detail" : { },
"tags" : [ {
"key" : "string",
"value" : "string"
} ]
} ],
"total_count" : 0
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
错误码
请参见错误码。