DescribeSignatures

Updated at: 2025-03-06 03:41

Queries backend signature keys.

Operation description

  • This API is intended for API providers.
  • This operation is used to query the backend signature keys in a Region. Region is a system parameter.

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
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeSignaturesget
*Signature
acs:apigateway:{#regionId}:{#accountId}:secretkey/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
SignatureIdstringNo

The IDs of the keys to query.

dd05f1c54d6749eda95f9fa6d491449a
SignatureNamestringNo

The names of the keys to query.

backendsignature
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

20
SignatureInfosarray<object>

The returned signature information. It is an array consisting of SignatureInfo data.

SignatureInfoobject
ModifiedTimestring

The last modification time of the key.

2016-07-24T08:28:48Z
SignatureIdstring

The ID of the backend signature key.

dd05f1c54d6749eda95f9fa6d491449a
SignatureSecretstring

The Secret value of the backend signature key.

asdfghjkl
SignatureNamestring

The name of the backend signature key.

backendsignature
SignatureKeystring

The Key value of the backend signature key.

qwertyuiop
CreatedTimestring

The creation time of the key.

2016-07-23T08:28:48Z
RegionIdstring

The region where the key is located.

cn-qingdao

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "SignatureInfos": {
    "SignatureInfo": [
      {
        "ModifiedTime": "2016-07-24T08:28:48Z",
        "SignatureId": "dd05f1c54d6749eda95f9fa6d491449a",
        "SignatureSecret": "asdfghjkl",
        "SignatureName": "backendsignature",
        "SignatureKey": "qwertyuiop",
        "CreatedTime": "2016-07-23T08:28:48Z",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2024-11-14API Description UpdateView Change Details
  • On this page (1)
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare