文档

TagResource

更新时间:

调用TagResource接口为主密钥、凭据或证书绑定标签。

使用限制:您最多可以为主密钥、凭据或证书分别绑定10个标签。

本文将提供一个示例,为ID为key-hzz630494463ejqjx**** 的密钥绑定标签[{"TagKey":"S1key1","TagValue":"S1val1"},{"TagKey":"S1key2","TagValue":"S2val2"}]

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String TagResource

要执行的操作。取值:TagResource

KeyId String key-hzz630494463ejqjx****

密钥的ID,也可以指定为密钥别名或密钥资源名称(ARN)。关于别名的详细介绍,请参见管理密钥别名

说明
  • 访问其他阿里云账号下的密钥时,必须输入密钥ARN。密钥ARN的格式为acs:kms:${region}:${account}:key/${keyid}
  • KeyId、SecretName和CertificateId必须且只能指定其中一个参数。
Tags String [{"TagKey":"S1key1","TagValue":"S1val1"},{"TagKey":"S1key2","TagValue":"S2val2"}]

一个或多个标签。格式为Tag对象数组。

Tag对象属性如下:

  • TagKey:标签键。
  • TagValue:标签值。
SecretName String MyDbC****

凭据名称。

说明 KeyId、SecretName和CertificateId必须且只能指定其中一个参数。
CertificateId String 770dbe42-e146-43d1-a55a-1355db86****

证书ID。

说明 KeyId、SecretName和CertificateId必须且只能指定其中一个参数。

关于公共请求参数的详情,请参见公共参数

返回数据

名称

类型

示例值

描述

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

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例

请求示例

http(s)://[Endpoint]/?Action=TagResource
&KeyId=key-hzz630494463ejqjx****
&Tags=[{"TagKey":"S1key1","TagValue":"S1val1"},{"TagKey":"S1key2","TagValue":"S2val2"}]
&SecretName=MyDbC****
&CertificateId=770dbe42-e146-43d1-a55a-1355db86****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<TagResourceResponse>
    <RequestId>4162a6af-bc99-40b3-a552-89dcc8aaf7c8</RequestId>
</TagResourceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode

错误码

错误信息

描述

400 InvalidParameter The specified parameter is not valid. 参数非法。

访问错误中心查看更多错误码。