UntagResources

Updated at:

Unbinds tags from specified Wuying delivery groups in compliance with Alibaba Cloud tagging standards. You can unbind specific tags by tag key or unbind all custom tags from a resource at once by setting `All=true` without specifying tag keys. Currently, only the delivery group (`APPINSTANCEGROUP`) resource type is supported.

Operation description

Before you begin

When calling this operation with a RAM user or STS credential, the appstreaming:UntagResources permission is required.

The resources from which you want to unbind tags must belong to the current Alibaba Cloud account. This operation currently supports only delivery group resources. You can set ResourceType only to APPINSTANCEGROUP. You can obtain delivery group IDs by calling ListAppInstanceGroup, and query tags that are bound to a resource by calling ListTagResources.

Parameter description

  • You can unbind tags from up to 50 resources in a single request. Duplicate resource IDs are automatically deduplicated.

  • Specify at least one of TagKey.N and All. If neither is specified, or if TagKey.N is not specified and All is set to false, the error code InvalidParameter.TagKeyListOrAll is returned.
    • If TagKey.N is specified: only the tags that correspond to the specified tag keys are unbound. You can specify up to 20 tag keys at a time. The All parameter is ignored.

    • If TagKey.N is not specified and All=true: all custom tags on the resource are unbound, including Wuying system tags that start with System/ and were attached by calling TagResources.

  • If a specified tag key does not exist on the resource, the tag key is skipped and no error is returned.

  • Tag keys that start with System/ are Wuying system tags. Only System/Scheduler/GRAYSCALE and System/Scheduler/STOP_NEW_USER_CONNECTION are supported. If you specify other tag keys that start with System/, the error code InvalidTagPolicy.KeyInvalid or InvalidTag.SystemKeyNotAllow is returned.

Execution results

  • If any specified delivery group does not exist or does not belong to the current account, the entire request fails with the error code InvalidAppInstanceGroup.NotFound, and no tags are unbound from any resource.

  • On success, the response contains only RequestId and does not return tag details.

  • When multiple resources are specified and only some fail to have tags unbound, the operation still returns success and the response does not contain failure details. Call ListTagResources to verify the unbinding results. When only one resource is specified and the unbinding fails, the operation returns the corresponding error code directly.

Call sequence

  1. Call ListAppInstanceGroup to obtain delivery group IDs. To check which tag keys are bound to a resource, call ListTagResources.

  2. Call this operation with ResourceType=APPINSTANCEGROUP and ResourceId.N, and specify TagKey.N or All=true to indicate the tags to unbind.

  3. To rebind tags, call TagResources.

The masked identifiers in the examples are for format demonstration purposes only. Replace them with your actual identifiers when making calls.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID. This parameter is required. Set this parameter to the ID of the region where the delivery group resides, such as cn-hangzhou.

cn-hangzhou

ResourceType

string

Yes

The resource type. This parameter is required. Currently, only delivery groups are supported. The value is case-insensitive. We recommend that you use uppercase.

Valid values:

  • APPINSTANCEGROUP: Wuying delivery group.

If you specify other values, the error code InvalidResourceType.Invalid is returned.

Valid values:

  • APPINSTANCEGROUP :

    Wuying delivery group.

APPINSTANCEGROUP

ResourceId

array

Yes

The list of resource IDs from which you want to unbind tags. This parameter is required. Specify delivery group IDs. You can specify up to 50 IDs at a time. Duplicate IDs are automatically deduplicated.

All IDs must correspond to existing delivery groups under the current Alibaba Cloud account. If any ID does not exist or does not belong to the current account, the entire request fails with the error code InvalidAppInstanceGroup.NotFound, and no tags are unbound from any resource.

string

Yes

The delivery group ID. You can obtain this ID by calling ListAppInstanceGroup.

aig-9ciijz60n4xsv****

TagKey

array

No

The list of tag keys to unbind. You can specify up to 20 tag keys at a time. Specify at least one of TagKey.N and All. If neither is specified, the error code InvalidParameter.TagKeyListOrAll is returned.

  • If TagKey.N is specified, only the tags that correspond to the specified tag keys are unbound. The All parameter is ignored.

  • If a specified tag key does not exist on the resource, the tag key is skipped and no error is returned.

  • If TagKey.N is not specified, set All to true to unbind all custom tags from the resource.

Tag keys that start with System/ are Wuying system tags. Only the following values are supported:

  • System/Scheduler/GRAYSCALE: the canary release tag for the delivery group.

  • System/Scheduler/STOP_NEW_USER_CONNECTION: prevents newly bound users from establishing connections to the delivery group.

If you specify other tag keys that start with System/, the error code InvalidTagPolicy.KeyInvalid or InvalidTag.SystemKeyNotAllow is returned.

string

Yes

The tag key. This parameter cannot be empty. You can query the tag keys bound to a resource by calling ListTagResources.

Resolution

All

boolean

No

Specifies whether to unbind all custom tags from the resource. This parameter takes effect only when TagKey.N is not specified. If TagKey.N is specified, this parameter is ignored. Valid values:

  • true: Unbinds all custom tags from the resource, including Wuying system tags that start with System/ and were bound by calling TagResources.

  • false (default): Does not perform a full unbinding. If TagKey.N is also not specified, the error code InvalidParameter.TagKeyListOrAll is returned.

false

Response elements

Element

Type

Description

Example

object

The response of this request. On success, only the request ID is returned.

RequestId

string

The request ID, which can be used to troubleshoot issues.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

HTTP status code

Error code

Error message

Description

500 ServiceUnavailable Service unavailable. Please try again later. Service unavailable. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.