该接口提供当前用户下所有应用的列表。其中可选参数keyword定义应用名中包含的关键字。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| bpstudio:ListApplication | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| NextToken | integer | 是 | 结果值的分页页码不能小于最小值 1，不能大于最大值 10000。 | 1 |
| MaxResults | integer | 是 | 结果值的分页大小不能小于最小值 1，也不能大于最大值 50。 | 10 |
| Keyword | string | 否 | 应用名称中的关键字 | test |
| OrderType | long | 否 | 1 更新时间 | 1 |
| Status | string | 否 | 应用的状态。 | 该参数可选值有“success”和“release”。 如果输入值是“success”，返回的应用列表包括所有部署成功（Deployed_Success）状态的应用； 如果输入值是“release”，返回的应用列表包括所有释放成功（Destroyed_Success）和释放失败（Destroyed_Failure）状态的应用； 如果置空该参数，返回的应用列表包括所有状态的应用。If the input value is "success", the returned application list includes all applications in the Deployed_Success state of successful deployment. If the input value is release, the returned application list includes all applications in the release success (Destroyed_Success) and release failure (Destroyed_Failure) status. If this parameter is left blank, the returned app list includes apps in all states. |
| ResourceGroupId | string | 否 | 资源组的 ID。 | default |
| ResourceId | string | 否 | 资源 ID | vsw-xxxxxxxxxxxx |
| TemplateId | string | 否 | 模板 ID | 0KSXXX6SJU03TXXX |
返回参数
应用状态列表：
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": "Success",
"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": "cadt-appName",
"CreateTime": "2021-09-15 08:30:00",
"ResourceGroupId": "default"
}
],
"Code": 200
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 200 | Success | The transaction is successful. | 交易成功 |
| 400 | ParameterEmpty | You must specify the request parameter. | 您必须指定请求参数。 |
| 404 | EntityNotExist.ResourceGroup | The resource group does not exist. | 资源组不存在 |
| 404 | EntityNotExist.ResourceId | The resource does not exist. | 资源不存在 |
| 500 | ServiceError | A server error occurred. Please try again later. | 服务器异常，请稍后再试 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-05-25 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-14 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-09-29 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |