生成密钥。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apig:CreateSecret | create | *全部资源 * |
| 无 |
请求语法
POST /v1/secrets HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求 Body。 | |
| name | string | 否 | 密钥名称，支持英文、数字、下划线"_"，不超过 64 个字符。 | my_secret |
| description | string | 否 | 密钥描述。 | test |
| kmsConfig | KMSConfig | 否 | KMS 密钥配置信息。 | |
| gatewayType | string | 否 | 网关类型。 | API |
| secretSource | string | 否 | 密钥来源。 | KMS |
| secretData | string | 否 | KMS 凭据值。 | apikey-123456xxxxxxxx |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "CFF809D7-045D-502F-BF6C-947Exxxxxxxx",
"code": "Ok",
"message": "Failed to upload data. Please try again",
"data": {
"secretId": "sec-d5e6shmm1hkoxxxxxxxx"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-07 | 新增 OpenAPI | 查看变更详情 |