文档

CreateSignature - 创建签名密钥

更新时间:

创建后端签名密钥。

接口说明

  • 此功能面向开放 API 的用户
  • 此功能效果仅是创建密钥策略,需要再调用绑定接口才能绑定到 API 上
  • 此密钥绑定到 API 后,网关到您后端服务的请求会带有签名字符串,您的后端服务可以自定义是否验证该签名字符串
  • 该接口调用的 QPS 限制为:单用户 QPS 不超过 50

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:CreateSignatureWrite
  • 全部资源
    *

请求参数

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

密钥显示名称。支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50 个字符

backendsignature
SignatureKeystring

设置密钥的 Key 值。支持英文字母、数字、英文格式的下划线,必须以英文字母开头,6~20 个字符

qwertyuiop
SignatureSecretstring

设置密钥的 secret 值。支持英文字母、数字、英文格式的下划线、及特殊字符(@、#、!、*),必须以英文字母开头,6~30 个字符

asdfghjkl

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
SignatureIdstring

后端签名密钥 ID

dd05f1c54d6749eda95f9fa6d491449a
SignatureNamestring

后端签名密钥名称

backendsignature

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
  "SignatureName": "backendsignature"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈