Query the APIs bound to a key - Developer Guide| Alibaba Cloud Documentation Center

Description

For querying the APIs bound to a specified signature key.

This function is intended for API activators.
The function is used to query the list of APIs bound to a specified signature key.
Results are returned by page.

Request parameters

Name	Type	Required?	Description
Action	String	Yes	Operation interface name, which is a required parameter; value: DescribeApisBySignature.
SignatureId	String	Yes	ID of the signature key you want to query.
PageSize	Integer	No	Number of lines per page set at paging query; maximum value: 100; default value: 10.
PageNumber	Integer	No	The page number specified for query; default value: 1; the starting number: 1.

Return parameters

Name	Type	Description
RequestId	String	ID of the current request.
TotalCount	Integer	Total number of returned results.
PageSize	Integer	Specified total number of results returned per page.
PageNumber	Integer	Page number specified to be returned.
ApiInfos	ApiInfo	Returned API information, which is an array consisting of ApiInfos.

Examples

Request example

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApisBySignature
&SignatureId=dd05f1c54d6749eda95f9fa6d491449a
&<Public request parameters>

Response example

XML format

<DescribeApisBySignatureResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
    <TotalCount>20</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <ApiInfos>
        <ApiInfo>
            <RegionId>cn-qingdao</RegionId>
            <GroupId>0009db9c828549768a200320714b8930</GroupId>        
            <GroupName>mygroup</GroupName>
            <StageName>test</StageName>
            <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>
            <ApiName>testapi</ApiName>
            <Description> Description</Description>
            <Visibility>public</Visibility>
            <BoundTime>2016-07-23T08:28:48Z</BoundTime>
        </ApiInfo>
    </ApiInfos>
</DescribeApisBySignatureResponse>

JSON format

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