All Products
Search

This Product

    Key Management Service:TagResource

    Document Center

    Key Management Service:TagResource

    Last Updated:Mar 12, 2026

    Adds tags to a CMK, secret, or certificate.

    Operation description

    You can add up to 10 tags to a CMK, secret, or certificate.

    In this example, the tags [{"TagKey":"S1key1","TagValue":"S1val1"},{"TagKey":"S1key2","TagValue":"S2val2"}] are added to the CMK whose ID is 08c33a6f-4e0a-4a1b-a3fa-7ddf****.

    For more information about the access policy required by a RAM user or RAM role to call this API, see Resource Access Management.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    KeyId

    string

    No

    The ID of the customer master key (CMK). The ID must be globally unique.

    Note

    You can configure only one of the KeyId, SecretName, and CertificateId parameters.

    08c33a6f-4e0a-4a1b-a3fa-7ddf****
    Tags

    string

    Yes

    One or more tags that you want to add. The value is in the array format.

    Tag attributes:

    • TagKey: the tag key.

    • TagValue: the tag value.

    [{"TagKey":"S1key1","TagValue":"S1val1"},{"TagKey":"S1key2","TagValue":"S2val2"}]
    SecretName

    string

    No

    The name of the secret.

    Note

    You can configure only one of the KeyId, SecretName, and CertificateId parameters.

    MyDbC****
    CertificateId

    string

    No

    The ID of the certificate.

    Note

    You can configure only one of the KeyId, SecretName, and CertificateId parameters.

    770dbe42-e146-43d1-a55a-1355db86****

    For more information about common request parameters, see Common parameters.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    4162a6af-bc99-40b3-a552-89dcc8aaf7c8

    Examples

    Success response

    JSON format

    {
  "RequestId": "4162a6af-bc99-40b3-a552-89dcc8aaf7c8"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The specified parameter is not valid. An invalid value is specified for the parameter.
    404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.