Modifies a backend signature key.
Operation description
- This API is intended for API providers.
- This API operation modifies the name, Key value, and Secret value of an existing signature key.
- Note that the modification takes effect immediately. If the key has been bound to an API, you must adjust the backend signature verification based on the new key accordingly.
- The QPS limit on this operation is 50 per user.
Debugging
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 Resourcesis 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:ModifySignature | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SignatureId | string | Yes | The ID of the signature key that you want to manage. | dd05f1c54d6749eda95f9fa6d491449a |
| SignatureName | string | No | The new name of the key. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). It must start with a letter. | backendsignature |
| SignatureKey | string | No | The new Key value of the key. The value must be 6 to 20 characters in length and can contain letters, digits, and underscores (_). It must start with a letter. | qwertyuiop |
| SignatureSecret | string | No | The new Secret value of the key. The value must be 6 to 30 characters in length and can contain letters, digits, and special characters. Special characters include underscores (_), at signs (@), number signs (#), exclamation points (!), and asterisks (*). The value must start with a letter. | asdfghjkl |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
"SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
"SignatureName": "backendsignature"
}Error codes
For a list of error codes, visit the Service error codes.