edit-icon download-icon

Query the signature keys bound to an API

Last Updated: May 17, 2017

Description

For querying the backend signature keys bound to a specified API.

  • This function is intended for API activators.
  • This interface is used to query the backend signature keys bound to a specified API.

Request parameters

Name Type Required? Description
Action String Yes Operation interface name, which is a required parameter; value: DescribeSignaturesByApi.
GroupId String Yes ID of the API group to which the API you want to query belongs.
ApiId String Yes ID of the API you want to query.
StageName String Yes Name of the stage you want to query.
  • RELEASE: Online
  • TEST: Test

Return parameters

Name Type Description
RequestId String ID of the current request.
Signatures SignatureItem Returned information items of backend signature keys, in an array consisting of SignatureItem.

Examples

Request example

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

Response example

XML format

  1. <DescribeSignaturesByApiResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <Signatures>
  4. <SignatureItem>
  5. <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId>
  6. <SignatureName>mysecret</SignatureName>
  7. <BoundTime>2016-07-23T08:28:48Z</BoundTime>
  8. </SignatureItem>
  9. </Signatures>
  10. </DescribeSignaturesByApiResponse>

JSON format

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3. "Signatures": {
  4. "SignatureItem": [
  5. {
  6. "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
  7. "SignatureName": "mysecret",
  8. "BoundTime": "2016-07-23T08:28:48Z"
  9. }
  10. ]
  11. }
  12. }
Thank you! We've received your feedback.