TagResources - PrivateLink - Alibaba Cloud Documentation Center

Adds tags to resources. You can call this API operation to add tags to one or more endpoints or endpoint services.

Operation description

Note You can add up to 20 tags to an instance. Before you add tags to a resource, Alibaba Cloud checks the number of existing tags of the resource. If the maximum number is reached, an error message is returned.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
privatelink:TagResources	update	VpcEndpoint acs:privatelink::{#accountId}:vpcendpoint/{#vpcendpointId} VpcEndpointService acs:privatelink::{#accountId}:vpcendpointservice/{#vpcendpointserviceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	array	Yes	The resource IDs. Up to 50 resource IDs are supported.
	string	Yes	The resource ID.	lb-bp16qjewdsunr41m1****
Tag	array<object>	Yes	The tags to add to the resources.
	object	Yes
Key	string	Yes	The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.	FinanceDept
Value	string	Yes	The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.	FinanceJoshua
ResourceType	string	Yes	The type of resource. Valid values: vpcendpoint: endpoint vpcendpointservice: endpoint service	1
DryRun	boolean	No	Specifies whether to perform only 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 message 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
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 request ID as the client token.******** The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The region ID of the PrivateLink instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	C46FF5A8-C5F0-4024-8262-B16B639225A0

Examples

Sample success responses

JSONformat

{
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTagKeyParam	The tag key is empty.	The tag key is empty.
400	MissingTagValueParam	The tag value is empty.	The tag value is empty.
400	IllegalTagKeyParam	IllegalTagKeyParam	IllegalTagKeyParam
400	IllegalTagValueParam	The tag value is Illegal.	The tag value is Illegal.
400	DuplicatedTagKey	The tag keys is duplicated.	The tag key must be unique.
400	QuotaExceed.TagsPerResource	The maximum number of tags for each resource is exceeded	The maximum number of tags for each resource is exceeded
400	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.	The specified ResourceIds are not found in our records.

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

Change history

Change time	Summary of changes	Operation
2024-01-18	The Error code has changed	View Change Details
2022-12-22	The Error code has changed	View Change Details
2022-08-11	The Error code has changed	View Change Details
2022-08-05	The Error code has changed	View Change Details
2022-08-02	Add Operation	View Change Details