凭据管理系统
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 凭据管理系统 > API 文档 > 数据安全相关接口 > 创建云产品凭据

创建云产品凭据

最近更新时间：2024-03-12 01:48:25

我的收藏

本页目录：

1. 接口描述

接口请求域名： ssm.tencentcloudapi.com 。

创建云产品凭据

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateProductSecret。
Version 是 String 公共参数，本接口取值：2019-09-23。
Region 是 String 公共参数，详见产品支持的 地域列表。
SecretName 是 String 凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。
示例值：test_name
UserNamePrefix 是 String 用户账号名前缀，由用户自行指定，长度限定在8个字符以内，
可选字符集包括：
数字字符：[0, 9]，
小写字符：[a, z]，
大写字符：[A, Z]，
特殊字符(全英文符号)：下划线()，
前缀必须以大写或小写字母开头。
示例值：testprefix
ProductName 是 String 凭据所绑定的云产品名称，如Mysql，可以通过DescribeSupportedProducts接口获取所支持的云产品名称。
示例值：Mysql
InstanceID 是 String 云产品实例ID。
示例值：cdb-xxxxxxxx
Domains.N 是 Array of String 账号的域名，IP形式，支持填入%。
示例值：["%","192.168.0.%"]
PrivilegesList.N 是 Array of ProductPrivilegeUnit 将凭据与云产品实例绑定时，需要授予的权限列表。
Description 否 String 描述信息，用于详细描述用途等，最大支持2048字节。
KmsKeyId 否 String 指定对凭据进行加密的KMS CMK。
如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。
您也可以指定在同region 下自行创建的KMS CMK进行加密。
Tags.N 否 Array of Tag 标签列表。
RotationBeginTime 否 String 用户自定义的开始轮转时间，格式：2006-01-02 15:04:05。
当EnableRotation为True时，此参数必填。
示例值：2006-01-02 15:04:05
EnableRotation 否 Boolean 是否开启轮转
True -- 开启
False -- 不开启
如果不指定，默认为False。
示例值：True
RotationFrequency 否 Integer 轮转周期，以天为单位，默认为1天。
示例值：1

3. 输出参数

参数名称 类型 描述
SecretName String 创建的凭据名称。
TagCode Integer 标签操作的返回码. 0: 成功；1: 内部错误；2: 业务处理错误。
注意：此字段可能返回 null，表示取不到有效值。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
TagMsg String 标签操作的返回信息。
注意：此字段可能返回 null，表示取不到有效值。
FlowID Integer 创建云产品凭据异步任务ID号。
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建云产品凭据

输入示例

https://ssm.tencentcloudapi.com/?Action=CreateProductSecret
&SecretName=testName
&UserNamePrefix=testPrefix
&ProductName=Mysql
&InstanceID=cdb-vosgis
&Description=test
&KmsKeyId=2609a8fd-4584-4f89-98be-8c7ae1b81ef4
&RotationBeginTime=2006-01-02 15:04:05
&EnableRotation=true
&RotationFrequency=35
&Domains.0=%
&Tags.0.TagKey=tagKey
&Tags.0.TagValue=tagVal
&PrivilegesList.0.PrivilegeName=object
&PrivilegesList.0.Privileges.0=read
&PrivilegesList.0.Database=testdb
&PrivilegesList.0.TableName=testtable
&PrivilegesList.0.ColumnName=testColumn
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "2609a8fd-4584-4f89-98be-8c7ae1b81ef4",
        "SecretName": "testName",
        "TagCode": 0,
        "TagMsg": "success",
        "FlowID": 123
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
FailedOperation.AccessKmsError KMS操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.TagKeysDuplicated 标签键重复。
InvalidParameterValue.TagsNotExisted 标签键或标签值不存在。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AutoRotatedResource 不允许手动更新具有自动轮换功能的凭据。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInUse.SecretExists 凭据名已存在。
ResourceInUse.VersionIdExists 版本号已存在。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.NotPurchased 服务未购买。
ResourceUnavailable.ResourceDisabled 凭据被禁用。
ResourceUnavailable.ResourcePendingDeleted 凭据处于计划删除状态。
ResourceUnavailable.ResourceUninitialized 凭据未完成初始化。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.AccessKmsError 访问KMS失败。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站