All Products
Search
Document Center

API Gateway:DescribeApisBySignature

Last Updated:Mar 01, 2024

Queries the APIs to which a specified backend signature key is bound.

Operation description

  • This API is intended for API providers.
  • The results are returned on separate pages. You can specify PageNumber to obtain the result on the specified page.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SignatureIdstringYes

The ID of the signature key.

dd05f1c54d6749eda95f9fa6d491449a
PageSizeintegerNo

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

10
PageNumberintegerNo

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

1

Response parameters

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
ApiInfosobject []

The returned API information. It is an array consisting of ApiInfo data.

BoundTimestring

The binding time of the API.

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

Indicates whether the API is public. Valid values:

  • PUBLIC
  • PRIVATE
PUBLIC
ApiIdstring

The ID of the API.

3b81fd160f5645e097cc8855d75a1cf6
Descriptionstring

The description of the API.

Description
GroupNamestring

The name of the group to which the API belongs.

mygroup
GroupIdstring

The ID of the API group.

0009db9c828549768a200320714b8930
StageNamestring

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
TEST
ApiNamestring

The name of the API.

testapi
RegionIdstring

The region where the API is located.

cn-qingdao

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiInfos": {
    "ApiInfo": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "Visibility": "PUBLIC",
        "ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
        "Description": "Description\n",
        "GroupName": "mygroup",
        "GroupId": "0009db9c828549768a200320714b8930",
        "StageName": "TEST",
        "ApiName": "testapi",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history