GetSecret - 获取密钥

更新时间:
复制为 MD 格式

获取密钥。

接口说明

接口支持创建多个服务。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:GetSecretnone
*Domain
acs:apig:{#regionId}:{#accountId}:secret/{#SecretId}

请求语法

GET /v1/secrets/{secretId} HTTP/1.1

请求参数

名称类型必填描述示例值
secretIdstring

密钥 ID。

sec-d5e6shmm1hkoxxxxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

CE857A85-251D-5018-8103-A38957D71E20
codestring

响应状态码。

Ok
messagestring

响应信息。

success
dataobject

密钥信息。

secretIdstring

密钥 ID。

sec-d5e6shmm1hkoxxxxxxxx
namestring

名称。

mysecret
secretSourcestring

密钥来源。

KMS
kmsConfigKMSConfig

KMS 配置信息。

gatewayTypestring

网关类型,分以下两种:

  • API:表示 API 网关
  • AI: 表示 AI 网关
API
createTimestamplong

创建时间戳。

1719386834548
updateTimestamplong

更新时间戳。

1725868548440
statusstring

密钥状态:

  • ENALBE: 已启用。
  • DISABLE: 不可用。
  • DELETED: 已删除。
ENALBE
referenceCountinteger

引用当前密钥的资源数。

1

示例

正常返回示例

JSON格式

{
  "requestId": "CE857A85-251D-5018-8103-A38957D71E20",
  "code": "Ok",
  "message": "success",
  "data": {
    "secretId": "sec-d5e6shmm1hkoxxxxxxxx",
    "name": "mysecret",
    "secretSource": "KMS",
    "kmsConfig": {
      "kmsInstanceId": "kst-xxxxxxxx",
      "kmsKeyId": "key-xxxxxxxx"
    },
    "gatewayType": "API",
    "createTimestamp": 1719386834548,
    "updateTimestamp": 1725868548440,
    "status": "ENALBE",
    "referenceCount": 1
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-01-15新增 OpenAPI查看变更详情