All Products
Search
Document Center

API Gateway:RemoveSignatureApis

Last Updated:Mar 06, 2025

Unbinds a backend signature key from APIs.

Operation description

  • This API is intended for API providers.
  • The operation takes effect immediately. The request sent from API Gateway to the backend service does not contain the signature string. The corresponding verification step can be removed from the backend.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:RemoveSignatureApisdelete
*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
ApiIdsstringNo

The IDs of the APIs from which you want to unbind the signature key.

  • If this parameter is not specified, the signature key is unbound from all the APIs in the specified environment of the API group.
  • The IDs of the APIs that you want to manage. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.
123
StageNamestringYes

The name of the runtime environment. Valid values:

  • RELEASE
  • 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-11-14API Description UpdateView Change Details