edit-icon download-icon

Create a signature key

Last Updated: Dec 19, 2017

Description

For creating a backend signature key.

  • This function is intended for API activators.
  • This API is only used to create key policies. You must call the binding interface to bind the key policies to APIs.
  • After a backend signature key created by this interface is bound to APIs, the requests sent from the API Gateway to your backend services carry the signature string. You can decide whether your backend services verify the signature string.
  • This API can call up to 50 QPS for a single user.

Request parameters

Name Type Required? Description
Action String Yes Operation interface name, which is a required parameter; value: CreateSignature.
SignatureName String Yes Displayed key name, which contains 4–50 characters including Chinese characters, English letters, numbers, and English-style underscores, and must start with an English letter or a Chinese character.
SignatureKey String Yes Key value of the backend signature key, which contains 6–20 characters including English letters, numbers, and English-style underscores, and must start with a letter.
SignatureSecret String Yes Secret value of the backend signature key, which contains 6–30 characters including English letters, numbers, English-style underscores, and special characters (@, #, !, and *), and must start with an English letter.

Return parameters

Name Type Description
RequestId String ID of the current request.
SignatureId String ID of the backend signature key.
SignatureName String Name of the backend signature key.

Examples

Request example

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=CreateSignature
  2. &SignatureName=backendsignature
  3. &SignatureKey=qwertyuiop
  4. &SignatureSecret=asdfghjkl
  5. &<Public request parameters>

Response example

XML format

  1. <CreateSignatureResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId>
  4. <SignatureName>backendsignature</SignatureName>
  5. </CreateSignatureResponse>

JSON format

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3. "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
  4. "SignatureName": "backendsignature"
  5. }
Thank you! We've received your feedback.