Backend Signature Keys Bound to an API Reference - API Gateway

Operation description

This API is intended for API providers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribeSignaturesByApi

get

*All Resource

*

None

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 elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
Signatures	object
SignatureItem	array<object>	The returned signature key information. It is an array consisting of SignatureItem data.
	object
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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.