调用ListApplications接口获取应用列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头。
请求语法
GET /pop/v1/sam/app/listApplications HTTP/1.1
请求参数
名称 |
类型 |
位置 |
是否必选 |
示例值 |
描述 |
CurrentPage | Integer | Query | 否 | 1 | 当前页数。 |
PageSize | Integer | Query | 否 | 20 | 分页查询时获取的每页数量。取值范围[0,10000]。 |
AppName | String | Query | 否 | demo-app | 应用名称。 |
NamespaceId | String | Query | 否 | cn-beijing:demo | 命名空间ID。 |
Tags | String | Query | 否 | [{"key":"key","value":"value"}] | 标签键值对。取值说明如下:
区分大小写。如果指定多个标签,则会为指定资源同时创建并绑定多个标签。同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键,则对应的标签值会更新为新值。 不能以 |
OrderBy | String | Query | 否 | runnings | 对应用进行排序。取值说明如下:
|
Reverse | Boolean | Query | 否 | true | 根据应用实例运行状态对其进行排序。如果状态相同,则按照实例ID排序。取值说明如下:
实例升序排列如下: 1. Error:实例启动过程中出错。 2. CrashLoopBackOff:容器无法启动,在启动过程中出错,重启后又出错。 3. ErrImagePull:拉取实例中的容器镜像出错。 4. ImagePullBackOff:无法获取容器镜像。 5. Pending:实例等待调度中。 6. Unknown:未知异常。 7. Terminating:实例终止接入中。 8. NotFound:无法找到实例。 9. PodInitializing:实例初始化中。 10. Init:0/1:实例初始化。 11. Running:实例运行中。 |
FieldType | String | Query | 否 | appName | 设置筛选应用的维度。取值说明如下:
|
FieldValue | String | Query | 否 | demo-app | 输入目标应用的应用名称、应用ID、SLB IP地址或实例IP地址。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
Message | String | success | 调用结果的附加信息。 |
RequestId | String | B4D805CA-926D-41B1-8E63-7AD0C1ED**** | 请求ID。 |
Data | Object | 应用列表。 |
|
CurrentPage | Integer | 1 | 当前页数。 |
TotalSize | Integer | 2 | 应用总个数。 |
PageSize | Integer | 20 | 页面大小。 |
Applications | Array of Application | 应用列表。 |
|
AppName | String | demo-app | 应用名称。 |
NamespaceId | String | cn-beijing:demo | 命名空间ID。 |
AppDeletingStatus | Boolean | false | 是否正在删除应用。取值说明如下:
|
AppId | String | f7730764-d88f-4b9a-8d8e-cd8efbfe**** | 应用ID。 |
Tags | Array of Tags | 应用标签。 |
|
Key | String | key | 标签键。 |
Value | String | value | 标签值。 |
RunningInstances | Integer | 2 | 运行中的实例个数。 |
Instances | Integer | 2 | 应用实例个数。 |
RegionId | String | cn-beijing | 地域ID。 |
AppDescription | String | description | 应用描述信息。 |
Cpu | Integer | 1000 | 每个实例所需的CPU,单位为毫核,不能为0。目前仅支持以下固定规格:
|
Mem | Integer | 1024 | 每个实例所需的内存,单位为MB,不能为0。与CPU为一一对应关系,目前仅支持以下固定规格:
|
ErrorCode | String | 空 | 错误码。取值说明如下:
|
Code | String | 200 | 接口状态或POP错误码。取值说明如下:
|
Success | Boolean | true | 获取应用列表。取值说明如下:
|
CurrentPage | Integer | 1 | 当前页数。 |
TotalSize | Integer | 2 | 应用总个数。 |
PageSize | Integer | 20 | 页面大小。 |
示例
请求示例
GET /pop/v1/sam/app/listApplications?CurrentPage=1&PageSize=20&AppName=demo-app&NamespaceId=cn-beijing:demo&Tags=[{"key":"key","value":"value"}]&OrderBy=runnings&Reverse=true&FieldType=appName&FieldValue=demo-app HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListApplicationsResponse>
<Message>success</Message>
<RequestId>B4D805CA-926D-41B1-8E63-7AD0C1ED****</RequestId>
<Data>
<CurrentPage>1</CurrentPage>
<TotalSize>2</TotalSize>
<PageSize>20</PageSize>
<Applications>
<AppName>demo-app</AppName>
<NamespaceId>cn-beijing:demo</NamespaceId>
<AppDeletingStatus>false</AppDeletingStatus>
<AppId>f7730764-d88f-4b9a-8d8e-cd8efbfe****</AppId>
<Tags>
<Key>key</Key>
<Value>value</Value>
</Tags>
<RunningInstances>2</RunningInstances>
<Instances>2</Instances>
<RegionId>cn-beijing</RegionId>
<AppDescription>description</AppDescription>
<Cpu>1000</Cpu>
<Mem>1024</Mem>
</Applications>
</Data>
<Code>200</Code>
<Success>true</Success>
<CurrentPage>1</CurrentPage>
<TotalSize>2</TotalSize>
<PageSize>20</PageSize>
</ListApplicationsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "success",
"RequestId" : "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
"Data" : {
"CurrentPage" : 1,
"TotalSize" : 2,
"PageSize" : 20,
"Applications" : [ {
"AppName" : "demo-app",
"NamespaceId" : "cn-beijing:demo",
"AppDeletingStatus" : false,
"AppId" : "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
"Tags" : [ {
"Key" : "key",
"Value" : "value"
} ],
"RunningInstances" : 2,
"Instances" : 2,
"RegionId" : "cn-beijing",
"AppDescription" : "description",
"Cpu" : 1000,
"Mem" : 1024
} ]
},
"Code" : "200",
"Success" : true,
"CurrentPage" : 1,
"TotalSize" : 2,
"PageSize" : 20
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | Illegal.argument | Illegal argument | 参数异常 |
访问错误中心查看更多错误码。
- 本页导读 (1)