查询应用列表 - ShowAppList
功能介绍
查询应用列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cpcs:app:list
List
app *
-
-
-
URI
GET /v1/{project_id}/dew/cpcs/apps
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 指定查询返回记录条数,默认值10 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 索引位置,从offset指定的下一条数据开始查询默认值为0 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| app_name | 否 | String | 参数解释: 应用名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| vpc_name | 否 | String | 参数解释: 所属的VPC名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| sort_key | 否 | String | 参数解释: 排序属性,目前支持以下属性: 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| sort_dir | 否 | String | 参数解释: 排序方向,支持以下值: 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_num | Integer | 参数解释: 满足条件的应用总数 取值范围: 不涉及 |
| result | Array of AppInfo objects | 参数解释: 应用列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| app_id | String | 参数解释: 应用ID 取值范围: 不涉及 |
| app_name | String | 参数解释: 应用名称 取值范围: 不涉及 |
| vpc_id | String | 参数解释: 应用所属的VPC的ID 取值范围: 不涉及 |
| vpc_name | String | 参数解释: 应用所属的VPC的名称 取值范围: 不涉及 |
| subnet_id | String | 参数解释: 应用所属的VPC的子网ID 取值范围: 不涉及 |
| subnet_name | String | 参数解释: 应用所属的VPC的子网 取值范围: 不涉及 |
| domain_id | String | 参数解释: 账号ID 取值范围: 不涉及 |
| description | String | 参数解释: 应用描述 取值范围: 不涉及 |
| create_time | Long | 参数解释: 应用的创建时间,UNIX时间戳,单位毫秒 取值范围: 不涉及 |
请求示例
查询应用列表请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限
GET https://cpcs.com/v1/{project_id}/dew/cpcs/apps?limit=2&offset=0 响应示例
状态码:200
请求已成功
{
"total_num" : 20,
"result" : [ {
"app_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe",
"app_name" : "test",
"vpc_name" : "vpc-test",
"subnet_name" : "subnet-bc37(192.168.0.0/24)",
"description" : "财务系统",
"create_time" : "1702181694618",
"vpc_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe",
"subnet_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe",
"domain_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe"
}, {
"app_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcc4",
"app_name" : "test1",
"vpc_name" : "vpc-test1",
"subnet_name" : "subnet-bc28(192.168.0.0/24)",
"description" : "IT系统",
"create_time" : "1702181694618",
"vpc_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe",
"subnet_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe",
"domain_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。