首页 云速搭 开发参考 API参考 API目录 应用 ListApplication - 获取应用列表

ListApplication - 获取应用列表

该接口提供当前用户下所有应用的列表。其中可选参数keyword定义应用名中包含的关键字。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
NextTokeninteger

结果值的分页页码

1
MaxResultsinteger

结果值的分页大小

10
Keywordstring

应用名称中的关键字

test
OrderTypelong

1更新时间,2创建时间

1
Statusstring

应用的状态

该参数可选值有“success”和“release”。 如果输入值是“success”,返回的应用列表包括所有部署成功(Deployed_Success)状态的应用; 如果输入值是“release”,返回的应用列表包括所有释放成功(Destroyed_Success)和释放失败(Destroyed_Failure)状态的应用; 如果置空该参数,返回的应用列表包括所有状态的应用。
ResourceGroupIdstring

资源组ID

default

返回参数

名称类型描述示例值
object
TotalCountinteger

返回应用列表的总数

123
Messagestring

报错信息

参数错误
NextTokeninteger

下一页

2
RequestIdstring

请求ID

BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C
Dataarray

应用列表

object
ImageURLstring

应用的图片链接

https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png
Statusstring

应用的状态

Deployed_Success
ApplicationIdstring

应用ID

JIX9NEZUALGS46UI
Namestring

应用的名称

我的应用
TopoURLstring

应用的拓扑图链接

https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/topo-H21P9MV03R1DY0T4.json
CreateTimestring

应用创建时间

2021-09-15 08:30:00
ResourceGroupIdstring

应用的资源组

default
Codeinteger

状态码

200

应用状态列表:

  • Creating 创建中
  • Modified 已修改
  • Verifying 校验中
  • Verified_Failure 校验失败
  • Verified_Success 校验成功
  • Valuating 计价中
  • Valuating_Failure 计价失败
  • Valuating_Success 计价成功
  • Deploying 部署中
  • Deployed_Failure 部署失败
  • Partially_Deployed_Success 部分部署成功
  • Deployed_Success 部署成功
  • Destroying 释放中
  • Delayed_Destroy 延时销毁
  • Destroyed_Failure 释放失败
  • Partially_Destroyed_Success 部分释放成功
  • Destroyed_Success 释放成功
  • Revised 架构调整
  • Verifying_In_Revision 资源验证(架构调整)
  • Verified_Failure_In_Revision 资源验证失败(架构调整)
  • Verified_Success_In_Revision 资源验证成功(架构调整)
  • Valuating_In_Revision 询价中(架构调整)
  • Valuating_Failure_In_Revision 询价失败(架构调整)
  • Valuating_Success_In_Revision 询价成功(架构调整)

示例

正常返回示例

JSON格式

{
  "TotalCount": 123,
  "Message": "参数错误",
  "NextToken": 2,
  "RequestId": "BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C",
  "Data": [
    {
      "ImageURL": "https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png",
      "Status": "Deployed_Success",
      "ApplicationId": "JIX9NEZUALGS46UI",
      "Name": "我的应用",
      "TopoURL": "https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/topo-H21P9MV03R1DY0T4.json",
      "CreateTime": "2021-09-15  08:30:00",
      "ResourceGroupId": "default"
    }
  ],
  "Code": 200
}

错误码

HTTP status code错误码错误信息描述
200SuccessThe transaction is successful.交易成功
400ParameterEmptyYou must specify the request parameter.请求参数为空
404EntityNotExist.ResourceGroupThe resource group does not exist.资源组不存在
404EntityNotExist.ResourceIdThe resource does not exist.资源不存在
500ServiceErrorA server error occurred. Please try again later.服务器异常,请稍后再试

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-14OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2022-09-29OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
阿里云首页 云速搭 相关技术圈