QueryInstanceByTag - Expenses and Costs - Alibaba Cloud Documentation Center

Queries a list of instances by tags.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bssapi:QueryInstanceByTag

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The type of the resource. Set this parameter to `instance` to query savings plan instances.	instance
ResourceId	array	No	A list of resource IDs.
	string	No	The ID of the resource.	spn-XXXXXX
Tag	array<object>	No	A list of tags.
	object	No	A key-value pair of a tag.
Key	string	No	The tag key.	ecs
Value	string	No	The tag value.	001

Response elements

Parameter	Type	Description	Example
	object	The data returned.
Code	string	The status code.	PARAM_ERROR
Message	string	The error message.	param is null
NextToken	string	The token used to query the next page of results. This is the `NextToken` value returned from the previous API call.	CAESEgoQCg4KCm
RequestId	string	The ID of the request.	9EC6C0B7-3397-5FAE-9915-8972CDDB1211
Success	boolean	Indicates whether the request was successful.	true
TagResource	array<object>	A list of instance information.
	object	The information about the instance.
ResourceId	string	The ID of the resource.	spn-xxxxx
ResourceType	string	The type of the resource. `instance` indicates a savings plan instance.	instance
Tag	array<object>	A list of tags.
	object	A key-value pair of a tag.
Key	string	The tag key.	tag1
Value	string	The tag value.	10

Examples

Success response

JSON format

{
  "Code": "PARAM_ERROR",
  "Message": "param is null",
  "NextToken": "CAESEgoQCg4KCm",
  "RequestId": "9EC6C0B7-3397-5FAE-9915-8972CDDB1211",
  "Success": true,
  "TagResource": [
    {
      "ResourceId": "spn-xxxxx",
      "ResourceType": "instance",
      "Tag": [
        {
          "Key": "tag1",
          "Value": "10"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.