v1

package
v0.1.39 Latest Latest
Warning

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

 Go to latest Published: May 11, 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 GenReqDefForContinueDeployStack added in v0.1.39 

func GenReqDefForContinueDeployStack() *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 GenReqDefForDeleteTemplate added in v0.1.30 

func GenReqDefForDeleteTemplate() *def.HttpRequestDef

func GenReqDefForDeleteTemplateVersion added in v0.1.30 

func GenReqDefForDeleteTemplateVersion() *def.HttpRequestDef

func GenReqDefForDeployStack 

func GenReqDefForDeployStack() *def.HttpRequestDef

func GenReqDefForEstimateExecutionPlanPrice 

func GenReqDefForEstimateExecutionPlanPrice() *def.HttpRequestDef

func GenReqDefForGetExecutionPlan added in v0.1.15 

func GenReqDefForGetExecutionPlan() *def.HttpRequestDef

func GenReqDefForGetExecutionPlanMetadata added in v0.1.30 

func GenReqDefForGetExecutionPlanMetadata() *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 GenReqDefForListTemplates added in v0.1.30 

func GenReqDefForListTemplates() *def.HttpRequestDef

func GenReqDefForParseTemplateVariables 

func GenReqDefForParseTemplateVariables() *def.HttpRequestDef

func GenReqDefForShowTemplateMetadata added in v0.1.30 

func GenReqDefForShowTemplateMetadata() *def.HttpRequestDef

func GenReqDefForShowTemplateVersionContent added in v0.1.30 

func GenReqDefForShowTemplateVersionContent() *def.HttpRequestDef

func GenReqDefForShowTemplateVersionMetadata added in v0.1.30 

func GenReqDefForShowTemplateVersionMetadata() *def.HttpRequestDef

func GenReqDefForUpdateStack added in v0.1.24 

func GenReqDefForUpdateStack() *def.HttpRequestDef

func GenReqDefForUpdateTemplateMetadata added in v0.1.30 

func GenReqDefForUpdateTemplateMetadata() *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 执行执行计划

执行执行计划（ApplyExecutionPlan）

此API用于执行一个执行计划

* 当执行请求接受后，执行计划状态将变为`APPLY_IN_PROGRESS`，后台会进行异步处理。 * 当执行结束后，执行计划状态将变为`APPLIED`。 * 用户可以调用GetStackMetadata查询资源栈的状态（status）来跟踪资源栈部署情况以及确认本次执行结果是否成功。

如果不希望通过执行计划进行部署操作，也可以选择调用DeployStack进行直接部署

关于执行计划的过期失效：

  1. 若指定资源栈下有多个执行计划，则在执行某个执行计划后（无论结果是否成功），剩余所有的执行计划将过期失效；
  2. 若调用ApplyExecutionPlan时，指定的执行计划已经过期失效，则返回403

若资源栈状态处于非终态（即以`IN_PROGRESS`结尾，详细见下方）状态时，则不允许执行执行计划，并返回403。非终态状态包括但不限于以下状态：

  • 正在部署（DEPLOYMENT_IN_PROGRESS）
  • 正在删除（DELETION_IN_PROGRESS）
  • 正在回滚（ROLLBACK_IN_PROGRESS）

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ApplyExecutionPlanInvoker 

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

ApplyExecutionPlanInvoker 执行执行计划

func (*AosClient) ContinueDeployStack added in v0.1.39 

func (c *AosClient) ContinueDeployStack(request *model.ContinueDeployStackRequest) (*model.ContinueDeployStackResponse, error)

ContinueDeployStack 继续部署资源栈

继续部署资源栈（ContinueDeployStack）

此API用于继续部署一个已有的资源栈

* 如果资源栈当前可以继续部署，即处于`DEPLOYMENT_FAILED`，则返回202与对应生成的deploymentId，否则将不允许继续部署并返回相应的错误码

* 继续部署操作依然有可能部署失败，用户可以从ListStackEvents获取对应的log，解决后可再次调用此API触发继续部署

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ContinueDeployStackInvoker added in v0.1.39 

func (c *AosClient) ContinueDeployStackInvoker(request *model.ContinueDeployStackRequest) *ContinueDeployStackInvoker

ContinueDeployStackInvoker 继续部署资源栈

func (*AosClient) ContinueRollbackStack 

func (c *AosClient) ContinueRollbackStack(request *model.ContinueRollbackStackRequest) (*model.ContinueRollbackStackResponse, error)

ContinueRollbackStack 继续回滚资源栈

继续回滚资源栈（ContinueRollbackStack）

此API用于继续回滚一个已有的资源栈

如果资源栈开启了自动回滚，在部署失败的时候则会自动回滚。但是自动回滚依然有可能失败，用户可以根据错误信息修复后，调用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 

func (c *AosClient) CreateExecutionPlan(request *model.CreateExecutionPlanRequest) (*model.CreateExecutionPlanResponse, error)

CreateExecutionPlan 创建执行计划

创建执行计划（CreateExecutionPlan）

此API用于在指定的资源栈下生成一个执行计划，执行计划描述了当前资源栈中记录的资源状态和模板描述的目的资源状态之间的区别（如，资源A将以以下配置文件生成，资源B将以下参数从XXX修改成YYY）

调用此API触发创建执行计划之后，可以通过GetExecutionPlanMetadata来跟踪执行计划的状态 当执行计划状态为`AVAILABLE`时，可以通过GetExecutionPlan获取本次执行计划的结果

执行计划不会做过多深层的检查和校验，如用户是否有权限生成、修改资源等

**注意：**

  • 若指定资源栈不存在，则返回404
  • 若请求中不含有template_body和template_uri，则返回400
  • 若资源栈进行了某次部署操作，则在该次部署操作前生成的执行计划将全部失效
  • 执行计划只代表生成时刻的结果，若执行计划生成后，用户手动修改资源状态，则执行计划不会自动更新
  • 若资源栈状态处于`DEPLOYMENT_IN_PROGRESS`、`ROLLBACK_IN_PROGRESS`、`DELETION_IN_PROGRESS`等状态时，则不允许创建执行计划，并返回403

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) CreateExecutionPlanInvoker 

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

CreateExecutionPlanInvoker 创建执行计划

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 

func (c *AosClient) DeleteExecutionPlan(request *model.DeleteExecutionPlanRequest) (*model.DeleteExecutionPlanResponse, error)

DeleteExecutionPlan 删除执行计划

删除执行计划（DeleteExecutionPlan）

删除指定的执行计划

若执行计划状态处于`CREATION_IN_PROGRESS`、`APPLY_IN_PROGRESS`状态时，则不允许删除并返回403

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 删除执行计划

func (*AosClient) DeleteStack added in v0.1.12 

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

DeleteStack 删除资源栈

删除资源栈（DeleteStack）

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

* 此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) DeleteTemplate added in v0.1.30 

func (c *AosClient) DeleteTemplate(request *model.DeleteTemplateRequest) (*model.DeleteTemplateResponse, error)

DeleteTemplate 删除模板

删除模板（DeleteTemplate）

此API用于删除某个模板以及模板下的全部模板版本 **请谨慎操作，删除模板将会删除模板下的所有模板版本。**

  • 若template_name和template_id同时存在，则模板服务会检查是否两个匹配

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) DeleteTemplateInvoker added in v0.1.30 

func (c *AosClient) DeleteTemplateInvoker(request *model.DeleteTemplateRequest) *DeleteTemplateInvoker

DeleteTemplateInvoker 删除模板

func (*AosClient) DeleteTemplateVersion added in v0.1.30 

func (c *AosClient) DeleteTemplateVersion(request *model.DeleteTemplateVersionRequest) (*model.DeleteTemplateVersionResponse, error)

DeleteTemplateVersion 删除模板版本

删除模板版本（DeleteTemplateVersion）

此API用于删除某个模板版本

  • 若template_name和template_id同时存在，则模板服务会检查是否两个匹配，否则返回400
  • 若模板下只存在唯一模板版本，此模板版本将无法被删除，如果需要删除此模板版本，请调用DeleteTemplate。模板服务不允许存在没有模板版本的模板

**请谨慎操作**

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) DeleteTemplateVersionInvoker added in v0.1.30 

func (c *AosClient) DeleteTemplateVersionInvoker(request *model.DeleteTemplateVersionRequest) *DeleteTemplateVersionInvoker

DeleteTemplateVersionInvoker 删除模板版本

func (*AosClient) DeployStack 

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

DeployStack 部署资源栈

部署资源栈（DeployStack）

此API用于部署一个已有的资源栈

* 用户可以使用此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) EstimateExecutionPlanPrice 

func (c *AosClient) EstimateExecutionPlanPrice(request *model.EstimateExecutionPlanPriceRequest) (*model.EstimateExecutionPlanPriceResponse, error)

EstimateExecutionPlanPrice 预估执行计划价格

预估执行计划价格（EstimateExecutionPlanPrice）

此API可以基于一份已有的执行计划中增量的资源进行询价，当前支持询价的计费模式有包周期计费、按需计费、免费，暂不支持其他形式的计费模式，例如竞价计费模式等。

注：

  • 由于某些资源的属性值含有默认值，且该属性和询价参数相关。若用户的模板中描述的资源没有声明这些属性，则询价结果可能存在偏差。
  • 询价结果仅为预估结果，具体请以实际为准。
  • 若用户在模板中使用了depends_on参数，如A资源询价必要字段依赖于B资源的创建，则A资源不支持询价。
  • 暂不支持传入data sources的flavor.id的场景的询价。
  • 暂不支持镜像询价。
  • 模板中询价的资源的个数是有限制的。当前一个模板中最多支持12个包周期计费资源和24个按需计费资源。

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 获取执行计划

获取执行计划（GetExecutionPlan）

此API用于获取指定执行计划的详细内容（即执行计划项目），用户可通过此API得知指定执行计划在执行后，资源栈中的资源会发生何种变化

若执行计划状态为`CREATION_IN_PROGRESS`或`CREATION_FAILED`，则不返回执行计划项目列表

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) GetExecutionPlanMetadata added in v0.1.30 

func (c *AosClient) GetExecutionPlanMetadata(request *model.GetExecutionPlanMetadataRequest) (*model.GetExecutionPlanMetadataResponse, error)

GetExecutionPlanMetadata 获取执行计划元数据

获取执行计划元数据（GetExecutionPlanMetadata）

该API可以获取指定执行计划的元数据，包括资源栈ID、资源栈名称、执行计划ID、执行计划名称、执行计划描述、执行计划的创建时间和执行时间、执行计划状态等信息。

具体信息见GetExecutionPlanMetadataResponseBody。

如果需要获取执行计划的具体内容，请调用GetExecutionPlan。

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) GetExecutionPlanMetadataInvoker added in v0.1.30 

func (c *AosClient) GetExecutionPlanMetadataInvoker(request *model.GetExecutionPlanMetadataRequest) *GetExecutionPlanMetadataInvoker

GetExecutionPlanMetadataInvoker 获取执行计划元数据

func (*AosClient) GetStackMetadata added in v0.1.15 

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

GetStackMetadata 获取资源栈元数据

获取资源栈元数据（GetStackMetadata）

此API用于获取指定资源栈的元数据，包括资源栈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 获取资源栈模板

获取资源栈模板（GetStackTemplate）

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

如果获取成功，则以临时重定向形式返回模板下载链接（OBS Pre Signed地址，有效期为5分钟），大多数的客户端会进行自动重定向并下载模板； 若未进行自动重定向，请参考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 列举执行计划

列举执行计划（ListExecutionPlans）

列举当前局点下用户指定资源栈下所有的执行计划

  • 默认按照生成时间排序，最早生成的在最前
  • 注意：目前暂时返回全量执行计划信息，即不支持分页
  • 如果指定的资源栈下没有任何执行计划，则返回空list
  • 如果指定的资源栈不存在，则返回404

ListExecutionPlans返回的只有摘要信息（具体摘要信息见ListExecutionPlansResponseBody），如果用户需要详细的执行计划元数据请调用GetExecutionPlanMetadata

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 列举资源栈事件

列举资源栈事件（ListStackEvents）

此API用于列举资源栈某一次或全部的部署事件

* 若给予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 列举资源栈输出

列举资源栈输出（ListStackOutputs）

此API用于列举该资源栈的所有输出

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

当资源栈状态处于非终态（状态以`IN_PROGRESS`结尾）状态时，此API将返回空。非终态包括但不限于以下状态：

  • 正在部署（DEPLOYMENT_IN_PROGRESS）
  • 正在删除（DELETION_IN_PROGRESS）
  • 正在回滚（ROLLBACK_IN_PROGRESS）

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 列举资源栈资源

列举资源栈资源（ListStackResources）

此API用于列举资源栈中当前管理的所有资源的信息

对于非终态的资源栈（状态以`IN_PROGRESS`结尾），不返回资源属性。非终态状态包括但不限于以下状态：

  • 正在部署（DEPLOYMENT_IN_PROGRESS）
  • 正在删除（DELETION_IN_PROGRESS）
  • 正在回滚（ROLLBACK_IN_PROGRESS）

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）

此API用于列举当前局点下用户所有的资源栈

  • 默认按照生成时间排序，最早生成的在最前
  • 注意：目前暂时返回全量资源栈信息，即不支持分页
  • 如果没有任何资源栈，则返回空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) ListTemplates added in v0.1.30 

func (c *AosClient) ListTemplates(request *model.ListTemplatesRequest) (*model.ListTemplatesResponse, error)

ListTemplates 列举模板

列举模板（ListTemplates）

此API用于列举当前局点下用户所有的模板

  • 默认按照生成时间排序，最早生成的模板排列在最前面
  • 注意：目前返回全量模板信息，即不支持分页
  • 如果没有任何模板，则返回空list
  • 若用户需要详细的模板版本信息，请调用ListTemplateVersions

ListTemplates返回的信息只包含模板摘要信息（具体摘要信息见ListTemplatesResponseBody），若用户需要详细的某个模板信息，请调用ShowTemplateMetadata

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ListTemplatesInvoker added in v0.1.30 

func (c *AosClient) ListTemplatesInvoker(request *model.ListTemplatesRequest) *ListTemplatesInvoker

ListTemplatesInvoker 列举模板

func (*AosClient) ParseTemplateVariables 

func (c *AosClient) ParseTemplateVariables(request *model.ParseTemplateVariablesRequest) (*model.ParseTemplateVariablesResponse, error)

ParseTemplateVariables 解析模板参数

解析模板参数（ParseTemplateVariables）

此API用于解析用户输入的模板中的参数（variable），将解析模板中的所有variable块并返回

* 若用户传入的模板中定义了variable参数，则返回200和所有variable * 若用户传入的模板中没有定义variable参数，则返回200和空对象 * 若用户请求非法或传入的模板非法，则返回400

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ParseTemplateVariablesInvoker 

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

ParseTemplateVariablesInvoker 解析模板参数

func (*AosClient) ShowTemplateMetadata added in v0.1.30 

func (c *AosClient) ShowTemplateMetadata(request *model.ShowTemplateMetadataRequest) (*model.ShowTemplateMetadataResponse, error)

ShowTemplateMetadata 获取模板元数据

获取模板元数据（ShowTemplateMetadata）

此API用于获取当前模板的元数据信息

具体信息见ShowTemplateMetadataResponseBody，若想查看模板下全部模板版本，请调用ListTemplateVersions。

  • 若template_name和template_id同时存在，则模板服务会检查是否两个匹配

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ShowTemplateMetadataInvoker added in v0.1.30 

func (c *AosClient) ShowTemplateMetadataInvoker(request *model.ShowTemplateMetadataRequest) *ShowTemplateMetadataInvoker

ShowTemplateMetadataInvoker 获取模板元数据

func (*AosClient) ShowTemplateVersionContent added in v0.1.30 

func (c *AosClient) ShowTemplateVersionContent(request *model.ShowTemplateVersionContentRequest) (*model.ShowTemplateVersionContentResponse, error)

ShowTemplateVersionContent 获取模板版本内容

获取模板版本内容（ShowTemplateVersionContent）

此API用于获取用户的模板版本内容

  • 若template_name和template_id同时存在，则模板服务会检查是否两个匹配，否则返回400
  • 此api会以临时重定向形式返回模板内容的下载链接，用户通过下载获取模板版本内容（OBS Pre Signed地址，有效期为5分钟）

ShowTemplateVersionContent返回的信息只包含模板版本内容，若想知道模板版本的元数据，请调用ShowTemplateVersionMetadata

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ShowTemplateVersionContentInvoker added in v0.1.30 

func (c *AosClient) ShowTemplateVersionContentInvoker(request *model.ShowTemplateVersionContentRequest) *ShowTemplateVersionContentInvoker

ShowTemplateVersionContentInvoker 获取模板版本内容

func (*AosClient) ShowTemplateVersionMetadata added in v0.1.30 

func (c *AosClient) ShowTemplateVersionMetadata(request *model.ShowTemplateVersionMetadataRequest) (*model.ShowTemplateVersionMetadataResponse, error)

ShowTemplateVersionMetadata 获取模板版本元数据

获取模板版本元数据（ShowTemplateVersionMetadata）

此API用于展示某一版本模板的元数据

ShowTemplateVersionMetadata返回的信息只包含模板版本元数据信息（具体摘要信息见ShowTemplateVersionMetadataResponseBody），若用户需要了解模板版本内容，请调用ShowTemplateVersionContent。

  • 若template_name和template_id同时存在，则模板服务会检查是否两个匹配，否则返回400

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) ShowTemplateVersionMetadataInvoker added in v0.1.30 

func (c *AosClient) ShowTemplateVersionMetadataInvoker(request *model.ShowTemplateVersionMetadataRequest) *ShowTemplateVersionMetadataInvoker

ShowTemplateVersionMetadataInvoker 获取模板版本元数据

func (*AosClient) UpdateStack added in v0.1.24 

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

UpdateStack 更新资源栈

更新资源栈的属性，该API可以根据用户给予的信息对资源栈的属性进行更新，可以更新资源栈的“description”、“enable_deletion_protection”、\"enable_auto_rollback\"、\"agencies\"四个属性中的一个或多个

该API只会更新用户给予的信息中所涉及的字段；若某字段未给予，则不会对该资源栈属性进行更新

注：所有属性的更新都是覆盖式更新。即，所给予的参数将被完全覆盖至资源栈已有的属性上

例如，若要新增agencies，请通过GetStackMetadata获取该资源栈原有的agencies信息，将新旧agencies信息进行整合后再调用UpdateStack

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 更新资源栈

func (*AosClient) UpdateTemplateMetadata added in v0.1.30 

func (c *AosClient) UpdateTemplateMetadata(request *model.UpdateTemplateMetadataRequest) (*model.UpdateTemplateMetadataResponse, error)

UpdateTemplateMetadata 更新模板元数据

更新模板元数据（UpdateTemplateMetadata）

此API用于更新模板元数据

* 此api只支持更新模板描述

Please refer to HUAWEI cloud API Explorer for details.

func (*AosClient) UpdateTemplateMetadataInvoker added in v0.1.30 

func (c *AosClient) UpdateTemplateMetadataInvoker(request *model.UpdateTemplateMetadataRequest) *UpdateTemplateMetadataInvoker

UpdateTemplateMetadataInvoker 更新模板元数据

type ApplyExecutionPlanInvoker 

type ApplyExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*ApplyExecutionPlanInvoker) Invoke 

func (i *ApplyExecutionPlanInvoker) Invoke() (*model.ApplyExecutionPlanResponse, error)

type ContinueDeployStackInvoker added in v0.1.39 

type ContinueDeployStackInvoker struct {
	*invoker.BaseInvoker
}

func (*ContinueDeployStackInvoker) Invoke added in v0.1.39 

func (i *ContinueDeployStackInvoker) Invoke() (*model.ContinueDeployStackResponse, error)

type ContinueRollbackStackInvoker 

type ContinueRollbackStackInvoker struct {
	*invoker.BaseInvoker
}

func (*ContinueRollbackStackInvoker) Invoke 

func (i *ContinueRollbackStackInvoker) Invoke() (*model.ContinueRollbackStackResponse, error)

type CreateExecutionPlanInvoker 

type CreateExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*CreateExecutionPlanInvoker) Invoke 

func (i *CreateExecutionPlanInvoker) Invoke() (*model.CreateExecutionPlanResponse, error)

type CreateStackInvoker 

type CreateStackInvoker struct {
	*invoker.BaseInvoker
}

func (*CreateStackInvoker) Invoke 

func (i *CreateStackInvoker) Invoke() (*model.CreateStackResponse, error)

type DeleteExecutionPlanInvoker added in v0.1.15 

type DeleteExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*DeleteExecutionPlanInvoker) Invoke added in v0.1.15 

func (i *DeleteExecutionPlanInvoker) Invoke() (*model.DeleteExecutionPlanResponse, error)

type DeleteStackInvoker added in v0.1.12 

type DeleteStackInvoker struct {
	*invoker.BaseInvoker
}

func (*DeleteStackInvoker) Invoke added in v0.1.12 

func (i *DeleteStackInvoker) Invoke() (*model.DeleteStackResponse, error)

type DeleteTemplateInvoker added in v0.1.30 

type DeleteTemplateInvoker struct {
	*invoker.BaseInvoker
}

func (*DeleteTemplateInvoker) Invoke added in v0.1.30 

func (i *DeleteTemplateInvoker) Invoke() (*model.DeleteTemplateResponse, error)

type DeleteTemplateVersionInvoker added in v0.1.30 

type DeleteTemplateVersionInvoker struct {
	*invoker.BaseInvoker
}

func (*DeleteTemplateVersionInvoker) Invoke added in v0.1.30 

func (i *DeleteTemplateVersionInvoker) Invoke() (*model.DeleteTemplateVersionResponse, error)

type DeployStackInvoker 

type DeployStackInvoker struct {
	*invoker.BaseInvoker
}

func (*DeployStackInvoker) Invoke 

func (i *DeployStackInvoker) Invoke() (*model.DeployStackResponse, error)

type EstimateExecutionPlanPriceInvoker 

type EstimateExecutionPlanPriceInvoker struct {
	*invoker.BaseInvoker
}

func (*EstimateExecutionPlanPriceInvoker) Invoke 

func (i *EstimateExecutionPlanPriceInvoker) Invoke() (*model.EstimateExecutionPlanPriceResponse, error)

type GetExecutionPlanInvoker added in v0.1.15 

type GetExecutionPlanInvoker struct {
	*invoker.BaseInvoker
}

func (*GetExecutionPlanInvoker) Invoke added in v0.1.15 

func (i *GetExecutionPlanInvoker) Invoke() (*model.GetExecutionPlanResponse, error)

type GetExecutionPlanMetadataInvoker added in v0.1.30 

type GetExecutionPlanMetadataInvoker struct {
	*invoker.BaseInvoker
}

func (*GetExecutionPlanMetadataInvoker) Invoke added in v0.1.30 

func (i *GetExecutionPlanMetadataInvoker) Invoke() (*model.GetExecutionPlanMetadataResponse, error)

type GetStackMetadataInvoker added in v0.1.15 

type GetStackMetadataInvoker struct {
	*invoker.BaseInvoker
}

func (*GetStackMetadataInvoker) Invoke added in v0.1.15 

func (i *GetStackMetadataInvoker) Invoke() (*model.GetStackMetadataResponse, error)

type GetStackTemplateInvoker 

type GetStackTemplateInvoker struct {
	*invoker.BaseInvoker
}

func (*GetStackTemplateInvoker) Invoke 

func (i *GetStackTemplateInvoker) Invoke() (*model.GetStackTemplateResponse, error)

type ListExecutionPlansInvoker 

type ListExecutionPlansInvoker struct {
	*invoker.BaseInvoker
}

func (*ListExecutionPlansInvoker) Invoke 

func (i *ListExecutionPlansInvoker) Invoke() (*model.ListExecutionPlansResponse, error)

type ListStackEventsInvoker added in v0.1.12 

type ListStackEventsInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStackEventsInvoker) Invoke added in v0.1.12 

func (i *ListStackEventsInvoker) Invoke() (*model.ListStackEventsResponse, error)

type ListStackOutputsInvoker 

type ListStackOutputsInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStackOutputsInvoker) Invoke 

func (i *ListStackOutputsInvoker) Invoke() (*model.ListStackOutputsResponse, error)

type ListStackResourcesInvoker added in v0.1.12 

type ListStackResourcesInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStackResourcesInvoker) Invoke added in v0.1.12 

func (i *ListStackResourcesInvoker) Invoke() (*model.ListStackResourcesResponse, error)

type ListStacksInvoker 

type ListStacksInvoker struct {
	*invoker.BaseInvoker
}

func (*ListStacksInvoker) Invoke 

func (i *ListStacksInvoker) Invoke() (*model.ListStacksResponse, error)

type ListTemplatesInvoker added in v0.1.30 

type ListTemplatesInvoker struct {
	*invoker.BaseInvoker
}

func (*ListTemplatesInvoker) Invoke added in v0.1.30 

func (i *ListTemplatesInvoker) Invoke() (*model.ListTemplatesResponse, error)

type ParseTemplateVariablesInvoker 

type ParseTemplateVariablesInvoker struct {
	*invoker.BaseInvoker
}

func (*ParseTemplateVariablesInvoker) Invoke 

func (i *ParseTemplateVariablesInvoker) Invoke() (*model.ParseTemplateVariablesResponse, error)

type ShowTemplateMetadataInvoker added in v0.1.30 

type ShowTemplateMetadataInvoker struct {
	*invoker.BaseInvoker
}

func (*ShowTemplateMetadataInvoker) Invoke added in v0.1.30 

func (i *ShowTemplateMetadataInvoker) Invoke() (*model.ShowTemplateMetadataResponse, error)

type ShowTemplateVersionContentInvoker added in v0.1.30 

type ShowTemplateVersionContentInvoker struct {
	*invoker.BaseInvoker
}

func (*ShowTemplateVersionContentInvoker) Invoke added in v0.1.30 

func (i *ShowTemplateVersionContentInvoker) Invoke() (*model.ShowTemplateVersionContentResponse, error)

type ShowTemplateVersionMetadataInvoker added in v0.1.30 

type ShowTemplateVersionMetadataInvoker struct {
	*invoker.BaseInvoker
}

func (*ShowTemplateVersionMetadataInvoker) Invoke added in v0.1.30 

func (i *ShowTemplateVersionMetadataInvoker) Invoke() (*model.ShowTemplateVersionMetadataResponse, error)

type UpdateStackInvoker added in v0.1.24 

type UpdateStackInvoker struct {
	*invoker.BaseInvoker
}

func (*UpdateStackInvoker) Invoke added in v0.1.24 

func (i *UpdateStackInvoker) Invoke() (*model.UpdateStackResponse, error)

type UpdateTemplateMetadataInvoker added in v0.1.30 

type UpdateTemplateMetadataInvoker struct {
	*invoker.BaseInvoker
}

func (*UpdateTemplateMetadataInvoker) Invoke added in v0.1.30 

func (i *UpdateTemplateMetadataInvoker) Invoke() (*model.UpdateTemplateMetadataResponse, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.