TagResources - Server Load Balancer - Alibaba Cloud Documentation Center

Creates and attaches tags to specified resources.

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

gwlb:TagResources

update

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

Listener

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Valid values: loadbalancer: a Gateway Load Balancer (GWLB) instance. listener: a listener. servergroup: a server group.	loadbalancer
ResourceId	array	Yes	The list of resource IDs. You can specify up to 50 resource IDs in each call.
	string	No	The resource ID.	gwlb-nrnrxwd15en27r****
Tag	array<object>	Yes	The tags. You can specify up to 20 tags in each call.
	object	Yes	The tag.
Key	string	Yes	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 `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	testKey
Value	string	Yes	The tag value. The tag value can be up to 256 characters in length and cannot contain `http://` or `https://`.	testValue
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, the request format, and the service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a normal request. If the request passes the check, the system returns a 2xx HTTP status code and performs the operation.	false
ClientToken	string	No	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 token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	54F6E60A-1777-5C17-A6A9-BCC1A7FE945B

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.TagKey	The param of TagKey is missing.	The parameter of tag key is missing.
400	MissingParam.TagValue	The param of TagValue is missing.	The parameter of tag value is missing.
400	ResourceQuotaExceeded.TagNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The number of tags bound to the resource exceeds the limit.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
400	IllegalParam.TagValue	The param of %s is illegal.	The parameter of tag value is illegal.
400	DuplicatedParam.ResourceId	The param of %s is duplicated.	The param of %s is duplicated.
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.	The specified resource of .LoadBalancer is not found.
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	The specified server group resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.