获取指定应用的基本信息、校验结果、计费结果、部署结果。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
bpstudio:GetApplication | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ApplicationId | string | 是 | 应用 ID | VVK605ZH00OA4MRT |
ResourceGroupId | string | 否 | 资源组 ID | rg-acfmyjt3c5om3hi |
返回参数
应用状态列表:
- 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
格式
{
"Message": "Success",
"RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
"Data": {
"Description": "remark",
"ImageURL": "https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png",
"ApplicationId": "VVK605ZH00OA4MRT",
"Name": "CADT应用",
"TemplateId": "FYS9VZ535U20V7HT",
"CreateTime": "2021-08-09 14:37:16",
"ResourceGroupId": "rg-aekzhfgmw4e6fwq",
"PriceList": [
{
"ResourceCode": "ecs",
"InstanceName": "ecs",
"OriginalPrice": 3.57,
"OnePrice": 0.01,
"Period": 1,
"Count": 1,
"PriceUnit": "金额/时",
"Price": 0.01,
"ChargeType": "PayAsYouGo",
"Region": "cn-hangzhou",
"Specification": "\"slb.s1.small\"\n \"192.168.0.0/24\"\n\"ecs.c6.large\"\n\"normal\"\n \"\"",
"Lifecycle": "Create",
"Remark": "ecs售罄",
"type": "1"
}
],
"Checklist": [
{
"ResourceCode": "vpc",
"ResourceName": "vpc",
"Region": "cn-hangzhou",
"Result": "Finish",
"Remark": "校验通过",
"Specification": "192.168.0.0/16",
"Lifecycle": "Create"
}
],
"Status": "Deployed_Success",
"ResourceList": [
{
"Status": "Finish",
"ResourceCode": "ecs",
"ResourceName": "ecs",
"ResourceId": "i-2zehnzxqixu1pywsfbx1",
"ChargeType": "PayAsYouGo",
"ResourceType": "ecs",
"Remark": "{\"hostName\":\"iZ2zehnzxqixu1pywsfbx1Z\",\"memory\":32768.0,\"creationTime\":\"2021-09-28T11:23:46Z\",\"instanceName\":\"ecs\",\"internetMaxBandwidthOut\":0.0,\"description\":\"\",\"clusterId\":\"\",\"private_ip\":\"192.168.0.247\",\"instanceId\":\"i-2zehnzxqixu1pywsfbx1\",\"requestId\":\"F1C64344-3723-51A0-855B-5F08B5634323\",\"zoneId\":\"cn-beijing-b\",\"ioOptimized\":\"optimized\",\"id\":\"i-2zehnzxqixu1pywsfbx1\",\"instanceNetworkType\":\"vpc\",\"instanceChargeType\":\"PostPaid\",\"imageId\":\"centos_8_4_x64_20G_alibase_20210824.vhd\",\"serialNumber\":\"cee246c4-38f3-4bf3-950b-c17e88ff6527\",\"vlanId\":\"\",\"instanceType\":\"ecs.e3.large\",\"cpu\":4.0,\"creditSpecification\":\"\",\"internetMaxBandwidthIn\":-1.0,\"expiredTime\":\"2099-12-31T15:59Z\",\"internetChargeType\":\"PayByTraffic\",\"regionId\":\"cn-beijing\",\"refId\":\"79224644_0\",\"stoppedMode\":\"Not-applicable\",\"status\":\"Running\"}",
"Lifecycle": "Create",
"NodeLabel": ""
}
],
"Error": "Success",
"DeployPercent": 0
},
"Code": "200"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | bp.java.8004 | No permissions. | 无权限访问 |
400 | bp.java.nopower | No permissions. | 没有权限 |
400 | bp.java.nopowerContact | You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions. | 您没有权限使用此功能,请联系主账号或权限管理员授权相关权限 |
400 | bp.java.userNotExist | The user does not exist. The current user does not authenticate AliCloud with his real name. | 用户不存在, 当前用户未实名认证阿里云 |
400 | ParameterEmpty | The request parameter cannot be empty. | 请求参数不能为空 |
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-08-30 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-08-01 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-06 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-05-25 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |