文档

DescribeApiSignatures - 查询API签名密钥绑定情况

更新时间:

查询指定分组指定环境下,所有API的签名密钥绑定情况。

接口说明

  • 此功能面向开放 API 的用户
  • 非必填的参数,不传入则默认返回所有,分页返回

调试

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

授权信息

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

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

请求参数

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

指定要查询的环境。

  • RELEASE:线上
  • TEST:测试
TEST
GroupIdstring

指定要查询的分组 ID

0009db9c828549768a200320714b8930
ApiIdsstring

指定要查询的 API 编号,支持输入多个,“,”分隔,最多支持 100 个

123
PageNumberinteger

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

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

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

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

20
ApiSignaturesobject []

由 ApiSignatureItem 组成的数组格式,返回签名密钥的信息项

BoundTimestring

后端签名密钥绑定时间

2016-07-23T08:28:48Z
ApiIdstring

API 编号

46fbb52840d146f186e38e8e70fc8c90
SignatureIdstring

后端签名密钥 ID

dd05f1c54d6749eda95f9fa6d491449a
SignatureNamestring

后端签名密钥名称

backendsignature
ApiNamestring

API 名称

testapi

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiSignatures": {
    "ApiSignatureItem": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
        "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
        "SignatureName": "backendsignature",
        "ApiName": "testapi"
      }
    ]
  }
}

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiSignatures": {
    "ApiSignatureItem": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
        "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
        "SignatureName": "backendsignature",
        "ApiName": "testapi"
      }
    ]
  }
}

错误码

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

变更历史

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