Documentation ¶
Index ¶
- type AgenciesPrimitiveTypeHolder
- type Agency
- type ApplyExecutionPlanRequest
- type ApplyExecutionPlanRequestBody
- type ApplyExecutionPlanResponse
- type ContinueRollbackStackRequest
- type ContinueRollbackStackRequestBody
- type ContinueRollbackStackResponse
- type CreateExecutionPlanRequest
- type CreateExecutionPlanRequestBody
- type CreateExecutionPlanResponse
- type CreateStackRequest
- type CreateStackRequestBody
- type CreateStackResponse
- type DeleteStackRequest
- type DeleteStackResponse
- type DeployStackRequest
- type DeployStackRequestBody
- type DeployStackResponse
- type EnableAutoRollbackPrimitiveTypeHolder
- type EnableDeletionProtectionPrimitiveTypeHolder
- type EncryptionStructure
- type EstimateExecutionPlanPriceRequest
- type EstimateExecutionPlanPriceResponse
- type EstimateExecutionPlanPriceResponseCurrency
- type EstimateExecutionPlanPriceResponseCurrencyEnum
- type ExecutionPlan
- type ExecutionPlanStatus
- type ExecutionPlanStatusEnum
- type ExecutorPrimitiveTypeHolder
- type GetStackTemplateRequest
- type GetStackTemplateResponse
- type ItemsResponse
- type KmsStructure
- type ListExecutionPlansRequest
- type ListExecutionPlansResponse
- type ListStackEventsRequest
- type ListStackEventsResponse
- type ListStackOutputsRequest
- type ListStackOutputsResponse
- type ListStackResourcesRequest
- type ListStackResourcesResponse
- type ListStacksRequest
- type ListStacksResponse
- type ParseTemplateVariablesRequest
- type ParseTemplateVariablesRequestBody
- type ParseTemplateVariablesResponse
- type ResourcePriceResponse
- type ResourcePriceResponseChargeMode
- type ResourcePriceResponseChargeModeEnum
- type ResourcePriceResponsePeriodType
- type ResourcePriceResponsePeriodTypeEnum
- type Stack
- type StackDescriptionPrimitiveTypeHolder
- type StackEventResponse
- type StackEventResponseEventType
- type StackEventResponseEventTypeEnum
- type StackIdPrimitiveTypeHolder
- type StackNamePrimitiveTypeHolder
- type StackOutput
- type StackResource
- type StackResourceResourceStatus
- type StackResourceResourceStatusEnum
- type StackStatus
- type StackStatusEnum
- type StackStatusPrimitiveTypeHolder
- type StackStatusPrimitiveTypeHolderStatus
- type StackStatusPrimitiveTypeHolderStatusEnum
- type TemplateBodyPrimitiveTypeHolder
- type TemplateUriPrimitiveTypeHolder
- type VariableResponse
- type VariableValidationResponse
- type VarsBodyPrimitiveTypeHolder
- type VarsStructure
- type VarsStructurePrimitiveTypeHolder
- type VarsUriPrimitiveTypeHolder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgenciesPrimitiveTypeHolder ¶
type AgenciesPrimitiveTypeHolder struct { // 委托授权的信息。 Agencies *[]Agency `json:"agencies,omitempty"` }
func (AgenciesPrimitiveTypeHolder) String ¶
func (o AgenciesPrimitiveTypeHolder) String() string
type Agency ¶
type Agency struct { // 用户使用的provider的名字。如果用户给与的provider_name含有重复的值,则返回400 ProviderName string `json:"provider_name"` // 对应provider所使用的IAM委托名称名称,RF会使用此委托的权限去访问、创建对应provider的资源 AgencyName string `json:"agency_name"` }
委托授权的信息
type ApplyExecutionPlanRequest ¶
type ApplyExecutionPlanRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 执行计划的名字。如果未指定,则使用execution_plan_id作为execution_plan_name。 ExecutionPlanName string `json:"execution_plan_name"` Body *ApplyExecutionPlanRequestBody `json:"body,omitempty"` }
Request Object
func (ApplyExecutionPlanRequest) String ¶
func (o ApplyExecutionPlanRequest) String() string
type ApplyExecutionPlanRequestBody ¶
type ApplyExecutionPlanRequestBody struct { // 堆栈id StackId *string `json:"stack_id,omitempty"` // 执行计划Id,在domain_id+region+project_id+stack_id下应唯一 ExecutionPlanId *string `json:"execution_plan_id,omitempty"` // 执行操作者的名字,用于审计工作 Executor *string `json:"executor,omitempty"` }
apply_execution_plan request body
func (ApplyExecutionPlanRequestBody) String ¶
func (o ApplyExecutionPlanRequestBody) String() string
type ApplyExecutionPlanResponse ¶
type ApplyExecutionPlanResponse struct { // 部署生成的唯一ID,由IAC生成 DeploymentId *string `json:"deployment_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ApplyExecutionPlanResponse) String ¶
func (o ApplyExecutionPlanResponse) String() string
type ContinueRollbackStackRequest ¶
type ContinueRollbackStackRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` Body *ContinueRollbackStackRequestBody `json:"body,omitempty"` }
Request Object
func (ContinueRollbackStackRequest) String ¶
func (o ContinueRollbackStackRequest) String() string
type ContinueRollbackStackRequestBody ¶
type ContinueRollbackStackRequestBody struct { // 资源栈(stack)的唯一Id。 此Id由RF在生成资源栈的时候生成,为UUID。 由于堆栈名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的堆栈,删除,再重新创建一个同名堆栈。 对于团队并行开发,用户可能希望确保,当前我操作的堆栈就是我认为的那个,而不是其他队友删除后创建的同名堆栈。因此,使用ID就可以做到强匹配。 RF保证每次创建的资源栈所对应的ID都不相同,更新不会影响ID。如果给与的stack_id和当前资源栈的ID不一致,则返回400 StackId *string `json:"stack_id,omitempty"` }
func (ContinueRollbackStackRequestBody) String ¶
func (o ContinueRollbackStackRequestBody) String() string
type ContinueRollbackStackResponse ¶
type ContinueRollbackStackResponse struct { // 继续回滚触发部署生成的唯一的deployment_id,由RF生成,通常为UUID DeploymentId *string `json:"deployment_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ContinueRollbackStackResponse) String ¶
func (o ContinueRollbackStackResponse) String() string
type CreateExecutionPlanRequest ¶
type CreateExecutionPlanRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` Body *CreateExecutionPlanRequestBody `json:"body,omitempty"` }
Request Object
func (CreateExecutionPlanRequest) String ¶
func (o CreateExecutionPlanRequest) String() string
type CreateExecutionPlanRequestBody ¶
type CreateExecutionPlanRequestBody struct { // 用户希望生成执行计划的栈(stack)的Id。此Id由IAC在生成栈的时候生成,为UUID。 StackId *string `json:"stack_id,omitempty"` // HCL模板,描述了资源的目标状态。IAC将比较此模板与当前远程资源的状态之间的区别 template_body 和 template_uri 有且仅有一个存在 TemplateBody *string `json:"template_body,omitempty"` // HCL模板的OBS地址,描述了资源的目标状态。IAC将比较此模板与当前远程资源的状态之间的区别。目前接受纯tf文件或zip压缩包。 纯tf文件需要以“.tf”结尾,并遵守tf模板格式。压缩包目前只支持zip格式,文件需要以\".zip\"结尾,压缩包解压后应该只包含文件,且文件均以“.tf”结尾,不支持nested结构 template_body 和 template_uri 有且仅有一个存在 TemplateUri *string `json:"template_uri,omitempty"` // 执行计划的名字,在domain_id+region+project_id+stack_id下应唯一。 ExecutionPlanName string `json:"execution_plan_name"` // 执行操作者的名字 Executor *string `json:"executor,omitempty"` // 执行计划的描述。可用于客户识别自己的执行计划 Description *string `json:"description,omitempty"` // terraform支持参数,即,同一个模板可以给予不同的参数而达到不同的效果。var是一系列terraform所需要的参数。 注:IaC支持vars、vars_body和vars_uri,如果vars、vars_body和vars_uri中声名了同一个变量,将报错400。 注:vars中的值只支持简单的字符串类型,如果其他类型,需要用户自己在HCL引用时转换,或者用户可以使用vars_body或vars_uri, vars_body和vars_uri中支持HCL支持的各种类型以及复杂结构。 VarsStructure *[]VarsStructure `json:"vars_structure,omitempty"` // terraform支持参数,即,同一个模板可以给予不同的参数而达到不同的效果。vars_body用于接收用户直接提交的tfvars文件内容 VarsBody *string `json:"vars_body,omitempty"` // 参数文件的OBS地址,如果客户偏向使用文件维护参数,可以将参数上传OBS,并将OBS地址提交。 注:如果用户同时使用了vars_body、vars_uri和vars,且他们的内容中定义了同一个参数,IAC将报错并返回400。 vars_uri和vars_body中的vars按照HCL的语义,可以支持各种类型、复杂结构等 VarsUri *string `json:"vars_uri,omitempty"` }
create-execution-plan request parameters
func (CreateExecutionPlanRequestBody) String ¶
func (o CreateExecutionPlanRequestBody) String() string
type CreateExecutionPlanResponse ¶
type CreateExecutionPlanResponse struct { // 栈的名字 StackName *string `json:"stack_name,omitempty"` // 栈的唯一Id StackId *string `json:"stack_id,omitempty"` // 执行计划的名字。如果未指定,则使用execution_plan_id作为execution_plan_name。 ExecutionPlanName *string `json:"execution_plan_name,omitempty"` // 执行计划的唯一Id,由IaC随机生成 ExecutionPlanId *string `json:"execution_plan_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (CreateExecutionPlanResponse) String ¶
func (o CreateExecutionPlanResponse) String() string
type CreateStackRequest ¶
type CreateStackRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` Body *CreateStackRequestBody `json:"body,omitempty"` }
Request Object
func (CreateStackRequest) String ¶
func (o CreateStackRequest) String() string
type CreateStackRequestBody ¶
type CreateStackRequestBody struct { // 用户希望生成的资源栈的名字。此名字在domain_id+区域+project_id下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。 StackName string `json:"stack_name"` // 执行操作者的名字,将用做未来的审计工作 Executor *string `json:"executor,omitempty"` // 委托授权的信息。 Agencies *[]Agency `json:"agencies,omitempty"` // 资源栈的描述。可用于客户识别自己的资源栈。 Description *string `json:"description,omitempty"` // 删除保护的标识位,如果不传默认为false,即默认不开启资源栈删除保护(删除保护开启后资源栈不允许被删除) EnableDeletionProtection *bool `json:"enable_deletion_protection,omitempty"` // 自动回滚的标识位,如果不传默认为false,即默认不开启资源栈自动回滚(自动回滚开启后,如果部署失败,则会自动回滚,并返回上一个稳定状态) EnableAutoRollback *bool `json:"enable_auto_rollback,omitempty"` // HCL模板,描述了资源的目标状态。RF将比较此模板与当前远程资源的状态之间的区别。 template_body和template_uri 必须有且只有一个存在 TemplateBody *string `json:"template_body,omitempty"` // HCL模板的OBS地址,该模板描述了资源的目标状态 OBS地址必须为同region的OBS地址,暂不支持跨region访问 对应的文件应该是纯tf文件或zip压缩包 纯tf文件需要以`.tf`或者`.tfjson`结尾,并遵守hcl语法 压缩包目前只支持zip格式,文件需要以\".zip\"结尾。解压后的文件不得包含\".tfvars\"文件 template_body和template_uri 必须有且只有一个存在 TemplateUri *string `json:"template_uri,omitempty"` // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果 * vars_body使用HCL的tfvars格式,用户可以将“.tfvars”中的内容提交到vars_body中。具体tfvars格式见:https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * 如果vars_body过大,可以使用vars_uri * 如果vars中都是简单的字符串格式,可以使用var_structure * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsBody *string `json:"vars_body,omitempty"` // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果。 * var_structure可以允许客户提交最简单的字符串类型的参数 * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * vars_structure中的值只支持简单的字符串类型,如果需要使用其他类型,需要用户自己在HCL引用时转换, 或者用户可以使用vars_uri、vars_body,vars_uri和vars_body中支持HCL支持的各种类型以及复杂结构 * 如果vars_structure过大,可以使用vars_uri * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsStructure *[]VarsStructure `json:"vars_structure,omitempty"` // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果 * vars_body使用HCL的tfvars格式,用户可以将“.tfvars”中的内容提交到vars_body中。具体tfvars格式见:https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * 如果vars_body过大,可以使用vars_uri * 如果vars中都是简单的字符串格式,可以使用var_structure * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsUri *string `json:"vars_uri,omitempty"` }
func (CreateStackRequestBody) String ¶
func (o CreateStackRequestBody) String() string
type CreateStackResponse ¶
type CreateStackResponse struct { // 资源栈(stack)的唯一Id。 此Id由RF在生成资源栈的时候生成,为UUID。 由于堆栈名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的堆栈,删除,再重新创建一个同名堆栈。 对于团队并行开发,用户可能希望确保,当前我操作的堆栈就是我认为的那个,而不是其他队友删除后创建的同名堆栈。因此,使用ID就可以做到强匹配。 RF保证每次创建的资源栈所对应的ID都不相同,更新不会影响ID。如果给与的stack_id和当前资源栈的ID不一致,则返回400 StackId *string `json:"stack_id,omitempty"` // 部署ID DeploymentId *string `json:"deployment_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (CreateStackResponse) String ¶
func (o CreateStackResponse) String() string
type DeleteStackRequest ¶ added in v0.1.12
type DeleteStackRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 用户希望描述的栈的Id。若stack_name和stack_id同时存在,则IaC会检查是否两个匹配,否则返回400 StackId *string `json:"stack_id,omitempty"` // 执行操作者的名字,将用做未来的审计工作。 Executor *string `json:"executor,omitempty"` }
Request Object
func (DeleteStackRequest) String ¶ added in v0.1.12
func (o DeleteStackRequest) String() string
type DeleteStackResponse ¶ added in v0.1.12
type DeleteStackResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (DeleteStackResponse) String ¶ added in v0.1.12
func (o DeleteStackResponse) String() string
type DeployStackRequest ¶
type DeployStackRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` Body *DeployStackRequestBody `json:"body,omitempty"` }
Request Object
func (DeployStackRequest) String ¶
func (o DeployStackRequest) String() string
type DeployStackRequestBody ¶
type DeployStackRequestBody struct { // 执行操作者的名字,将用做未来的审计工作 Executor *string `json:"executor,omitempty"` // HCL模板,描述了资源的目标状态。RF将比较此模板与当前远程资源的状态之间的区别。 template_body和template_uri 必须有且只有一个存在 TemplateBody *string `json:"template_body,omitempty"` // HCL模板的OBS地址,该模板描述了资源的目标状态 OBS地址必须为同region的OBS地址,暂不支持跨region访问 对应的文件应该是纯tf文件或zip压缩包 纯tf文件需要以`.tf`或者`.tfjson`结尾,并遵守hcl语法 压缩包目前只支持zip格式,文件需要以\".zip\"结尾。解压后的文件不得包含\".tfvars\"文件 template_body和template_uri 必须有且只有一个存在 TemplateUri *string `json:"template_uri,omitempty"` // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果。 * var_structure可以允许客户提交最简单的字符串类型的参数 * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * vars_structure中的值只支持简单的字符串类型,如果需要使用其他类型,需要用户自己在HCL引用时转换, 或者用户可以使用vars_uri、vars_body,vars_uri和vars_body中支持HCL支持的各种类型以及复杂结构 * 如果vars_structure过大,可以使用vars_uri * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsStructure *[]VarsStructure `json:"vars_structure,omitempty"` // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果 * vars_body使用HCL的tfvars格式,用户可以将“.tfvars”中的内容提交到vars_body中。具体tfvars格式见:https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * 如果vars_body过大,可以使用vars_uri * 如果vars中都是简单的字符串格式,可以使用var_structure * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsBody *string `json:"vars_body,omitempty"` // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果 * vars_body使用HCL的tfvars格式,用户可以将“.tfvars”中的内容提交到vars_body中。具体tfvars格式见:https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * 如果vars_body过大,可以使用vars_uri * 如果vars中都是简单的字符串格式,可以使用var_structure * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsUri *string `json:"vars_uri,omitempty"` // 资源栈(stack)的唯一Id。 此Id由RF在生成资源栈的时候生成,为UUID。 由于堆栈名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的堆栈,删除,再重新创建一个同名堆栈。 对于团队并行开发,用户可能希望确保,当前我操作的堆栈就是我认为的那个,而不是其他队友删除后创建的同名堆栈。因此,使用ID就可以做到强匹配。 RF保证每次创建的资源栈所对应的ID都不相同,更新不会影响ID。如果给与的stack_id和当前资源栈的ID不一致,则返回400 StackId *string `json:"stack_id,omitempty"` }
func (DeployStackRequestBody) String ¶
func (o DeployStackRequestBody) String() string
type DeployStackResponse ¶
type DeployStackResponse struct { // 部署ID DeploymentId *string `json:"deployment_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (DeployStackResponse) String ¶
func (o DeployStackResponse) String() string
type EnableAutoRollbackPrimitiveTypeHolder ¶
type EnableAutoRollbackPrimitiveTypeHolder struct { // 自动回滚的标识位,如果不传默认为false,即默认不开启资源栈自动回滚(自动回滚开启后,如果部署失败,则会自动回滚,并返回上一个稳定状态) EnableAutoRollback *bool `json:"enable_auto_rollback,omitempty"` }
func (EnableAutoRollbackPrimitiveTypeHolder) String ¶
func (o EnableAutoRollbackPrimitiveTypeHolder) String() string
type EnableDeletionProtectionPrimitiveTypeHolder ¶
type EnableDeletionProtectionPrimitiveTypeHolder struct { // 删除保护的标识位,如果不传默认为false,即默认不开启资源栈删除保护(删除保护开启后资源栈不允许被删除) EnableDeletionProtection *bool `json:"enable_deletion_protection,omitempty"` }
func (EnableDeletionProtectionPrimitiveTypeHolder) String ¶
func (o EnableDeletionProtectionPrimitiveTypeHolder) String() string
type EncryptionStructure ¶
type EncryptionStructure struct {
Kms *KmsStructure `json:"kms"`
}
如果用户传递的var_value是已经加密过的,可以通过声名此项以要求RF在使用前进行解密,目前暂时只支持KMS加解密
func (EncryptionStructure) String ¶
func (o EncryptionStructure) String() string
type EstimateExecutionPlanPriceRequest ¶
type EstimateExecutionPlanPriceRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 执行计划的名字。如果未指定,则使用execution_plan_id作为execution_plan_name。 ExecutionPlanName string `json:"execution_plan_name"` // 用户希望描述的栈的Id。若stack_name和stack_id同时存在,则IaC会检查是否两个匹配,否则返回400 StackId *string `json:"stack_id,omitempty"` // 执行计划ID(uuid) ExecutionPlanId *string `json:"execution_plan_id,omitempty"` }
Request Object
func (EstimateExecutionPlanPriceRequest) String ¶
func (o EstimateExecutionPlanPriceRequest) String() string
type EstimateExecutionPlanPriceResponse ¶
type EstimateExecutionPlanPriceResponse struct { // 币种,枚举值 CNY 元,中国站返回的币种 USD 美元,国际站返回的币种 Currency *EstimateExecutionPlanPriceResponseCurrency `json:"currency,omitempty"` // 执行计划中所有资源的询价结果 Items *[]ItemsResponse `json:"items,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (EstimateExecutionPlanPriceResponse) String ¶
func (o EstimateExecutionPlanPriceResponse) String() string
type EstimateExecutionPlanPriceResponseCurrency ¶
type EstimateExecutionPlanPriceResponseCurrency struct {
// contains filtered or unexported fields
}
func (EstimateExecutionPlanPriceResponseCurrency) MarshalJSON ¶
func (c EstimateExecutionPlanPriceResponseCurrency) MarshalJSON() ([]byte, error)
func (*EstimateExecutionPlanPriceResponseCurrency) UnmarshalJSON ¶
func (c *EstimateExecutionPlanPriceResponseCurrency) UnmarshalJSON(b []byte) error
func (EstimateExecutionPlanPriceResponseCurrency) Value ¶
func (c EstimateExecutionPlanPriceResponseCurrency) Value() string
type EstimateExecutionPlanPriceResponseCurrencyEnum ¶
type EstimateExecutionPlanPriceResponseCurrencyEnum struct { CNY EstimateExecutionPlanPriceResponseCurrency USD EstimateExecutionPlanPriceResponseCurrency }
func GetEstimateExecutionPlanPriceResponseCurrencyEnum ¶
func GetEstimateExecutionPlanPriceResponseCurrencyEnum() EstimateExecutionPlanPriceResponseCurrencyEnum
type ExecutionPlan ¶
type ExecutionPlan struct { // 栈的唯一Id,为uuid StackId *string `json:"stack_id,omitempty"` // 栈的名字 StackName *string `json:"stack_name,omitempty"` // 执行计划的唯一Id,由IaC随机生成,为uuid ExecutionPlanId *string `json:"execution_plan_id,omitempty"` // 执行计划的名字 ExecutionPlanName *string `json:"execution_plan_name,omitempty"` // 执行计划的描述,此描述为用户在生成时指定 Description *string `json:"description,omitempty"` // 执行计划的生成时间 CreateTime *string `json:"create_time,omitempty"` // 执行时间 ApplyTime *string `json:"apply_time,omitempty"` // 执行计划的执行状态,只有当AVAILABLE的时候才可以使用apply执行 * `CREATION_IN_PROGRESS` - 正在生成 * `CREATION_FAILED` - 生成失败 * `AVAILABLE` - 执行计划已经生成完成。可以使用apply进行执行 * `APPLIED` - 执行完成 Status *ExecutionPlanStatus `json:"status,omitempty"` // 展示执行计划状态更多细节的信息 StatusMessage *string `json:"status_message,omitempty"` }
执行计划的元数据
func (ExecutionPlan) String ¶
func (o ExecutionPlan) String() string
type ExecutionPlanStatus ¶
type ExecutionPlanStatus struct {
// contains filtered or unexported fields
}
func (ExecutionPlanStatus) MarshalJSON ¶
func (c ExecutionPlanStatus) MarshalJSON() ([]byte, error)
func (*ExecutionPlanStatus) UnmarshalJSON ¶
func (c *ExecutionPlanStatus) UnmarshalJSON(b []byte) error
func (ExecutionPlanStatus) Value ¶
func (c ExecutionPlanStatus) Value() string
type ExecutionPlanStatusEnum ¶
type ExecutionPlanStatusEnum struct { CREATION_IN_PROGRESS ExecutionPlanStatus CREATION_FAILED ExecutionPlanStatus AVAILABLE ExecutionPlanStatus APPLIED ExecutionPlanStatus }
func GetExecutionPlanStatusEnum ¶
func GetExecutionPlanStatusEnum() ExecutionPlanStatusEnum
type ExecutorPrimitiveTypeHolder ¶
type ExecutorPrimitiveTypeHolder struct { // 执行操作者的名字,将用做未来的审计工作 Executor *string `json:"executor,omitempty"` }
func (ExecutorPrimitiveTypeHolder) String ¶
func (o ExecutorPrimitiveTypeHolder) String() string
type GetStackTemplateRequest ¶
type GetStackTemplateRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 用户希望描述的栈的Id。若stack_name和stack_id同时存在,则IaC会检查是否两个匹配,否则返回400 StackId *string `json:"stack_id,omitempty"` // 执行操作者的名字,将用做未来的审计工作。 Executor *string `json:"executor,omitempty"` }
Request Object
func (GetStackTemplateRequest) String ¶
func (o GetStackTemplateRequest) String() string
type GetStackTemplateResponse ¶
type GetStackTemplateResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (GetStackTemplateResponse) String ¶
func (o GetStackTemplateResponse) String() string
type ItemsResponse ¶
type ItemsResponse struct { // 执行计划中的资源类型,如:huaweicloud_evs_volume ResourceType *string `json:"resource_type,omitempty"` // 执行计划中的用户定义的资源的名字,如:my_volume ResourceName *string `json:"resource_name,omitempty"` // 使用count构建的资源时资源对应的index Index *string `json:"index,omitempty"` // 执行计划中的资源是否支持询价 Supported *bool `json:"supported,omitempty"` // 执行计划中的每个资源部署后的总的询价信息,如果该资源询价结果包含不同的period_type,则询价结果根据period_type类型展示总价。 包周期计费和按需计费返回,免费和不支持询价的资源不返回 ResourcePrice *[]ResourcePriceResponse `json:"resource_price,omitempty"` }
items response
func (ItemsResponse) String ¶
func (o ItemsResponse) String() string
type KmsStructure ¶
type KmsStructure struct { // 解密时,RF应该使用的KMS秘钥的ID,通常是加密时所使用的秘钥ID Id string `json:"id"` // 数据加密秘钥所对应的密文 CipherText string `json:"cipher_text"` }
如果用户给与的var_value是经过KMS加密的,可以通过传递相关加密信息,RF在使用的时候会帮助用户进行KMS解密 更多关于KMS加密介绍见:https://support.huaweicloud.com/productdesc-dew/dew_01_0006.html * 注意:KMS每个月有免费试用的额度,如果超过,则KMS需要收费,此费用不是RF收取, 具体标准见:https://www.huaweicloud.com/pricing.html?tab=detail#/dew * 注意:KMS加密只代表RF在存储和传输的时候传递的是密文,但是在stack-events中依然是明文,如果希望在log中以密文形式对待, 请在模板中声名sensitive,更多关于sensitive的介绍见:https://learn.hashicorp.com/tutorials/terraform/sensitive-variables
func (KmsStructure) String ¶
func (o KmsStructure) String() string
type ListExecutionPlansRequest ¶
type ListExecutionPlansRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 执行操作者的名字,将用做未来的审计工作。 Executor *string `json:"executor,omitempty"` // 用户希望描述的栈的Id。若stack_name和stack_id同时存在,则IaC会检查是否两个匹配,否则返回400 StackId *string `json:"stack_id,omitempty"` }
Request Object
func (ListExecutionPlansRequest) String ¶
func (o ListExecutionPlansRequest) String() string
type ListExecutionPlansResponse ¶
type ListExecutionPlansResponse struct { // 执行计划的元数据 ExecutionPlans *[]ExecutionPlan `json:"execution_plans,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListExecutionPlansResponse) String ¶
func (o ListExecutionPlansResponse) String() string
type ListStackEventsRequest ¶ added in v0.1.12
type ListStackEventsRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 用户希望描述的栈的Id。若stack_name和stack_id同时存在,则IaC会检查是否两个匹配,否则返回400 StackId *string `json:"stack_id,omitempty"` // 部署时API返回的id(uuid)。如果deployment_id不存在,则返回整个栈从生成到现在的所有更新状态 DeploymentId *string `json:"deployment_id,omitempty"` // 一次返回的stack-events的最大数量 Limit *int32 `json:"limit,omitempty"` // 当一页无法发回所有的细节,上一次的请求将返回next_marker以指引还有更多页数,客户可以将next_marker中的值放到此处以查询下一页的信息。 Marker *string `json:"marker,omitempty"` // 执行操作者的名字,将用做未来的审计工作。 Executor *string `json:"executor,omitempty"` }
Request Object
func (ListStackEventsRequest) String ¶ added in v0.1.12
func (o ListStackEventsRequest) String() string
type ListStackEventsResponse ¶ added in v0.1.12
type ListStackEventsResponse struct { // 栈的更新状态 StackEvents *[]StackEventResponse `json:"stack_events,omitempty"` // 当一页无法发回所有的细节,将返回next_marker,客户可以继续调用list-stack-events并给与next_marker来继续读取下页 NextMarker *string `json:"next_marker,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListStackEventsResponse) String ¶ added in v0.1.12
func (o ListStackEventsResponse) String() string
type ListStackOutputsRequest ¶
type ListStackOutputsRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 用户希望描述的栈的Id。若stack_name和stack_id同时存在,则IaC会检查是否两个匹配,否则返回400 StackId *string `json:"stack_id,omitempty"` // 执行操作者的名字,将用做未来的审计工作。 Executor *string `json:"executor,omitempty"` // 分页limit Limit *int32 `json:"limit,omitempty"` // 当一页无法发回所有的细节,上一次的请求将返回next_marker以指引还有更多页数,客户可以将next_marker中的值放到此处以查询下一页的信息。 Marker *string `json:"marker,omitempty"` }
Request Object
func (ListStackOutputsRequest) String ¶
func (o ListStackOutputsRequest) String() string
type ListStackOutputsResponse ¶
type ListStackOutputsResponse struct { // 堆栈输出 Outputs *[]StackOutput `json:"outputs,omitempty"` // 下一页的标记信息 NextMarker *string `json:"next_marker,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListStackOutputsResponse) String ¶
func (o ListStackOutputsResponse) String() string
type ListStackResourcesRequest ¶ added in v0.1.12
type ListStackResourcesRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 用户希望操作的资源栈名 StackName string `json:"stack_name"` // 用户希望描述的栈的Id。若stack_name和stack_id同时存在,则IaC会检查是否两个匹配,否则返回400 StackId *string `json:"stack_id,omitempty"` // 执行操作者的名字,将用做未来的审计工作。 Executor *string `json:"executor,omitempty"` }
Request Object
func (ListStackResourcesRequest) String ¶ added in v0.1.12
func (o ListStackResourcesRequest) String() string
type ListStackResourcesResponse ¶ added in v0.1.12
type ListStackResourcesResponse struct { // 堆栈输出 StackResources *[]StackResource `json:"stack_resources,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListStackResourcesResponse) String ¶ added in v0.1.12
func (o ListStackResourcesResponse) String() string
type ListStacksRequest ¶
type ListStacksRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` // 执行操作者的名字,将用做未来的审计工作。 Executor *string `json:"executor,omitempty"` }
Request Object
func (ListStacksRequest) String ¶
func (o ListStacksRequest) String() string
type ListStacksResponse ¶
type ListStacksResponse struct { // 资源栈列表。默认按照生成时间排序,最早生成的在最前 Stacks *[]Stack `json:"stacks,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListStacksResponse) String ¶
func (o ListStacksResponse) String() string
type ParseTemplateVariablesRequest ¶
type ParseTemplateVariablesRequest struct { // 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID ClientRequestId string `json:"Client-Request-Id"` Body *ParseTemplateVariablesRequestBody `json:"body,omitempty"` }
Request Object
func (ParseTemplateVariablesRequest) String ¶
func (o ParseTemplateVariablesRequest) String() string
type ParseTemplateVariablesRequestBody ¶
type ParseTemplateVariablesRequestBody struct { // HCL模板,描述了资源的目标状态 template_body 和 template_uri 有且仅有一个存在 TemplateBody *string `json:"template_body,omitempty"` // HCL模板文件的uri,代码需从该uri下载HCL模板获取模板内容。其描述了资源的目标状态 template_body 和 template_uri 有且仅有一个存在 TemplateUri *string `json:"template_uri,omitempty"` }
parse-template-variables request parameters
func (ParseTemplateVariablesRequestBody) String ¶
func (o ParseTemplateVariablesRequestBody) String() string
type ParseTemplateVariablesResponse ¶
type ParseTemplateVariablesResponse struct { // 模板中的所有参数 Variables *[]VariableResponse `json:"variables,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ParseTemplateVariablesResponse) String ¶
func (o ParseTemplateVariablesResponse) String() string
type ResourcePriceResponse ¶
type ResourcePriceResponse struct { // 计费模式,包周期计费、按需计费、免费的返回,不支持的资源不返回 PRE_PAID 包周期计费 POST_PAID 按需计费 FREE 免费 ChargeMode *ResourcePriceResponseChargeMode `json:"charge_mode,omitempty"` // 执行计划中的每个资源部署后最终优惠后的金额(只考虑商务折扣以及伙伴折扣,不包含促销折扣及优惠券),保留小数点后2位,向上取整,默认单位是元 SalePrice *interface{} `json:"sale_price,omitempty"` // 执行计划中的每个资源部署后的优惠额,保留小数点后2位,向上取整,默认单位是元 Discount *interface{} `json:"discount,omitempty"` // 执行计划中的每个资源部署后的原价,保留小数点后2位,向上取整,默认单位是元 OriginalPrice *interface{} `json:"original_price,omitempty"` // 包周期和按需的计费单位,包周期计费和按需计费返回,免费不会返回 HOUR:小时,包周期计费和按需计费返回,免费不会返回 DAY:天,包周期计费返回,按需计费和免费不会返回 WEEK:周,包周期计费返回,按需计费和免费不会返回 MONTH:月,包周期计费返回,按需计费和免费不会返回 YEAR:年,包周期计费返回,按需计费和免费不会返回 BYTE:字节,按需计费返回,包周期计费和免费不会返回 MB:百万字节,按需计费返回,包周期计费和免费不会返回 GB:千兆字节,按需计费返回,包周期计费和免费不会返回 PeriodType *ResourcePriceResponsePeriodType `json:"period_type,omitempty"` // 订购数量。包周期计费和按需计费返回,免费不会返回。 PeriodCount *int32 `json:"period_count,omitempty"` }
resource price response
func (ResourcePriceResponse) String ¶
func (o ResourcePriceResponse) String() string
type ResourcePriceResponseChargeMode ¶
type ResourcePriceResponseChargeMode struct {
// contains filtered or unexported fields
}
func (ResourcePriceResponseChargeMode) MarshalJSON ¶
func (c ResourcePriceResponseChargeMode) MarshalJSON() ([]byte, error)
func (*ResourcePriceResponseChargeMode) UnmarshalJSON ¶
func (c *ResourcePriceResponseChargeMode) UnmarshalJSON(b []byte) error
func (ResourcePriceResponseChargeMode) Value ¶
func (c ResourcePriceResponseChargeMode) Value() string
type ResourcePriceResponseChargeModeEnum ¶
type ResourcePriceResponseChargeModeEnum struct { PRE_PAID ResourcePriceResponseChargeMode POST_PAID ResourcePriceResponseChargeMode FREE ResourcePriceResponseChargeMode }
func GetResourcePriceResponseChargeModeEnum ¶
func GetResourcePriceResponseChargeModeEnum() ResourcePriceResponseChargeModeEnum
type ResourcePriceResponsePeriodType ¶
type ResourcePriceResponsePeriodType struct {
// contains filtered or unexported fields
}
func (ResourcePriceResponsePeriodType) MarshalJSON ¶
func (c ResourcePriceResponsePeriodType) MarshalJSON() ([]byte, error)
func (*ResourcePriceResponsePeriodType) UnmarshalJSON ¶
func (c *ResourcePriceResponsePeriodType) UnmarshalJSON(b []byte) error
func (ResourcePriceResponsePeriodType) Value ¶
func (c ResourcePriceResponsePeriodType) Value() string
type ResourcePriceResponsePeriodTypeEnum ¶
type ResourcePriceResponsePeriodTypeEnum struct { HOUR ResourcePriceResponsePeriodType DAY ResourcePriceResponsePeriodType WEEK ResourcePriceResponsePeriodType MONTH ResourcePriceResponsePeriodType YEAR ResourcePriceResponsePeriodType BYTE ResourcePriceResponsePeriodType MB ResourcePriceResponsePeriodType GB ResourcePriceResponsePeriodType }
func GetResourcePriceResponsePeriodTypeEnum ¶
func GetResourcePriceResponsePeriodTypeEnum() ResourcePriceResponsePeriodTypeEnum
type Stack ¶
type Stack struct { // 用户希望生成的资源栈的名字。此名字在domain_id+区域+project_id下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。 StackName string `json:"stack_name"` // 资源栈的描述。可用于客户识别自己的资源栈。 Description *string `json:"description,omitempty"` // 资源栈(stack)的唯一Id。 此Id由RF在生成资源栈的时候生成,为UUID。 由于堆栈名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的堆栈,删除,再重新创建一个同名堆栈。 对于团队并行开发,用户可能希望确保,当前我操作的堆栈就是我认为的那个,而不是其他队友删除后创建的同名堆栈。因此,使用ID就可以做到强匹配。 RF保证每次创建的资源栈所对应的ID都不相同,更新不会影响ID。如果给与的stack_id和当前资源栈的ID不一致,则返回400 StackId *string `json:"stack_id,omitempty"` // 资源栈的状态 * `CREATION_COMPLETE` - 生成空资源栈完成,并没有任何部署 * `DEPLOYMENT_IN_PROGRESS` - 正在部署,请等待 * `DEPLOYMENT_FAILED` - 部署失败。请于status_message见错误信息汇总,或者调用ListStackEvents获得事件详情 * `DEPLOYMENT_COMPLETE` - 部署完成 * `ROLLBACK_IN_PROGRESS` - 部署失败,正在回滚,请等待 * `ROLLBACK_FAILED` - 回滚失败。请于status_message见错误信息汇总,或者调用ListStackEvents获得事件详情 * `ROLLBACK_COMPLETE` - 回滚完成 * `DELETION_IN_PROGRESS` - 正在删除,请等待 * `DELETION_FAILED` - 删除失败。请于status_message见错误信息汇总,或者调用ListStackEvents获得事件详情 Status *StackStatus `json:"status,omitempty"` // 资源栈的生成时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z CreateTime *string `json:"create_time,omitempty"` // 资源栈的更新时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z UpdateTime *string `json:"update_time,omitempty"` // 在失败的时候(资源栈状态以FAILED结尾)会显示简要的错误信息总结以供debug StatusMessage *string `json:"status_message,omitempty"` }
type StackDescriptionPrimitiveTypeHolder ¶
type StackDescriptionPrimitiveTypeHolder struct { // 资源栈的描述。可用于客户识别自己的资源栈。 Description *string `json:"description,omitempty"` }
func (StackDescriptionPrimitiveTypeHolder) String ¶
func (o StackDescriptionPrimitiveTypeHolder) String() string
type StackEventResponse ¶ added in v0.1.12
type StackEventResponse struct { // 资源的id名称,即对应资源作为唯一id使用的值的名称,当资源未创建的时候,不返回resource_id_key ResourceIdKey *string `json:"resource_id_key,omitempty"` // 资源的id值,即对应资源作为唯一id使用的值,当资源未创建的时候,不返回resource_id_value ResourceIdValue *string `json:"resource_id_value,omitempty"` // 资源的名称 ResourceName *string `json:"resource_name,omitempty"` // 资源的类型 ResourceType *string `json:"resource_type,omitempty"` // 事件发生的时间,格式遵循RFC3339,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z Time *string `json:"time,omitempty"` // 此次事件的类型 * `LOG` - 记录状态信息,比如当前状态,目标状态等。详细信息将在EventMessage中存储。此为暂时状态, 因为目前我们无法解析terraform的log,只能直全部以LOG形式打出,未来我们吃掉terraform内核以后, 将去除这个状态,并改为下列的更精准的状态 * `ERROR` - 记录失败信息 * `DRIFT` - 记录资源偏移信息 * `SUMMARY` - 记录资源变更结果总结 * `CREATION_IN_PROGRESS` - 正在生成 * `CREATION_FAILED` - 生成失败 * `CREATION_COMPLETE` - 生成完成 * `DELETION_IN_PROGRESS` - 正在删除 * `DELETION_FAILED` - 删除失败 * `DELETION_COMPLETE` - 已经删除 * `DELETION_SKIPPED` - 跳过删除。未来我们将支持,用户可以从IaC中删除,但是不真的删除资源本身 * `UPDATE_IN_PROGRESS` - 正在更新。此处的更新特指非替换式更新,如果是替换式更新,则使用CREATION后DELETION * `UPDATE_FAILED` - 更新失败。此处的更新特指非替换式更新,如果是替换式更新,则使用CREATION后 * `UPDATE_COMPLETE` - 更新完成。此处的更新特指非替换式更新,如果是替换式更新,则使用CREATION后DELETION EventType *StackEventResponseEventType `json:"event_type,omitempty"` // 事件对应的详细信息 EventMessage *string `json:"event_message,omitempty"` // 资源改动所花的时间,以秒为单位 ElapsedSeconds *int32 `json:"elapsed_seconds,omitempty"` }
stack_event
func (StackEventResponse) String ¶ added in v0.1.12
func (o StackEventResponse) String() string
type StackEventResponseEventType ¶ added in v0.1.12
type StackEventResponseEventType struct {
// contains filtered or unexported fields
}
func (StackEventResponseEventType) MarshalJSON ¶ added in v0.1.12
func (c StackEventResponseEventType) MarshalJSON() ([]byte, error)
func (*StackEventResponseEventType) UnmarshalJSON ¶ added in v0.1.12
func (c *StackEventResponseEventType) UnmarshalJSON(b []byte) error
func (StackEventResponseEventType) Value ¶ added in v0.1.12
func (c StackEventResponseEventType) Value() string
type StackEventResponseEventTypeEnum ¶ added in v0.1.12
type StackEventResponseEventTypeEnum struct { LOG StackEventResponseEventType ERROR StackEventResponseEventType DRIFT StackEventResponseEventType SUMMARY StackEventResponseEventType CREATION_IN_PROGRESS StackEventResponseEventType CREATION_FAILED StackEventResponseEventType CREATION_COMPLETE StackEventResponseEventType DELETION_IN_PROGRESS StackEventResponseEventType DELETION_FAILED StackEventResponseEventType DELETION_COMPLETE StackEventResponseEventType DELETION_SKIPPED StackEventResponseEventType UPDATE_IN_PROGRESS StackEventResponseEventType UPDATE_FAILED StackEventResponseEventType UPDATE_COMPLETE StackEventResponseEventType }
func GetStackEventResponseEventTypeEnum ¶ added in v0.1.12
func GetStackEventResponseEventTypeEnum() StackEventResponseEventTypeEnum
type StackIdPrimitiveTypeHolder ¶
type StackIdPrimitiveTypeHolder struct { // 资源栈(stack)的唯一Id。 此Id由RF在生成资源栈的时候生成,为UUID。 由于堆栈名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的堆栈,删除,再重新创建一个同名堆栈。 对于团队并行开发,用户可能希望确保,当前我操作的堆栈就是我认为的那个,而不是其他队友删除后创建的同名堆栈。因此,使用ID就可以做到强匹配。 RF保证每次创建的资源栈所对应的ID都不相同,更新不会影响ID。如果给与的stack_id和当前资源栈的ID不一致,则返回400 StackId *string `json:"stack_id,omitempty"` }
func (StackIdPrimitiveTypeHolder) String ¶
func (o StackIdPrimitiveTypeHolder) String() string
type StackNamePrimitiveTypeHolder ¶
type StackNamePrimitiveTypeHolder struct { // 用户希望生成的资源栈的名字。此名字在domain_id+区域+project_id下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。 StackName string `json:"stack_name"` }
func (StackNamePrimitiveTypeHolder) String ¶
func (o StackNamePrimitiveTypeHolder) String() string
type StackOutput ¶
type StackOutput struct { // 堆栈输出的name,由用户自己在模板中定义 Name *string `json:"name,omitempty"` // 描述 Description *string `json:"description,omitempty"` // 输出的类型 Type *string `json:"type,omitempty"` // 输出的值(json字符串) Value *string `json:"value,omitempty"` // 是否为敏感信息 Sensitive *bool `json:"sensitive,omitempty"` }
堆栈输出
func (StackOutput) String ¶
func (o StackOutput) String() string
type StackResource ¶ added in v0.1.12
type StackResource struct { // 资源的物理id,由资源提供服务的provider在资源部署的时候生成 PhysicalResourceId *string `json:"physical_resource_id,omitempty"` // 资源的物理名称,资源提供服务在资源部署的时候给予 PhysicalResourceName *string `json:"physical_resource_name,omitempty"` // 资源名,是用户在模板中定义的 LogicalResourceName *string `json:"logical_resource_name,omitempty"` // 资源的类型,是用户在模板中定义的 LogicalResourceType *string `json:"logical_resource_type,omitempty"` // 此次事件的类型 * `CREATION_IN_PROGRESS` - 正在生成 * `CREATION_FAILED` - 生成失败 * `CREATION_COMPLETE` - 生成完成 * `DELETION_IN_PROGRESS` - 正在删除 * `DELETION_FAILED` - 删除失败 * `DELETION_COMPLETE` - 已经删除 * `DELETION_SKIPPED` - 跳过删除。未来我们将支持,用户可以从IaC中删除,但是不真的删除资源本身 * `UPDATE_IN_PROGRESS` - 正在更新。此处的更新特指非替换式更新,如果是替换式更新,则使用CREATION后DELETION * `UPDATE_FAILED` - 更新失败。此处的更新特指非替换式更新,如果是替换式更新,则使用CREATION后DELETION * `UPDATE_COMPLETE` - 更新完成。此处的更新特指非替换式更新,如果是替换式更新,则使用CREATION后DELETION ResourceStatus *StackResourceResourceStatus `json:"resource_status,omitempty"` // 如果是成功状态或执行中状态,则没有信息 StatusMessage *string `json:"status_message,omitempty"` // 资源的生成时间 CreateTime *string `json:"create_time,omitempty"` // 资源的更新时间 UpdateTime *string `json:"update_time,omitempty"` }
stack resource api model
func (StackResource) String ¶ added in v0.1.12
func (o StackResource) String() string
type StackResourceResourceStatus ¶ added in v0.1.12
type StackResourceResourceStatus struct {
// contains filtered or unexported fields
}
func (StackResourceResourceStatus) MarshalJSON ¶ added in v0.1.12
func (c StackResourceResourceStatus) MarshalJSON() ([]byte, error)
func (*StackResourceResourceStatus) UnmarshalJSON ¶ added in v0.1.12
func (c *StackResourceResourceStatus) UnmarshalJSON(b []byte) error
func (StackResourceResourceStatus) Value ¶ added in v0.1.12
func (c StackResourceResourceStatus) Value() string
type StackResourceResourceStatusEnum ¶ added in v0.1.12
type StackResourceResourceStatusEnum struct { CREATION_IN_PROGRESS StackResourceResourceStatus CREATION_FAILED StackResourceResourceStatus CREATION_COMPLETE StackResourceResourceStatus DELETION_IN_PROGRESS StackResourceResourceStatus DELETION_FAILED StackResourceResourceStatus DELETION_COMPLETE StackResourceResourceStatus DELETION_SKIPPED StackResourceResourceStatus UPDATE_IN_PROGRESS StackResourceResourceStatus UPDATE_FAILED StackResourceResourceStatus UPDATE_COMPLETE StackResourceResourceStatus }
func GetStackResourceResourceStatusEnum ¶ added in v0.1.12
func GetStackResourceResourceStatusEnum() StackResourceResourceStatusEnum
type StackStatus ¶
type StackStatus struct {
// contains filtered or unexported fields
}
func (StackStatus) MarshalJSON ¶
func (c StackStatus) MarshalJSON() ([]byte, error)
func (*StackStatus) UnmarshalJSON ¶
func (c *StackStatus) UnmarshalJSON(b []byte) error
func (StackStatus) Value ¶
func (c StackStatus) Value() string
type StackStatusEnum ¶
type StackStatusEnum struct { CREATION_COMPLETE StackStatus DEPLOYMENT_IN_PROGRESS StackStatus DEPLOYMENT_FAILED StackStatus DEPLOYMENT_COMPLETE StackStatus ROLLBACK_IN_PROGRESS StackStatus ROLLBACK_FAILED StackStatus ROLLBACK_COMPLETE StackStatus DELETION_IN_PROGRESS StackStatus DELETION_FAILED StackStatus }
func GetStackStatusEnum ¶
func GetStackStatusEnum() StackStatusEnum
type StackStatusPrimitiveTypeHolder ¶
type StackStatusPrimitiveTypeHolder struct { // 资源栈的状态 * `CREATION_COMPLETE` - 生成空资源栈完成,并没有任何部署 * `DEPLOYMENT_IN_PROGRESS` - 正在部署,请等待 * `DEPLOYMENT_FAILED` - 部署失败。请于status_message见错误信息汇总,或者调用ListStackEvents获得事件详情 * `DEPLOYMENT_COMPLETE` - 部署完成 * `ROLLBACK_IN_PROGRESS` - 部署失败,正在回滚,请等待 * `ROLLBACK_FAILED` - 回滚失败。请于status_message见错误信息汇总,或者调用ListStackEvents获得事件详情 * `ROLLBACK_COMPLETE` - 回滚完成 * `DELETION_IN_PROGRESS` - 正在删除,请等待 * `DELETION_FAILED` - 删除失败。请于status_message见错误信息汇总,或者调用ListStackEvents获得事件详情 Status *StackStatusPrimitiveTypeHolderStatus `json:"status,omitempty"` }
func (StackStatusPrimitiveTypeHolder) String ¶
func (o StackStatusPrimitiveTypeHolder) String() string
type StackStatusPrimitiveTypeHolderStatus ¶
type StackStatusPrimitiveTypeHolderStatus struct {
// contains filtered or unexported fields
}
func (StackStatusPrimitiveTypeHolderStatus) MarshalJSON ¶
func (c StackStatusPrimitiveTypeHolderStatus) MarshalJSON() ([]byte, error)
func (*StackStatusPrimitiveTypeHolderStatus) UnmarshalJSON ¶
func (c *StackStatusPrimitiveTypeHolderStatus) UnmarshalJSON(b []byte) error
func (StackStatusPrimitiveTypeHolderStatus) Value ¶
func (c StackStatusPrimitiveTypeHolderStatus) Value() string
type StackStatusPrimitiveTypeHolderStatusEnum ¶
type StackStatusPrimitiveTypeHolderStatusEnum struct { CREATION_COMPLETE StackStatusPrimitiveTypeHolderStatus DEPLOYMENT_IN_PROGRESS StackStatusPrimitiveTypeHolderStatus DEPLOYMENT_FAILED StackStatusPrimitiveTypeHolderStatus DEPLOYMENT_COMPLETE StackStatusPrimitiveTypeHolderStatus ROLLBACK_IN_PROGRESS StackStatusPrimitiveTypeHolderStatus ROLLBACK_FAILED StackStatusPrimitiveTypeHolderStatus ROLLBACK_COMPLETE StackStatusPrimitiveTypeHolderStatus DELETION_IN_PROGRESS StackStatusPrimitiveTypeHolderStatus DELETION_FAILED StackStatusPrimitiveTypeHolderStatus }
func GetStackStatusPrimitiveTypeHolderStatusEnum ¶
func GetStackStatusPrimitiveTypeHolderStatusEnum() StackStatusPrimitiveTypeHolderStatusEnum
type TemplateBodyPrimitiveTypeHolder ¶
type TemplateBodyPrimitiveTypeHolder struct { // HCL模板,描述了资源的目标状态。RF将比较此模板与当前远程资源的状态之间的区别。 template_body和template_uri 必须有且只有一个存在 TemplateBody *string `json:"template_body,omitempty"` }
func (TemplateBodyPrimitiveTypeHolder) String ¶
func (o TemplateBodyPrimitiveTypeHolder) String() string
type TemplateUriPrimitiveTypeHolder ¶
type TemplateUriPrimitiveTypeHolder struct { // HCL模板的OBS地址,该模板描述了资源的目标状态 OBS地址必须为同region的OBS地址,暂不支持跨region访问 对应的文件应该是纯tf文件或zip压缩包 纯tf文件需要以`.tf`或者`.tfjson`结尾,并遵守hcl语法 压缩包目前只支持zip格式,文件需要以\".zip\"结尾。解压后的文件不得包含\".tfvars\"文件 template_body和template_uri 必须有且只有一个存在 TemplateUri *string `json:"template_uri,omitempty"` }
func (TemplateUriPrimitiveTypeHolder) String ¶
func (o TemplateUriPrimitiveTypeHolder) String() string
type VariableResponse ¶
type VariableResponse struct { // 参数的名字 Name *string `json:"name,omitempty"` // 参数类型 Type *string `json:"type,omitempty"` // 描述参数的用途 Description *string `json:"description,omitempty"` // 参数默认值。该类型与type保持一致 Default *interface{} `json:"default,omitempty"` // 参数是否为敏感字段 Sensitive *bool `json:"sensitive,omitempty"` // 参数是否可设置为null Nullable *bool `json:"nullable,omitempty"` // 参数校验模块 Validations *[]VariableValidationResponse `json:"validations,omitempty"` }
variable response
func (VariableResponse) String ¶
func (o VariableResponse) String() string
type VariableValidationResponse ¶
type VariableValidationResponse struct { // 校验表达式。支持Terraform表达式 Condition *string `json:"condition,omitempty"` // 校验失败后的错误信息 ErrorMessage *string `json:"error_message,omitempty"` }
variable-validation response
func (VariableValidationResponse) String ¶
func (o VariableValidationResponse) String() string
type VarsBodyPrimitiveTypeHolder ¶
type VarsBodyPrimitiveTypeHolder struct { // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果 * vars_body使用HCL的tfvars格式,用户可以将“.tfvars”中的内容提交到vars_body中。具体tfvars格式见:https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * 如果vars_body过大,可以使用vars_uri * 如果vars中都是简单的字符串格式,可以使用var_structure * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsBody *string `json:"vars_body,omitempty"` }
func (VarsBodyPrimitiveTypeHolder) String ¶
func (o VarsBodyPrimitiveTypeHolder) String() string
type VarsStructure ¶
type VarsStructure struct { // 参数的名字 VarKey string `json:"var_key"` // 参数的值。 注意,参数需要以字符串形式存在,如果是数字,也需要以字符串形式存在,如'10'。 如果需要支持不同类型,或者复杂结构,请使用vars_uri或vars_body VarValue string `json:"var_value"` Encryption *EncryptionStructure `json:"encryption,omitempty"` }
HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果。 var_structure可以允许客户提交最简单的字符串类型的参数 RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 vars_structure中的值只支持简单的字符串类型,如果需要使用其他类型,需要用户自己在HCL引用时转换, 或者用户可以使用vars_uri、vars_body,vars_uri和vars_body中支持HCL支持的各种类型以及复杂结构 如果vars_structure过大,可以使用vars_uri 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars
func (VarsStructure) String ¶
func (o VarsStructure) String() string
type VarsStructurePrimitiveTypeHolder ¶
type VarsStructurePrimitiveTypeHolder struct { // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果。 * var_structure可以允许客户提交最简单的字符串类型的参数 * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * vars_structure中的值只支持简单的字符串类型,如果需要使用其他类型,需要用户自己在HCL引用时转换, 或者用户可以使用vars_uri、vars_body,vars_uri和vars_body中支持HCL支持的各种类型以及复杂结构 * 如果vars_structure过大,可以使用vars_uri * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsStructure *[]VarsStructure `json:"vars_structure,omitempty"` }
func (VarsStructurePrimitiveTypeHolder) String ¶
func (o VarsStructurePrimitiveTypeHolder) String() string
type VarsUriPrimitiveTypeHolder ¶
type VarsUriPrimitiveTypeHolder struct { // HCL支持参数,即,同一个模板可以给予不同的参数而达到不同的效果 * vars_body使用HCL的tfvars格式,用户可以将“.tfvars”中的内容提交到vars_body中。具体tfvars格式见:https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files * RF支持vars_structure,vars_body和vars_uri,如果他们中声名了同一个变量,将报错400 * 如果vars_body过大,可以使用vars_uri * 如果vars中都是简单的字符串格式,可以使用var_structure * 注意:vars中不应该传递任何敏感信息,RF会直接明文使用、log、展示、存储对应的vars VarsUri *string `json:"vars_uri,omitempty"` }
func (VarsUriPrimitiveTypeHolder) String ¶
func (o VarsUriPrimitiveTypeHolder) String() string
Source Files ¶
- model_agencies_primitive_type_holder.go
- model_agency.go
- model_apply_execution_plan_request.go
- model_apply_execution_plan_request_body.go
- model_apply_execution_plan_response.go
- model_continue_rollback_stack_request.go
- model_continue_rollback_stack_request_body.go
- model_continue_rollback_stack_response.go
- model_create_execution_plan_request.go
- model_create_execution_plan_request_body.go
- model_create_execution_plan_response.go
- model_create_stack_request.go
- model_create_stack_request_body.go
- model_create_stack_response.go
- model_delete_stack_request.go
- model_delete_stack_response.go
- model_deploy_stack_request.go
- model_deploy_stack_request_body.go
- model_deploy_stack_response.go
- model_enable_auto_rollback_primitive_type_holder.go
- model_enable_deletion_protection_primitive_type_holder.go
- model_encryption_structure.go
- model_estimate_execution_plan_price_request.go
- model_estimate_execution_plan_price_response.go
- model_execution_plan.go
- model_executor_primitive_type_holder.go
- model_get_stack_template_request.go
- model_get_stack_template_response.go
- model_items_response.go
- model_kms_structure.go
- model_list_execution_plans_request.go
- model_list_execution_plans_response.go
- model_list_stack_events_request.go
- model_list_stack_events_response.go
- model_list_stack_outputs_request.go
- model_list_stack_outputs_response.go
- model_list_stack_resources_request.go
- model_list_stack_resources_response.go
- model_list_stacks_request.go
- model_list_stacks_response.go
- model_parse_template_variables_request.go
- model_parse_template_variables_request_body.go
- model_parse_template_variables_response.go
- model_resource_price_response.go
- model_stack.go
- model_stack_description_primitive_type_holder.go
- model_stack_event_response.go
- model_stack_id_primitive_type_holder.go
- model_stack_name_primitive_type_holder.go
- model_stack_output.go
- model_stack_resource.go
- model_stack_status_primitive_type_holder.go
- model_template_body_primitive_type_holder.go
- model_template_uri_primitive_type_holder.go
- model_variable_response.go
- model_variable_validation_response.go
- model_vars_body_primitive_type_holder.go
- model_vars_structure.go
- model_vars_structure_primitive_type_holder.go
- model_vars_uri_primitive_type_holder.go