查询资源实例
功能介绍
使用标签过滤实例，标签管理服务需要提供按标签过滤各服务实例并汇总显示在列表中，需要各服务提供查询能力。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/{resource_type}/resource-instances/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，对应控制台用户名->我的凭证->项目列表->项目ID 约束限制： 不涉及 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及 |
|
resource_type |
是 |
String |
参数解释： 资源类型，目前支持waf-instance，waf 约束限制： 不涉及 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
Content-Type |
是 |
String |
参数解释： 内容类型 约束限制： 不涉及 取值范围： 不涉及 默认取值： application/json;charset=utf8 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
索引位置，默认为0 |
|
limit |
否 |
Integer |
查询记录数，默认为1000 |
|
action |
否 |
String |
操作标识 |
|
tags |
否 |
Array of TmsResourceInstancesTag objects |
|
|
sys_tags |
否 |
Array of TmsResourceInstancesTag objects |
|
|
matches |
否 |
Array of TmsResourceTag objects |
TMS标签信息详情 |
|
without_any_tag |
否 |
String |
无任何标签的资源筛选标识 |
|
tags_any |
否 |
Array of TmsResourceInstancesTag objects |
|
|
not_tags_any |
否 |
Array of TmsResourceInstancesTag objects |
|
|
not_tags |
否 |
Array of TmsResourceInstancesTag objects |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
|
|
resources |
Array of TmsResourceInstance objects |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
|
|
resource_name |
String |
|
|
resource_detail |
Object |
|
|
tags |
Array of TmsResourceTag objects |
TMS标签信息详情 |
|
sysTags |
Array of TmsResourceTag objects |
TMS标签信息详情 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释： 标签键 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
value |
String |
参数解释： 标签值 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 |
请求示例
GET https://{endpoint}/v1/{projectId}/waf/waf-instance/resource_instances/action
响应示例
状态码：200
请求成功
{
"total_count" : 1,
"resources" : [ {
"resource_id" : "res-123456",
"resource_name" : "server-01",
"resource_detail" : {
"type" : "ECS",
"status" : "running",
"create_time" : "2023-09-01T10:00:00Z"
},
"tags" : [ {
"key" : "environment",
"value" : "production"
}, {
"key" : "department",
"value" : "IT"
} ],
"sysTags" : [ {
"key" : "sys_owner",
"value" : "system"
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求失败 |
|
401 |
token权限不足 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。
