调用ListApplication获取应用列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /pop/v5/app/app_list HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
ClusterId | String | Query | 否 | c37aec2a-bcca-4ec1-****-************ |
以集群维度筛选应用列表 |
LogicalRegionId | String | Query | 否 | cn-beijing:test |
以命名空间维度筛选应用列表 |
AppName | String | Query | 否 | testapp |
以appName维度筛选应用列表 |
ResourceGroupId | String | Query | 否 | rg-aek24j4s4b***** |
以资源组维度筛选应用列表 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ApplicationList | Array of Application |
应用列表。 |
|
Application | |||
AppId | String | 00ee517d-dd7d-4d4e-****-************ |
应用ID。 |
ApplicationType | String | FatJar |
应用部署类型:
|
BuildPackageId | Long | 58 |
容器版本ID。 |
ClusterId | String | c37aec2a-bcca-4ec1-****-************ |
集群ID。 |
ClusterType | Integer | 2 |
应用集群环境类型:
|
Name | String | doc-test-consumer |
应用名称。 |
RegionId | String | cn-beijing:docTes |
地域ID。 |
ResourceGroupId | String | rg-aek24j4s4b***** |
资源组ID。 |
RunningInstanceCount | Integer | 0 |
正在运行的应用实例数量。 |
Code | Integer | 200 |
接口状态码。 |
Message | String | success |
附加信息。 |
RequestId | String | 5d6fa0bc-cc3********** |
请求ID。 |
示例
请求示例
POST /pop/v5/app/app_list HTTP/1.1
公共请求头
正常返回示例
XML
格式
<RequestId>5d6fa0bc-cc3**********</RequestId>
<Message>success</Message>
<ApplicationList>
<Application>
<BuildPackageId>58</BuildPackageId>
<ApplicationType>FatJar</ApplicationType>
<ResourceGroupId>rg-aek24j4s4b*****</ResourceGroupId>
<AppId>00ee517d-dd7d-4d4e-****-************</AppId>
<ClusterId>c37aec2a-bcca-4ec1-****-************</ClusterId>
<ClusterType>2</ClusterType>
<RegionId>cn-beijing:docTes</RegionId>
<RunningInstanceCount>0</RunningInstanceCount>
<Name>doc-test-consumer</Name>
</Application>
</ApplicationList>
<Code>200</Code>
JSON
格式
{
"RequestId": "5d6fa0bc-cc3**********",
"Message": "success",
"ApplicationList": {
"Application": {
"BuildPackageId": 58,
"ApplicationType": "FatJar",
"ResourceGroupId": "rg-aek24j4s4b*****",
"AppId": "00ee517d-dd7d-4d4e-****-************",
"ClusterId": "c37aec2a-bcca-4ec1-****-************",
"ClusterType": 2,
"RegionId": "cn-beijing:docTes",
"RunningInstanceCount": 0,
"Name": "doc-test-consumer"
}
},
"Code": 200
}
错误码
访问错误中心查看更多错误码。