Batch Tag Cloud Resources via TagCloudResources API - App Streaming - Alibaba Cloud - App Streaming

Creates and attaches tags to cloud resources. If a tag already exists on a resource, the tag value is updated.

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

appstreaming:TagCloudResources

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The cloud resource type. Valid values: CenterImageId : center image ID. AppId : application ID. WyId : unique ID of the Wuying user. AppInstanceGroupId : delivery group ID. AliUid : tenant ID.	AppInstanceGroupId
ResourceIds	array	No	The list of resource IDs. A maximum of 50 resource IDs are supported. You do not need to specify this parameter when the resource type is tenant ID.
	string	Yes	The resource ID.	aig-0002
Tags	array<object>	Yes	The list of tags. System tags and custom tags are supported. System tag enumeration values: `System/Scheduler/GRAYSCALE`: canary release tag `System/Scheduler/STOP_NEW_USER_CONNECTION`: tag that prevents new user connections from being established for the delivery group Custom tags: A maximum of 20 custom tags can be created. Note Each tag key on the same resource can have only one tag value. If you add a tag key that already exists, the corresponding tag value is updated to the new value.
	object	Yes	The tag information.
Key	string	Yes	The tag key. This parameter is case-sensitive. The tag key must be 1 to 128 characters in length.	Resolution
Value	string	Yes	The tag value. This parameter is case-sensitive. The tag value must be 1 to 128 characters in length.	720p

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
FailedResources	array<object>	The list of failed resources and tag information.
	array<object>	The failed resource and tag information.
ResourceType	string	The cloud resource type. Valid values: CenterImageId : center image ID. AppId : application ID. WyId : unique ID of the Wuying user. AppInstanceGroupId : delivery group ID. AliUid : tenant ID.	AppInstanceGroupId
ResourceId	string	The resource ID.	aig-001
Tags	array<object>	The list of failed tag information.
	object	The failed tag information.
Key	string	Tag key.	System/Scheduler/STOP_NEW_USER_CONNECTION
Value	string	Tag value.	true
Scope	string	Tag Type. Valid values: Custom : System :	System
Code	string	The error code.	TAG_KEY_DUPLICATED
Message	string	The error message.	Duplicate tag keys exist.

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "FailedResources": [
    {
      "ResourceType": "AppInstanceGroupId",
      "ResourceId": "aig-001",
      "Tags": [
        {
          "Key": "System/Scheduler/STOP_NEW_USER_CONNECTION",
          "Value": "true",
          "Scope": "System"
        }
      ],
      "Code": "TAG_KEY_DUPLICATED",
      "Message": "Duplicate tag keys exist."
    }
  ]
}

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.