DescribeSignatures - API Gateway - Alibaba Cloud Documentation Center

Queries backend signature keys.

Operation description

This API is intended for API providers.
This operation is used to query the backend signature keys in a Region. Region is a system parameter.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeSignatures	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SignatureId	string	No	The IDs of the keys to query.	dd05f1c54d6749eda95f9fa6d491449a
SignatureName	string	No	The names of the keys to query.	backendsignature
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	20
SignatureInfos	object []	The returned signature information. It is an array consisting of SignatureInfo data.
ModifiedTime	string	The last modification time of the key.	2016-07-24T08:28:48Z
SignatureId	string	The ID of the backend signature key.	dd05f1c54d6749eda95f9fa6d491449a
SignatureSecret	string	The Secret value of the backend signature key.	asdfghjkl
SignatureName	string	The name of the backend signature key.	backendsignature
SignatureKey	string	The Key value of the backend signature key.	qwertyuiop
CreatedTime	string	The creation time of the key.	2016-07-23T08:28:48Z
RegionId	string	The region where the key is located.	cn-qingdao

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "SignatureInfos": {
    "SignatureInfo": [
      {
        "ModifiedTime": "2016-07-24T08:28:48Z",
        "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
        "SignatureSecret": "asdfghjkl",
        "SignatureName": "backendsignature",
        "SignatureKey": "qwertyuiop",
        "CreatedTime": "2016-07-23T08:28:48Z",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history