文档

SearchResources - 搜索当前账号的资源

更新时间:

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

接口说明

  • 仅能搜索当前账号下有权限访问的资源。
  • 仅能搜索支持资源中心的云服务及资源类型
  • 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:SearchResourceslist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
NextTokenstring

查询返回结果下一页的令牌。

当返回结果数据总条数超过MaxResults限制,则数据会被截断,您可以使用NextToken查询下一页数据。

eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
MaxResultsinteger

每页的最大数据条数。

取值范围:1~500。

默认值:20。

10
Filterarray<object>

过滤条件。

object

过滤条件。

Keystring

过滤条件键。取值见下方支持的过滤参数

RegionId
Valuearray

过滤条件值。

string

过滤条件值。

过滤条件值。
MatchTypestring

匹配方式。

取值:Equals,表示相等匹配。

Equals
ResourceGroupIdstring

资源组 ID。

rg-acfmzawhxxc****
SortCriterionobject

排序参数。

Keystring

排序条件。

取值:CreateTime,表示按资源创建时间排序。

CreateTime
Orderstring

排序顺序。取值:

  • 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
VpcIdVPC ID。Equals
VSwitchId交换机 ID。Equals

返回参数

名称类型描述示例值
object

返回参数。

NextTokenstring

查询返回结果下一页的令牌。

eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
RequestIdstring

请求 ID。

D696E6EF-3A6D-5770-801E-4982081FE4D0
MaxResultsinteger

每页的最大数据条数。

10
Filtersarray<object>

过滤条件。

object

过滤条件。

Keystring

过滤条件键。

RegionId
MatchTypestring

匹配方式。

Equals
Valuesarray

过滤条件值。

string

过滤条件值。

cn-hangzhou
Resourcesarray<object>

资源信息。

object

资源信息。

ResourceTypestring

资源类型。

ACS::VPC::RouteTable
CreateTimestring

资源的创建时间。

说明 资源是否返回该参数,由所属的云服务决定。
2021-06-30T09:20:08Z
ResourceGroupIdstring

资源组 ID。

rg-acfmzawhxxc****
ZoneIdstring

可用区 ID。

说明 资源是否返回该参数,由所属的云服务决定。
cn-hangzhou-k
AccountIdstring

阿里云账号 ID。

151266687691****
ResourceIdstring

资源 ID。

vtb-bp11lbh452fr8940s****
ResourceNamestring

资源名称。

group1
RegionIdstring

地域 ID。

cn-hangzhou
Tagsarray<object>

标签。

object

标签。

Keystring

标签键。

test_key
Valuestring

标签值。

test_value
IpAddressesarray

IP 地址。

说明 资源是否返回该参数,由所属的云服务决定。
string

IP 地址。

说明 资源是否返回该参数,由所属的云服务决定。
192.168.1.2
IpAddressAttributesarray<object>

IP 地址属性。

object

IP 地址属性。

IpAddressstring

IP 地址。

192.168.1.2
NetworkTypestring

网络类型,取值:

  • Public:公网。
  • Private:私网。
Public
Versionstring

IP 地址的版本。

Ipv4
ExpireTimestring

资源过期时间。

2021-07-30T09:20:08Z

示例

正常返回示例

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错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.无操作权限。
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.参数 MaxResults 不合法。
409InvalidParameter.SortCriterion.KeyThe specified parameter SortCriterion.Key is not valid.参数 SortCriterion.Key 不合法。
409ExceedLimit.FilterThe maximum length of Filters is exceeded.参数 Filter 数量超出上限。

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

变更历史

变更时间变更内容概要操作
2023-11-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-11-10OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-22OpenAPI 错误码发生变更查看变更详情
2023-03-30OpenAPI 错误码发生变更查看变更详情
2023-03-07OpenAPI 错误码发生变更查看变更详情