• Key Management Service

kms
  1. Help Center
  2. Key Management Service
  3. API Reference
  4. APIs
  5. Adding a CMK Tag

Adding a CMK Tag

Function

This API allows you to add a CMK tag.

URI

  • URI format

    POST /v1.0/{project_id}/kms/{key_id}/tags

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    project_id

    string

    Yes

    Project ID

    key_id

    string

    Yes

    36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$

    Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f

Requests

  • Request parameters

    Parameter

    Type

    Mandatory

    Description

    tag

    resource_tag

    Yes

    Included tag

    sequence

    string

    No

    36-byte serial number of a request message

    Example: 919c82d4-8046-4722-9094-35c3c6524cff

  • Description of the resource_tag field

    Parameter

    Type

    Mandatory

    Description

    key

    string

    Yes

    Key. The value contains a maximum of 36 characters. The value of key cannot be empty, and cannot contain the following characters: ASCII (0-31) and *<>\=

    value

    string

    Yes

    Value. Each value contains a maximum of 43 Unicode characters and can be an empty string. The value cannot contain the following characters: ASCII (0-31) and *<>\=

Responses

Response parameters

None

Examples

The following example describes how to add a tag, the key and value of which are DEV and DEV1 respectively.

  • Example request
    {   
      "tag":
         {  
            "key":"DEV",
            "value":"DEV1"
         }
    }
  • Example response
    { 
    }
    or
    {    
           "error": {        
                  "error_code": "KMS.XXXX",        
                  "error_msg": "XXX"     
         } 
    }

Status Codes

Table 1 lists the normal status code returned by the response.
Table 1 Status codes

Status Code

Status

Description

204

No Content

The request is processed successfully and no content is returned.

Exception status code. For details, see Status Codes.