调用SearchResources API搜索账号内云资源-资源管理-阿里云

搜索当前账号下有权限访问的资源。

接口说明

仅能搜索当前账号下有权限访问的资源。
仅能搜索支持资源中心的云服务及资源类型。
SearchResources 接口默认最多返回 20 条数据，您可以通过指定MaxResults参数调整最大返回条目数。
如果返回结果中不存在NextToken，则表示没有更多数据。否则，则表示还有更多数据。如果想要查询后续页，需要将 SearchResources 接口的NextToken参数设置为上一次返回结果中获取到的NextToken 。如果未输入NextToken参数，查询时默认返回第一页的数据。
通过设置一个或多个过滤条件，可以精确资源的搜索范围。支持的过滤参数以及匹配方式见下文。多个过滤条件之间是逻辑与AND的关系，只有同时满足所有过滤条件的资源才会被返回。每个过滤条件内部是逻辑或OR的关系，只要满足任意一个过滤条件值的资源都会被返回。
您可以在示例中心获取更多查询示例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

resourcecenter:SearchResources

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	查询返回结果下一页的令牌。当返回结果数据总条数超过`MaxResults`限制，则数据会被截断，您可以使用`NextToken`查询下一页数据。	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
MaxResults	integer	否	每页的最大数据条数。取值范围：1~500。默认值：20。	10
Filter	array<object>	否	过滤条件。
	object	否	过滤条件。
Key	string	否	过滤条件键。取值见下方`支持的过滤参数`。	RegionId
MatchType	string	否	匹配方式。取值： Equals，表示相等匹配。 Prefix，表示前缀匹配。 Contains，表示包含某值。 NotContains，表示不包含某值。 Exists，表示存在。 NotExists，表示不存在。	Equals
Value	array	否	过滤条件值。
	string	否	过滤条件值。	过滤条件值。
ResourceGroupId	string	否	资源组 ID。	rg-acfmzawhxxc****
SortCriterion	object	否	排序参数。
Key	string	否	排序条件。取值：CreateTime，表示按资源创建时间排序。	CreateTime
Order	string	否	排序顺序。取值： ASC（默认值）：升序。 DESC：降序。	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
IpAddress	IP 地址。	Equals、Contains

返回参数

名称	类型	描述	示例值
	object	返回参数。
Filters	array<object>	过滤条件。
	object	过滤条件。
Key	string	过滤条件键。	RegionId
MatchType	string	匹配方式。	Equals
Values	array	过滤条件值。
	string	过滤条件值。	cn-hangzhou
MaxResults	integer	每页的最大数据条数。	10
NextToken	string	查询返回结果下一页的令牌。	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
RequestId	string	请求 ID。	D696E6EF-3A6D-5770-801E-4982081FE4D0
Resources	array<object>	资源信息。
	object	资源信息。
AccountId	string	阿里云账号 ID。	151266687691****
CreateTime	string	资源的创建时间。说明资源是否返回该参数，由所属的云服务决定。	2021-06-30T09:20:08Z
ExpireTime	string	资源过期时间。	2021-07-30T09:20:08Z
IpAddressAttributes	array<object>	IP 地址属性。
	object	IP 地址属性。
IpAddress	string	IP 地址。	192.168.1.2
NetworkType	string	网络类型，取值： Public：公网。 Private：私网。	Public
Version	string	IP 地址的版本。	Ipv4
IpAddresses	array	IP 地址。说明资源是否返回该参数，由所属的云服务决定。
	string	IP 地址。说明资源是否返回该参数，由所属的云服务决定。	192.168.1.2
RegionId	string	地域 ID。	cn-hangzhou
ResourceGroupId	string	资源组 ID。	rg-acfmzawhxxc****
ResourceId	string	资源 ID。	vtb-bp11lbh452fr8940s****
ResourceName	string	资源名称。	group1
ResourceType	string	资源类型。	ACS::VPC::RouteTable
Tags	array<object>	标签。
	object	标签。
Key	string	标签键。	test_key
Value	string	标签值。	test_value
ZoneId	string	可用区 ID。说明资源是否返回该参数，由所属的云服务决定。	cn-hangzhou-k

示例

正常返回示例

JSON格式

{
  "Filters": [
    {
      "Key": "RegionId",
      "MatchType": "Equals",
      "Values": [
        "cn-hangzhou"
      ]
    }
  ],
  "MaxResults": 10,
  "NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****\t\n",
  "RequestId": "D696E6EF-3A6D-5770-801E-4982081FE4D0",
  "Resources": [
    {
      "AccountId": "151266687691****",
      "CreateTime": "2021-06-30T09:20:08Z",
      "ExpireTime": "2021-07-30T09:20:08Z",
      "IpAddressAttributes": [
        {
          "IpAddress": "192.168.1.2",
          "NetworkType": "Public",
          "Version": "Ipv4"
        }
      ],
      "IpAddresses": [
        "192.168.1.2"
      ],
      "RegionId": "cn-hangzhou",
      "ResourceGroupId": "rg-acfmzawhxxc****",
      "ResourceId": "vtb-bp11lbh452fr8940s****",
      "ResourceName": "group1",
      "ResourceType": "ACS::VPC::RouteTable",
      "Tags": [
        {
          "Key": "test_key",
          "Value": "test_value"
        }
      ],
      "ZoneId": "cn-hangzhou-k"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	You are not authorized to perform this operation.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	参数 MaxResults 不合法。
400	InvalidParameter.Filter.ResourceType	The specified parameter value of Filter.ResourceType is not valid.
409	InvalidParameter.SortCriterion.Key	The specified parameter SortCriterion.Key is not valid.
409	ExceedLimit.Filter	The maximum length of Filters is exceeded.	参数 Filter 数量超出上限。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。