搜索当前账号下有权限访问的资源。
接口说明
- 仅能搜索当前账号下有权限访问的资源。
- 仅能搜索支持资源中心的云服务及资源类型。
- SearchResources 接口默认最多返回 20 条数据，您可以通过指定
MaxResults参数调整最大返回条目数。 - 如果返回结果中不存在
NextToken，则表示没有更多数据。否则，则表示还有更多数据。如果想要查询后续页，需要将 SearchResources 接口的NextToken参数设置为上一次返回结果中获取到的NextToken。如果未输入NextToken参数，查询时默认返回第一页的数据。 - 通过设置一个或多个过滤条件，可以精确资源的搜索范围。支持的过滤参数以及匹配方式见下文。多个过滤条件之间是逻辑与
AND的关系，只有同时满足所有过滤条件的资源才会被返回。每个过滤条件内部是逻辑或OR的关系，只要满足任意一个过滤条件值的资源都会被返回。 - 您可以在示例中心获取更多查询示例。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| NextToken | string | 否 | 查询返回结果下一页的令牌。 当返回结果数据总条数超过 | eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd**** |
| MaxResults | integer | 否 | 每页的最大数据条数。 取值范围：1~100。 默认值：20。 | 10 |
| Filter | object [] | 否 | 过滤条件。 | |
| Key | string | 否 | 过滤条件键。取值见下方 | RegionId |
| Value | array | 否 | 过滤条件值。 | |
| string | 否 | 过滤条件值。 | 过滤条件值。 | |
| MatchType | string | 否 | 匹配方式。 取值：Equals，表示相等匹配。 | Equals |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmzawhxxc**** |
| SortCriterion | object | 否 | 排序参数。 | |
| Key | string | 否 | 排序条件。 取值：CreateTime，表示按资源创建时间排序。 | CreateTime |
| Order | string | 否 | 排序顺序。取值：
| ASC |
支持的过滤参数
| 参数 | 描述 | 支持的匹配类型 |
|---|---|---|
| ResourceType | 资源类型。 | Equals |
| RegionId | 地域 ID。 | Equals |
| ResourceId | 资源 ID。 | Equals、Prefix |
| ResourceGroupId | 资源组 ID。 | Equals、Exists、NotExists |
| ResourceName | 资源名称。 | Equals、Contains |
| Tag | 标签键值对。 JSON 格式为 { "key": $key, "value": $value } ，key 与 value 至少出现一个。例如：查询标签键foo和标签值bar，则传递{ "key": "foo", "value": "bar" } ；查询标签键foo，则传递{ "key": "foo" }。 | Contains、NotContains、NotExists |
| VpcId | VPC ID。 | Equals |
| VSwitchId | 交换机 ID。 | Equals |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****\t\n",
"RequestId": "D696E6EF-3A6D-5770-801E-4982081FE4D0",
"MaxResults": 10,
"Filters": [
{
"Key": "RegionId",
"MatchType": "Equals",
"Values": [
"cn-hangzhou"
]
}
],
"Resources": [
{
"ResourceType": "ACS::VPC::RouteTable",
"CreateTime": "2021-06-30T09:20:08Z",
"ResourceGroupId": "rg-acfmzawhxxc****",
"ZoneId": "cn-hangzhou-k",
"AccountId": "151266687691****",
"ResourceId": "vtb-bp11lbh452fr8940s****",
"ResourceName": "group1",
"RegionId": "cn-hangzhou",
"Tags": [
{
"Key": "test_key",
"Value": "test_value"
}
],
"IpAddresses": [
"192.168.1.2"
],
"IpAddressAttributes": [
{
"IpAddress": "192.168.1.2",
"NetworkType": "Public",
"Version": "Ipv4"
}
],
"ExpireTime": "2021-07-30T09:20:08Z"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | NoPermission | You are not authorized to perform this operation. | 无操作权限。 |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 参数 MaxResults 不合法。 |
| 409 | InvalidParameter.SortCriterion.Key | The specified parameter SortCriterion.Key is not valid. | 参数 SortCriterion.Key 不合法。 |
| 409 | ExceedLimit.Filter | The maximum length of Filters is exceeded. | 参数 Filter 数量超出上限。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-11-21 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-11-10 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-03-30 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-03-07 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|