查询已经发布到某指定环境中的API列表,即查询指定环境中正在运行的API列表。
接口说明
- 此功能面向开放 API 的用户
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GroupId | string | 否 | 指定的分组编号 | 63be9002440b4778a61122f14c2b2bbb |
StageName | string | 否 | 环境名称,可选值:
| RELEASE |
ApiId | string | 否 | 指定的 API 编号 | c076144d7878437b8f82fb85890ce6a0 |
ApiName | string | 否 | API 名称(模糊匹配) | weather |
PageNumber | integer | 否 | 指定要查询的页码,默认是 1,起始是 1 | 1 |
PageSize | integer | 否 | 指定分页查询时每页行数,最大值 100,默认值为 10 | 10 |
EnableTagAuth | boolean | 否 | 是否启用标签验证 | true |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | |||
Key | string | 否 | 标签键 | appname |
Value | string | 否 | 标签值 | testapp |
ApiPath | string | 否 | API 的请求 Path | /st4 |
ApiMethod | string | 否 | API 的请求 HTTP 方法 | POST |
返回参数
示例
正常返回示例
JSON
格式
{
"PageNumber": 1,
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ002",
"PageSize": 10,
"TotalCount": 2,
"DeployedApis": {
"DeployedApiItem": [
{
"Visibility": "PUBLIC",
"ApiId": "c076144d7878437b8f82fb85890ce6a0",
"Description": "分页显示对象列表",
"GroupName": "myGroup3",
"GroupId": "63be9002440b4778a61122f14c2b2bbb",
"DeployedTime": "2016-07-23T08:28:48Z",
"StageName": "RELEASE",
"ApiName": "获取对象列表",
"RegionId": "cn-qingdao",
"ApiPath": "/trademark/search",
"ApiMethod": "POST"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-09-02 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |