获取应用列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
edas:ReadApplication | *全部资源 * |
| 无 |
请求语法
POST /pop/v5/app/app_list HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 否 | 以集群维度筛选应用列表。 | c37aec2a-bcca-4ec1-****-************ |
LogicalRegionId | string | 否 | 以微服务空间维度匹配筛选应用列表。 | cn-beijing:test |
AppName | string | 否 | 以 appName 维度筛选应用列表。 | testapp |
ResourceGroupId | string | 否 | 以资源组维度筛选应用列表。 | rg-aek24j4s4b***** |
LogicalRegionIdFilter | string | 否 | 按精确匹配微服务空间的方式筛选应用。 | cn-beijing:test |
AppIds | string | 否 | 应用 ID 列表。 | [ "5657d271-****-4f03-9bb2-431f942886bb", "5657d271-****-4f03-9bb2-431f942bbddd" ] |
CurrentPage | integer | 否 | 分页查询,当前第几页,默认值为 1。 | 1 |
PageSize | integer | 否 | 分页查询,每页显示的条数。 | 20 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "success",
"RequestId": "5d6fa0bc-cc3**********",
"ApplicationList": {
"Application": [
{
"AppId": "00ee517d-dd7d-4d4e-****-************",
"RegionId": "cn-beijing:docTes",
"Name": "doc-test-consumer",
"Instances": 5,
"Port": 8080,
"State": "RUNNING",
"CreateTime": 1664208000000,
"SlbIp": "192.168.0.***",
"SlbPort": 80,
"SlbListenerPort": 8088,
"ExtSlbListenerPort": 8080,
"BuildPackageId": 58,
"ExtSlbIp": "100.100.70.***",
"ApplicationType": "FatJar",
"ClusterType": 2,
"RunningInstanceCount": 0,
"ClusterId": "c37aec2a-bcca-4ec1-****-************",
"ResourceGroupId": "rg-aek24j4s4b*****",
"K8sNamespace": "default",
"NamespaceId": "cn-hangzhou:test"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-07-12 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |