All Products
Search
Document Center

Server Load Balancer:ListTagResources

Last Updated:Mar 21, 2025

Queries the tags of a resource.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
nlb:ListTagResourcesget
ServerGroup
acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServergroupId}
LoadBalancer
acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}
SecurityPolicy
acs:nlb:{#regionId}:{#accountId}:securitypolicy/{#SecurityPolicyId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The type of the resource. Valid values:

  • loadbalancer: the Network Load Balancer (NLB) instance
  • securitypolicy: the security policy
  • servergroup: the server group
  • listener: the listener
loadbalancer
ResourceIdarrayNo

The IDs of the resources.

ResourceIdstringNo

The ID of the resource.

nlb-nrnrxwd15en27r****
Tagarray<object>No

The tags

TagModelobjectNo

The tag.

KeystringNo

The key of the tag. The tag key can be up to 128 characters in length, cannot start with acs: or aliyun, and cannot contain http:// or https://.

env
ValuestringNo

The value of the tag. The tag value can be up to 128 characters in length, cannot start with acs: or aliyun, and cannot contain http:// or https://.

product
NextTokenstringNo

The pagination token used to specify a particular page of results. Valid values:

  • Leave this parameter empty for the first query or the only query.
  • Set this parameter to the value of NextToken obtained from the previous query.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsintegerNo

The number of entries to return in each call. Valid values: 1 to 50. Default value: 50.

20
RegionIdstringNo

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

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Queries the tags of a resource.

RequestIdstring

The request ID.

54B48E3D-DF70-471B-AA93-08E683A1B45
TagResourcesarray<object>

The details about the resource and its tags, including the resource ID, the resource type, and the keys and values of the tags.

TagResultModelListobject
ResourceIdstring

The resource ID.

nlb-nrnrxwd15en27r****
ResourceTypestring

The type of resource. Valid values:

  • loadbalancer: an NLB instance
  • securitypolicy: a security policy
  • servergroup: a server group
loadbalancer
RegionNostring

The region information.

cn-hangzhou
AliUidlong

The UID of the Alibaba Cloud account.

1429****39299349
TagKeystring

The tag key.

env
TagValuestring

The tag value.

product
Scopestring

The visible range of the tags.

public
Categorystring

The type of the tag. Valid values:

  • Custom
  • System
  • All
All
TotalCountinteger

The total number of entries returned.

10
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If NextToken is empty, no next page exists.
  • If a value is returned for NextToken, the value is the token that determines the start point of the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

The number of entries per page.

20

Examples

Sample success responses

JSONformat

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TagResources": [
    {
      "ResourceId": "nlb-nrnrxwd15en27r****",
      "ResourceType": "loadbalancer",
      "RegionNo": "cn-hangzhou",
      "AliUid": 0,
      "TagKey": "env",
      "TagValue": "product",
      "Scope": "public",
      "Category": "All"
    }
  ],
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

Error codes

HTTP status codeError codeError messageDescription
400SystemBusySystem is busy, please try again later.-
400IllegalParam.resourceTypeThe param of resourceType is illegal.The parameter resourceType is invalid. Please check the input value of the parameter resourceType.
400MissingParam.%sThe parameter of %s is missing.-
403Forbidden.NoPermissionAuthentication is failed for NoPermission.Authentication is failed for NoPermission.
404ResourceNotFound.securitypolicyThe specified resource of securitypolicy is not found.-
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.The specified load balancer resource was not found. Please check the input parameters.
404ResourceNotFound.listenerThe specified resource %s is not found.-
404ResourceNotFound.serverGroupThe specified resource of serverGroup is not found.The specified resource of serverGroup is not found. Please check the input parameters.

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

Change history

Change timeSummary of changesOperation
2023-10-30The Error code has changedView Change Details
2023-10-09The Error code has changedView Change Details
2023-09-26The Error code has changedView Change Details
2023-09-12The Error code has changedView Change Details
2023-09-05The Error code has changedView Change Details
2023-08-22The Error code has changedView Change Details
2023-07-04The Error code has changed. The request parameters of the API has changedView Change Details
2023-06-29The Error code has changedView Change Details