调用ListApplications列出创建的应用列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ens:ListApplications | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterNames | string | 否 | 应用集群名。支持多选,以","分割;输入 All,查询用户名下所有集群的应用列表;默认查询全量。 | poc,pre |
AppVersions | string | 否 | 应用的业务服务版本号。支持多选,以","分割;输入 All,输出所有版本数据。默认只输出稳定版版本号的关联数据。 | v1,v2 |
Level | string | 否 | 应用边缘资源的区域统计级别。枚举类型,取值范围:
默认 National。 | National |
OutAppInfoParams | string | 否 | 是否输出统计资源实例/容器 Pod 等维度的信息。Json 的字符串格式。默认输出所有信息。 | {\"appInfo\":true,\"detailStat\": true, \"appVersionStat\": true, \"districtStat\":true ,\"instanceStat\": true, \"podCountStat\": true} |
PageNumber | integer | 否 | 页码,起始值为 1,导出全部信息时可不传入。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数,导出全部时可不传入。 | 10 |
MinDate | string | 否 | 查询起始时间,格式"2006-01-02";默认无时间限制。 | 2022-02-15 |
MaxDate | string | 否 | 查询终止时间,格式"2006-01-02";默认无时间限制。 | 2022-02-20 |
返回参数
示例
正常返回示例
JSON
格式
{
"Applications": {
"Application": [
{
"AppList": {
"App": [
{
"AppId": "e76f8985-7965-41fc-925b-9648bb6bf650",
"AppInfo": "{\n \"AppStatus\":{\n \"Phase\":\"RUNNING\",\n \"StatusDescrip\":\"{\\\"status\\\":\\\"UPDATE_SUCCESS\\\",\\\"step\\\":\\\"DONE\\\",\\\"descrip\\\":\\\"update to version:1022 success\\\",\\\"start_time\\\":\\\"2022-03-01 16:18:22\\\"}\",\n \"UpdateTime\":\"2022-03-01 16:18:22\",\n \"OrderStatus\":null\n },\n \"ResourceAttribute\":{\n \"NetSecurityInfo\":null,\n \"InitConfig\":null,\n \"InventoryType\":\"Ens\",\n \"InstanceSpec\":\"ens.gi6s-c12g1.large\",\n \"SystemDiskSize\":100,\n \"DataDiskSize\":0,\n \"BandwithOut\":5000,\n \"SchedulingStrategy\":\"Disperse\",\n \"ImageId\":\"m-5or73kzkuxytv7hh6wxr6yc5q\",\n \"ResourceType\":\"Linux\",\n \"AreaLevel\":\"National\",\n \"IpType\":\"PublicIP\"\n },\n \"WorkloadAttribute\":[\n {\n \"Name\":\"andorid\",\n \"Count\":15,\n \"ServiceConfig\":{\n \"PortsBindConfig\":{\n \"NetServiceContainer\":\"uravi-service\",\n \"Ports\":[\n {\n \"Protocol\":\"TCP\",\n \"BindType\":\"Mapping\",\n \"StartNodePorts\":\"31000-31009\",\n \"ContainerPorts\":\"4440-4449\"\n },\n {\n \"Protocol\":\"TCP\",\n \"BindType\":\"PassThrough\",\n \"StartNodePorts\":\"59000-59000\",\n \"ContainerPorts\":\"59000-59000\"\n },\n {\n \"Protocol\":\"UDP\",\n \"BindType\":\"PassThrough\",\n \"StartNodePorts\":\"40001-40010\",\n \"ContainerPorts\":\"40001-40010\"\n }\n ]\n },\n \"ServiceContainerName\":\"android\"\n }\n },\n {\n \"Name\":\"coturn\",\n \"Count\":1,\n \"ServiceConfig\":{\n \"PortsBindConfig\":{\n \"NetServiceContainer\":\"coturn\",\n \"Ports\":[\n {\n \"Protocol\":\"TCP\",\n \"BindType\":\"PassThrough\",\n \"StartNodePorts\":\"3478-3478\",\n \"ContainerPorts\":\"3478-3478\"\n },\n {\n \"Protocol\":\"UDP\",\n \"BindType\":\"PassThrough\",\n \"StartNodePorts\":\"3478-3478\",\n \"ContainerPorts\":\"3478-3478\"\n }\n ]\n },\n \"ServiceContainerName\":\"coturn\"\n }\n },\n {\n \"Name\":\"aic-manager\",\n \"Count\":1,\n \"ServiceConfig\":null\n }\n ]\n}"
}
]
},
"ClusterName": "ay-ads-hz-h"
}
]
},
"PageNumber": 1,
"PageSize": 10,
"RequestId": "50373E71-7710-4620-8AAB-133CCE49451C",
"TotalCount": 49
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | - |
400 | NoPermission | Permission denied. | 没有足够的权限,请联系云账号管理员授予您相应权限。 |
400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
400 | InvalidParameter | The errorMessage is %s. Please check it again. | - |
400 | ens.interface.error | An error occurred while calling the API. | - |
400 | CallInterface | Call Interface Happen Error. | 接口调用出错。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-21 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |