UntagResources - PrivateLink - Alibaba Cloud Documentation Center

Removes tags from one or more endpoints or endpoint services at a time.

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:UntagResources

update

*VpcEndpointService

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

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	array	Yes	The resource IDs. You can specify up to 50 resource IDs.
	string	No	The resource ID.	ep-hp3i05294c2****
TagKey	array	No	The keys of the tags that you want to remove from the resources. You can specify up to 20 tag keys.
	string	No	The key of the tag that you want to remove from the resource. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The tag key must start with a letter but cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	FinanceDept
ResourceType	string	Yes	The resource type. Valid values: vpcendpoint: endpoint vpcendpointservice: endpoint service	vpcendpoint
All	boolean	No	Specifies whether to remove all tags from the resource. Valid values: true false Note If you specify both the All and TagKey.N parameters, the All parameter does not take effect.	true
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.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
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
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	Schema of Response
RequestId	string	The ID of the request.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status code	Error code	Error message	Description
400	TagInfoNotExist	Tag info not exist	The tag key information does not exist.
400	DuplicatedTagKey	The tag keys is duplicated.	The tag key must be unique.
400	IllegalTagKeyParam	IllegalTagKeyParam	IllegalTagKeyParam
400	IllegalTagValueParam	The tag value is Illegal.	The tag value is Illegal.
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.