All Products
Search
Document Center

BSS OpenAPI:QueryInstanceByTag

Last Updated:Mar 01, 2024

Queries instances by tag.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bssapi:QueryInstanceByTagRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The type of the resource. Specify the savings plan instance as the type of the resource.

instance
ResourceIdarrayNo

The IDs of resources.

stringNo

The ID of the resource.

spn-XXXXXX
Tagobject []No

The tags.

KeystringNo

The tag key.

ecs
ValuestringNo

The tag value.

001

Response parameters

ParameterTypeDescriptionExample
object

The values returned.

Codestring

The status code returned.

PARAM_ERROR
Messagestring

The error message returned.

param is null
NextTokenstring

The token that determines the start point of the query. The return value is the value of the NextToken response parameter that was returned last time the QueryInstanceByTag operation was called.

CAESEgoQCg4KCm
RequestIdstring

The ID of the request.

9EC6C0B7-3397-5FAE-9915-8972CDDB1211
Successboolean

Indicates whether the request is successful.

true
TagResourceobject []

The instances returned.

ResourceIdstring

The ID of the resource.

spn-xxxxx
ResourceTypestring

The type of the resource. The returned resource type indicates a savings plan instance.

instance
Tagobject []

The tags.

Keystring

The tag key.

tag1
Valuestring

The tag value.

10

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history