Use TagResources to add tags to resources - Application Real-Time Monitoring Service - Alibaba Cloud - Application Real-Time Monitoring Service

Adds tags to ARMS resources.

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

arms:TagResources

update

*Prometheus

acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}

*RetcodeApp

acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}

*TraceApp

acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#EnvironmentId}

*GrafanaWorkspace

acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	array	Yes	The resource IDs. You can specify a maximum of 50 resource IDs.
	string	No	The instance ID.	uxqcr8b***
Tag	array<object>	Yes	The tags to add to the resource. You can specify a maximum of 20 tags.
	object	No	code!=""
Key	string	No	The key of the tag.	Key1
Value	string	No	The value of the tag.	Test1
ResourceType	string	Yes	The type of the ARMS resources for which you want to modify tags. Valid values: WEB: Browser Monitoring APPLICATION: Application Monitoring PROMETHEUS: Managed Service for Prometheus SYNTHETICTASK: Synthetic Monitoring ALERTRULE: Application Monitoring alert rule PROMETHEUSALERTRULE: Managed Service for Prometheus alert rule XTRACEAPP: Managed Service for OpenTelemetry	APPLICATION

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	05919CF2-B8A1-588D-B3DB-89B3********
Data	string	The returned message.	success

Examples

Success response

JSON format

{
  "RequestId": "05919CF2-B8A1-588D-B3DB-89B3********",
  "Data": "success"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DuplicateTagKey	Param tagKey is duplicate.
400	NoPermissionKeyOperator	user is no permission for operating param tagKey.
400	ResourceIdAndTagIsNull	resourceId or tag param must have one
400	TagISNull	param tag must be not null.
400	TagNumOUT	the number of tag is out .
400	ResourceIdIsNull	param resourceId must be not null.
400	ResourceTypeIllegal	The ResourceType parameter is invalid.	The specified ResourceType parameter is invalid.
400	NoPermissionUSER	user no permission
400	ScopeDisAgreement	Param scope is different from before.
400	ParameterNextTokenIllegal	param nextToken is invalid.
400	InvalidParameterTagKey	The specified TagKey is invalid.	The specified TagKey parameter is invalid.
400	InvalidParameterTagValue	The specified TagValue is invalid.	The specified TagValue parameter is invalid.
400	TagKeyIsIllegal	The specified TagKey is invalid.	The specified TagKey parameter is invalid.
400	TagValueIsIllegal	The specified TagValue is invalid.	The specified TagValue parameter is invalid.
400	ResourceIDOUT	The specified resourceId number is out of range.	The number of resource IDs exceeds the upper limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.