Querying Resource Tags
Function
This API is used to query tags of a specified resource.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/{resource_type}/{resource_id}/tags
| 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. The type can be the following: 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
| 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| tags | Array of ResourceTag objects | Specifies resource tags. |
| Parameter | Type | Description |
|---|---|---|
| key | String | Specifies the key field to be matched. key can only be resource_name. In such a case, value is the ECS name.
|
| value | String | Specifies the value. key can only be resource_name. In such a case, value is the ECS name.
|
Status code: 400
| 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
| 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
| 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
| 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
Querying resource tags
GET https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags
null Example Responses
Status code: 200
OK
{
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value3"
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.