All Products
Search
Document Center

Server Load Balancer:TagResources

Last Updated:Dec 02, 2024

Creates and adds tags to resources.

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:
    • 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
gwlb:TagResourcesupdate
*ServerGroup
acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}
*Listener
acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}
*LoadBalancer
acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The type of resource. Valid values:

  • loadbalancer: Gateway Load Balancer (GWLB) instance
  • listener: listener
  • servergroup: server group
loadbalancer
ResourceIdarrayYes

The resource IDs. You can specify at most 50 resource IDs in each call.

ResourceIdstringYes

The resource ID.

gwlb-nrnrxwd15en27r****
Tagarray<object>Yes

The tags. You can specify at most 20 tags in each call.

TagModelobjectYes

The tag.

KeystringYes

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

testKey
ValuestringYes

The tag value. The tag value can be up to 256 characters in length and cannot contain http:// or https://.

testValue
DryRunbooleanNo

Specifies whether to perform a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.

123e4567-e89b-12d3-a456-42665544****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

54F6E60A-1777-5C17-A6A9-BCC1A7FE945B

Examples

Sample success responses

JSONformat

{
  "RequestId": "54F6E60A-1777-5C17-A6A9-BCC1A7FE945B"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParam.TagKeyThe param of TagKey is missing.The parameter of tag key is missing.
400MissingParam.TagValueThe param of TagValue is missing.The parameter of tag value is missing.
400ResourceQuotaExceeded.TagNumThe quota of %s is exceeded for resource %s, usage %s/%s.The number of tags bound to the resource exceeds the limit.
400DuplicatedParam.TagKeyThe param of %s is duplicated.The parameter of tag key is duplicated.
400IllegalParam.TagKeyThe param of %s is illegal.-
400IllegalParam.TagValueThe param of %s is illegal.The parameter of tag value is illegal.
400DuplicatedParam.ResourceIdThe param of %s is duplicated.The param of %s is duplicated.
404ResourceNotFound.LoadBalancerThe specified resource of %s is not found.The specified resource of .LoadBalancer is not found.
404ResourceNotFound.ListenerThe specified resource of %s is not found.The specified resource of %s is not found.
404ResourceNotFound.ServerGroupThe specified resource of %s is not found.The specified server group resource does not exist.

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