All Products
Search
Document Center

API Gateway:SetSignatureApis

Last Updated:Mar 01, 2024

Binds a signature key to APIs.

Operation description

  • This API is intended for API providers.
  • This operation allows you to bind a signature key to an API. You can bind signature keys for up to 100 APIs at a time.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:SetSignatureApisRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SignatureIdstringYes

The ID of the signature key.

dd05f1c54d6749eda95f9fa6d491449a
GroupIdstringYes

The ID of the API group to which the API that you want to manage belongs.

0009db9c828549768a200320714b8930
ApiIdsstringYes

The API ID for the specified operation. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.

3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12
StageNamestringYes

The name of the runtime environment. Valid values:

  • RELEASE
  • PRE
  • TEST
TEST

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-02-19The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.