查询已发布 API 列表_API 管理相关接口_API 参考_开发指南

描述

查询已经发布到某指定环境中的API列表，即查询指定环境中正在运行的API列表。

此功能面向开放API的用户

请求参数

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数，取值：DescribeDeployedApis
GroupId	String	否	指定的分组编号
StageName	String	是	环境名称，可选值： RELEASE：线上 TEST：测试
ApiId	String	否	指定的API编号
ApiName	String	否	API名称（模糊匹配）
PageSize	Integer	否	指定分页查询时每页行数，最大值100，默认值为10
PageNumber	Integer	否	指定要查询的页码，默认是1，起始是1

返回参数

名称	类型	描述
RequestId	String	本次请求编号
TotalCount	Integer	返回结果的总条数
PageNumber	Integer	返回指定的页码
PageSize	Integer	返回指定的每页条数
DeployedApis	DeployedApiItem	由 DeployedApiItem 组成的数组格式，返回API的信息

示例

请求示例

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeDeployedApis
&ApiName=weather
&pageSize=15
&pageNumber=3
&<公共请求参数>

返回示例

XML格式

<DescribeDeployedApisResponse>
    <DeployedApis>
        <DeployedApiItem>
            <RegionId>cn-qingdao</RegionId>
            <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>
            <GroupName>myGroup3</GroupName>
            <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>
            <ApiName>获取对象列表</ApiName>
            <StageName>release</StageName>
            <Visibility>public</Visibility>
            <Description>分页显示对象列表</Description>
            <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
        </DeployedApiItem>
        <DeployedApiItem>
            <RegionId>cn-qingdao</RegionId>
            <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
            <GroupName>myGroup2</GroupName>
            <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
            <ApiName>创建对象</ApiName>
            <StageName>release</StageName>
            <Visibility>public</Visibility>
            <Description>创建对象接口</Description>
            <DeployedTime>2016-07-20T08:28:48Z</DeployedTime>
        </DeployedApiItem>
    </DeployedApis>
    <PageNumber>3</PageNumber>
    <PageSize>15</PageSize>
    <TotalCount>32</TotalCount>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ002</RequestId>        
</DescribeDeployedApisResponse>

JSON格式

{
    "DeployedApis": {
        "DeployedApiItem": [
              {
                "RegionId": "cn-qingdao",
                "GroupId": "63be9002440b4778a61122f14c2b2bbb",
                "GroupName": "myGroup3",
                "ApiId": "c076144d7878437b8f82fb85890ce6a0",
                "ApiName": "获取对象列表",
                "StageName": "release",
                "Visibility": "public",
                "Description": "分页显示对象列表",
                "DeployedTime": "2016-07-23T08:28:48Z"
              },
              {
                "RegionId": "cn-qingdao",
                "GroupId": "1084f9034c744137901057206b39d2b6",
                "GroupName": "myGroup2",
                "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
                "ApiName": "创建对象",
                "StageName": "release",
                "Visibility": "public",
                "Description": "创建对象接口",
                "DeployedTime": "2016-07-20T08:28:48Z"
              }
        ]
      },
    "PageNumber": 3,
      "PageSize": 15,  
      "TotalCount": 32,
    "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002"
}