AI 助理
备案控制台
文档
输入文档关键字查找
首页云速搭开发参考CADT API使用指南功能介绍应用查询应用

查询应用

更新时间：2023-08-09 09:59:03
产品详情
我的收藏

对应接口

GetApplication

功能说明

通过此API 获取指定应用的基本信息、校验结果、计费结果、部署结果。

接口类型

同步

请求参数

ApplicationId

应用ID（必填）

ResourceGroupId

资源组ID（可选 ）

响应参数

Code

状态码

RequestId

请求ID

Data

可忽略

Message

若API调用失败，此字段包含错误信息。

Status

应用状态

应用状态列表：

  • 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 询价成功（架构调整）

应用状态机轮转

一个CADT的应用生命周期大致如下：

  1. 调用CreateApplication创建出来的应用处于“Modified”状态。

  2. 首先需要对应用进行校验，调用ValidateApplication，校验成功后方可进行下一步计价调用。若校验不成功，应用处于“Verified_Failure”,此时需要人为介入分析错误原因，并对应用配置手动进行调整并保存后，方可进入下一步计价环节。

  3. 调用ValuateApplication，对应用进行询价，询价成功后方可进行下一步部署调用。若询价失败，应用处于“Valuating_Failure”，此时需要人为介入分析错误原因，并对应用配置手动进行调整并保存后，方可进入下一步部署环节。

  4. 调用DeployApplication，对应用进行部署，部署失败状态可能是“Partially_Deployed_Success”或者“Deploy_Failure”，两种情况都需要人为介入分析错误原因，并对应用配置手动进行调整并保存后，方可重新进行部署。

  5. 调用ReleaseApplication, 对应用内的资源进行销毁，释放失败可能是“Partially_Destroyed_Success”或者“Destroyed_Failure”，两种情况都需要人为介入分析错误原因，并对应用配置手动进行调整并保存后，方可重新进行释放。

image.png

Description

应用描述

ImageURL

应用的架构图地址

https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png

ApplicationId

应用ID

Name

CADT应用名称

TemplateId

CADT应用关联的模板ID

CreateTime

应用创建时间

示例： 2021-08-09 14:37:16

ResourceGroupId

CADT应用所属资源组ID

示例： rg-aekzhfgmw4e6fwq

CheckList

校验结果

当CADT应用校验完成后时，将校验结果保存在CheckList 数组对象中，数组中包含1个或多个字典类型数据，有以下字段。

  • Remark：包含了CADT应用中每个资源校验失败和成功的结果。若失败，会写出详细失败原因，若成功，则显示“校验通过”。

  • Result：标记当前该资源校验成功还是失败。

Key

Type

描述

示例

Key

Type

描述

示例

ResourceCode

String

产品code

vpc

ResourceName

String

实例名

vpc

Region

String

区域

cn-hangzhou

Result

String

校验结果

Finish

Remark

String

失败原因

校验通过

Specification

String

规格

192.168.0.0/16

Lifecycle

String

资源标记

Create

PriceList

询价结果

当CADT应用询价成功时，将询价结果保存在PriceList 数组对象中，数组中包含1个或多个字典类型数据，有以下字段。

  • Remark：包含了CADT应用中每个资源询价失败的原因，询价成功，此字段为空。

  • type：标记当前该资源是属于导入还是新购的。

Key

type

描述

示例

Key

type

描述

示例

ResourceCode

String

产品code

ecs

InstanceName

String

实例名

ecs

OriginalPrice

Float

原价

3.570

OnePrice

Float

单价

0.01

Period

Float

时长

1

Count

Long

数量

1

PriceUnit

String

单位：元/时

金额/时

Price

Float

总价

0.01

ChargeType

String

支付类型

PayAsYouGo

Region

String

区域

cn-hangzhou

Specification

String

实例规格。 返回实例规格信息，例如VPC返回网段信息“192.168.0.0/16”，ECS返回实例规格“ecs.g5.large”，SLB返回“slb.s1.small”等；如果该实例没有规格属性，则返回空。

"slb.s1.small" "192.168.0.0/24" "ecs.c6.large" "normal" ""

Lifecycle

String

资源标记

Create

Remark

String

询价失败时返回错误信息

ecs售罄

type

String

创建类型： 新建-1 导入-2

1

ResourceList

部署结果

当CADT应用部署完成后，将部署结果保存在ResourceList 数组对象中，数组中包含1个或多个字典类型数据，有以下字段。

  • Remark：包含了CADT应用中每个资源部署结束后的元数据，相当于调用DescribeInstance返回的数据，可用于回写到CMDB库中。

  • Lifecycle：标记当前该资源是属于导入还是新购的。

Key

Type

描述

示例

Key

Type

描述

示例

Status

String

资源部署结果

Finish

ResourceCode

String

产品code

ecs

ResourceName

String

实例名称

ecs

ResourceId

String

实例ID

i-2zehnzxqixu1pywsfbx1

ChargeType

String

支付类型

PayAsYouGo

ResourceType

String

资源类型

ecs

Remark

String

部署结果

{"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

String

资源标记

Create

Error

Error字段用于汇总应用部署失败或者释放失败时的详情信息。

上一篇：应用释放下一篇：获取应用列表
  • 本页导读 （0）
  • 对应接口
  • 功能说明
  • 接口类型
  • 请求参数
  • ApplicationId
  • ResourceGroupId
  • 响应参数
  • Code
  • RequestId
  • Data
  • Message
  • Status
  • Description
  • ImageURL
  • ApplicationId
  • Name
  • TemplateId
  • CreateTime
  • ResourceGroupId
  • CheckList
  • PriceList
  • ResourceList
  • Error