engines

Documentation

Index

• type AuthCred
• type CceSpec
• type CreateOpts
• type Detail
• type Engine
  • func Get(c *golangsdk.ServiceClient, engineId, epsId string) (*Engine, error)
• type ErrorResponse
• type ExecutorBrief
• type ExternalEntrypoint
• type Job
  • func GetJob(c *golangsdk.ServiceClient, engineId, jobId, epsId string) (*Job, error)
• type Node
• type NodeDetails
• type Reference
• type RequestResp
  • func Create(c *golangsdk.ServiceClient, opts CreateOpts) (*RequestResp, error)
  • func Delete(c *golangsdk.ServiceClient, engineId, epsId string) (*RequestResp, error)
• type ServiceEndpoint
• type SubTask
• type Task

Types

type AuthCred

type AuthCred struct {
	// The root account password that needs to be specified when selecting security authentication.
	Password string `json:"pwd" required:"true"`
}

AuthCred is an object that specifies the configuration of the security authentication.

type CceSpec

type CceSpec struct {
	// The CCE flavor ID.
	ID int `json:"id"`
	// The ID of the dedicated microservice engine.
	EngineId string `json:"engineId"`
	// The deployment type of the dedicated microservice engine.
	SpecType string `json:"specType"`
	// The cluster ID of the dedicated microservice engine.
	ClusterId string `json:"clusterId"`
	// The list of the CCE nodes for the dedicated microservice engine.
	ClusterNodes NodeDetails `json:"clusterNodes"`
	// The CCE cluster flavor.
	Flavor string `json:"flavor"`
	// The region where the CCE cluster is located.
	Region string `json:"region"`
	// The CCE cluster version.
	Version string `json:"version"`
	// Additional parameters for the CCE cluster.
	ExtendParam string `json:"extendParam"`
}

CceSpec is an object that represents the configuration of the associated CCE cluster.

type CreateOpts

type CreateOpts struct {
	// The name of the dedicated microservice engine.
	// The value can contain 3 to 24 characters, including letters, digits, and hyphens (-).
	// It must start with a letter and cannot end with a hyphen.
	Name string `json:"name" required:"true"`
	// The charging mode of the dedicated microservice engine.
	Payment string `json:"payment" required:"true"`
	// The flavor of the dedicated microservice engine.
	//   cse.s1.small2: High availability 100 instance engine.
	//   cse.s1.medium2: High availability 200 instance engine.
	//   cse.s1.large2: High availability 500 instance engine.
	//   cse.s1.xlarge2: High availability 2000 instance engine.
	Flavor string `json:"flavor" required:"true"`
	// List of available zones for the current region.
	AvailabilityZones []string `json:"azList" required:"true"`
	// The authentication method for the dedicated microservice engine.
	// The "RBAC" is security authentication, and the "NONE" is no authentication.
	AuthType string `json:"authType" required:"true"`
	// The VPC name.
	VpcName string `json:"vpc" required:"true"`
	// The network ID of the subnet.
	NetworkId string `json:"networkId" required:"true"`
	// The subnet CIDR.
	SubnetCidr string `json:"subnetCidr" required:"true"`
	// The deployment type of the dedicated microservice engine. The fixed value is "CSE2".
	SpecType string `json:"specType" required:"true"`
	// The description of the dedicated microservice engine. The value can contain up to 255 characters.
	Description string `json:"description,omitempty"`
	// The VPC ID.
	VpcId string `json:"vpcId,omitempty"`
	// The public access for the dedicated microservice engine.
	PublicIpId string `json:"publicIpId,omitempty"`
	// The dedicated microservice engine must be passed when security authentication is selected,
	// including the authentication information of the engine.
	AuthCred *AuthCred `json:"auth_cred,omitempty"`
	// The additional parameters of the dedicated microservice engine.
	Inputs map[string]interface{} `json:"inputs,omitempty"`
	// The enterprise project ID to which the dedicated microservice engine.
	EnterpriseProjectId string `json:"-"`
}

CreateOpts is the structure required by the Create method to create a new engine.

type Detail

type Detail struct {
	// The main ipv4 access address in the VPC of the Microservice Engine Exclusive Edition component.
	MasterEntrypoint string `json:"masterEntrypoint"`
	// The main ipv6 access address in the VPC of the Microservice Engine Exclusive Edition component.
	MasterEntrypointIpv6 string `json:"masterEntrypointIpv6"`
	// The ipv4 standby access address in the VPC of the Microservice Engine Exclusive Edition component.
	SlaveEntrypoint string `json:"slaveEntrypoint"`
	// The ipv6 standby access address in the VPC of the Microservice Engine Exclusive Edition component.
	SlaveEntrypointIpv6 string `json:"slaveEntrypointIpv6"`
	// The component type of the dedicated microservice engine.
	Type string `json:"type"`
}

Detail is an object that represent the endpoint informations of the service center or config center.

type Engine

type Engine struct {
	// The ID of the dedicated microservice engine.
	ID string `json:"id"`
	// The name of the dedicated microservice engine.
	Name string `json:"name"`
	// The project ID to which the dedicated microservice engine belongs.
	ProjectId string `json:"projectId"`
	// The enterprise project ID to which the dedicated microservice engine belongs.
	EnterpriseProjectId string `json:"enterpriseProjectId"`
	// The enterprise project name to which the dedicated microservice engine belongs.
	EnterpriseProjectName string `json:"enterpriseProjectName"`
	// The engine type.
	Type string `json:"type"`
	// The description of the dedicated microservice engine.
	Description string `json:"description"`
	// Whether the engine is the default engine.
	IsDefault bool `json:"beDefault"`
	// The flavor of the dedicated microservice engine.
	//   cse.s1.small2: High availability 100 instance engine.
	//   cse.s1.medium2: High availability 200 instance engine.
	//   cse.s1.large2: High availability 500 instance engine.
	//   cse.s1.xlarge2: High availability 2000 instance engine.
	Flavor string `json:"flavor"`
	// The charging mode of the dedicated microservice engine.
	//   0: pre-paid.
	//   1: post-paid.
	//   2: free.
	Payment string `json:"payment"`
	// The authentication method for the dedicated microservice engine.
	// The "RBAC" is security authentication, and the "NONE" is no authentication.
	AuthType string `json:"authType"`
	// The current status.
	Status string `json:"status"`
	// The CCE flavor of the dedicated microservice engine.
	CceSpec CceSpec `json:"cceSpec"`
	// The access address of the dedicated microservice engine.
	ExternalEntrypoint ExternalEntrypoint `json:"externalEntrypoint"`
	// The IP address of the public access for the dedicated microservice engine.
	PublicAddress string `json:"publicAddress"`
	// The current version of the dedicated microservice engine.
	Version string `json:"version"`
	// The latest version of the dedicated microservice engine.
	LatestVersion string `json:"latestVersion"`
	// The creation time of the dedicated microservice engine.
	CreateTime int `json:"createTime"`
	// The creator of the dedicated microservice engine.
	CreateUser string `json:"createUser"`
	// The latest task ID of the dedicated microservice engine.
	LatestJobId int `json:"latestJobId"`
	// Additional operations allowed by the dedicated microservice engine.
	//   Delete
	//   ForceDelete
	//   Upgrade
	//   Modify
	//   Retry
	EngineAdditionalActions []string `json:"engineAdditionalActions"`
	// The deployment type of the dedicated microservice engine. The fixed value is "CSE2".
	SpecType string `json:"specType"`
	// Additional information for the dedicated microservice engine.
	Reference Reference `json:"reference"`
	//The list of virtual machine IDs used by the current microservice engine on the resource tenant side.
	VmIds []string `json:"vmIds"`
}

Engine is the structure that represents the details of the Microservice engine.

func Get

func Get(c *golangsdk.ServiceClient, engineId, epsId string) (*Engine, error)

Get is a method to retrieves a particular configuration based on its unique ID and enterprise project ID.

type ErrorResponse

type ErrorResponse struct {
	// Error code
	ErrCode string `json:"error_code"`
	// Error message
	ErrMessage string `json:"error_message"`
}

type ExecutorBrief

type ExecutorBrief struct {
	// The subtask duration.
	Duration int `json:"duration"`
	// The subtask description.
	Description string `json:"description"`
}

ExecutorBrief is an object that represent the job metadata.

type ExternalEntrypoint

type ExternalEntrypoint struct {
	// The access address in the VPC on the tenant side of the dedicated microservice engine.
	ExternalAddress string `json:"externalAddress"`
	// The public network access address of the dedicated microservice engine, it needs to be enabled for public access.
	PublicAddress string `json:"publicAddress"`
	// Access address in the VPC on the tenant side of the component of the dedicated Microservice Engine.
	ServiceEndpoint ServiceEndpoint `json:"serviceEndpoint"`
	// The public network access address of the component of the dedicated Microservice Engine.
	// The public network access needs to be enabled.
	PublicServiceEndpoint ServiceEndpoint `json:"publicServiceEndpoint"`
}

ExternalEntrypoint is an object that represents the access information.

type Job

type Job struct {
	// The job ID.
	Id int `json:"id"`
	// The engine ID corresponding to the currently executing job.
	EngineId string `json:"engineId"`
	// The job type.
	//   Create: create engine.
	//   Delete: delete engine.
	//   Upgrade: upgrade engine.
	//   Modify：update engine flavor.
	//   Configure：update engine configuration.
	Type string `json:"type"`
	// The job description.
	Description string `json:"description"`
	// The current execution status of the job.
	//   Init：initialization.
	//   Executing：executing.
	//   Error：failed to execute.
	//   Timeout：timeout to execute。
	//   Finished：execution complete。
	Status string `json:"status"`
	// Whether the job is executing, 0 means not executing, 1 means executing.
	Scheduling int `json:"scheduling"`
	// The job creator.
	CreateUser string `json:"createUser"`
	// The time when the job started executing.
	StartTime int `json:"startTime"`
	// The time when the job ends.
	EndTime int `json:"endTime"`
	// The job execution context.
	Context string `json:"context"`
	// The processing stages of the job.
	Tasks []Task `json:"tasks"`
}

Job is an object that represent the details of the excuting job.

func GetJob

func GetJob(c *golangsdk.ServiceClient, engineId, jobId, epsId string) (*Job, error)

GetJob is a method to obtain the job detail using engine ID and job ID.

type Node

type Node struct {
	// The node ID.
	ID string `json:"id"`
	// The availability zone where the node is located.
	AvailabilityZone string `json:"az"`
	// The node IP.
	IP string `json:"ip"`
	// The node tag.
	Label string `json:"label"`
	// The node status.
	Status string `json:"status"`
}

Node is an object that represents the details of the CCE node.

type NodeDetails

type NodeDetails struct {
	// The list of the CCE nodes.
	Nodes []Node `json:"clusterNodes"`
}

NodeDetails is an object that represents the nodes list.

type Reference

type Reference struct {
	// The VPC name.
	Vpc string `json:"vpc"`
	// The VPC ID.
	VpcId string `json:"vpcId"`
	// List of deployment availability zones for the dedicated Microservice Engine.
	AzList []string `json:"azList"`
	// The subnet network ID of the dedicated microservice engine.
	NetworkId string `json:"networkId"`
	// The ipv4 subnet division.
	SubnetCidr string `json:"subnetCidr"`
	// The ipv6 subnet division.
	SubnetCidV6 string `json:"subnetCidV6"`
	// The subnet gateway.
	SubnetGateway string `json:"subnetGateway"`
	// The public network address ID of the dedicated microservice engine. Public network access needs to be enabled.
	PublicIpId string `json:"publicIpId"`
	// The total number of microservices that the plan can support.
	ServiceLimit string `json:"serviceLimit"`
	// The total number of microservice instances that the plan can support.
	InstanceLimit string `json:"instanceLimit"`
	// Additional parameters for the dedicated microservice engine.
	Inputs map[string]interface{} `json:"inputs"`
}

Reference is an object that represent the additional parameters of the dedicated microservice engine.

type RequestResp

type RequestResp struct {
	// The ID of the dedicated microservice engine.
	ID string `json:"id"`
	// The name of the dedicated microservice engine.
	Name string `json:"name"`
	// The Job ID.
	JobId int `json:"jobId"`
}

RequestResp is the structure that represents the response of the API request.

func Create

func Create(c *golangsdk.ServiceClient, opts CreateOpts) (*RequestResp, error)

Create is a method to create a microservice engine using given parameters.

func Delete

func Delete(c *golangsdk.ServiceClient, engineId, epsId string) (*RequestResp, error)

Delete is a method to remove an existing engine using its unique ID and enterprise project ID.

type ServiceEndpoint

type ServiceEndpoint struct {
	// The entrypoint details of the service center.
	ServiceCenter Detail `json:"serviceCenter"`
	// The entrypoint details of the config center.
	ConfigCenter Detail `json:"kie"`
}

ServiceEndpoint is an object that represent the entrypoints of the service center and config center.

type SubTask

type SubTask struct {
	// The task ID to which the subtask belongs.
	JobId int `json:"jobId"`
	// The subtask ID.
	Id int `json:"id"`
	// The subtask type.
	Type string `json:"type"`
	// The executor of the subtask
	Assigned string `json:"assigned"`
	// The subtask name.
	TaskName string `json:"taskName"`
	// The name of the engine to which the subtask belongs.
	EngineName string `json:"engineName"`
	// The order in which the subtasks are executed, from small to large.
	TaskOrder int `json:"taskOrder"`
	// The subtask status
	Status string `json:"status"`
	// The subtask start time.
	StartTime int `json:"startTime"`
	// The subtask end time.
	EndTime int `json:"endTime"`
	// The subtask creation time.
	CreateTime int `json:"createTime"`
	// The subtask update time.
	UpdateTime int `json:"updateTime"`
	// Whether subtask is timeout.
	Timeout int `json:"timeout"`
	// The subtask details, auxiliary information generated during execution.
	Log string `json:"log"`
	// The subtask output information.
	Output string `json:"output"`
	// The subtask metadata.
	ExecutorBrief ExecutorBrief `json:"taskExecutorBrief"`
}

SubTask is an object that represent the details of the subjob.

type Task

type Task struct {
	// The current task name.
	Name string `json:"taskName"`
	// List of processing step names contained in the current processing stage.
	Steps []string `json:"taskNames"`
	// The current status.
	Status string `json:"status"`
	// Task processing phase start time.
	StartTime int `json:"startTime"`
	// Task processing phase end time.
	EndTime int `json:"endTime"`
	// The task metadata.
	ExecutorBrief ExecutorBrief `json:"taskExecutorBrief"`
	// Subtasks included in the processing phase.
	SubTasks []SubTask `json:"tasks"`
}

Task is an object that represent the details of the processing stages of the job.