查询资源实例数量 - CountV2TagResources
功能介绍
通过标签查询资源实例数量。此接口为同步接口,无配套使用接口和特殊场景。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/{resource_type}/resource-instances/count
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:项目ID。获取方法,请参见获取项目ID。 约束限制:不涉及。 取值范围:长度为1~36的英文字符、数字和中划线的组合。 默认取值:不涉及。 |
| resource_type | 是 | Object | 参数解释:端点引擎类型列表。 约束限制:不能为空。 取值范围: 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| without_any_tag | 否 | Boolean | 参数解释:不包含任意一个标签。 约束限制:不涉及。 取值范围: 默认取值:不涉及。 |
| tags | 否 | Array of V2ResourceTagParam objects | 参数解释:包含标签,最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。 约束限制:最大数量为20个。 |
| matches | 否 | Array of V2TagMatch objects | 参数解释:前缀搜索字段。key为固定字典值,当前只支持resource_name,表示基于资源名称前缀搜索。value为匹配的值。 约束限制:不涉及。 |
| sys_tags | 否 | Array of V2SystemTagParam objects | 参数解释:系统标签列表,目前只包含一个tag结构体。key下面只包含一个value。 约束限制:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:长度为1~128个字符。 默认取值:不涉及。 |
| values | 否 | Array of strings | 参数解释:资源标签的值列表。 约束限制:最大20个字符串。每个字符串最大255个字符。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释:标签资源实例数量。 取值范围:0~2147483647。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为0~4096个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
请求示例
基于标签过滤统计资源数量,具体请求示例如下。
POST /v2/{project_id}/{resource_type}/resource-instances/count
{
"without_any_tag" : false,
"tags" : [ {
"key" : "tag_key",
"values" : [ "tag_value" ]
} ],
"matches" : [ {
"key" : "resource_name",
"value" : "resource_name_value"
} ]
} 响应示例
状态码:200
请求成功。
{
"total_count" : 1
} 状态码:400
请求参数错误。
{
"error_code" : "AIDataLake.00010151",
"error_msg" : "Parameter value is invalid.",
"solution_msg" : "Please input valid parameter value."
} 状态码:401
未授权。
{
"error_code" : "APIGW.0301",
"error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
"solution_msg" : "Check whether the IAM authentication information is correct."
} 状态码:403
禁止访问。
{
"error_code" : "AIDataLake.00010150",
"error_msg" : "The operation is not allowed.",
"solution_msg" : "Check whether the operation is allowed in the current status."
} 状态码:404
资源未找到。
{
"error_code" : "AIDataLake.00010009",
"error_msg" : "No resources found.",
"solution_msg" : "Enter correct resource and project IDs."
} 状态码:408
请求超时。
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
} 状态码:500
内部服务器错误。
{
"error_code" : "AIDataLake.00011001",
"error_msg" : "Internal error.",
"solution_msg" : "Contact technical support or try again later."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求参数错误。 |
| 401 | 未授权。 |
| 403 | 禁止访问。 |
| 404 | 资源未找到。 |
| 408 | 请求超时。 |
| 500 | 内部服务器错误。 |