All Products
Search
Document Center

Resource Management:SearchResources

Last Updated:Jun 21, 2024

Search for resources that you can access within the current account.

Operation description

  • You can use this operation to search for only resources whose types are supported by Resource Center in services that work with Resource Center. For more information about the services and the resource types that are supported by Resource Center, see Services that work with Resource Center.
  • By default, the operation returns a maximum of 20 entries. You can configure the MaxResults parameter to specify the maximum number of entries to return.
  • If the response does not contain the NextToken parameter, all entries are returned. Otherwise, more entries exist. If you want to obtain the entries, you can call the operation again to initiate another query request. In the request, set the NextToken parameter to the value of NextToken in the last response of the operation. If you do not configure the NextToken parameter, entries on the first page are returned by default.
  • You can specify one or more filter conditions to narrow the search scope. For more information about supported filter parameters and matching methods, see the Supported filter parameters section. Multiple filter conditions have logical AND relations. Only resources that meet all filter conditions are returned. The values of a filter condition have logical OR relations. Resources that meet any value of the filter condition are returned.
  • You can visit Sample Code Center to view more sample queries.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

If the total number of entries returned for the current request exceeds the value of the MaxResults parameter, the entries are truncated. In this case, you can use the token to initiate another request and obtain the remaining entries.

eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
MaxResultsintegerNo

The maximum number of entries per page.

Valid values: 1 to 100.

Default value: 20.

10
Filterobject []No

The filter conditions.

KeystringNo

The key of the filter condition. For more information, see Supported filter parameters.

RegionId
ValuearrayNo

The values of the filter condition.

stringNo

A value of the filter condition.

Filter condition value
MatchTypestringNo

The matching mode.

The value Equals indicates an equal match.

Equals
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmzawhxxc****
SortCriterionobjectNo

The method that is used to sort the entries returned.

KeystringNo

The attribute based on which the entries are sorted.

The value CreateTime indicates the creation time of resources.

CreateTime
OrderstringNo

The order in which the entries are sorted. Valid values:

  • ASC: The entries are sorted in ascending order. This value is the default value.
  • DESC: The entries are sorted in descending order.
ASC

Supported filter parameters

ParameterDescriptionSupported matching mode
ResourceTypeThe resource type.Equals
RegionIdThe region ID.Equals
ResourceIdThe resource ID.Equals and Prefix
ResourceGroupIdThe resource group ID.Equals, Exists, and NotExists
ResourceNameThe resource name.Equals and Contains
TagThe key-value pair of the tag. The key-value pair must be in the { "key": $key, "value": $value } JSON format. You must specify at least one of key and value. For example, if you want to query the tag key foo and tag value bar, set this parameter to { "key": "foo", "value": "bar" }. If you want to query only the tag key foo, set this parameter to { "key": "foo" }.Contains, NotContains, and NotExists
VpcIdThe VPC ID.Equals
VSwitchIdThe vSwitch ID.Equals

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

NextTokenstring

The pagination token that is used in the next request to retrieve a new page of results.

eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
RequestIdstring

The ID of the request.

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

The maximum number of entries returned per page.

10
Filtersobject []

The filter conditions.

Keystring

The key of the filter condition.

RegionId
MatchTypestring

The matching mode.

Equals
Valuesarray

The values of the filter condition.

string

A value of the filter condition.

cn-hangzhou
Resourcesobject []

The information about the resources.

ResourceTypestring

The resource type.

ACS::VPC::RouteTable
CreateTimestring

The time when the resource was created.

Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.
2021-06-30T09:20:08Z
ResourceGroupIdstring

The resource group ID.

rg-acfmzawhxxc****
ZoneIdstring

The zone ID.

Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.
cn-hangzhou-k
AccountIdstring

The ID of the Alibaba Cloud account.

151266687691****
ResourceIdstring

The resource ID.

vtb-bp11lbh452fr8940s****
ResourceNamestring

The resource name.

group1
RegionIdstring

The region ID.

cn-hangzhou
Tagsobject []

The tags.

Keystring

The key of tag N.

test_key
Valuestring

The value of tag N.

test_value
IpAddressesarray

The IP addresses.

Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.
string

The IP address.

Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.
192.168.1.2
IpAddressAttributesobject []

The attributes of the IP address.

IpAddressarray

The IP address.

string

The IP address.

120.221.xxx.xxx
NetworkTypestring

The network type. Valid values:

  • Public: the Internet
  • Private: internal network
Public
Versionstring

The version.

Ipv4
ExpireTimestring

The time when the resource expires.

2021-07-30T09:20:08Z

Examples

Sample success responses

JSONformat

{
  "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": [
            "120.221.xxx.xxx"
          ],
          "NetworkType": "Public",
          "Version": "Ipv4"
        }
      ],
      "ExpireTime": "2021-07-30T09:20:08Z"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform the operation.
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.The MaxResults parameter is invalid.
409InvalidParameter.SortCriterion.KeyThe specified parameter SortCriterion.Key is not valid.The SortCriterion.Key parameter is invalid.
409ExceedLimit.FilterThe maximum length of Filters is exceeded.The number of objects specified in the Filter parameter exceeds the upper limit.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-21The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 409
Output ParametersThe response structure of the API has changed.
2023-11-10The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 409
Output ParametersThe response structure of the API has changed.
2023-08-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 409
2023-03-30The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 409
2023-03-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 409