edit-icon download-icon

Query the signature keys bound to APIs

Last Updated: May 17, 2017

Description

For querying the signature keys bound to all the APIs in the specified stage of an API group.

  • This function is intended for API activators.
  • This interface is used to query the signature keys bound to all the APIs in the specified stage of an API group.
  • If you do not input optional parameters, the system returns the signature keys bound to all the APIs in the specified stage of an API group.

Request parameters

Name Type Required? Description
Action String Yes Operation interface name, which is a required parameter; value: DescribeApiSignatures.
StageName String Yes Name of the stage you want to query.
  • RELEASE: Online
  • TEST: Test
GroupId String Yes ID of the API group you want to query.
ApiIds String No IDs of the APIs you want to query. If multiple API IDs are input, they must be separated by a comma (,). Up to 100 API IDs can be input.
PageNumber Integer No The page number specified for query; default value: 1; the starting number: 1.
PageSize Integer No Number of lines per page set at paging query; maximum value: 100; default value: 10.

Return parameters

Name Type Description
RequestId String ID of the current request.
TotalCount Integer Total number of returned results.
PageSize Integer Specified total number of results returned per page.
PageNumber Integer Page number specified to be returned.
ApiSignatures ApiSignatureItem Returned information items of signature keys, in an array consisting of ApiSignatureItem.

Examples

Request example

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiSignatures
  2. &StageName=test
  3. &GroupId=0009db9c828549768a200320714b8930
  4. &<Public request parameters>

Response example

XML format

  1. <DescribeApiSignaturesResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <TotalCount>20</TotalCount>
  4. <PageSize>10</PageSize>
  5. <PageNumber>1</PageNumber>
  6. <ApiSignatures>
  7. <ApiSignatureItem>
  8. <ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>
  9. <ApiName>testapi</ApiName>
  10. <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId>
  11. <SignatureName>backendsignature</SignatureName>
  12. <BoundTime>2016-07-23T08:28:48Z</BoundTime>
  13. </ApiSignatureItem>
  14. </ApiSignatures>
  15. </DescribeApiSignaturesResponse>

JSON format

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3. "TotalCount": "20",
  4. "PageSize": "10",
  5. "PageNumber": "1",
  6. "ApiSignatures": {
  7. "ApiSignatureItem": [
  8. {
  9. "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
  10. "ApiName": "testapi",
  11. "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
  12. "SignatureName": "backendsignature",
  13. "BoundTime": "2016-07-23T08:28:48Z"
  14. }
  15. ]
  16. }
  17. }
Thank you! We've received your feedback.