v1

package
v0.1.24 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 2, 2023 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AosClientBuilder

func AosClientBuilder() *http_client.HcHttpClientBuilder

func GenReqDefForApplyExecutionPlan

func GenReqDefForApplyExecutionPlan() *def.HttpRequestDef

func GenReqDefForContinueRollbackStack

func GenReqDefForContinueRollbackStack() *def.HttpRequestDef

func GenReqDefForCreateExecutionPlan

func GenReqDefForCreateExecutionPlan() *def.HttpRequestDef

func GenReqDefForCreateStack

func GenReqDefForCreateStack() *def.HttpRequestDef

func GenReqDefForDeleteExecutionPlan added in v0.1.15

func GenReqDefForDeleteExecutionPlan() *def.HttpRequestDef

func GenReqDefForDeleteStack added in v0.1.12

func GenReqDefForDeleteStack() *def.HttpRequestDef

func GenReqDefForDeployStack

func GenReqDefForDeployStack() *def.HttpRequestDef

func GenReqDefForDescribeExecutionPlan added in v0.1.15

func GenReqDefForDescribeExecutionPlan() *def.HttpRequestDef

func GenReqDefForEstimateExecutionPlanPrice

func GenReqDefForEstimateExecutionPlanPrice() *def.HttpRequestDef

func GenReqDefForGetExecutionPlan added in v0.1.15

func GenReqDefForGetExecutionPlan() *def.HttpRequestDef

func GenReqDefForGetStackMetadata added in v0.1.15

func GenReqDefForGetStackMetadata() *def.HttpRequestDef

func GenReqDefForGetStackTemplate

func GenReqDefForGetStackTemplate() *def.HttpRequestDef

func GenReqDefForListExecutionPlans

func GenReqDefForListExecutionPlans() *def.HttpRequestDef

func GenReqDefForListStackEvents added in v0.1.12

func GenReqDefForListStackEvents() *def.HttpRequestDef

func GenReqDefForListStackOutputs

func GenReqDefForListStackOutputs() *def.HttpRequestDef

func GenReqDefForListStackResources added in v0.1.12

func GenReqDefForListStackResources() *def.HttpRequestDef

func GenReqDefForListStacks

func GenReqDefForListStacks() *def.HttpRequestDef

func GenReqDefForParseTemplateVariables

func GenReqDefForParseTemplateVariables() *def.HttpRequestDef

func GenReqDefForUpdateStack added in v0.1.24

func GenReqDefForUpdateStack() *def.HttpRequestDef

Types

type AosClient

type AosClient struct {
	HcClient *http_client.HcHttpClient
}

func NewAosClient

func NewAosClient(hcClient *http_client.HcHttpClient) *AosClient

func (*AosClient) ApplyExecutionPlan

func (c *AosClient) ApplyExecutionPlan(request *model.ApplyExecutionPlanRequest) (*model.ApplyExecutionPlanResponse, error)

ApplyExecutionPlan 此命令用于执行已有的执行计划(execution plan)

此命令用于执行已有的执行计划(execution plan)

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ApplyExecutionPlanInvoker

func (c *AosClient) ApplyExecutionPlanInvoker(request *model.ApplyExecutionPlanRequest) *ApplyExecutionPlanInvoker

ApplyExecutionPlanInvoker 此命令用于执行已有的执行计划(execution plan)

func (*AosClient) ContinueRollbackStack

ContinueRollbackStack 继续回滚资源栈

如果资源栈开启了自动回滚,在部署失败的时候则会自动回滚。但是自动回滚依然有可能失败,用户可以根据错误信息修复后,调用ContinueRollbackStack触发继续回滚,即重试回滚

* 如果资源栈当前可以回滚,即处于`ROLLBACK_FAILED`,则返回202与对应生成的deploymentId,否则将不允许回滚并返回响应的错误码 * 继续回滚也有可能会回滚失败。如果失败,用户可以从ListStackEvents获取对应的log,解决后可再次调用ContinueRollbackStack去继续触发回滚

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ContinueRollbackStackInvoker

func (c *AosClient) ContinueRollbackStackInvoker(request *model.ContinueRollbackStackRequest) *ContinueRollbackStackInvoker

ContinueRollbackStackInvoker 继续回滚资源栈

func (*AosClient) CreateExecutionPlan

CreateExecutionPlan 此命令用于生成一个执行计划(execution plan)

此命令用于生成一个执行计划(execution plan) * 如果资源栈删除失败,可在修复当前模板中的错误后调用CreateExecutionPlan生成执行计划。

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) CreateExecutionPlanInvoker

func (c *AosClient) CreateExecutionPlanInvoker(request *model.CreateExecutionPlanRequest) *CreateExecutionPlanInvoker

CreateExecutionPlanInvoker 此命令用于生成一个执行计划(execution plan)

func (*AosClient) CreateStack

func (c *AosClient) CreateStack(request *model.CreateStackRequest) (*model.CreateStackResponse, error)

CreateStack 创建资源栈

CreateStack用于生成一个资源栈

* 当请求中不含有模板(template)、参数(vars)等信息,将生成一个无任何资源的空资源栈,返回资源栈ID(stack_id) * 当请求中携带了模板(template)、参数(vars)等信息,则会同时创建并部署资源栈,返回资源栈ID(stack_id)和部署ID(deployment_id)

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) CreateStackInvoker

func (c *AosClient) CreateStackInvoker(request *model.CreateStackRequest) *CreateStackInvoker

CreateStackInvoker 创建资源栈

func (*AosClient) DeleteExecutionPlan added in v0.1.15

DeleteExecutionPlan 此命令用于删除已有的执行计划(execution plan)

此命令用于删除已有的执行计划(execution plan)

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) DeleteExecutionPlanInvoker added in v0.1.15

func (c *AosClient) DeleteExecutionPlanInvoker(request *model.DeleteExecutionPlanRequest) *DeleteExecutionPlanInvoker

DeleteExecutionPlanInvoker 此命令用于删除已有的执行计划(execution plan)

func (*AosClient) DeleteStack added in v0.1.12

func (c *AosClient) DeleteStack(request *model.DeleteStackRequest) (*model.DeleteStackResponse, error)

DeleteStack 删除资源栈

删除某个资源栈 **请谨慎操作,删除资源栈将会删除与该资源栈相关的所有数据和资源,如:执行计划、资源栈事件、资源栈输出、资源等。**

* 此API会触发删除资源栈,并以最终一致性删除所有数据,用户可以调用GetStackMetadata或ListStacks跟踪资源栈删除情况 * 如果资源栈状态处于非终态(状态以`IN_PROGRESS`结尾)状态时,则不允许删除。包括但不限于以下状态:

  • 正在部署(DEPLOYMENT_IN_PROGRESS)
  • 正在删除(DELETION_IN_PROGRESS)
  • 正在回滚(ROLLBACK_IN_PROGRESS)

* 如果资源栈开启了删除保护,则不允许删除。用户可调用GetStackMetadata,查看返回中的`enable_deletion_protection`字段判断删除保护是否开启。用户可通过调用UpdateStack关闭删除保护。 * 如果资源栈删除失败,可以根据StackEvents提示信息修复当前模板中的错误后,部署成功后再次删除资源栈。有以下两种方式触发部署:

  • 调用CreateExecutionPlan创建执行计划,执行计划创建成功后调用ApplyExecutionPlan部署资源栈。
  • 调用DeployStack部署资源栈

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) DeleteStackInvoker added in v0.1.12

func (c *AosClient) DeleteStackInvoker(request *model.DeleteStackRequest) *DeleteStackInvoker

DeleteStackInvoker 删除资源栈

func (*AosClient) DeployStack

func (c *AosClient) DeployStack(request *model.DeployStackRequest) (*model.DeployStackResponse, error)

DeployStack 部署资源栈

部署一个已有的资源栈

* 用户可以使用此API更新模板、参数等并触发一个新的部署

* 此API会直接触发部署,如果用户希望先确认部署会发生的时间,请使用执行计划,即使用CreateExecutionPlan以创建执行计划、使用GetExecutionPlan以获取执行计划

* 此API为全量API,即用户每次部署都需要给予所想要使用的template、vars的全量

* 当触发的部署失败时,如果资源栈开启了自动回滚,会触发自动回滚的流程,否则就会停留在部署失败时的状态

* 资源栈状态是DELETION_FAILED时,用户可根据StackEvents信息修复当前模板中的错误后,重新触发部署。

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) DeployStackInvoker

func (c *AosClient) DeployStackInvoker(request *model.DeployStackRequest) *DeployStackInvoker

DeployStackInvoker 部署资源栈

func (*AosClient) DescribeExecutionPlan added in v0.1.15

DescribeExecutionPlan 描述执行计划当前的状态,返回执行计划的元数据

描述执行计划当前的状态,返回执行计划的元数据

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) DescribeExecutionPlanInvoker added in v0.1.15

func (c *AosClient) DescribeExecutionPlanInvoker(request *model.DescribeExecutionPlanRequest) *DescribeExecutionPlanInvoker

DescribeExecutionPlanInvoker 描述执行计划当前的状态,返回执行计划的元数据

func (*AosClient) EstimateExecutionPlanPrice

EstimateExecutionPlanPrice 预估执行计划的价格

预估执行计划的价格

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) EstimateExecutionPlanPriceInvoker

func (c *AosClient) EstimateExecutionPlanPriceInvoker(request *model.EstimateExecutionPlanPriceRequest) *EstimateExecutionPlanPriceInvoker

EstimateExecutionPlanPriceInvoker 预估执行计划的价格

func (*AosClient) GetExecutionPlan added in v0.1.15

func (c *AosClient) GetExecutionPlan(request *model.GetExecutionPlanRequest) (*model.GetExecutionPlanResponse, error)

GetExecutionPlan 此接口用于获取执行计划的详细内容

此接口用于获取执行计划的详细内容

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) GetExecutionPlanInvoker added in v0.1.15

func (c *AosClient) GetExecutionPlanInvoker(request *model.GetExecutionPlanRequest) *GetExecutionPlanInvoker

GetExecutionPlanInvoker 此接口用于获取执行计划的详细内容

func (*AosClient) GetStackMetadata added in v0.1.15

func (c *AosClient) GetStackMetadata(request *model.GetStackMetadataRequest) (*model.GetStackMetadataResponse, error)

GetStackMetadata 获取资源栈的元数据

获取资源栈的元数据,包括资源栈ID、资源栈名称、资源栈描述、创建时间、更新时间、资源栈状态、委托授权等信息。

具体信息见GetStackMetadataResponseBody。

注: 当资源栈状态处于非终态(即以`IN_PROGRESS`结尾,详细见下方)状态时,资源栈的元数据信息处于转变阶段,可能为部署前的状态,也可能为部署后的状态。 只有当资源栈状态处于终态(即以`COMPLETE`或`FAILED`结尾,详细见下方)时,资源栈的元数据信息才是部署后的状态

非终态状态包括但不限于以下状态:

  • 正在部署(DEPLOYMENT_IN_PROGRESS)
  • 正在回滚(ROLLBACK_IN_PROGRESS)
  • 正在删除(DELETION_IN_PROGRESS)

终态状态包括但不限于以下状态:

  • 生成空资源栈完成(CREATION_COMPLETE)
  • 部署失败(DEPLOYMENT_FAILED)
  • 部署完成(DEPLOYMENT_COMPLETE)
  • 回滚失败(ROLLBACK_FAILED)
  • 回滚完成(ROLLBACK_COMPLETE)
  • 删除失败(DELETION_FAILED)

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) GetStackMetadataInvoker added in v0.1.15

func (c *AosClient) GetStackMetadataInvoker(request *model.GetStackMetadataRequest) *GetStackMetadataInvoker

GetStackMetadataInvoker 获取资源栈的元数据

func (*AosClient) GetStackTemplate

func (c *AosClient) GetStackTemplate(request *model.GetStackTemplateRequest) (*model.GetStackTemplateResponse, error)

GetStackTemplate 获取资源栈模板

获取资源栈最近的一次部署使用的模板。

如果获取成功,则以临时重定向形式返回模板下载链接,大多数的客户端会进行自动重定向并下载模板;若未进行自动重定向,请参考HTTP的重定向规则获取模板下载链接,手动下载模板

如果资源栈当前没有模板,则返回404,并提示模板不存在

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) GetStackTemplateInvoker

func (c *AosClient) GetStackTemplateInvoker(request *model.GetStackTemplateRequest) *GetStackTemplateInvoker

GetStackTemplateInvoker 获取资源栈模板

func (*AosClient) ListExecutionPlans

func (c *AosClient) ListExecutionPlans(request *model.ListExecutionPlansRequest) (*model.ListExecutionPlansResponse, error)

ListExecutionPlans 列举执行计划

列举执行计划

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ListExecutionPlansInvoker

func (c *AosClient) ListExecutionPlansInvoker(request *model.ListExecutionPlansRequest) *ListExecutionPlansInvoker

ListExecutionPlansInvoker 列举执行计划

func (*AosClient) ListStackEvents added in v0.1.12

func (c *AosClient) ListStackEvents(request *model.ListStackEventsRequest) (*model.ListStackEventsResponse, error)

ListStackEvents 列举资源栈事件

列举资源栈某一次或全部的部署事件

* 若给予deployment_id,则会将deployment_id作为查询条件,返回对应某一次部署的资源栈事件;若不给予deployment_id,则返回全量的资源栈事件 * 若给定的deployment_id对应的部署不存在,则返回404 * 可以使用filter作为过滤器,过滤出指定事件类型(event_type)、资源类型(resource_type)、资源名称(resource_name)的资源栈事件 * 可以使用field选择数据应返回的属性,属性事件类型(event_type)不可配置,一定会返回,可选择的属性有逝去时间(elapsed_seconds)、事件消息(event_message)、 资源ID键(resource_id_key)、资源ID值(resource_id_value)、资源键(resource_key)、资源类型(resource_type)、资源名称(resource_name)和时间戳(timestamp) * 事件返回将以时间降序排列

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ListStackEventsInvoker added in v0.1.12

func (c *AosClient) ListStackEventsInvoker(request *model.ListStackEventsRequest) *ListStackEventsInvoker

ListStackEventsInvoker 列举资源栈事件

func (*AosClient) ListStackOutputs

func (c *AosClient) ListStackOutputs(request *model.ListStackOutputsRequest) (*model.ListStackOutputsResponse, error)

ListStackOutputs 列举资源栈输出

列举该资源栈的所有输出

资源栈输出为用户在模板中定义的 output 语句块在部署结束后所产生的返回信息,用户可在部署结束后,调用此API获取其具体的输出信息

output为HCL官方定义的语法,其返回信息类似于常见编程语言中的返回值,详细定义请参考HCL官方的说明

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ListStackOutputsInvoker

func (c *AosClient) ListStackOutputsInvoker(request *model.ListStackOutputsRequest) *ListStackOutputsInvoker

ListStackOutputsInvoker 列举资源栈输出

func (*AosClient) ListStackResources added in v0.1.12

func (c *AosClient) ListStackResources(request *model.ListStackResourcesRequest) (*model.ListStackResourcesResponse, error)

ListStackResources 列举资源栈资源

列举资源栈中当前管理的所有资源的信息

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ListStackResourcesInvoker added in v0.1.12

func (c *AosClient) ListStackResourcesInvoker(request *model.ListStackResourcesRequest) *ListStackResourcesInvoker

ListStackResourcesInvoker 列举资源栈资源

func (*AosClient) ListStacks

func (c *AosClient) ListStacks(request *model.ListStacksRequest) (*model.ListStacksResponse, error)

ListStacks 列举资源栈

ListStacks 列举当前局点下用户所有的资源栈

  • 默认按照生成时间排序,最早生成的在最前
  • 注意:目前暂时返回全量资源栈信息,即不支持分页
  • 如果没有任何资源栈,则返回空list

ListStacks返回的只有摘要信息(具体摘要信息见ListStacksResponseBody),如果用户需要详细的资源栈元数据请调用GetStackMetadata

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ListStacksInvoker

func (c *AosClient) ListStacksInvoker(request *model.ListStacksRequest) *ListStacksInvoker

ListStacksInvoker 列举资源栈

func (*AosClient) ParseTemplateVariables

ParseTemplateVariables 此命令用于解析模板参数

此命令用于解析模板参数

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ParseTemplateVariablesInvoker

func (c *AosClient) ParseTemplateVariablesInvoker(request *model.ParseTemplateVariablesRequest) *ParseTemplateVariablesInvoker

ParseTemplateVariablesInvoker 此命令用于解析模板参数

func (*AosClient) UpdateStack added in v0.1.24

func (c *AosClient) UpdateStack(request *model.UpdateStackRequest) (*model.UpdateStackResponse, error)

UpdateStack 更新资源栈

更新资源栈的“description”、“enable_deletion_protection”、\"enable_auto_rollback\"、\"agencies\"四个属性字段中的一个或多个

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) UpdateStackInvoker added in v0.1.24

func (c *AosClient) UpdateStackInvoker(request *model.UpdateStackRequest) *UpdateStackInvoker

UpdateStackInvoker 更新资源栈

type ApplyExecutionPlanInvoker

type ApplyExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*ApplyExecutionPlanInvoker) Invoke

type ContinueRollbackStackInvoker

type ContinueRollbackStackInvoker struct {
	*invoker.BaseInvoker
}

func (*ContinueRollbackStackInvoker) Invoke

type CreateExecutionPlanInvoker

type CreateExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*CreateExecutionPlanInvoker) Invoke

type CreateStackInvoker

type CreateStackInvoker struct {
	*invoker.BaseInvoker
}

func (*CreateStackInvoker) Invoke

type DeleteExecutionPlanInvoker added in v0.1.15

type DeleteExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*DeleteExecutionPlanInvoker) Invoke added in v0.1.15

type DeleteStackInvoker added in v0.1.12

type DeleteStackInvoker struct {
	*invoker.BaseInvoker
}

func (*DeleteStackInvoker) Invoke added in v0.1.12

type DeployStackInvoker

type DeployStackInvoker struct {
	*invoker.BaseInvoker
}

func (*DeployStackInvoker) Invoke

type DescribeExecutionPlanInvoker added in v0.1.15

type DescribeExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*DescribeExecutionPlanInvoker) Invoke added in v0.1.15

type EstimateExecutionPlanPriceInvoker

type EstimateExecutionPlanPriceInvoker struct {
	*invoker.BaseInvoker
}

func (*EstimateExecutionPlanPriceInvoker) Invoke

type GetExecutionPlanInvoker added in v0.1.15

type GetExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*GetExecutionPlanInvoker) Invoke added in v0.1.15

type GetStackMetadataInvoker added in v0.1.15

type GetStackMetadataInvoker struct {
	*invoker.BaseInvoker
}

func (*GetStackMetadataInvoker) Invoke added in v0.1.15

type GetStackTemplateInvoker

type GetStackTemplateInvoker struct {
	*invoker.BaseInvoker
}

func (*GetStackTemplateInvoker) Invoke

type ListExecutionPlansInvoker

type ListExecutionPlansInvoker struct {
	*invoker.BaseInvoker
}

func (*ListExecutionPlansInvoker) Invoke

type ListStackEventsInvoker added in v0.1.12

type ListStackEventsInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStackEventsInvoker) Invoke added in v0.1.12

type ListStackOutputsInvoker

type ListStackOutputsInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStackOutputsInvoker) Invoke

type ListStackResourcesInvoker added in v0.1.12

type ListStackResourcesInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStackResourcesInvoker) Invoke added in v0.1.12

type ListStacksInvoker

type ListStacksInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStacksInvoker) Invoke

type ParseTemplateVariablesInvoker

type ParseTemplateVariablesInvoker struct {
	*invoker.BaseInvoker
}

func (*ParseTemplateVariablesInvoker) Invoke

type UpdateStackInvoker added in v0.1.24

type UpdateStackInvoker struct {
	*invoker.BaseInvoker
}

func (*UpdateStackInvoker) Invoke added in v0.1.24

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL