DescribeApiSignatures - API Gateway - Alibaba Cloud Documentation Center

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:DescribeApiSignatures	get	*ApiGroup `acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
StageName	string	Yes	The runtime environment. Valid values: RELEASE TEST	TEST
GroupId	string	Yes	The ID of the API group.	0009db9c828549768a200320714b8930
ApiIds	string	No	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
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
ApiSignatures	array<object>	The returned signature key information. It is an array consisting of ApiSignatureItem data.
ApiSignatureItem	object
BoundTime	string	The time when the backend signature key was bound.	2016-07-23T08:28:48Z
ApiId	string	The ID of the API.	46fbb52840d146f186e38e8e70fc8c90
SignatureId	string	The ID of the backend signature key.	dd05f1c54d6749eda95f9fa6d491449a
SignatureName	string	The name of the backend signature key.	backendsignature
ApiName	string	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 time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details