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.

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

privatelink:TagResources

update

*VpcEndpoint

acs:privatelink:*:{#accountId}:vpcendpoint/{#vpcendpointId}

*VpcEndpointService

acs:privatelink:*:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	array	Yes	The resource IDs. Up to 50 resource IDs are supported.
	string	No	The resource ID.	ep-ba16baebdf35641a1****
Tag	array<object>	Yes	The tags to add to the resources.
	object	No
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	vpcendpoint
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 elements

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

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.