DescribeSignatures - 查询后端签名密钥列表

更新时间:
复制为 MD 格式

查询API网关后端签名密钥列表。

接口说明

  • 此功能面向开放 API 的用户

  • 用于查询某 Region 下的后端签名密钥列表,Region 为系统参数

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribeSignatures

get

*Signature

acs:apigateway:{#regionId}:{#accountId}:secretkey/*

请求参数

名称

类型

必填

描述

示例值

SignatureId

string

指定要查询的密钥 ID

dd05f1c54d6749eda95f9fa6d491449a

SignatureName

string

指定要查询的密钥名称

backendsignature

PageNumber

integer

指定要查询的页码,默认是 1,起始是 1

1

PageSize

integer

指定分页查询时每页行数,最大值 100,默认值为 10

10

返回参数

名称

类型

描述

示例值

object

PageNumber

integer

返回指定的页码

1

RequestId

string

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

PageSize

integer

返回指定的每页条数

10

TotalCount

integer

返回结果的总条数

20

SignatureInfos

object

SignatureInfo

array<object>

由 SignatureInfo 组成的数组格式,返回后端签名的信息项

object

ModifiedTime

string

密钥最后修改时间

2016-07-24T08:28:48Z

SignatureId

string

后端签名密钥编号

dd05f1c54d6749eda95f9fa6d491449a

SignatureSecret

string

密钥 Secret 值

asdfghjkl

SignatureName

string

后端签名密钥名称

backendsignature

SignatureKey

string

密钥 Key 值

qwertyuiop

CreatedTime

string

密钥创建时间

2016-07-23T08:28:48Z

RegionId

string

所在的 region

cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "SignatureInfos": {
    "SignatureInfo": [
      {
        "ModifiedTime": "2016-07-24T08:28:48Z",
        "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
        "SignatureSecret": "asdfghjkl",
        "SignatureName": "backendsignature",
        "SignatureKey": "qwertyuiop",
        "CreatedTime": "2016-07-23T08:28:48Z",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情