All Products
Search
Document Center

API Gateway:DescribeApiSignatures

Last Updated:Mar 01, 2024

Queries the backend signature keys that are bound to the APIs of a specified API group in a specified environment.

Operation description

  • This API is intended for API providers.
  • The ApiIds parameter is optional. If this parameter is not specified, all results in the specified environment of an API group are returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StageNamestringYes

The runtime environment. Valid values:

  • RELEASE
  • TEST
TEST
GroupIdstringYes

The ID of the API group.

0009db9c828549768a200320714b8930
ApiIdsstringNo

The IDs of the APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.

123
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

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

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

20
ApiSignaturesobject []

The returned signature key information. It is an array consisting of ApiSignatureItem data.

BoundTimestring

The time when the backend signature key was bound.

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

The ID of the API.

46fbb52840d146f186e38e8e70fc8c90
SignatureIdstring

The ID of the backend signature key.

dd05f1c54d6749eda95f9fa6d491449a
SignatureNamestring

The name of the backend signature key.

backendsignature
ApiNamestring

The name of the API.

testapi

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history