Adding a Resource Tag

Function

You can add a maximum of 10 tags to a resource. The API is idempotent. If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/{resource_type}/{resource_id}/tags

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.
resource_type	Yes	String	Specifies the resource type. Possible values are: smn_topic: topic smn_sms: SMS smn_application: mobile push
resource_id	Yes	String	Specifies the resource ID. To obtain the value of resource_id, perform the following steps: When resource_type is set to smn_topic: Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name. Call the GetResourceInstances API to obtain the resource ID. If you set resource_type to smn_sms, the resource ID is the signature ID, which can be obtained on the console.

Request Parameters

Table 2 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters
Parameter	Mandatory	Type	Description
tag	Yes	ResourceTag object	Specifies the resource tag structure.

Table 4 ResourceTag
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the key field to be matched. key can only be resource_name. In such a case, value is the ECS name. The key must be unique, and the value is used for matching. The key field is a fixed dictionary value. key cannot be left blank.
value	Yes	String	Specifies the value. key can only be resource_name. In such a case, value is the ECS name. It can contain a maximum of 255 Unicode characters. This field cannot be left blank.

Response Parameters

Status code: 400

Table 5 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 403

Table 6 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 404

Table 7 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 500

Table 8 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Example Requests

Adding a resource tag

POST https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags

{
  "tag" : {
    "key" : "DEV",
    "value" : "DEV1"
  }
}

Example Responses

None

Status Codes

Status Code	Description
204	OK
400	Bad Request
403	Unauthorized
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Tags

Предыдущая статья

Querying Resource Tags

Следующая статья

Querying Project Tags

Была ли эта статья полезна?

Поддержка Юридические документы