更新时间:2024-12-16 GMT+08:00

根据环境ID开通环境资源

功能介绍

此API用于通过环境ID开通环境资源。

URI

POST /v3/{project_id}/cas/environments/{environment_id}/iac-resources/provision

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID。获取方法,请参考获取项目ID

environment_id

String

环境ID。获取方法,请参考获取所有环境

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),默认取值为“application/json;charset=utf8”。

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权

响应消息

表3 响应参数

参数

参数类型

描述

status

String

环境资源开通状态。

  • CREATION_IN_PROGRESS,环境资源创建中。
  • CREATION_FAILED,环境资源创建失败。
  • CREATION_COMPLETE,环境资源创建成功。
  • UPDATE_IN_PROGRESS,环境资源更新中。
  • UPDATE_FAILED,环境资源更新失败。
  • UPDATE_COMPLETE,环境资源更新成功。
  • DELETION_IN_PROGRESS,环境资源删除中。
  • DELETION_FAILED,环境资源删除失败。
  • DELETION_COMPLETE,环境资源删除成功。

status_message

String

环境资源开通的状态信息。

当环境资源开通状态为环境资源创建失败状态(CREATION_FAILED)时,提供错误提示信息以供排错使用。

create_time

Integer

创建时间。

execution_plan_item

Array of objects

执行计划项目的列表,请参考表4

表4 ExecutionPlanItem

参数

参数类型

描述

resource_type

String

资源的类型。

resource_name

String

资源的名称,默认为资源的逻辑名称。

index

String

资源的索引。

action

String

资源变更的类型。

action_reason

String

触发该项目变更的原因。

mode

String

资源模式。

  • DATA:用于在模板解析期间查询已经存在资源的属性和信息。
  • RESOURCE:通过模板管理的由服务定义的基础设施组件抽象,可以是物理资源也可以是逻辑资源。

drifted

Boolean

当前资源的变更是否由偏差导致。

  • true:是。
  • false:否。

imported

Boolean

当前资源的变更是否是导入的。

  • true:是。
  • false:否。

resource_id

String

资源的物理id。

attributes

Array of objects

执行计划项目中变更的属性,当无属性变更时为空列表,请参考表5

表5 ExecutionPlanDiffAttribute

参数

参数类型

描述

name

String

当前资源将要被修改的参数的名字。

previous_value

String

当前资源被修改的参数的原始值。

target_value

String

当前资源被修改的参数的目的值。

请求示例

响应示例

{
    "status": "CREATION_COMPLETE",
    "status_message": null,
    "execution_plan_items": [
	{
            "resource_type": "hcs_vpc_subnet",
	    "resource_name": "subnet",
	    "action": "ADD",
	    "attributes": [
		{
		    "name": "cidr",
		    "target_value": "172.16.0.0/16"
		}
	     ],
	     "mode": "RESOURCE",
	 }
     ]
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考ServiceStage错误码