All Products
Search
Document Center

Server Load Balancer:ListTagResources

Last Updated:Mar 14, 2024

Queries the tags that are added to resources.

Operation description

  • Set ResourceId.N or Tag.N that consists of Tag.N.Key and Tag.N.Value in the request to specify the object to be queried.
  • Tag.N is a resource tag that consists of a key-value pair. If you set only Tag.N.Key, all tag values that are associated with the specified tag key are returned. If you set only Tag.N.Value, an error message is returned.
  • If you set Tag.N and ResourceId.N to filter tags, ResourceId.N must match all specified key-value pairs.
  • If you specify multiple key-value pairs, resources that contain these key-value pairs are returned.

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
slb:ListTagResourcesLIST
  • acl
    acs:slb:{#regionId}:{#accountId}:acl/{#aclId}
  • certificate
    acs:slb:{#regionId}:{#accountId}:certificate/{#certificateId}
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/*
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Server Load Balancer (SLB) instance is created.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceTypestringYes

The type of the resource. Valid values:

  • instance: an SLB instance
  • certificate: a certificate
  • acl: a network access control list (ACL)
instance
NextTokenstringNo

The token that determines the start point of the query. Valid values:

  • If this is your first query or no subsequent query is to be sent, ignore this parameter.
  • If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.
caeba0bbb2be03f84eb48b699f0a****
ResourceIdarrayNo

The ID of a resource. You can specify up to 20 resources.

stringNo

The ID of a resource. You can specify up to 20 resources.

lb-bp1qnnvj18yy6h****
Tagobject []No

The tags.

KeystringNo

The tag key. You can specify at most 20 tag keys.

The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.

FinanceDept
ValuestringNo

The tag value. You can specify at most 20 tag values. The tag value cannot be an empty string.

The tag value must be 1 to 128 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

FinanceJoshua

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token that determines the start point of the query. Valid values:

  • If NextToken is empty, it indicates that no subsequent query is to be sent.
  • If a value of NextToken is returned, the value is the token that is used for the subsequent query.
caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

The ID of the request.

DE65F6B7-7566-4802-9007-96F2494AC512
TagResourcesobject []

The details about the resource to which the tags are added.

TagValuestring

The tag value.

FinanceJoshua
ResourceTypestring

The resource type.

instance
ResourceIdstring

The ID of the resource.

lb-bp16qjewdsunr4****
TagKeystring

The tag key.

FinanceDept

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "ResourceType": "instance",
        "ResourceId": "lb-bp16qjewdsunr4****",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400TagTypeNotSameThe category of tags in the same request must be the same.
400ResourceNotExist%s.
400QueryTokenNotExistThe specified NextToken does not exist.
400InvalidParam.NextTokenThe specified NextToken is invalid.
400InvalidParam.ScopeThe specified Scope is invalid.
400InvalidParam.ResourceTypeThe specified ResourceType is invalid.
400InvalidParam.TagKeyThe specified TagKey is invalid.
400InvalidParam.TagValueThe specified TagValue is invalid.
400InvalidParam.TagKeyOrValueThe specified TagKey or TagValue is invalid.
400InvalidParam.TagOwnerUidThe specified TagOwnerUid is invalid.
400InvalidParam.TagOwnerBidThe specified TagOwnerBid is invalid.
400MissingParam.ScopeThe parameter Scope is required.
400MissingParam.TagOwnerUidThe parameter TagOwnerUid is required.
400MissingParam.TagOwnerBidThe parameter TagOwnerBid is required.
400InvalidParameter.RegionIdThe specified RegionId does not exist.
400MissingParam.TagOrResourceIdThe parameter Tag or ResourceId is required at least one.
400SizeLimitExceeded.ResourceIdThe maximum size of ResourceId is exceeded.
400SizeLimitExceeded.TagThe maximum size of Tag is exceeded.

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

Change history

Change timeSummary of changesOperation
No change history