阅读840 返回首页    go 阿里云

查询已发布API列表__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的信息

示例

请求示例

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

返回示例

XML格式

  1. <DescribeDeployedApisResponse>
  2.     <DeployedApis>
  3.         <DeployedApiItem>
  4.             <RegionId>cn-qingdao</RegionId>
  5.             <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>
  6.             <GroupName>myGroup3</GroupName>
  7.             <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>
  8.             <ApiName>获取对象列表</ApiName>
  9.             <StageName>release</StageName>
  10.             <Visibility>public</Visibility>
  11.             <Description>分页显示对象列表</Description>
  12.             <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
  13.         </DeployedApiItem>
  14.         <DeployedApiItem>
  15.             <RegionId>cn-qingdao</RegionId>
  16.             <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
  17.             <GroupName>myGroup2</GroupName>
  18.             <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
  19.             <ApiName>创建对象</ApiName>
  20.             <StageName>release</StageName>
  21.             <Visibility>public</Visibility>
  22.             <Description>创建对象接口</Description>
  23.             <DeployedTime>2016-07-20T08:28:48Z</DeployedTime>
  24.         </DeployedApiItem>
  25.     </DeployedApis>
  26.     <PageNumber>3</PageNumber>
  27.     <PageSize>15</PageSize>
  28.     <TotalCount>32</TotalCount>
  29.     <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ002</RequestId>        
  30. </DescribeDeployedApisResponse>

JSON格式

  1. {
  2.     "DeployedApis": {
  3.         "DeployedApiItem": [
  4.               {
  5.                 "RegionId": "cn-qingdao",
  6.                 "GroupId": "63be9002440b4778a61122f14c2b2bbb",
  7.                 "GroupName": "myGroup3",
  8.                 "ApiId": "c076144d7878437b8f82fb85890ce6a0",
  9.                 "ApiName": "获取对象列表",
  10.                 "StageName": "release",
  11.                 "Visibility": "public",
  12.                 "Description": "分页显示对象列表",
  13.                 "DeployedTime": "2016-07-23T08:28:48Z"
  14.               },
  15.               {
  16.                 "RegionId": "cn-qingdao",
  17.                 "GroupId": "1084f9034c744137901057206b39d2b6",
  18.                 "GroupName": "myGroup2",
  19.                 "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
  20.                 "ApiName": "创建对象",
  21.                 "StageName": "release",
  22.                 "Visibility": "public",
  23.                 "Description": "创建对象接口",
  24.                 "DeployedTime": "2016-07-20T08:28:48Z"
  25.               }
  26.         ]
  27.       },
  28.     "PageNumber": 3,
  29.       "PageSize": 15,  
  30.       "TotalCount": 32,
  31.     "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002"
  32. }

最后更新：2016-11-23 17:16:09

  上一篇：go 查询已发布API详情__API管理相关接口_API_API 网关-阿里云
  下一篇：go 查询API错误分布数据__API管理相关接口_API_API 网关-阿里云