通过SQL的Select语句根据资源属性中的字段精确搜索指定账号组内的资源。
接口说明
当您写 SQL 的Select语句时,需要从目标资源类型的属性文件中获取搜索字段及其类型。关于资源属性文件,请参见alibabacloud-config-resource-schema。
配置审计支持的所有资源类型均在资源属性文件中,且根据资源类型命名,例如:资源类型
ACS::ECS::Instance的属性文件是ACS_ECS_Instance.properties.json。资源类型对应的属性文件路径为config/properties/resource-types。关于 SQL 搜索的示例和使用限制,请参见 SQL 搜索示例和 SQL 搜索的使用限制。
本文将提供一个示例,应用高级搜索查询账号组ca-4b05626622af000c****中所有具有标签键为business且标签值为online的资源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
config:ListAggregateResourcesByAdvancedSearch |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Sql |
string |
是 |
SQL 查询语句。 |
SELECT ResourceId, ResourceName WHERE Tags.Kvpair='business:online' |
| AggregatorId |
string |
是 |
账号组 ID。 |
ca-4b05626622af000c**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
B0DBF868-460F-5E7C-8F76-1ACE2FCCE153 |
| QueryResults |
object |
查询结果。 |
|
| QueryResultList |
object |
查询返回的资源列表,最大返回 1000 条数据。查看更多数据请使用搜索文件下载。 |
|
| Columns |
array |
搜索返回的字段名称列表。 |
|
|
string |
搜索返回的字段名称。 |
["ResourceId", "ResourceName"] |
|
| Values |
array |
搜索返回的资源数据列表。 |
|
|
any |
搜索返回的资源数据。 |
[ "eni-2ze5lq7xaluy5kb5****", "test-resource" ] |
示例
正常返回示例
JSON格式
{
"RequestId": "B0DBF868-460F-5E7C-8F76-1ACE2FCCE153",
"QueryResults": {
"QueryResultList": {
"Columns": [
"[\"ResourceId\", \"ResourceName\"]"
],
"Values": [
"[\n \"eni-2ze5lq7xaluy5kb5****\",\n \"test-resource\"\n]"
]
}
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | AccountNotExisted | Your account does not exist. | |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。