DescribeSignaturesByApi - API Gateway - Alibaba Cloud Documentation Center

Queries the backend signature keys that are bound to a specified API.

Operation description

This API is intended for API providers.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the group to which the API belongs.	0009db9c828549768a200320714b8930
ApiId	string	Yes	The ID of the API.	3b81fd160f5645e097cc8855d75a1cf6
StageName	string	Yes	The runtime environment. Valid values: RELEASE TEST	TEST

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
Signatures	object []	The returned signature key information. It is an array consisting of SignatureItem data.
BoundTime	string	The time when the key was bound.	2016-07-23T08:28:48Z
SignatureId	string	The ID of the backend signature key.	dd05f1c54d6749eda95f9fa6d491449a
SignatureName	string	The name of the backend signature key.	mysecret

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "Signatures": {
    "SignatureItem": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
        "SignatureName": "mysecret"
      }
    ]
  }
}

Error codes

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