Documentation ¶
Index ¶
- Constants
- type Activity
- type AgentRunningMode
- type AnonymousComputeEnv
- type Application
- type AttachInstancesRequest
- type AttachInstancesResponse
- type Authentication
- type Client
- func (c *Client) AttachInstances(request *AttachInstancesRequest) (response *AttachInstancesResponse, err error)
- func (c *Client) CreateComputeEnv(request *CreateComputeEnvRequest) (response *CreateComputeEnvResponse, err error)
- func (c *Client) CreateTaskTemplate(request *CreateTaskTemplateRequest) (response *CreateTaskTemplateResponse, err error)
- func (c *Client) DeleteComputeEnv(request *DeleteComputeEnvRequest) (response *DeleteComputeEnvResponse, err error)
- func (c *Client) DeleteJob(request *DeleteJobRequest) (response *DeleteJobResponse, err error)
- func (c *Client) DeleteTaskTemplates(request *DeleteTaskTemplatesRequest) (response *DeleteTaskTemplatesResponse, err error)
- func (c *Client) DescribeAvailableCvmInstanceTypes(request *DescribeAvailableCvmInstanceTypesRequest) (response *DescribeAvailableCvmInstanceTypesResponse, err error)
- func (c *Client) DescribeComputeEnv(request *DescribeComputeEnvRequest) (response *DescribeComputeEnvResponse, err error)
- func (c *Client) DescribeComputeEnvActivities(request *DescribeComputeEnvActivitiesRequest) (response *DescribeComputeEnvActivitiesResponse, err error)
- func (c *Client) DescribeComputeEnvCreateInfo(request *DescribeComputeEnvCreateInfoRequest) (response *DescribeComputeEnvCreateInfoResponse, err error)
- func (c *Client) DescribeComputeEnvCreateInfos(request *DescribeComputeEnvCreateInfosRequest) (response *DescribeComputeEnvCreateInfosResponse, err error)
- func (c *Client) DescribeComputeEnvs(request *DescribeComputeEnvsRequest) (response *DescribeComputeEnvsResponse, err error)
- func (c *Client) DescribeCvmZoneInstanceConfigInfos(request *DescribeCvmZoneInstanceConfigInfosRequest) (response *DescribeCvmZoneInstanceConfigInfosResponse, err error)
- func (c *Client) DescribeInstanceCategories(request *DescribeInstanceCategoriesRequest) (response *DescribeInstanceCategoriesResponse, err error)
- func (c *Client) DescribeJob(request *DescribeJobRequest) (response *DescribeJobResponse, err error)
- func (c *Client) DescribeJobSubmitInfo(request *DescribeJobSubmitInfoRequest) (response *DescribeJobSubmitInfoResponse, err error)
- func (c *Client) DescribeJobs(request *DescribeJobsRequest) (response *DescribeJobsResponse, err error)
- func (c *Client) DescribeTask(request *DescribeTaskRequest) (response *DescribeTaskResponse, err error)
- func (c *Client) DescribeTaskLogs(request *DescribeTaskLogsRequest) (response *DescribeTaskLogsResponse, err error)
- func (c *Client) DescribeTaskTemplates(request *DescribeTaskTemplatesRequest) (response *DescribeTaskTemplatesResponse, err error)
- func (c *Client) DetachInstances(request *DetachInstancesRequest) (response *DetachInstancesResponse, err error)
- func (c *Client) ModifyComputeEnv(request *ModifyComputeEnvRequest) (response *ModifyComputeEnvResponse, err error)
- func (c *Client) ModifyTaskTemplate(request *ModifyTaskTemplateRequest) (response *ModifyTaskTemplateResponse, err error)
- func (c *Client) RetryJobs(request *RetryJobsRequest) (response *RetryJobsResponse, err error)
- func (c *Client) SubmitJob(request *SubmitJobRequest) (response *SubmitJobResponse, err error)
- func (c *Client) TerminateComputeNode(request *TerminateComputeNodeRequest) (response *TerminateComputeNodeResponse, err error)
- func (c *Client) TerminateComputeNodes(request *TerminateComputeNodesRequest) (response *TerminateComputeNodesResponse, err error)
- func (c *Client) TerminateJob(request *TerminateJobRequest) (response *TerminateJobResponse, err error)
- func (c *Client) TerminateTaskInstance(request *TerminateTaskInstanceRequest) (response *TerminateTaskInstanceResponse, err error)
- type ComputeEnvCreateInfo
- type ComputeEnvData
- type ComputeEnvView
- type ComputeNode
- type ComputeNodeMetrics
- type CreateComputeEnvRequest
- type CreateComputeEnvResponse
- type CreateTaskTemplateRequest
- type CreateTaskTemplateResponse
- type DataDisk
- type DeleteComputeEnvRequest
- type DeleteComputeEnvResponse
- type DeleteJobRequest
- type DeleteJobResponse
- type DeleteTaskTemplatesRequest
- type DeleteTaskTemplatesResponse
- type Dependence
- type DescribeAvailableCvmInstanceTypesRequest
- type DescribeAvailableCvmInstanceTypesResponse
- type DescribeComputeEnvActivitiesRequest
- type DescribeComputeEnvActivitiesResponse
- type DescribeComputeEnvCreateInfoRequest
- type DescribeComputeEnvCreateInfoResponse
- type DescribeComputeEnvCreateInfosRequest
- type DescribeComputeEnvCreateInfosResponse
- type DescribeComputeEnvRequest
- type DescribeComputeEnvResponse
- type DescribeComputeEnvsRequest
- type DescribeComputeEnvsResponse
- type DescribeCvmZoneInstanceConfigInfosRequest
- type DescribeCvmZoneInstanceConfigInfosResponse
- type DescribeInstanceCategoriesRequest
- type DescribeInstanceCategoriesResponse
- type DescribeJobRequest
- type DescribeJobResponse
- type DescribeJobSubmitInfoRequest
- type DescribeJobSubmitInfoResponse
- type DescribeJobsRequest
- type DescribeJobsResponse
- type DescribeTaskLogsRequest
- type DescribeTaskLogsResponse
- type DescribeTaskRequest
- type DescribeTaskResponse
- type DescribeTaskTemplatesRequest
- type DescribeTaskTemplatesResponse
- type DetachInstancesRequest
- type DetachInstancesResponse
- type Docker
- type EnhancedService
- type EnvData
- type EnvVar
- type EventConfig
- type EventVar
- type Externals
- type Filter
- type InputMapping
- type Instance
- type InstanceCategoryItem
- type InstanceMarketOptionsRequest
- type InstanceTypeConfig
- type InstanceTypeOptions
- type InstanceTypeQuotaItem
- type InternetAccessible
- type ItemPrice
- type Job
- type JobView
- type LocalDiskType
- type LoginSettings
- type ModifyComputeEnvRequest
- type ModifyComputeEnvResponse
- type ModifyTaskTemplateRequest
- type ModifyTaskTemplateResponse
- type MountDataDisk
- type NamedComputeEnv
- type Notification
- type OutputMapping
- type OutputMappingConfig
- type Placement
- type RedirectInfo
- type RedirectLocalInfo
- type RetryJobsRequest
- type RetryJobsResponse
- type RunAutomationServiceEnabled
- type RunMonitorServiceEnabled
- type RunSecurityServiceEnabled
- type SpotMarketOptions
- type StorageBlock
- type SubmitJobRequest
- type SubmitJobResponse
- type SystemDisk
- type Tag
- type Task
- type TaskInstanceLog
- type TaskInstanceMetrics
- type TaskInstanceView
- type TaskMetrics
- type TaskTemplateView
- type TaskView
- type TerminateComputeNodeRequest
- type TerminateComputeNodeResponse
- type TerminateComputeNodesRequest
- type TerminateComputeNodesResponse
- type TerminateJobRequest
- type TerminateJobResponse
- type TerminateTaskInstanceRequest
- type TerminateTaskInstanceResponse
- type VirtualPrivateCloud
Constants ¶
const ( // One (and only one) parameter must be specified for ComputeEnv and EnvId. ALLOWEDONEATTRIBUTEINENVIDANDCOMPUTEENV = "AllowedOneAttributeInEnvIdAndComputeEnv" // Internal error. INTERNALERROR = "InternalError" // The CPM API call returns an error. INTERNALERROR_CALLCPMAPI = "InternalError.CallCpmAPI" // An error is returned for the CVM API call. INTERNALERROR_CALLCVM = "InternalError.CallCvm" // Error while obtaining the Tag component. INTERNALERROR_CALLTAGAPI = "InternalError.CallTagAPI" // The specified filter is not supported. INVALIDFILTER = "InvalidFilter" // Invalid compute node ID format. INVALIDPARAMETER_COMPUTENODEIDMALFORMED = "InvalidParameter.ComputeNodeIdMalformed" // Invalid CVM parameter. INVALIDPARAMETER_CVMPARAMETERS = "InvalidParameter.CvmParameters" // The compute environment description is too long. INVALIDPARAMETER_ENVDESCRIPTIONTOOLONG = "InvalidParameter.EnvDescriptionTooLong" // Invalid compute environment ID format. INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" // The compute environment name is too long. INVALIDPARAMETER_ENVNAMETOOLONG = "InvalidParameter.EnvNameTooLong" // Incorrect image ID. INVALIDPARAMETER_IMAGEIDMALFORMED = "InvalidParameter.ImageIdMalformed" // Invalid parameter combination. INVALIDPARAMETER_INVALIDPARAMETERCOMBINATION = "InvalidParameter.InvalidParameterCombination" // The instance description is too long. INVALIDPARAMETER_JOBDESCRIPTIONTOOLONG = "InvalidParameter.JobDescriptionTooLong" // Invalid instance ID format. INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" // The instance name is too long. INVALIDPARAMETER_JOBNAMETOOLONG = "InvalidParameter.JobNameTooLong" // Duplicate message notification event name. INVALIDPARAMETER_NOTIFICATIONEVENTNAMEDUPLICATE = "InvalidParameter.NotificationEventNameDuplicate" // Invalid topic name. INVALIDPARAMETER_NOTIFICATIONTOPICNAME = "InvalidParameter.NotificationTopicName" // The topic name is too long. INVALIDPARAMETER_NOTIFICATIONTOPICNAMETOOLONG = "InvalidParameter.NotificationTopicNameTooLong" // Invalid job name. INVALIDPARAMETER_TASKNAME = "InvalidParameter.TaskName" // The task name is too long. INVALIDPARAMETER_TASKNAMETOOLONG = "InvalidParameter.TaskNameTooLong" // The task template description is too long. INVALIDPARAMETER_TASKTEMPLATEDESCRIPTIONTOOLONG = "InvalidParameter.TaskTemplateDescriptionTooLong" // Invalid task template ID format. INVALIDPARAMETER_TASKTEMPLATEIDMALFORMED = "InvalidParameter.TaskTemplateIdMalformed" // Invalid task template name. INVALIDPARAMETER_TASKTEMPLATENAME = "InvalidParameter.TaskTemplateName" // The task template name is too long. INVALIDPARAMETER_TASKTEMPLATENAMETOOLONG = "InvalidParameter.TaskTemplateNameTooLong" // At least one of TaskTemplateName, TaskTemplateDescription, and TaskTemplateInfo must be contained. INVALIDPARAMETERATLEASTONEATTRIBUTE = "InvalidParameterAtLeastOneAttribute" // Incorrect parameter value. INVALIDPARAMETERVALUE = "InvalidParameterValue" // Compute environment parameter validation failed. INVALIDPARAMETERVALUE_COMPUTEENV = "InvalidParameterValue.ComputeEnv" // The dependent task definition was not found. INVALIDPARAMETERVALUE_DEPENDENCENOTFOUNDTASKNAME = "InvalidParameterValue.DependenceNotFoundTaskName" // Loop task dependency is prohibited. INVALIDPARAMETERVALUE_DEPENDENCEUNFEASIBLE = "InvalidParameterValue.DependenceUnfeasible" // Instance IDs duplicate. INVALIDPARAMETERVALUE_INSTANCEIDDUPLICATED = "InvalidParameterValue.InstanceIdDuplicated" // The specified instance type is not supported. INVALIDPARAMETERVALUE_INSTANCETYPE = "InvalidParameterValue.InstanceType" // The instance type value must be unique. INVALIDPARAMETERVALUE_INSTANCETYPEDUPLICATE = "InvalidParameterValue.InstanceTypeDuplicate" // The list of instance types cannot be empty. INVALIDPARAMETERVALUE_INSTANCETYPESEMPTY = "InvalidParameterValue.InstanceTypesEmpty" // INVALIDPARAMETERVALUE_INVALIDDATATYPEANY = "InvalidParameterValue.InvalidDataTypeAny" // The number of filter parameter values exceeds the limit. INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" // Invalid local storage path. INVALIDPARAMETERVALUE_LOCALPATH = "InvalidParameterValue.LocalPath" // The number of retries is too large. INVALIDPARAMETERVALUE_MAXRETRYCOUNT = "InvalidParameterValue.MaxRetryCount" // Invalid negative parameter. INVALIDPARAMETERVALUE_NEGATIVE = "InvalidParameterValue.Negative" // INVALIDPARAMETERVALUE_NOTFLOAT = "InvalidParameterValue.NotFloat" // Invalid storage path format. INVALIDPARAMETERVALUE_REMOTESTORAGEPATH = "InvalidParameterValue.RemoteStoragePath" // Invalid storage type. INVALIDPARAMETERVALUE_REMOTESTORAGESCHEMETYPE = "InvalidParameterValue.RemoteStorageSchemeType" // The specified ResourceType is invalid. INVALIDPARAMETERVALUE_RESOURCETYPE = "InvalidParameterValue.ResourceType" // The availability zone is unavailable. INVALIDPARAMETERVALUE_UNAVAILABLEZONE = "InvalidParameterValue.UnavailableZone" // The model billing type is not supported by BatchCompute. INVALIDPARAMETERVALUE_UNSUPPORTEDBATCHINSTANCECHARGETYPE = "InvalidParameterValue.UnsupportedBatchInstanceChargeType" // The specified zone does not exist. INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion" // Insufficient compute environment quota. LIMITEXCEEDED_COMPUTEENVQUOTA = "LimitExceeded.ComputeEnvQuota" // Insufficient CPU quota. LIMITEXCEEDED_CPUQUOTA = "LimitExceeded.CpuQuota" // Insufficient instance quota. LIMITEXCEEDED_JOBQUOTA = "LimitExceeded.JobQuota" // Insufficient task template quota. LIMITEXCEEDED_TASKTEMPLATEQUOTA = "LimitExceeded.TaskTemplateQuota" // The job is in use. RESOURCEINUSE_JOB = "ResourceInUse.Job" // The specified compute environment does not exist. RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" // The specified compute node does not exist. RESOURCENOTFOUND_COMPUTENODE = "ResourceNotFound.ComputeNode" // The specified instance does not exist. RESOURCENOTFOUND_JOB = "ResourceNotFound.Job" // The specified job task does not exist. RESOURCENOTFOUND_TASK = "ResourceNotFound.Task" // The specified task instance does not exist. RESOURCENOTFOUND_TASKINSTANCE = "ResourceNotFound.TaskInstance" // The specified job template ID does not exist. RESOURCENOTFOUND_TASKTEMPLATE = "ResourceNotFound.TaskTemplate" // It is prohibited to use the BatchCompute service. UNAUTHORIZEDOPERATION_USERNOTALLOWEDTOUSEBATCH = "UnauthorizedOperation.UserNotAllowedToUseBatch" // Unknown parameter. UNKNOWNPARAMETER = "UnknownParameter" // Unsupported operation. UNSUPPORTEDOPERATION = "UnsupportedOperation" // Another request is being processed and deletion is prohibited. UNSUPPORTEDOPERATION_ACCEPTOTHERREQUEST = "UnsupportedOperation.AcceptOtherRequest" // The compute environment accepts other requests. UNSUPPORTEDOPERATION_COMPUTEENVACCEPTOTHERREQUEST = "UnsupportedOperation.ComputeEnvAcceptOtherRequest" // Deletion is prohibited. UNSUPPORTEDOPERATION_COMPUTEENVOPERATION = "UnsupportedOperation.ComputeEnvOperation" // Compute node termination is prohibited. UNSUPPORTEDOPERATION_COMPUTENODEFORBIDTERMINATE = "UnsupportedOperation.ComputeNodeForbidTerminate" // The compute node is terminating. UNSUPPORTEDOPERATION_COMPUTENODEISTERMINATING = "UnsupportedOperation.ComputeNodeIsTerminating" // This instance cannot be added to the compute environment. UNSUPPORTEDOPERATION_INSTANCESNOTALLOWTOATTACH = "UnsupportedOperation.InstancesNotAllowToAttach" // The number of compute nodes to be removed for scale-in is greater than the number of existing compute nodes. UNSUPPORTEDOPERATION_NOTENOUGHCOMPUTENODESTOTERMINATE = "UnsupportedOperation.NotEnoughComputeNodesToTerminate" // This operation is prohibited for the task instances in the specified compute environment. UNSUPPORTEDOPERATION_TERMINATEOPERATIONWITHENVID = "UnsupportedOperation.TerminateOperationWithEnvId" )
const APIVersion = "2017-03-12"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Activity ¶
type Activity struct { // Activity ID ActivityId *string `json:"ActivityId,omitempty" name:"ActivityId"` // Compute node ID ComputeNodeId *string `json:"ComputeNodeId,omitempty" name:"ComputeNodeId"` // Compute node activity type: creation or termination ComputeNodeActivityType *string `json:"ComputeNodeActivityType,omitempty" name:"ComputeNodeActivityType"` // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Cause Cause *string `json:"Cause,omitempty" name:"Cause"` // Active status ActivityState *string `json:"ActivityState,omitempty" name:"ActivityState"` // State reason StateReason *string `json:"StateReason,omitempty" name:"StateReason"` // Activity start time StartTime *string `json:"StartTime,omitempty" name:"StartTime"` // Activity end time // Note: This field may return null, indicating that no valid values can be obtained. EndTime *string `json:"EndTime,omitempty" name:"EndTime"` // CVM instance ID // Note: This field may return null, indicating that no valid values can be obtained. InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"` }
type AgentRunningMode ¶
type AnonymousComputeEnv ¶
type AnonymousComputeEnv struct { // Compute environment management type EnvType *string `json:"EnvType,omitempty" name:"EnvType"` // Compute environment's specific parameters EnvData *EnvData `json:"EnvData,omitempty" name:"EnvData"` // Data disk mounting option MountDataDisks []*MountDataDisk `json:"MountDataDisks,omitempty" name:"MountDataDisks"` // Agent running mode; applicable for Windows AgentRunningMode *AgentRunningMode `json:"AgentRunningMode,omitempty" name:"AgentRunningMode"` }
type Application ¶
type Application struct { // Task execution command Command *string `json:"Command,omitempty" name:"Command"` // Delivery form of the application. Value range: PACKAGE, LOCAL, which refer to remotely stored software package and local compute environment, respectively. DeliveryForm *string `json:"DeliveryForm,omitempty" name:"DeliveryForm"` // Remote storage path of the application package PackagePath *string `json:"PackagePath,omitempty" name:"PackagePath"` // Relevant configuration of the Docker used by the application. In case that the Docker configuration is used, "LOCAL" DeliveryForm means that the application software inside the Docker image is used directly and run in Docker mode; "PACKAGE" DeliveryForm means that the remote application package is run in Docker mode after being injected into the Docker image. To avoid compatibility issues with different versions of Docker, the Docker installation package and relevant dependencies are taken care of by BatchCompute. For custom images where Docker has already been installed, uninstall Docker first and then use the Docker feature. Docker *Docker `json:"Docker,omitempty" name:"Docker"` }
type AttachInstancesRequest ¶
type AttachInstancesRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // List of instances that added to the compute environment Instances []*Instance `json:"Instances,omitempty" name:"Instances"` }
func NewAttachInstancesRequest ¶
func NewAttachInstancesRequest() (request *AttachInstancesRequest)
func (*AttachInstancesRequest) FromJsonString ¶
func (r *AttachInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AttachInstancesRequest) ToJsonString ¶
func (r *AttachInstancesRequest) ToJsonString() string
type AttachInstancesResponse ¶
type AttachInstancesResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewAttachInstancesResponse ¶
func NewAttachInstancesResponse() (response *AttachInstancesResponse)
func (*AttachInstancesResponse) FromJsonString ¶
func (r *AttachInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AttachInstancesResponse) ToJsonString ¶
func (r *AttachInstancesResponse) ToJsonString() string
type Authentication ¶
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) AttachInstances ¶
func (c *Client) AttachInstances(request *AttachInstancesRequest) (response *AttachInstancesResponse, err error)
AttachInstances This API is used to add existing instances to the compute environment.
Considerations: <br/>
1. The instance should not be in the batch compute system.<br/>
2. The instance status should be 'running'.<br/>
3. It supports dedicated CVMs and pay-as-you-go instances that billed on an hourly basis. Spot instances are not supported.<b/>
For instances added to the compute environment, their UserData will be reset and the operating systems will be reinstalled.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_CALLCVM = "InternalError.CallCvm" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" INVALIDPARAMETERVALUE_INSTANCEIDDUPLICATED = "InvalidParameterValue.InstanceIdDuplicated" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" UNSUPPORTEDOPERATION = "UnsupportedOperation" UNSUPPORTEDOPERATION_INSTANCESNOTALLOWTOATTACH = "UnsupportedOperation.InstancesNotAllowToAttach"
func (*Client) CreateComputeEnv ¶
func (c *Client) CreateComputeEnv(request *CreateComputeEnvRequest) (response *CreateComputeEnvResponse, err error)
CreateComputeEnv This API is used to create a compute environment.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_CALLCVM = "InternalError.CallCvm" INTERNALERROR_CALLTAGAPI = "InternalError.CallTagAPI" INVALIDPARAMETER_CVMPARAMETERS = "InvalidParameter.CvmParameters" INVALIDPARAMETER_ENVDESCRIPTIONTOOLONG = "InvalidParameter.EnvDescriptionTooLong" INVALIDPARAMETER_ENVNAMETOOLONG = "InvalidParameter.EnvNameTooLong" INVALIDPARAMETER_IMAGEIDMALFORMED = "InvalidParameter.ImageIdMalformed" INVALIDPARAMETER_NOTIFICATIONEVENTNAMEDUPLICATE = "InvalidParameter.NotificationEventNameDuplicate" INVALIDPARAMETER_NOTIFICATIONTOPICNAME = "InvalidParameter.NotificationTopicName" INVALIDPARAMETER_NOTIFICATIONTOPICNAMETOOLONG = "InvalidParameter.NotificationTopicNameTooLong" INVALIDPARAMETERVALUE_COMPUTEENV = "InvalidParameterValue.ComputeEnv" INVALIDPARAMETERVALUE_INSTANCETYPE = "InvalidParameterValue.InstanceType" INVALIDPARAMETERVALUE_INVALIDDATATYPEANY = "InvalidParameterValue.InvalidDataTypeAny" INVALIDPARAMETERVALUE_LOCALPATH = "InvalidParameterValue.LocalPath" INVALIDPARAMETERVALUE_NEGATIVE = "InvalidParameterValue.Negative" INVALIDPARAMETERVALUE_REMOTESTORAGEPATH = "InvalidParameterValue.RemoteStoragePath" INVALIDPARAMETERVALUE_REMOTESTORAGESCHEMETYPE = "InvalidParameterValue.RemoteStorageSchemeType" INVALIDPARAMETERVALUE_UNAVAILABLEZONE = "InvalidParameterValue.UnavailableZone" INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion" LIMITEXCEEDED_COMPUTEENVQUOTA = "LimitExceeded.ComputeEnvQuota" LIMITEXCEEDED_CPUQUOTA = "LimitExceeded.CpuQuota" UNAUTHORIZEDOPERATION_USERNOTALLOWEDTOUSEBATCH = "UnauthorizedOperation.UserNotAllowedToUseBatch"
func (*Client) CreateTaskTemplate ¶
func (c *Client) CreateTaskTemplate(request *CreateTaskTemplateRequest) (response *CreateTaskTemplateResponse, err error)
CreateTaskTemplate This API is used to create a task template.
error code that may be returned:
ALLOWEDONEATTRIBUTEINENVIDANDCOMPUTEENV = "AllowedOneAttributeInEnvIdAndComputeEnv" INTERNALERROR = "InternalError" INTERNALERROR_CALLTAGAPI = "InternalError.CallTagAPI" INVALIDPARAMETER_CVMPARAMETERS = "InvalidParameter.CvmParameters" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" INVALIDPARAMETER_TASKNAME = "InvalidParameter.TaskName" INVALIDPARAMETER_TASKNAMETOOLONG = "InvalidParameter.TaskNameTooLong" INVALIDPARAMETER_TASKTEMPLATENAME = "InvalidParameter.TaskTemplateName" INVALIDPARAMETER_TASKTEMPLATENAMETOOLONG = "InvalidParameter.TaskTemplateNameTooLong" INVALIDPARAMETERVALUE_COMPUTEENV = "InvalidParameterValue.ComputeEnv" INVALIDPARAMETERVALUE_DEPENDENCENOTFOUNDTASKNAME = "InvalidParameterValue.DependenceNotFoundTaskName" INVALIDPARAMETERVALUE_DEPENDENCEUNFEASIBLE = "InvalidParameterValue.DependenceUnfeasible" INVALIDPARAMETERVALUE_LOCALPATH = "InvalidParameterValue.LocalPath" INVALIDPARAMETERVALUE_MAXRETRYCOUNT = "InvalidParameterValue.MaxRetryCount" INVALIDPARAMETERVALUE_NEGATIVE = "InvalidParameterValue.Negative" INVALIDPARAMETERVALUE_REMOTESTORAGEPATH = "InvalidParameterValue.RemoteStoragePath" INVALIDPARAMETERVALUE_REMOTESTORAGESCHEMETYPE = "InvalidParameterValue.RemoteStorageSchemeType" LIMITEXCEEDED_TASKTEMPLATEQUOTA = "LimitExceeded.TaskTemplateQuota"
func (*Client) DeleteComputeEnv ¶
func (c *Client) DeleteComputeEnv(request *DeleteComputeEnvRequest) (response *DeleteComputeEnvResponse, err error)
DeleteComputeEnv This API is used to delete a compute environment.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" UNSUPPORTEDOPERATION = "UnsupportedOperation" UNSUPPORTEDOPERATION_ACCEPTOTHERREQUEST = "UnsupportedOperation.AcceptOtherRequest" UNSUPPORTEDOPERATION_COMPUTEENVOPERATION = "UnsupportedOperation.ComputeEnvOperation" UNSUPPORTEDOPERATION_COMPUTENODEFORBIDTERMINATE = "UnsupportedOperation.ComputeNodeForbidTerminate"
func (*Client) DeleteJob ¶
func (c *Client) DeleteJob(request *DeleteJobRequest) (response *DeleteJobResponse, err error)
DeleteJob This API is used to delete a job.
Deleting a job is equivalent to deleting all the information related to the job. After successful deletion, all information related to the job cannot be queried.
The job to be deleted must be in a completed state, and all task instances contained in it must also be in a completed state; otherwise, the operation will be prohibited. The completed state can be either SUCCEED or FAILED.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" RESOURCEINUSE_JOB = "ResourceInUse.Job" RESOURCENOTFOUND_JOB = "ResourceNotFound.Job" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DeleteTaskTemplates ¶
func (c *Client) DeleteTaskTemplates(request *DeleteTaskTemplatesRequest) (response *DeleteTaskTemplatesResponse, err error)
DeleteTaskTemplates This API is used to delete task template information.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_TASKTEMPLATEIDMALFORMED = "InvalidParameter.TaskTemplateIdMalformed" RESOURCENOTFOUND_TASKTEMPLATE = "ResourceNotFound.TaskTemplate"
func (*Client) DescribeAvailableCvmInstanceTypes ¶
func (c *Client) DescribeAvailableCvmInstanceTypes(request *DescribeAvailableCvmInstanceTypesRequest) (response *DescribeAvailableCvmInstanceTypesResponse, err error)
DescribeAvailableCvmInstanceTypes This API is used to view the information of available CVM model configurations.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_CALLCVM = "InternalError.CallCvm" INVALIDFILTER = "InvalidFilter" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion"
func (*Client) DescribeComputeEnv ¶
func (c *Client) DescribeComputeEnv(request *DescribeComputeEnvRequest) (response *DescribeComputeEnvResponse, err error)
DescribeComputeEnv This API is used to query compute environment details.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv"
func (*Client) DescribeComputeEnvActivities ¶
func (c *Client) DescribeComputeEnvActivities(request *DescribeComputeEnvActivitiesRequest) (response *DescribeComputeEnvActivitiesResponse, err error)
DescribeComputeEnvActivities This API is used to query the information of activities in the compute environment.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_COMPUTENODEIDMALFORMED = "InvalidParameter.ComputeNodeIdMalformed" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" UNKNOWNPARAMETER = "UnknownParameter"
func (*Client) DescribeComputeEnvCreateInfo ¶
func (c *Client) DescribeComputeEnvCreateInfo(request *DescribeComputeEnvCreateInfoRequest) (response *DescribeComputeEnvCreateInfoResponse, err error)
DescribeComputeEnvCreateInfo Views compute environment creation information.
error code that may be returned:
INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv"
func (*Client) DescribeComputeEnvCreateInfos ¶
func (c *Client) DescribeComputeEnvCreateInfos(request *DescribeComputeEnvCreateInfosRequest) (response *DescribeComputeEnvCreateInfosResponse, err error)
DescribeComputeEnvCreateInfos This API is used to view the list of information of compute environment creation, including name, description, type, environment parameters, notifications, and number of desired nodes.
error code that may be returned:
INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" INVALIDPARAMETER_INVALIDPARAMETERCOMBINATION = "InvalidParameter.InvalidParameterCombination" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion" UNKNOWNPARAMETER = "UnknownParameter"
func (*Client) DescribeComputeEnvs ¶
func (c *Client) DescribeComputeEnvs(request *DescribeComputeEnvsRequest) (response *DescribeComputeEnvsResponse, err error)
DescribeComputeEnvs This API is used to view the list of compute environments.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDFILTER = "InvalidFilter" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" INVALIDPARAMETER_INVALIDPARAMETERCOMBINATION = "InvalidParameter.InvalidParameterCombination" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_RESOURCETYPE = "InvalidParameterValue.ResourceType" INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion" UNKNOWNPARAMETER = "UnknownParameter"
func (*Client) DescribeCvmZoneInstanceConfigInfos ¶
func (c *Client) DescribeCvmZoneInstanceConfigInfos(request *DescribeCvmZoneInstanceConfigInfosRequest) (response *DescribeCvmZoneInstanceConfigInfosResponse, err error)
DescribeCvmZoneInstanceConfigInfos This API is used to get the model configuration information of the availability zone of BatchCompute.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_CALLCVM = "InternalError.CallCvm" INVALIDFILTER = "InvalidFilter" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" INVALIDPARAMETERVALUE_UNSUPPORTEDBATCHINSTANCECHARGETYPE = "InvalidParameterValue.UnsupportedBatchInstanceChargeType" INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion"
func (*Client) DescribeInstanceCategories ¶
func (c *Client) DescribeInstanceCategories(request *DescribeInstanceCategoriesRequest) (response *DescribeInstanceCategoriesResponse, err error)
DescribeInstanceCategories Currently, CVM instance families are classified into different category, and each category contains several instance families. This API is used to query the instance category information.
error code that may be returned:
INTERNALERROR = "InternalError" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeJob ¶
func (c *Client) DescribeJob(request *DescribeJobRequest) (response *DescribeJobResponse, err error)
DescribeJob This API is used to view the details of a job, including internal task (Task) and dependency (Dependence) information.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" RESOURCENOTFOUND_JOB = "ResourceNotFound.Job"
func (*Client) DescribeJobSubmitInfo ¶
func (c *Client) DescribeJobSubmitInfo(request *DescribeJobSubmitInfoRequest) (response *DescribeJobSubmitInfoResponse, err error)
DescribeJobSubmitInfo This API is used to query the submission information of the specified job, with the return including the job submission information used as input parameters in the JobId and SubmitJob APIs.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" RESOURCENOTFOUND_JOB = "ResourceNotFound.Job"
func (*Client) DescribeJobs ¶
func (c *Client) DescribeJobs(request *DescribeJobsRequest) (response *DescribeJobsResponse, err error)
DescribeJobs This API is used to query the overview information of several instances.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDFILTER = "InvalidFilter" INVALIDPARAMETER_INVALIDPARAMETERCOMBINATION = "InvalidParameter.InvalidParameterCombination" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion" UNKNOWNPARAMETER = "UnknownParameter"
func (*Client) DescribeTask ¶
func (c *Client) DescribeTask(request *DescribeTaskRequest) (response *DescribeTaskResponse, err error)
DescribeTask This API is used to query the details of a specified task, including information of the task instances inside the task.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" RESOURCENOTFOUND_TASK = "ResourceNotFound.Task"
func (*Client) DescribeTaskLogs ¶
func (c *Client) DescribeTaskLogs(request *DescribeTaskLogsRequest) (response *DescribeTaskLogsResponse, err error)
DescribeTaskLogs This API is used to get the standard outputs and standard error logs of multiple task instances.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" INVALIDPARAMETER_TASKNAME = "InvalidParameter.TaskName" INVALIDPARAMETER_TASKNAMETOOLONG = "InvalidParameter.TaskNameTooLong" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_NEGATIVE = "InvalidParameterValue.Negative" RESOURCENOTFOUND_JOB = "ResourceNotFound.Job" RESOURCENOTFOUND_TASK = "ResourceNotFound.Task" RESOURCENOTFOUND_TASKINSTANCE = "ResourceNotFound.TaskInstance" UNKNOWNPARAMETER = "UnknownParameter"
func (*Client) DescribeTaskTemplates ¶
func (c *Client) DescribeTaskTemplates(request *DescribeTaskTemplatesRequest) (response *DescribeTaskTemplatesResponse, err error)
DescribeTaskTemplates This API is used to query the information of task templates.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPARAMETERCOMBINATION = "InvalidParameter.InvalidParameterCombination" INVALIDPARAMETER_TASKTEMPLATEIDMALFORMED = "InvalidParameter.TaskTemplateIdMalformed" INVALIDPARAMETERVALUE = "InvalidParameterValue" UNKNOWNPARAMETER = "UnknownParameter"
func (*Client) DetachInstances ¶
func (c *Client) DetachInstances(request *DetachInstancesRequest) (response *DetachInstancesResponse, err error)
DetachInstances This API is used to remove instances that from compute environment.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_CALLCVM = "InternalError.CallCvm" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" INVALIDPARAMETERVALUE_INSTANCEIDDUPLICATED = "InvalidParameterValue.InstanceIdDuplicated" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ModifyComputeEnv ¶
func (c *Client) ModifyComputeEnv(request *ModifyComputeEnvRequest) (response *ModifyComputeEnvResponse, err error)
ModifyComputeEnv This API is used to modify the attributes of a compute environment.
error code that may be returned:
INTERNALERROR = "InternalError" INTERNALERROR_CALLCPMAPI = "InternalError.CallCpmAPI" INVALIDPARAMETER_ENVDESCRIPTIONTOOLONG = "InvalidParameter.EnvDescriptionTooLong" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" INVALIDPARAMETER_ENVNAMETOOLONG = "InvalidParameter.EnvNameTooLong" INVALIDPARAMETERVALUE_INSTANCETYPE = "InvalidParameterValue.InstanceType" INVALIDPARAMETERVALUE_INSTANCETYPEDUPLICATE = "InvalidParameterValue.InstanceTypeDuplicate" INVALIDPARAMETERVALUE_INSTANCETYPESEMPTY = "InvalidParameterValue.InstanceTypesEmpty" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" INVALIDPARAMETERVALUE_NEGATIVE = "InvalidParameterValue.Negative" LIMITEXCEEDED_CPUQUOTA = "LimitExceeded.CpuQuota" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" UNSUPPORTEDOPERATION_ACCEPTOTHERREQUEST = "UnsupportedOperation.AcceptOtherRequest" UNSUPPORTEDOPERATION_COMPUTEENVACCEPTOTHERREQUEST = "UnsupportedOperation.ComputeEnvAcceptOtherRequest" UNSUPPORTEDOPERATION_COMPUTENODEFORBIDTERMINATE = "UnsupportedOperation.ComputeNodeForbidTerminate" UNSUPPORTEDOPERATION_NOTENOUGHCOMPUTENODESTOTERMINATE = "UnsupportedOperation.NotEnoughComputeNodesToTerminate"
func (*Client) ModifyTaskTemplate ¶
func (c *Client) ModifyTaskTemplate(request *ModifyTaskTemplateRequest) (response *ModifyTaskTemplateResponse, err error)
ModifyTaskTemplate This API is used to modify a task template.
error code that may be returned:
ALLOWEDONEATTRIBUTEINENVIDANDCOMPUTEENV = "AllowedOneAttributeInEnvIdAndComputeEnv" INTERNALERROR = "InternalError" INVALIDPARAMETER_CVMPARAMETERS = "InvalidParameter.CvmParameters" INVALIDPARAMETER_TASKNAME = "InvalidParameter.TaskName" INVALIDPARAMETER_TASKNAMETOOLONG = "InvalidParameter.TaskNameTooLong" INVALIDPARAMETER_TASKTEMPLATEDESCRIPTIONTOOLONG = "InvalidParameter.TaskTemplateDescriptionTooLong" INVALIDPARAMETER_TASKTEMPLATEIDMALFORMED = "InvalidParameter.TaskTemplateIdMalformed" INVALIDPARAMETER_TASKTEMPLATENAME = "InvalidParameter.TaskTemplateName" INVALIDPARAMETER_TASKTEMPLATENAMETOOLONG = "InvalidParameter.TaskTemplateNameTooLong" INVALIDPARAMETERATLEASTONEATTRIBUTE = "InvalidParameterAtLeastOneAttribute" INVALIDPARAMETERVALUE_COMPUTEENV = "InvalidParameterValue.ComputeEnv" INVALIDPARAMETERVALUE_DEPENDENCENOTFOUNDTASKNAME = "InvalidParameterValue.DependenceNotFoundTaskName" INVALIDPARAMETERVALUE_DEPENDENCEUNFEASIBLE = "InvalidParameterValue.DependenceUnfeasible" INVALIDPARAMETERVALUE_LOCALPATH = "InvalidParameterValue.LocalPath" INVALIDPARAMETERVALUE_MAXRETRYCOUNT = "InvalidParameterValue.MaxRetryCount" INVALIDPARAMETERVALUE_NEGATIVE = "InvalidParameterValue.Negative" INVALIDPARAMETERVALUE_REMOTESTORAGEPATH = "InvalidParameterValue.RemoteStoragePath" INVALIDPARAMETERVALUE_REMOTESTORAGESCHEMETYPE = "InvalidParameterValue.RemoteStorageSchemeType" RESOURCENOTFOUND_TASKTEMPLATE = "ResourceNotFound.TaskTemplate"
func (*Client) RetryJobs ¶
func (c *Client) RetryJobs(request *RetryJobsRequest) (response *RetryJobsResponse, err error)
RetryJobs This API is used to retry the failing task instance in instances.
Job retry is supported only if a job is in the "FAILED" state. After the retry operation succeeds, the instance will retry the failing task instances in each task in turn according to the task dependencies specified in the "DAG". The history information of the task instances will be reset, the instances will participate in subsequent scheduling and execution as if they are run for the first time.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" RESOURCENOTFOUND_JOB = "ResourceNotFound.Job" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) SubmitJob ¶
func (c *Client) SubmitJob(request *SubmitJobRequest) (response *SubmitJobResponse, err error)
SubmitJob This API is used to submit a instance.
error code that may be returned:
ALLOWEDONEATTRIBUTEINENVIDANDCOMPUTEENV = "AllowedOneAttributeInEnvIdAndComputeEnv" INTERNALERROR = "InternalError" INTERNALERROR_CALLCVM = "InternalError.CallCvm" INTERNALERROR_CALLTAGAPI = "InternalError.CallTagAPI" INVALIDPARAMETER_CVMPARAMETERS = "InvalidParameter.CvmParameters" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" INVALIDPARAMETER_IMAGEIDMALFORMED = "InvalidParameter.ImageIdMalformed" INVALIDPARAMETER_INVALIDPARAMETERCOMBINATION = "InvalidParameter.InvalidParameterCombination" INVALIDPARAMETER_JOBDESCRIPTIONTOOLONG = "InvalidParameter.JobDescriptionTooLong" INVALIDPARAMETER_JOBNAMETOOLONG = "InvalidParameter.JobNameTooLong" INVALIDPARAMETER_NOTIFICATIONEVENTNAMEDUPLICATE = "InvalidParameter.NotificationEventNameDuplicate" INVALIDPARAMETER_NOTIFICATIONTOPICNAME = "InvalidParameter.NotificationTopicName" INVALIDPARAMETER_NOTIFICATIONTOPICNAMETOOLONG = "InvalidParameter.NotificationTopicNameTooLong" INVALIDPARAMETER_TASKNAME = "InvalidParameter.TaskName" INVALIDPARAMETER_TASKNAMETOOLONG = "InvalidParameter.TaskNameTooLong" INVALIDPARAMETERVALUE_COMPUTEENV = "InvalidParameterValue.ComputeEnv" INVALIDPARAMETERVALUE_DEPENDENCENOTFOUNDTASKNAME = "InvalidParameterValue.DependenceNotFoundTaskName" INVALIDPARAMETERVALUE_DEPENDENCEUNFEASIBLE = "InvalidParameterValue.DependenceUnfeasible" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" INVALIDPARAMETERVALUE_LOCALPATH = "InvalidParameterValue.LocalPath" INVALIDPARAMETERVALUE_MAXRETRYCOUNT = "InvalidParameterValue.MaxRetryCount" INVALIDPARAMETERVALUE_NEGATIVE = "InvalidParameterValue.Negative" INVALIDPARAMETERVALUE_NOTFLOAT = "InvalidParameterValue.NotFloat" INVALIDPARAMETERVALUE_REMOTESTORAGEPATH = "InvalidParameterValue.RemoteStoragePath" INVALIDPARAMETERVALUE_REMOTESTORAGESCHEMETYPE = "InvalidParameterValue.RemoteStorageSchemeType" INVALIDZONE_MISMATCHREGION = "InvalidZone.MismatchRegion" LIMITEXCEEDED_JOBQUOTA = "LimitExceeded.JobQuota" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" UNAUTHORIZEDOPERATION_USERNOTALLOWEDTOUSEBATCH = "UnauthorizedOperation.UserNotAllowedToUseBatch"
func (*Client) TerminateComputeNode ¶
func (c *Client) TerminateComputeNode(request *TerminateComputeNodeRequest) (response *TerminateComputeNodeResponse, err error)
TerminateComputeNode This API is used to terminate a compute node.
Termination is allowed for nodes in the CREATED, CREATION_FAILED, RUNNING or ABNORMAL state.
error code that may be returned:
INVALIDPARAMETER_COMPUTENODEIDMALFORMED = "InvalidParameter.ComputeNodeIdMalformed" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" RESOURCENOTFOUND_COMPUTENODE = "ResourceNotFound.ComputeNode" UNSUPPORTEDOPERATION_ACCEPTOTHERREQUEST = "UnsupportedOperation.AcceptOtherRequest" UNSUPPORTEDOPERATION_COMPUTEENVACCEPTOTHERREQUEST = "UnsupportedOperation.ComputeEnvAcceptOtherRequest" UNSUPPORTEDOPERATION_COMPUTENODEFORBIDTERMINATE = "UnsupportedOperation.ComputeNodeForbidTerminate" UNSUPPORTEDOPERATION_COMPUTENODEISTERMINATING = "UnsupportedOperation.ComputeNodeIsTerminating"
func (*Client) TerminateComputeNodes ¶
func (c *Client) TerminateComputeNodes(request *TerminateComputeNodesRequest) (response *TerminateComputeNodesResponse, err error)
TerminateComputeNodes This API is used to terminate compute nodes in batches. It is not allowed to repeatedly terminate the same node.
error code that may be returned:
INVALIDPARAMETER_COMPUTENODEIDMALFORMED = "InvalidParameter.ComputeNodeIdMalformed" INVALIDPARAMETER_ENVIDMALFORMED = "InvalidParameter.EnvIdMalformed" RESOURCENOTFOUND_COMPUTEENV = "ResourceNotFound.ComputeEnv" RESOURCENOTFOUND_COMPUTENODE = "ResourceNotFound.ComputeNode" UNSUPPORTEDOPERATION_ACCEPTOTHERREQUEST = "UnsupportedOperation.AcceptOtherRequest" UNSUPPORTEDOPERATION_COMPUTEENVACCEPTOTHERREQUEST = "UnsupportedOperation.ComputeEnvAcceptOtherRequest" UNSUPPORTEDOPERATION_COMPUTENODEFORBIDTERMINATE = "UnsupportedOperation.ComputeNodeForbidTerminate"
func (*Client) TerminateJob ¶
func (c *Client) TerminateJob(request *TerminateJobRequest) (response *TerminateJobResponse, err error)
TerminateJob This API is used to terminate an instance.
Termination is prohibited if an instance is in the "SUBMITTED" state and does not take effect if it is in the "SUCCEED" state.
Instance termination is an asynchronous process, and the time it takes to complete the entire process is directly proportional to the total number of tasks. The effect of terminating an instance is equivalent to performing the TerminateTaskInstance operation on all the task instances contained in the job. For more information on the specific effect and usage, see TerminateTaskInstance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" RESOURCENOTFOUND_JOB = "ResourceNotFound.Job" UNSUPPORTEDOPERATION = "UnsupportedOperation" UNSUPPORTEDOPERATION_TERMINATEOPERATIONWITHENVID = "UnsupportedOperation.TerminateOperationWithEnvId"
func (*Client) TerminateTaskInstance ¶
func (c *Client) TerminateTaskInstance(request *TerminateTaskInstanceRequest) (response *TerminateTaskInstanceResponse, err error)
TerminateTaskInstance This API is used to terminate a task instance.
Task instances in the "SUCCEED" or "FAILED" state will not be processed.
Task instances in the "SUBMITTED", "PENDING", or "RUNNABLE" state will be set to the "FAILED" state.
For task instances in the "STARTING", "RUNNING", or "FAILED_INTERRUPTED" state, there will be two cases: if no compute environment is specified, the CVM instance will be terminated first, and then the state will be set to "FAILED"; if a compute environment's EnvId is specified, the state of the task instances will be set to "FAILED" first, and then the CVM instance that performs the task will be restarted. Both cases takes a certain amount of time to be completed.
For task instances in the "FAILED_INTERRUPTED" state, the related resources and quotas will be released only after the termination actually succeeds.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_JOBIDMALFORMED = "InvalidParameter.JobIdMalformed" RESOURCENOTFOUND_TASKINSTANCE = "ResourceNotFound.TaskInstance" UNSUPPORTEDOPERATION_TERMINATEOPERATIONWITHENVID = "UnsupportedOperation.TerminateOperationWithEnvId"
type ComputeEnvCreateInfo ¶
type ComputeEnvCreateInfo struct { // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Compute environment name // Note: This field may return null, indicating that no valid values can be obtained. EnvName *string `json:"EnvName,omitempty" name:"EnvName"` // Compute environment description // Note: This field may return null, indicating that no valid values can be obtained. EnvDescription *string `json:"EnvDescription,omitempty" name:"EnvDescription"` // Compute environment type. Only "MANAGED" type is supported EnvType *string `json:"EnvType,omitempty" name:"EnvType"` // Compute environment parameter EnvData *EnvData `json:"EnvData,omitempty" name:"EnvData"` // Data disk mounting option // Note: This field may return null, indicating that no valid values can be obtained. MountDataDisks []*MountDataDisk `json:"MountDataDisks,omitempty" name:"MountDataDisks"` // Input mapping // Note: This field may return null, indicating that no valid values can be obtained. InputMappings []*InputMapping `json:"InputMappings,omitempty" name:"InputMappings"` // Authorization information // Note: This field may return null, indicating that no valid values can be obtained. Authentications []*Authentication `json:"Authentications,omitempty" name:"Authentications"` // Notification information // Note: This field may return null, indicating that no valid values can be obtained. Notifications []*Notification `json:"Notifications,omitempty" name:"Notifications"` // Number of desired compute nodes DesiredComputeNodeCount *uint64 `json:"DesiredComputeNodeCount,omitempty" name:"DesiredComputeNodeCount"` // Tag list of the compute environment. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
type ComputeEnvData ¶
type ComputeEnvData struct { // List of CVM instance types InstanceTypes []*string `json:"InstanceTypes,omitempty" name:"InstanceTypes"` }
type ComputeEnvView ¶
type ComputeEnvView struct { // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Compute environment name EnvName *string `json:"EnvName,omitempty" name:"EnvName"` // Location information Placement *Placement `json:"Placement,omitempty" name:"Placement"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Compute node statistical metrics ComputeNodeMetrics *ComputeNodeMetrics `json:"ComputeNodeMetrics,omitempty" name:"ComputeNodeMetrics"` // Compute environment type EnvType *string `json:"EnvType,omitempty" name:"EnvType"` // Number of desired compute nodes DesiredComputeNodeCount *uint64 `json:"DesiredComputeNodeCount,omitempty" name:"DesiredComputeNodeCount"` // Compute environment resource type. Valid values: `CVM`, `CPM` (Bare Metal) ResourceType *string `json:"ResourceType,omitempty" name:"ResourceType"` // Next action NextAction *string `json:"NextAction,omitempty" name:"NextAction"` // Number of compute nodes added to the compute environment by the user AttachedComputeNodeCount *uint64 `json:"AttachedComputeNodeCount,omitempty" name:"AttachedComputeNodeCount"` // Tag list bound to the compute environment. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
type ComputeNode ¶
type ComputeNode struct { // Compute node ID ComputeNodeId *string `json:"ComputeNodeId,omitempty" name:"ComputeNodeId"` // Compute node instance ID. In a CVM scenario, this parameter is the CVM InstanceId ComputeNodeInstanceId *string `json:"ComputeNodeInstanceId,omitempty" name:"ComputeNodeInstanceId"` // Compute node state ComputeNodeState *string `json:"ComputeNodeState,omitempty" name:"ComputeNodeState"` // Number of CPU cores Cpu *uint64 `json:"Cpu,omitempty" name:"Cpu"` // Memory size in GiB Mem *uint64 `json:"Mem,omitempty" name:"Mem"` // Resource creation time ResourceCreatedTime *string `json:"ResourceCreatedTime,omitempty" name:"ResourceCreatedTime"` // Available capacity of the compute node when running TaskInstance. 0 means that the compute node is busy. TaskInstanceNumAvailable *uint64 `json:"TaskInstanceNumAvailable,omitempty" name:"TaskInstanceNumAvailable"` // BatchCompute Agent version AgentVersion *string `json:"AgentVersion,omitempty" name:"AgentVersion"` // Private IP of the instance PrivateIpAddresses []*string `json:"PrivateIpAddresses,omitempty" name:"PrivateIpAddresses"` // Public IP of the instance PublicIpAddresses []*string `json:"PublicIpAddresses,omitempty" name:"PublicIpAddresses"` // Compute environment resource type. Valid values: `CVM`, `CPM` (Bare Metal) ResourceType *string `json:"ResourceType,omitempty" name:"ResourceType"` // Source of compute environment resources. <br>BATCH_CREATED: instance resources created by BatchCompute.<br> // USER_ATTACHED: instance resources added by users to the compute environment. ResourceOrigin *string `json:"ResourceOrigin,omitempty" name:"ResourceOrigin"` }
type ComputeNodeMetrics ¶
type ComputeNodeMetrics struct { // Number of compute nodes that have been submitted SubmittedCount *uint64 `json:"SubmittedCount,omitempty" name:"SubmittedCount"` // Number of compute nodes that are being created CreatingCount *uint64 `json:"CreatingCount,omitempty" name:"CreatingCount"` // Number of compute nodes that failed to be created CreationFailedCount *uint64 `json:"CreationFailedCount,omitempty" name:"CreationFailedCount"` // Number of compute nodes that have been created CreatedCount *uint64 `json:"CreatedCount,omitempty" name:"CreatedCount"` // Number of running compute nodes RunningCount *uint64 `json:"RunningCount,omitempty" name:"RunningCount"` // Number of compute nodes that are being terminated DeletingCount *uint64 `json:"DeletingCount,omitempty" name:"DeletingCount"` // Number of exceptional compute nodes AbnormalCount *uint64 `json:"AbnormalCount,omitempty" name:"AbnormalCount"` }
type CreateComputeEnvRequest ¶
type CreateComputeEnvRequest struct { *tchttp.BaseRequest // Compute environment information ComputeEnv *NamedComputeEnv `json:"ComputeEnv,omitempty" name:"ComputeEnv"` // Location information Placement *Placement `json:"Placement,omitempty" name:"Placement"` // The string used to guarantee the idempotency of the request, which is generated by the user and must be unique for different requests. The maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed. ClientToken *string `json:"ClientToken,omitempty" name:"ClientToken"` }
func NewCreateComputeEnvRequest ¶
func NewCreateComputeEnvRequest() (request *CreateComputeEnvRequest)
func (*CreateComputeEnvRequest) FromJsonString ¶
func (r *CreateComputeEnvRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateComputeEnvRequest) ToJsonString ¶
func (r *CreateComputeEnvRequest) ToJsonString() string
type CreateComputeEnvResponse ¶
type CreateComputeEnvResponse struct { *tchttp.BaseResponse Response *struct { // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateComputeEnvResponse ¶
func NewCreateComputeEnvResponse() (response *CreateComputeEnvResponse)
func (*CreateComputeEnvResponse) FromJsonString ¶
func (r *CreateComputeEnvResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateComputeEnvResponse) ToJsonString ¶
func (r *CreateComputeEnvResponse) ToJsonString() string
type CreateTaskTemplateRequest ¶
type CreateTaskTemplateRequest struct { *tchttp.BaseRequest // Task template name TaskTemplateName *string `json:"TaskTemplateName,omitempty" name:"TaskTemplateName"` // Task template content with the same parameter requirements as the task TaskTemplateInfo *Task `json:"TaskTemplateInfo,omitempty" name:"TaskTemplateInfo"` // Task template description TaskTemplateDescription *string `json:"TaskTemplateDescription,omitempty" name:"TaskTemplateDescription"` // Tag list. By setting this parameter, you can bind tags to a task template. Each task template supports up to 10 tags. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
func NewCreateTaskTemplateRequest ¶
func NewCreateTaskTemplateRequest() (request *CreateTaskTemplateRequest)
func (*CreateTaskTemplateRequest) FromJsonString ¶
func (r *CreateTaskTemplateRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateTaskTemplateRequest) ToJsonString ¶
func (r *CreateTaskTemplateRequest) ToJsonString() string
type CreateTaskTemplateResponse ¶
type CreateTaskTemplateResponse struct { *tchttp.BaseResponse Response *struct { // Task template ID TaskTemplateId *string `json:"TaskTemplateId,omitempty" name:"TaskTemplateId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateTaskTemplateResponse ¶
func NewCreateTaskTemplateResponse() (response *CreateTaskTemplateResponse)
func (*CreateTaskTemplateResponse) FromJsonString ¶
func (r *CreateTaskTemplateResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateTaskTemplateResponse) ToJsonString ¶
func (r *CreateTaskTemplateResponse) ToJsonString() string
type DataDisk ¶
type DataDisk struct { // Data disk size (in GB). The minimum adjustment increment is 10 GB. The value range varies by data disk type. For more information on limits, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation. DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"` // Data disk type. For more information about limits on different data disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). Valid values: <br><li>LOCAL_BASIC: local disk<br><li>LOCAL_SSD: local SSD disk<br><li>LOCAL_NVME: local NVME disk, specified in the `InstanceType`<br><li>LOCAL_PRO: local HDD disk, specified in the `InstanceType`<br><li>CLOUD_BASIC: HDD cloud disk<br><li>CLOUD_PREMIUM: Premium Cloud Storage<br><li>CLOUD_SSD: SSD<br><li>CLOUD_HSSD: Enhanced SSD<br><li>CLOUD_TSSD: Tremendous SSD<br><br>Default value: LOCAL_BASIC.<br><br>This parameter is invalid for the `ResizeInstanceDisk` API. DiskType *string `json:"DiskType,omitempty" name:"DiskType"` // Data disk ID. Data disks of the type `LOCAL_BASIC` or `LOCAL_SSD` do not have IDs and do not support this parameter. DiskId *string `json:"DiskId,omitempty" name:"DiskId"` // Whether to terminate the data disk when its CVM is terminated. Valid values: // <li>TRUE: terminate the data disk when its CVM is terminated. This value only supports pay-as-you-go cloud disks billed on an hourly basis. // <li>FALSE: retain the data disk when its CVM is terminated.<br> // Default value: TRUE<br> // Currently this parameter is only used in the `RunInstances` API. // Note: This field may return null, indicating that no valid value is found. DeleteWithInstance *bool `json:"DeleteWithInstance,omitempty" name:"DeleteWithInstance"` // Data disk snapshot ID. The size of the selected data disk snapshot must be smaller than that of the data disk. // Note: This field may return null, indicating that no valid value is found. SnapshotId *string `json:"SnapshotId,omitempty" name:"SnapshotId"` // Specifies whether the data disk is encrypted. Valid values: // <li>TRUE: encrypted // <li>FALSE: not encrypted<br> // Default value: FALSE<br> // This parameter is only used with `RunInstances`. // Note: this field may return `null`, indicating that no valid value is obtained. Encrypt *bool `json:"Encrypt,omitempty" name:"Encrypt"` // ID of the custom CMK in the format of UUID or “kms-abcd1234”. This parameter is used to encrypt cloud disks. // // Currently, this parameter is only used in the `RunInstances` API. // Note: this field may return null, indicating that no valid values can be obtained. KmsKeyId *string `json:"KmsKeyId,omitempty" name:"KmsKeyId"` // Cloud disk performance, in MB/s // Note: this field may return `null`, indicating that no valid values can be obtained. ThroughputPerformance *int64 `json:"ThroughputPerformance,omitempty" name:"ThroughputPerformance"` // ID of the dedicated cluster to which the instance belongs. // Note: this field may return `null`, indicating that no valid values can be obtained. CdcId *string `json:"CdcId,omitempty" name:"CdcId"` }
type DeleteComputeEnvRequest ¶
type DeleteComputeEnvRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` }
func NewDeleteComputeEnvRequest ¶
func NewDeleteComputeEnvRequest() (request *DeleteComputeEnvRequest)
func (*DeleteComputeEnvRequest) FromJsonString ¶
func (r *DeleteComputeEnvRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteComputeEnvRequest) ToJsonString ¶
func (r *DeleteComputeEnvRequest) ToJsonString() string
type DeleteComputeEnvResponse ¶
type DeleteComputeEnvResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteComputeEnvResponse ¶
func NewDeleteComputeEnvResponse() (response *DeleteComputeEnvResponse)
func (*DeleteComputeEnvResponse) FromJsonString ¶
func (r *DeleteComputeEnvResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteComputeEnvResponse) ToJsonString ¶
func (r *DeleteComputeEnvResponse) ToJsonString() string
type DeleteJobRequest ¶
type DeleteJobRequest struct { *tchttp.BaseRequest // Job ID JobId *string `json:"JobId,omitempty" name:"JobId"` }
func NewDeleteJobRequest ¶
func NewDeleteJobRequest() (request *DeleteJobRequest)
func (*DeleteJobRequest) FromJsonString ¶
func (r *DeleteJobRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteJobRequest) ToJsonString ¶
func (r *DeleteJobRequest) ToJsonString() string
type DeleteJobResponse ¶
type DeleteJobResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteJobResponse ¶
func NewDeleteJobResponse() (response *DeleteJobResponse)
func (*DeleteJobResponse) FromJsonString ¶
func (r *DeleteJobResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteJobResponse) ToJsonString ¶
func (r *DeleteJobResponse) ToJsonString() string
type DeleteTaskTemplatesRequest ¶
type DeleteTaskTemplatesRequest struct { *tchttp.BaseRequest // This API is used to delete task template information. TaskTemplateIds []*string `json:"TaskTemplateIds,omitempty" name:"TaskTemplateIds"` }
func NewDeleteTaskTemplatesRequest ¶
func NewDeleteTaskTemplatesRequest() (request *DeleteTaskTemplatesRequest)
func (*DeleteTaskTemplatesRequest) FromJsonString ¶
func (r *DeleteTaskTemplatesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteTaskTemplatesRequest) ToJsonString ¶
func (r *DeleteTaskTemplatesRequest) ToJsonString() string
type DeleteTaskTemplatesResponse ¶
type DeleteTaskTemplatesResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteTaskTemplatesResponse ¶
func NewDeleteTaskTemplatesResponse() (response *DeleteTaskTemplatesResponse)
func (*DeleteTaskTemplatesResponse) FromJsonString ¶
func (r *DeleteTaskTemplatesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteTaskTemplatesResponse) ToJsonString ¶
func (r *DeleteTaskTemplatesResponse) ToJsonString() string
type Dependence ¶
type DescribeAvailableCvmInstanceTypesRequest ¶
type DescribeAvailableCvmInstanceTypesRequest struct { *tchttp.BaseRequest // Filter. // <li> zone - String - Required: No - (Filter) Filter by availability zone.</li> // <li> instance-family - String - Required: No - (Filter) Filter by model family such as S1, I1, and M1.</li> Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeAvailableCvmInstanceTypesRequest ¶
func NewDescribeAvailableCvmInstanceTypesRequest() (request *DescribeAvailableCvmInstanceTypesRequest)
func (*DescribeAvailableCvmInstanceTypesRequest) FromJsonString ¶
func (r *DescribeAvailableCvmInstanceTypesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAvailableCvmInstanceTypesRequest) ToJsonString ¶
func (r *DescribeAvailableCvmInstanceTypesRequest) ToJsonString() string
type DescribeAvailableCvmInstanceTypesResponse ¶
type DescribeAvailableCvmInstanceTypesResponse struct { *tchttp.BaseResponse Response *struct { // Array of model configurations InstanceTypeConfigSet []*InstanceTypeConfig `json:"InstanceTypeConfigSet,omitempty" name:"InstanceTypeConfigSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeAvailableCvmInstanceTypesResponse ¶
func NewDescribeAvailableCvmInstanceTypesResponse() (response *DescribeAvailableCvmInstanceTypesResponse)
func (*DescribeAvailableCvmInstanceTypesResponse) FromJsonString ¶
func (r *DescribeAvailableCvmInstanceTypesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAvailableCvmInstanceTypesResponse) ToJsonString ¶
func (r *DescribeAvailableCvmInstanceTypesResponse) ToJsonString() string
type DescribeComputeEnvActivitiesRequest ¶
type DescribeComputeEnvActivitiesRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Offset Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Filter // <li> compute-node-id - String - Required: No - (Filter) Filter by compute node ID.</li> Filters *Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeComputeEnvActivitiesRequest ¶
func NewDescribeComputeEnvActivitiesRequest() (request *DescribeComputeEnvActivitiesRequest)
func (*DescribeComputeEnvActivitiesRequest) FromJsonString ¶
func (r *DescribeComputeEnvActivitiesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvActivitiesRequest) ToJsonString ¶
func (r *DescribeComputeEnvActivitiesRequest) ToJsonString() string
type DescribeComputeEnvActivitiesResponse ¶
type DescribeComputeEnvActivitiesResponse struct { *tchttp.BaseResponse Response *struct { // List of activities in the compute environment ActivitySet []*Activity `json:"ActivitySet,omitempty" name:"ActivitySet"` // Number of activities TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeComputeEnvActivitiesResponse ¶
func NewDescribeComputeEnvActivitiesResponse() (response *DescribeComputeEnvActivitiesResponse)
func (*DescribeComputeEnvActivitiesResponse) FromJsonString ¶
func (r *DescribeComputeEnvActivitiesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvActivitiesResponse) ToJsonString ¶
func (r *DescribeComputeEnvActivitiesResponse) ToJsonString() string
type DescribeComputeEnvCreateInfoRequest ¶
type DescribeComputeEnvCreateInfoRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` }
func NewDescribeComputeEnvCreateInfoRequest ¶
func NewDescribeComputeEnvCreateInfoRequest() (request *DescribeComputeEnvCreateInfoRequest)
func (*DescribeComputeEnvCreateInfoRequest) FromJsonString ¶
func (r *DescribeComputeEnvCreateInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvCreateInfoRequest) ToJsonString ¶
func (r *DescribeComputeEnvCreateInfoRequest) ToJsonString() string
type DescribeComputeEnvCreateInfoResponse ¶
type DescribeComputeEnvCreateInfoResponse struct { *tchttp.BaseResponse Response *struct { // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Compute environment name EnvName *string `json:"EnvName,omitempty" name:"EnvName"` // Compute environment description // Note: This field may return null, indicating that no valid values can be obtained. EnvDescription *string `json:"EnvDescription,omitempty" name:"EnvDescription"` // Compute environment type. Only "MANAGED" type is supported EnvType *string `json:"EnvType,omitempty" name:"EnvType"` // Compute environment parameter EnvData *EnvData `json:"EnvData,omitempty" name:"EnvData"` // Data disk mounting option MountDataDisks []*MountDataDisk `json:"MountDataDisks,omitempty" name:"MountDataDisks"` // Input mapping InputMappings []*InputMapping `json:"InputMappings,omitempty" name:"InputMappings"` // Authorization information Authentications []*Authentication `json:"Authentications,omitempty" name:"Authentications"` // Notification information Notifications []*Notification `json:"Notifications,omitempty" name:"Notifications"` // Number of desired compute nodes DesiredComputeNodeCount *int64 `json:"DesiredComputeNodeCount,omitempty" name:"DesiredComputeNodeCount"` // Tag list bound to the compute environment. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeComputeEnvCreateInfoResponse ¶
func NewDescribeComputeEnvCreateInfoResponse() (response *DescribeComputeEnvCreateInfoResponse)
func (*DescribeComputeEnvCreateInfoResponse) FromJsonString ¶
func (r *DescribeComputeEnvCreateInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvCreateInfoResponse) ToJsonString ¶
func (r *DescribeComputeEnvCreateInfoResponse) ToJsonString() string
type DescribeComputeEnvCreateInfosRequest ¶
type DescribeComputeEnvCreateInfosRequest struct { *tchttp.BaseRequest // Compute environment ID EnvIds []*string `json:"EnvIds,omitempty" name:"EnvIds"` // Filter // <li> zone - String - Required: No - (Filter) Filter by availability zone.</li> // <li> env-id - String - Required: No - (Filter) Filter by compute environment ID.</li> // <li> env-name - String - Required: No - (Filter) Filter by compute environment name.</li> Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Offset Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results Limit *uint64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeComputeEnvCreateInfosRequest ¶
func NewDescribeComputeEnvCreateInfosRequest() (request *DescribeComputeEnvCreateInfosRequest)
func (*DescribeComputeEnvCreateInfosRequest) FromJsonString ¶
func (r *DescribeComputeEnvCreateInfosRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvCreateInfosRequest) ToJsonString ¶
func (r *DescribeComputeEnvCreateInfosRequest) ToJsonString() string
type DescribeComputeEnvCreateInfosResponse ¶
type DescribeComputeEnvCreateInfosResponse struct { *tchttp.BaseResponse Response *struct { // Number of compute environments TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // List of compute environment creation information ComputeEnvCreateInfoSet []*ComputeEnvCreateInfo `json:"ComputeEnvCreateInfoSet,omitempty" name:"ComputeEnvCreateInfoSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeComputeEnvCreateInfosResponse ¶
func NewDescribeComputeEnvCreateInfosResponse() (response *DescribeComputeEnvCreateInfosResponse)
func (*DescribeComputeEnvCreateInfosResponse) FromJsonString ¶
func (r *DescribeComputeEnvCreateInfosResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvCreateInfosResponse) ToJsonString ¶
func (r *DescribeComputeEnvCreateInfosResponse) ToJsonString() string
type DescribeComputeEnvRequest ¶
type DescribeComputeEnvRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` }
func NewDescribeComputeEnvRequest ¶
func NewDescribeComputeEnvRequest() (request *DescribeComputeEnvRequest)
func (*DescribeComputeEnvRequest) FromJsonString ¶
func (r *DescribeComputeEnvRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvRequest) ToJsonString ¶
func (r *DescribeComputeEnvRequest) ToJsonString() string
type DescribeComputeEnvResponse ¶
type DescribeComputeEnvResponse struct { *tchttp.BaseResponse Response *struct { // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Compute environment name EnvName *string `json:"EnvName,omitempty" name:"EnvName"` // Location information Placement *Placement `json:"Placement,omitempty" name:"Placement"` // Compute environment creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // List of compute nodes ComputeNodeSet []*ComputeNode `json:"ComputeNodeSet,omitempty" name:"ComputeNodeSet"` // Compute node statistical metrics ComputeNodeMetrics *ComputeNodeMetrics `json:"ComputeNodeMetrics,omitempty" name:"ComputeNodeMetrics"` // Number of desired compute nodes DesiredComputeNodeCount *uint64 `json:"DesiredComputeNodeCount,omitempty" name:"DesiredComputeNodeCount"` // Compute environment type EnvType *string `json:"EnvType,omitempty" name:"EnvType"` // Compute environment resource type. Valid values: CVM, CPM (Bare Metal) ResourceType *string `json:"ResourceType,omitempty" name:"ResourceType"` // Next action NextAction *string `json:"NextAction,omitempty" name:"NextAction"` // Number of compute nodes added to the compute environment by the user AttachedComputeNodeCount *uint64 `json:"AttachedComputeNodeCount,omitempty" name:"AttachedComputeNodeCount"` // Tag list bound to the compute environment. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeComputeEnvResponse ¶
func NewDescribeComputeEnvResponse() (response *DescribeComputeEnvResponse)
func (*DescribeComputeEnvResponse) FromJsonString ¶
func (r *DescribeComputeEnvResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvResponse) ToJsonString ¶
func (r *DescribeComputeEnvResponse) ToJsonString() string
type DescribeComputeEnvsRequest ¶
type DescribeComputeEnvsRequest struct { *tchttp.BaseRequest // Compute environment ID EnvIds []*string `json:"EnvIds,omitempty" name:"EnvIds"` // Filter. // <li> `zone` - String - Optional - Filter by availability zone.</li> // <li> `env-id` - String - Optional - Filter by compute environment ID.</li> // <li> `env-name` - String - Optional - Filter by compute environment name.</li> // <li> `resource-type` - String - Optional - Filter by compute resource type, which can be CVM or CPM (BM).</li> // <li> `tag-key` - String - Optional - Filter by tag key.</li> // </li>`tag-value` - String - Optional - Filter by tag value.</li> // <li> `tag:tag-key` - String - Optional - Filter by tag key-value pair. The tag-key should be replaced by a specified tag key.</li> // It cannot be specified together with the `EnvIds` parameter. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Offset Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results Limit *uint64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeComputeEnvsRequest ¶
func NewDescribeComputeEnvsRequest() (request *DescribeComputeEnvsRequest)
func (*DescribeComputeEnvsRequest) FromJsonString ¶
func (r *DescribeComputeEnvsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvsRequest) ToJsonString ¶
func (r *DescribeComputeEnvsRequest) ToJsonString() string
type DescribeComputeEnvsResponse ¶
type DescribeComputeEnvsResponse struct { *tchttp.BaseResponse Response *struct { // List of compute environments ComputeEnvSet []*ComputeEnvView `json:"ComputeEnvSet,omitempty" name:"ComputeEnvSet"` // Number of compute environments TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeComputeEnvsResponse ¶
func NewDescribeComputeEnvsResponse() (response *DescribeComputeEnvsResponse)
func (*DescribeComputeEnvsResponse) FromJsonString ¶
func (r *DescribeComputeEnvsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeComputeEnvsResponse) ToJsonString ¶
func (r *DescribeComputeEnvsResponse) ToJsonString() string
type DescribeCvmZoneInstanceConfigInfosRequest ¶
type DescribeCvmZoneInstanceConfigInfosRequest struct { *tchttp.BaseRequest // Filter. // <li> zone - String - Required: No - (Filter) Filter by availability zone.</li> // <li> instance-family - String - Required: No - (Filter) Filter by model family such as S1, I1, and M1.</li> // <li> instance-type - String - Required: No - (Filter) Filter by model.</li> // <li> instance-charge-type - String - Required: No - (Filter) Filter by instance billing method. ( POSTPAID_BY_HOUR: pay-as-you-go | SPOTPAID: bidding.) </li> Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeCvmZoneInstanceConfigInfosRequest ¶
func NewDescribeCvmZoneInstanceConfigInfosRequest() (request *DescribeCvmZoneInstanceConfigInfosRequest)
func (*DescribeCvmZoneInstanceConfigInfosRequest) FromJsonString ¶
func (r *DescribeCvmZoneInstanceConfigInfosRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeCvmZoneInstanceConfigInfosRequest) ToJsonString ¶
func (r *DescribeCvmZoneInstanceConfigInfosRequest) ToJsonString() string
type DescribeCvmZoneInstanceConfigInfosResponse ¶
type DescribeCvmZoneInstanceConfigInfosResponse struct { *tchttp.BaseResponse Response *struct { // List of model configurations in the availability zone. InstanceTypeQuotaSet []*InstanceTypeQuotaItem `json:"InstanceTypeQuotaSet,omitempty" name:"InstanceTypeQuotaSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeCvmZoneInstanceConfigInfosResponse ¶
func NewDescribeCvmZoneInstanceConfigInfosResponse() (response *DescribeCvmZoneInstanceConfigInfosResponse)
func (*DescribeCvmZoneInstanceConfigInfosResponse) FromJsonString ¶
func (r *DescribeCvmZoneInstanceConfigInfosResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeCvmZoneInstanceConfigInfosResponse) ToJsonString ¶
func (r *DescribeCvmZoneInstanceConfigInfosResponse) ToJsonString() string
type DescribeInstanceCategoriesRequest ¶
type DescribeInstanceCategoriesRequest struct {
*tchttp.BaseRequest
}
func NewDescribeInstanceCategoriesRequest ¶
func NewDescribeInstanceCategoriesRequest() (request *DescribeInstanceCategoriesRequest)
func (*DescribeInstanceCategoriesRequest) FromJsonString ¶
func (r *DescribeInstanceCategoriesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeInstanceCategoriesRequest) ToJsonString ¶
func (r *DescribeInstanceCategoriesRequest) ToJsonString() string
type DescribeInstanceCategoriesResponse ¶
type DescribeInstanceCategoriesResponse struct { *tchttp.BaseResponse Response *struct { // List of CVM instance categories InstanceCategorySet []*InstanceCategoryItem `json:"InstanceCategorySet,omitempty" name:"InstanceCategorySet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeInstanceCategoriesResponse ¶
func NewDescribeInstanceCategoriesResponse() (response *DescribeInstanceCategoriesResponse)
func (*DescribeInstanceCategoriesResponse) FromJsonString ¶
func (r *DescribeInstanceCategoriesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeInstanceCategoriesResponse) ToJsonString ¶
func (r *DescribeInstanceCategoriesResponse) ToJsonString() string
type DescribeJobRequest ¶
type DescribeJobRequest struct { *tchttp.BaseRequest // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` }
func NewDescribeJobRequest ¶
func NewDescribeJobRequest() (request *DescribeJobRequest)
func (*DescribeJobRequest) FromJsonString ¶
func (r *DescribeJobRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeJobRequest) ToJsonString ¶
func (r *DescribeJobRequest) ToJsonString() string
type DescribeJobResponse ¶
type DescribeJobResponse struct { *tchttp.BaseResponse Response *struct { // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` // Instance name JobName *string `json:"JobName,omitempty" name:"JobName"` // Information of availability zone Zone *string `json:"Zone,omitempty" name:"Zone"` // Instance priority Priority *int64 `json:"Priority,omitempty" name:"Priority"` // Instance state JobState *string `json:"JobState,omitempty" name:"JobState"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // End time EndTime *string `json:"EndTime,omitempty" name:"EndTime"` // Task view information TaskSet []*TaskView `json:"TaskSet,omitempty" name:"TaskSet"` // Information of the dependency among tasks DependenceSet []*Dependence `json:"DependenceSet,omitempty" name:"DependenceSet"` // Task statistical metrics TaskMetrics *TaskMetrics `json:"TaskMetrics,omitempty" name:"TaskMetrics"` // Task instance statistical metrics TaskInstanceMetrics *TaskInstanceMetrics `json:"TaskInstanceMetrics,omitempty" name:"TaskInstanceMetrics"` // Instance failure reason StateReason *string `json:"StateReason,omitempty" name:"StateReason"` // Tag list bound to the job. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Next action // Note: This field may return `null`, indicating that no valid value was found. NextAction *string `json:"NextAction,omitempty" name:"NextAction"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeJobResponse ¶
func NewDescribeJobResponse() (response *DescribeJobResponse)
func (*DescribeJobResponse) FromJsonString ¶
func (r *DescribeJobResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeJobResponse) ToJsonString ¶
func (r *DescribeJobResponse) ToJsonString() string
type DescribeJobSubmitInfoRequest ¶
type DescribeJobSubmitInfoRequest struct { *tchttp.BaseRequest // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` }
func NewDescribeJobSubmitInfoRequest ¶
func NewDescribeJobSubmitInfoRequest() (request *DescribeJobSubmitInfoRequest)
func (*DescribeJobSubmitInfoRequest) FromJsonString ¶
func (r *DescribeJobSubmitInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeJobSubmitInfoRequest) ToJsonString ¶
func (r *DescribeJobSubmitInfoRequest) ToJsonString() string
type DescribeJobSubmitInfoResponse ¶
type DescribeJobSubmitInfoResponse struct { *tchttp.BaseResponse Response *struct { // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` // Instance name JobName *string `json:"JobName,omitempty" name:"JobName"` // Instance description JobDescription *string `json:"JobDescription,omitempty" name:"JobDescription"` // Job priority. Tasks (Task) and task instances (TaskInstance) inherit the priority of the job Priority *int64 `json:"Priority,omitempty" name:"Priority"` // Task information Tasks []*Task `json:"Tasks,omitempty" name:"Tasks"` // Dependency information Dependences []*Dependence `json:"Dependences,omitempty" name:"Dependences"` // Tag list bound to the job. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeJobSubmitInfoResponse ¶
func NewDescribeJobSubmitInfoResponse() (response *DescribeJobSubmitInfoResponse)
func (*DescribeJobSubmitInfoResponse) FromJsonString ¶
func (r *DescribeJobSubmitInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeJobSubmitInfoResponse) ToJsonString ¶
func (r *DescribeJobSubmitInfoResponse) ToJsonString() string
type DescribeJobsRequest ¶
type DescribeJobsRequest struct { *tchttp.BaseRequest // Instance ID JobIds []*string `json:"JobIds,omitempty" name:"JobIds"` // Filter. // <li> `job-id` - String - Optional - Filter by job ID.</li> // <li> `job-name` - String - Optional - Filter by job name.</li> // <li> `job-state` - String - Optional - Filter by job state.</li> // <li> `zone` - String - Optional - Filter by availability zone.</li> // <li> `tag-key` - String - Optional - Filter by tag key.</li> // <li> `tag-value` - String - Optional - Filter by tag value.</li> // <li> `tag:tag-key` - String - Optional - Filter by tag key-value pair. The tag-key should be replaced by a specified tag key.</li> // It cannot be specified together with the `JobIds` parameter. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Offset Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeJobsRequest ¶
func NewDescribeJobsRequest() (request *DescribeJobsRequest)
func (*DescribeJobsRequest) FromJsonString ¶
func (r *DescribeJobsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeJobsRequest) ToJsonString ¶
func (r *DescribeJobsRequest) ToJsonString() string
type DescribeJobsResponse ¶
type DescribeJobsResponse struct { *tchttp.BaseResponse Response *struct { // List of instances JobSet []*JobView `json:"JobSet,omitempty" name:"JobSet"` // Number of eligible instances TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeJobsResponse ¶
func NewDescribeJobsResponse() (response *DescribeJobsResponse)
func (*DescribeJobsResponse) FromJsonString ¶
func (r *DescribeJobsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeJobsResponse) ToJsonString ¶
func (r *DescribeJobsResponse) ToJsonString() string
type DescribeTaskLogsRequest ¶
type DescribeTaskLogsRequest struct { *tchttp.BaseRequest // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` // Job name TaskName *string `json:"TaskName,omitempty" name:"TaskName"` // Set of task instances TaskInstanceIndexes []*uint64 `json:"TaskInstanceIndexes,omitempty" name:"TaskInstanceIndexes"` // Starting task instance Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of task instances Limit *uint64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeTaskLogsRequest ¶
func NewDescribeTaskLogsRequest() (request *DescribeTaskLogsRequest)
func (*DescribeTaskLogsRequest) FromJsonString ¶
func (r *DescribeTaskLogsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTaskLogsRequest) ToJsonString ¶
func (r *DescribeTaskLogsRequest) ToJsonString() string
type DescribeTaskLogsResponse ¶
type DescribeTaskLogsResponse struct { *tchttp.BaseResponse Response *struct { // Total number of task instances TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // Set of task instance log details TaskInstanceLogSet []*TaskInstanceLog `json:"TaskInstanceLogSet,omitempty" name:"TaskInstanceLogSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeTaskLogsResponse ¶
func NewDescribeTaskLogsResponse() (response *DescribeTaskLogsResponse)
func (*DescribeTaskLogsResponse) FromJsonString ¶
func (r *DescribeTaskLogsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTaskLogsResponse) ToJsonString ¶
func (r *DescribeTaskLogsResponse) ToJsonString() string
type DescribeTaskRequest ¶
type DescribeTaskRequest struct { *tchttp.BaseRequest // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` // Task name TaskName *string `json:"TaskName,omitempty" name:"TaskName"` // Offset Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results. Default value: 100. Maximum value: 1,000. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Filter as detailed below: // <li> task-instance-type - String - Required: No - (Filter) Filter by task instance state. (SUBMITTED: submitted; PENDING: pending; RUNNABLE: runnable; STARTING: starting; RUNNING: running; SUCCEED: succeeded; FAILED: failed; FAILED_INTERRUPTED: instance retained after failure).</li> Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeTaskRequest ¶
func NewDescribeTaskRequest() (request *DescribeTaskRequest)
func (*DescribeTaskRequest) FromJsonString ¶
func (r *DescribeTaskRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTaskRequest) ToJsonString ¶
func (r *DescribeTaskRequest) ToJsonString() string
type DescribeTaskResponse ¶
type DescribeTaskResponse struct { *tchttp.BaseResponse Response *struct { // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` // Job name TaskName *string `json:"TaskName,omitempty" name:"TaskName"` // Job state TaskState *string `json:"TaskState,omitempty" name:"TaskState"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // End time EndTime *string `json:"EndTime,omitempty" name:"EndTime"` // Total number of task instances TaskInstanceTotalCount *int64 `json:"TaskInstanceTotalCount,omitempty" name:"TaskInstanceTotalCount"` // Task instance information TaskInstanceSet []*TaskInstanceView `json:"TaskInstanceSet,omitempty" name:"TaskInstanceSet"` // Task instance statistical metrics TaskInstanceMetrics *TaskInstanceMetrics `json:"TaskInstanceMetrics,omitempty" name:"TaskInstanceMetrics"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeTaskResponse ¶
func NewDescribeTaskResponse() (response *DescribeTaskResponse)
func (*DescribeTaskResponse) FromJsonString ¶
func (r *DescribeTaskResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTaskResponse) ToJsonString ¶
func (r *DescribeTaskResponse) ToJsonString() string
type DescribeTaskTemplatesRequest ¶
type DescribeTaskTemplatesRequest struct { *tchttp.BaseRequest // Job template ID TaskTemplateIds []*string `json:"TaskTemplateIds,omitempty" name:"TaskTemplateIds"` // Filter. // <li> `task-template-name` - String - Optional - Filter by task template name.</li> // <li> `tag-key` - String - Optional - Filter by tag key.</li> // <li> `tag-value` - String - Optional - Filter by tag value.</li> // <li> `tag:tag-key` - String - Optional - Filter by tag key-value pair. The tag-key should be replaced by a specified tag key.</li> // It cannot be specified together with the `TaskTemplateIds` parameter. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Offset Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeTaskTemplatesRequest ¶
func NewDescribeTaskTemplatesRequest() (request *DescribeTaskTemplatesRequest)
func (*DescribeTaskTemplatesRequest) FromJsonString ¶
func (r *DescribeTaskTemplatesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTaskTemplatesRequest) ToJsonString ¶
func (r *DescribeTaskTemplatesRequest) ToJsonString() string
type DescribeTaskTemplatesResponse ¶
type DescribeTaskTemplatesResponse struct { *tchttp.BaseResponse Response *struct { // List of job templates TaskTemplateSet []*TaskTemplateView `json:"TaskTemplateSet,omitempty" name:"TaskTemplateSet"` // Number of job templates TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeTaskTemplatesResponse ¶
func NewDescribeTaskTemplatesResponse() (response *DescribeTaskTemplatesResponse)
func (*DescribeTaskTemplatesResponse) FromJsonString ¶
func (r *DescribeTaskTemplatesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTaskTemplatesResponse) ToJsonString ¶
func (r *DescribeTaskTemplatesResponse) ToJsonString() string
type DetachInstancesRequest ¶
type DetachInstancesRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Instance ID list InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"` }
func NewDetachInstancesRequest ¶
func NewDetachInstancesRequest() (request *DetachInstancesRequest)
func (*DetachInstancesRequest) FromJsonString ¶
func (r *DetachInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetachInstancesRequest) ToJsonString ¶
func (r *DetachInstancesRequest) ToJsonString() string
type DetachInstancesResponse ¶
type DetachInstancesResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDetachInstancesResponse ¶
func NewDetachInstancesResponse() (response *DetachInstancesResponse)
func (*DetachInstancesResponse) FromJsonString ¶
func (r *DetachInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetachInstancesResponse) ToJsonString ¶
func (r *DetachInstancesResponse) ToJsonString() string
type Docker ¶
type Docker struct { // Docker Hub username or Tencent Registry username User *string `json:"User,omitempty" name:"User"` // Docker Hub password or Tencent Registry password Password *string `json:"Password,omitempty" name:"Password"` // For Docker Hub, enter "[user/repo]:[tag]"; for Tencent Registry, enter "ccr.ccs.tencentyun.com/[namespace/repo]:[tag]" Image *string `json:"Image,omitempty" name:"Image"` // For Docker Hub, this can be left blank, but please ensure public network access is present. For Tencent Registry, the server address is "ccr.ccs.tencentyun.com" Server *string `json:"Server,omitempty" name:"Server"` }
type EnhancedService ¶
type EnhancedService struct { // Enables cloud security service. If this parameter is not specified, the cloud security service will be enabled by default. SecurityService *RunSecurityServiceEnabled `json:"SecurityService,omitempty" name:"SecurityService"` // Enables cloud monitor service. If this parameter is not specified, the cloud monitor service will be enabled by default. MonitorService *RunMonitorServiceEnabled `json:"MonitorService,omitempty" name:"MonitorService"` // Enables the TAT service. If this parameter is not specified, the TAT service will not be enabled. AutomationService *RunAutomationServiceEnabled `json:"AutomationService,omitempty" name:"AutomationService"` }
type EnvData ¶
type EnvData struct { // CVM instance type, which cannot be present together with InstanceTypes or InstanceTypeOptions at the same time. InstanceType *string `json:"InstanceType,omitempty" name:"InstanceType"` // CVM image ID ImageId *string `json:"ImageId,omitempty" name:"ImageId"` // Information of the instance's system disk configuration SystemDisk *SystemDisk `json:"SystemDisk,omitempty" name:"SystemDisk"` // Information of the instance's data disk configuration DataDisks []*DataDisk `json:"DataDisks,omitempty" name:"DataDisks"` // Information of the VPC configuration, which cannot be specified together with Zones and VirtualPrivateClouds. VirtualPrivateCloud *VirtualPrivateCloud `json:"VirtualPrivateCloud,omitempty" name:"VirtualPrivateCloud"` // Information of the public network bandwidth configuration InternetAccessible *InternetAccessible `json:"InternetAccessible,omitempty" name:"InternetAccessible"` // CVM instance display name InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"` // Instance login settings LoginSettings *LoginSettings `json:"LoginSettings,omitempty" name:"LoginSettings"` // Security group of the instance SecurityGroupIds []*string `json:"SecurityGroupIds,omitempty" name:"SecurityGroupIds"` // Enhanced service. This parameter is used to specify whether to enable Cloud Security, Cloud Monitoring and other services. If this parameter is not specified, Cloud Monitoring and Cloud Security will be enabled by default. EnhancedService *EnhancedService `json:"EnhancedService,omitempty" name:"EnhancedService"` // CVM instance billing method <br><li>POSTPAID_BY_HOUR: pay-as-you-go by the hour <br><li>SPOTPAID: bidding <br>Default value: POSTPAID_BY_HOUR. InstanceChargeType *string `json:"InstanceChargeType,omitempty" name:"InstanceChargeType"` // Market-related options of the instance, such as parameters related to spot instance InstanceMarketOptions *InstanceMarketOptionsRequest `json:"InstanceMarketOptions,omitempty" name:"InstanceMarketOptions"` // List of CVM instance types, which cannot be present together with InstanceType or InstanceTypeOptions at the same time. After the field is specified, the system will try creating compute nodes in the order of the models until successful creation and then stop the traversal process. Up to 10 models are supported. InstanceTypes []*string `json:"InstanceTypes,omitempty" name:"InstanceTypes"` // CVM instance model configuration, which cannot be present together with InstanceType or InstanceTypes at the same time. InstanceTypeOptions *InstanceTypeOptions `json:"InstanceTypeOptions,omitempty" name:"InstanceTypeOptions"` // List of availability zones (creation of CVM instances across availability zones is supported), which cannot be specified together with VirtualPrivateCloud or VirtualPrivateClouds at the same time. Zones []*string `json:"Zones,omitempty" name:"Zones"` // List of VPCs (creation of CVM instances across VPCs is supported), which cannot be specified together with VirtualPrivateCloud or Zones at the same time. VirtualPrivateClouds []*VirtualPrivateCloud `json:"VirtualPrivateClouds,omitempty" name:"VirtualPrivateClouds"` }
type EventConfig ¶
type EventConfig struct { // Event type. Value range: <br/><li>"JOB_RUNNING": the job is running, applicable to "SubmitJob". </li><li>"JOB_SUCCEED: the job succeeded, applicable to "SubmitJob". </li><li>"JOB_FAILED": the job failed, applicable to "SubmitJob". </li><li>"JOB_FAILED_INTERRUPTED": the job failed and the instance is retained, applicable to "SubmitJob". </li><li>"TASK_RUNNING": the task is running, applicable to "SubmitJob". </li><li>"TASK_SUCCEED": the task succeeded, applicable to "SubmitJob". </li><li>"TASK_FAILED": the task failed, applicable to "SubmitJob". </li><li>"TASK_FAILED_INTERRUPTED": the task failed and the instance is retained, applicable to "SubmitJob". </li><li>"TASK_INSTANCE_RUNNING": the task instance is running, applicable to "SubmitJob". </li><li>"TASK_INSTANCE_SUCCEED": the task instance succeeded, applicable to "SubmitJob". </li><li>"TASK_INSTANCE_FAILED": the task instance failed, applicable to "SubmitJob". </li><li>"TASK_INSTANCE_FAILED_INTERRUPTED": the task instance failed and the instance is retained, applicable to "SubmitJob". </li><li>"COMPUTE_ENV_CREATED": the compute environment has been created, applicable to "CreateComputeEnv". </li><li>"COMPUTE_ENV_DELETED": the compute environment has been deleted, applicable to "CreateComputeEnv". </li><li>"COMPUTE_NODE_CREATED": the compute node has been created, applicable to "CreateComputeEnv" and "SubmitJob". </li><li>"COMPUTE_NODE_CREATION_FAILED": the compute node creation failed, applicable to "CreateComputeEnv" and "SubmitJob". </li><li>"COMPUTE_NODE_RUNNING": the compute node is running, applicable to "CreateComputeEnv" and "SubmitJob". </li><li>"COMPUTE_NODE_ABNORMAL": the compute node is exceptional, applicable to "CreateComputeEnv" and "SubmitJob". </li><li>"COMPUTE_NODE_DELETING": the compute node has been deleted, applicable to "CreateComputeEnv" and "SubmitJob". </li> EventName *string `json:"EventName,omitempty" name:"EventName"` // Custom key-value pair EventVars []*EventVar `json:"EventVars,omitempty" name:"EventVars"` }
type Externals ¶
type Externals struct { // Release address // Note: This field may return null, indicating that no valid value is found. ReleaseAddress *bool `json:"ReleaseAddress,omitempty" name:"ReleaseAddress"` // Not supported network. Value: <br><li>BASIC: classic network<br><li>VPC1.0: VPC1.0 // Note: This field may return null, indicating that no valid value was found. UnsupportNetworks []*string `json:"UnsupportNetworks,omitempty" name:"UnsupportNetworks"` // Attributes of local HDD storage // Note: This field may return null, indicating that no valid value is found. StorageBlockAttr *StorageBlock `json:"StorageBlockAttr,omitempty" name:"StorageBlockAttr"` }
type InputMapping ¶
type InputMapping struct { // Source path SourcePath *string `json:"SourcePath,omitempty" name:"SourcePath"` // Destination path DestinationPath *string `json:"DestinationPath,omitempty" name:"DestinationPath"` // Mounting configuration item parameter MountOptionParameter *string `json:"MountOptionParameter,omitempty" name:"MountOptionParameter"` }
type Instance ¶
type Instance struct { // Instance ID. InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"` // Image ID. ImageId *string `json:"ImageId,omitempty" name:"ImageId"` // Instance login settings. LoginSettings *LoginSettings `json:"LoginSettings,omitempty" name:"LoginSettings"` }
type InstanceCategoryItem ¶
type InstanceMarketOptionsRequest ¶
type InstanceMarketOptionsRequest struct { // Options related to bidding SpotOptions *SpotMarketOptions `json:"SpotOptions,omitempty" name:"SpotOptions"` // Market option type. Currently `spot` is the only supported value. MarketType *string `json:"MarketType,omitempty" name:"MarketType"` }
type InstanceTypeConfig ¶
type InstanceTypeConfig struct { // Memory size in GB. Mem *int64 `json:"Mem,omitempty" name:"Mem"` // Number of CPU cores. Cpu *int64 `json:"Cpu,omitempty" name:"Cpu"` // Instance model. InstanceType *string `json:"InstanceType,omitempty" name:"InstanceType"` // Availability zone. Zone *string `json:"Zone,omitempty" name:"Zone"` // Instance model family. InstanceFamily *string `json:"InstanceFamily,omitempty" name:"InstanceFamily"` }
type InstanceTypeOptions ¶
type InstanceTypeOptions struct { // Number of CPU cores. CPU *uint64 `json:"CPU,omitempty" name:"CPU"` // Memory size in GB. Memory *uint64 `json:"Memory,omitempty" name:"Memory"` // Instance model category. Value range: "ALL", "GENERAL", "GENERAL_2", "GENERAL_3", "COMPUTE", "COMPUTE_2", and "COMPUTE_3". Default value: "ALL". InstanceCategories []*string `json:"InstanceCategories,omitempty" name:"InstanceCategories"` }
type InstanceTypeQuotaItem ¶
type InstanceTypeQuotaItem struct { // Availability zone. Zone *string `json:"Zone,omitempty" name:"Zone"` // Instance model. InstanceType *string `json:"InstanceType,omitempty" name:"InstanceType"` // Instance billing plan. Valid values: <br><li>POSTPAID_BY_HOUR: pay after use. You are billed for your traffic by the hour.<br><li>`CDHPAID`: [`CDH`](https://intl.cloud.tencent.com/document/product/416?from_cn_redirect=1) billing plan. Applicable to `CDH` only, not the instances on the host. InstanceChargeType *string `json:"InstanceChargeType,omitempty" name:"InstanceChargeType"` // ENI type. For example, 25 represents an ENI of 25 GB. NetworkCard *int64 `json:"NetworkCard,omitempty" name:"NetworkCard"` // Additional data. // Note: This field may return null, indicating that no valid value is found. Externals *Externals `json:"Externals,omitempty" name:"Externals"` // Number of CPU cores of an instance model. Cpu *int64 `json:"Cpu,omitempty" name:"Cpu"` // Instance memory capacity; unit: `GB`. Memory *int64 `json:"Memory,omitempty" name:"Memory"` // Instance model family. InstanceFamily *string `json:"InstanceFamily,omitempty" name:"InstanceFamily"` // Model name. TypeName *string `json:"TypeName,omitempty" name:"TypeName"` // List of local disk specifications. If the parameter returns null, it means that local disks cannot be created. LocalDiskTypeList []*LocalDiskType `json:"LocalDiskTypeList,omitempty" name:"LocalDiskTypeList"` // Whether an instance model is available. Valid values: <br><li>SELL: available <br><li>SOLD_OUT: sold out Status *string `json:"Status,omitempty" name:"Status"` // Price of an instance model. Price *ItemPrice `json:"Price,omitempty" name:"Price"` // Details of out-of-stock items // Note: this field may return null, indicating that no valid value is obtained. SoldOutReason *string `json:"SoldOutReason,omitempty" name:"SoldOutReason"` // Private network bandwidth, in Gbps. InstanceBandwidth *float64 `json:"InstanceBandwidth,omitempty" name:"InstanceBandwidth"` // The max packet sending and receiving capability (in 10k PPS). InstancePps *int64 `json:"InstancePps,omitempty" name:"InstancePps"` // Number of local storage blocks. StorageBlockAmount *int64 `json:"StorageBlockAmount,omitempty" name:"StorageBlockAmount"` // CPU type. CpuType *string `json:"CpuType,omitempty" name:"CpuType"` // Number of GPUs of the instance. Gpu *int64 `json:"Gpu,omitempty" name:"Gpu"` // Number of FPGAs of the instance. Fpga *int64 `json:"Fpga,omitempty" name:"Fpga"` // Descriptive information of the instance. Remark *string `json:"Remark,omitempty" name:"Remark"` }
type InternetAccessible ¶
type InternetAccessible struct { // Network connection billing plan. Valid value: <br><li>TRAFFIC_POSTPAID_BY_HOUR: pay after use. You are billed for your traffic, by the hour. InternetChargeType *string `json:"InternetChargeType,omitempty" name:"InternetChargeType"` // The maximum outbound bandwidth of the public network, in Mbps. The default value is 0 Mbps. The upper limit of bandwidth varies for different models. For more information, see [Purchase Network Bandwidth](https://intl.cloud.tencent.com/document/product/213/12523?from_cn_redirect=1). InternetMaxBandwidthOut *int64 `json:"InternetMaxBandwidthOut,omitempty" name:"InternetMaxBandwidthOut"` // Whether to assign a public IP. Valid values: <br><li>TRUE: Assign a public IP <br><li>FALSE: Do not assign a public IP <br><br>If the public network bandwidth is greater than 0 Mbps, you can choose whether to assign a public IP; by default a public IP will be assigned. If the public network bandwidth is 0 Mbps, you will not be able to assign a public IP. PublicIpAssigned *bool `json:"PublicIpAssigned,omitempty" name:"PublicIpAssigned"` // Bandwidth package ID. To obatin the IDs, you can call [`DescribeBandwidthPackages`](https://intl.cloud.tencent.com/document/api/215/19209?from_cn_redirect=1) and look for the `BandwidthPackageId` fields in the response. BandwidthPackageId *string `json:"BandwidthPackageId,omitempty" name:"BandwidthPackageId"` }
type ItemPrice ¶
type ItemPrice struct { // The original unit price for pay-as-you-go mode in USD. <br><li>When a billing tier is returned, it indicates the price fo the returned billing tier. For example, if `UnitPriceSecondStep` is returned, it refers to the unit price for the usage between 0 to 96 hours. Otherwise, it refers to that the unit price for unlimited usage. // Note: this field may return null, indicating that no valid value is obtained. UnitPrice *float64 `json:"UnitPrice,omitempty" name:"UnitPrice"` // Billing unit for pay-as-you-go mode. Valid values: <br><li>HOUR: billed on an hourly basis. It's used for hourly postpaid instances (`POSTPAID_BY_HOUR`). <br><li>GB: bill by traffic in GB. It's used for postpaid products that are billed by the hourly traffic (`TRAFFIC_POSTPAID_BY_HOUR`). // Note: this field may return null, indicating that no valid value is obtained. ChargeUnit *string `json:"ChargeUnit,omitempty" name:"ChargeUnit"` // The original price of a pay-in-advance instance, in USD. // Note: this field may return null, indicating that no valid value is obtained. OriginalPrice *float64 `json:"OriginalPrice,omitempty" name:"OriginalPrice"` // Discount price of a prepaid instance, in USD. // Note: this field may return null, indicating that no valid value is obtained. DiscountPrice *float64 `json:"DiscountPrice,omitempty" name:"DiscountPrice"` // Percentage of the original price. For example, if you enter "20.0", the discounted price will be 20% of the original price. // Note: this field may return null, indicating that no valid values can be obtained. Discount *float64 `json:"Discount,omitempty" name:"Discount"` // The discounted unit price for pay-as-you-go mode in USD. <br><li>When a billing tier is returned, it indicates the price fo the returned billing tier. For example, if `UnitPriceSecondStep` is returned, it refers to the unit price for the usage between 0 to 96 hours. Otherwise, it refers to that the unit price for unlimited usage. // Note: this field may return null, indicating that no valid value is obtained. UnitPriceDiscount *float64 `json:"UnitPriceDiscount,omitempty" name:"UnitPriceDiscount"` // Original unit price for the usage between 96 to 360 hours in USD. It's applicable to pay-as-you-go mode. // Note: this field may return null, indicating that no valid value is obtained. UnitPriceSecondStep *float64 `json:"UnitPriceSecondStep,omitempty" name:"UnitPriceSecondStep"` // Discounted unit price for the usage between 96 to 360 hours in USD. It's applicable to pay-as-you-go mode. // Note: this field may return null, indicating that no valid value is obtained. UnitPriceDiscountSecondStep *float64 `json:"UnitPriceDiscountSecondStep,omitempty" name:"UnitPriceDiscountSecondStep"` // Original unit price for the usage after 360 hours in USD. It's applicable to pay-as-you-go mode. // Note: this field may return null, indicating that no valid value is obtained. UnitPriceThirdStep *float64 `json:"UnitPriceThirdStep,omitempty" name:"UnitPriceThirdStep"` // Discounted unit price for the usage after 360 hours in USD. It's applicable to pay-as-you-go mode. // Note: this field may return null, indicating that no valid value is obtained. UnitPriceDiscountThirdStep *float64 `json:"UnitPriceDiscountThirdStep,omitempty" name:"UnitPriceDiscountThirdStep"` // Original 3-year payment, in USD. This parameter is only available to upfront payment mode. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. OriginalPriceThreeYear *float64 `json:"OriginalPriceThreeYear,omitempty" name:"OriginalPriceThreeYear"` // Discounted 3-year upfront payment, in USD. This parameter is only available to upfront payment mode. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. DiscountPriceThreeYear *float64 `json:"DiscountPriceThreeYear,omitempty" name:"DiscountPriceThreeYear"` // Discount for 3-year upfront payment. For example, 20.0 indicates 80% off. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. DiscountThreeYear *float64 `json:"DiscountThreeYear,omitempty" name:"DiscountThreeYear"` // Original 5-year payment, in USD. This parameter is only available to upfront payment mode. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. OriginalPriceFiveYear *float64 `json:"OriginalPriceFiveYear,omitempty" name:"OriginalPriceFiveYear"` // Discounted 5-year upfront payment, in USD. This parameter is only available to upfront payment mode. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. DiscountPriceFiveYear *float64 `json:"DiscountPriceFiveYear,omitempty" name:"DiscountPriceFiveYear"` // Discount for 5-year upfront payment. For example, 20.0 indicates 80% off. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. DiscountFiveYear *float64 `json:"DiscountFiveYear,omitempty" name:"DiscountFiveYear"` // Original 1-year payment, in USD. This parameter is only available to upfront payment mode. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. OriginalPriceOneYear *float64 `json:"OriginalPriceOneYear,omitempty" name:"OriginalPriceOneYear"` // Discounted 1-year payment, in USD. This parameter is only available to upfront payment mode. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. DiscountPriceOneYear *float64 `json:"DiscountPriceOneYear,omitempty" name:"DiscountPriceOneYear"` // Discount for 1-year upfront payment. For example, 20.0 indicates 80% off. // Note: this field may return `null`, indicating that no valid value was found. // Note: this field may return `null`, indicating that no valid value was found. DiscountOneYear *float64 `json:"DiscountOneYear,omitempty" name:"DiscountOneYear"` }
type Job ¶
type Job struct { // Job information Tasks []*Task `json:"Tasks,omitempty" name:"Tasks"` // Instance name JobName *string `json:"JobName,omitempty" name:"JobName"` // Instance description JobDescription *string `json:"JobDescription,omitempty" name:"JobDescription"` // Instance priority. Tasks (Task) and task instances (TaskInstance) inherit the priority of the instance Priority *uint64 `json:"Priority,omitempty" name:"Priority"` // Dependency information Dependences []*Dependence `json:"Dependences,omitempty" name:"Dependences"` // Notification information Notifications []*Notification `json:"Notifications,omitempty" name:"Notifications"` // This is the dependency of the subsequent task on the previous task if there is a dependent relationship between them. Value range: PRE_TASK_SUCCEED, PRE_TASK_AT_LEAST_PARTLY_SUCCEED, PRE_TASK_FINISHED. Default value: PRE_TASK_SUCCEED. TaskExecutionDependOn *string `json:"TaskExecutionDependOn,omitempty" name:"TaskExecutionDependOn"` // Indicates which policy will be used in case that CVM instance creation fails. Value range: FAILED, RUNNABLE. FAILED indicates that the CVM instance creation failure will be processed as an execution failure, while RUNNABLE indicates that the failure will be processed as "keep waiting". Default value: FAILED. StateIfCreateCvmFailed is not valid for submitted jobs for which a compute environment is specified. StateIfCreateCvmFailed *string `json:"StateIfCreateCvmFailed,omitempty" name:"StateIfCreateCvmFailed"` // Tag list. By setting this parameter, you can bind tags to a job. Each job supports up to 10 tags. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
type JobView ¶
type JobView struct { // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` // Instance name JobName *string `json:"JobName,omitempty" name:"JobName"` // Instance state JobState *string `json:"JobState,omitempty" name:"JobState"` // Instance priority Priority *int64 `json:"Priority,omitempty" name:"Priority"` // Location information // Note: This field may return null, indicating that no valid values can be obtained. Placement *Placement `json:"Placement,omitempty" name:"Placement"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // End time // Note: This field may return null, indicating that no valid values can be obtained. EndTime *string `json:"EndTime,omitempty" name:"EndTime"` // Task statistical metrics TaskMetrics *TaskMetrics `json:"TaskMetrics,omitempty" name:"TaskMetrics"` // Tag list bound to the job. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
type LocalDiskType ¶
type LocalDiskType struct { // Type of a local disk. Type *string `json:"Type,omitempty" name:"Type"` // Attributes of a local disk. PartitionType *string `json:"PartitionType,omitempty" name:"PartitionType"` // Minimum size of a local disk. MinSize *int64 `json:"MinSize,omitempty" name:"MinSize"` // Maximum size of a local disk. MaxSize *int64 `json:"MaxSize,omitempty" name:"MaxSize"` // Whether a local disk is required during purchase. Valid values:<br><li>REQUIRED: required<br><li>OPTIONAL: optional Required *string `json:"Required,omitempty" name:"Required"` }
type LoginSettings ¶
type LoginSettings struct { // Login password of the instance. The password requirements vary among different operating systems: <br><li>For Linux instances, the password must be 8-16 characters long and contain at least one character from two of the following categories: [a-z, A-Z], [0-9] and [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]. <br><li>For Windows instances, the password must be 12-16 characters long and contain at least one character from three of the following categories: [a-z], [A-Z], [0-9] and [( ) ` ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]. <br><br>If this parameter is not specified, a random password will be generated and sent to you via the Message Center. Password *string `json:"Password,omitempty" name:"Password"` // List of key IDs. After an instance is associated with a key, you can access the instance with the private key in the key pair. You can call `DescribeKeyPairs` to obtain `KeyId`. Key and password cannot be specified at the same time. Windows instances do not support keys. Currently, you can only specify one key when purchasing an instance. KeyIds []*string `json:"KeyIds,omitempty" name:"KeyIds"` // Whether to keep the original settings of an image. You cannot specify this parameter and `Password` or `KeyIds.N` at the same time. You can specify this parameter as `TRUE` only when you create an instance using a custom image, a shared image, or an imported image. Valid values: <br><li>TRUE: keep the login settings of the image <br><li>FALSE: do not keep the login settings of the image <br><br>Default value: FALSE. KeepImageLogin *string `json:"KeepImageLogin,omitempty" name:"KeepImageLogin"` }
type ModifyComputeEnvRequest ¶
type ModifyComputeEnvRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Number of desired compute nodes DesiredComputeNodeCount *int64 `json:"DesiredComputeNodeCount,omitempty" name:"DesiredComputeNodeCount"` // Compute environment name EnvName *string `json:"EnvName,omitempty" name:"EnvName"` // Compute environment description EnvDescription *string `json:"EnvDescription,omitempty" name:"EnvDescription"` // Compute environment attributes EnvData *ComputeEnvData `json:"EnvData,omitempty" name:"EnvData"` }
func NewModifyComputeEnvRequest ¶
func NewModifyComputeEnvRequest() (request *ModifyComputeEnvRequest)
func (*ModifyComputeEnvRequest) FromJsonString ¶
func (r *ModifyComputeEnvRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyComputeEnvRequest) ToJsonString ¶
func (r *ModifyComputeEnvRequest) ToJsonString() string
type ModifyComputeEnvResponse ¶
type ModifyComputeEnvResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyComputeEnvResponse ¶
func NewModifyComputeEnvResponse() (response *ModifyComputeEnvResponse)
func (*ModifyComputeEnvResponse) FromJsonString ¶
func (r *ModifyComputeEnvResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyComputeEnvResponse) ToJsonString ¶
func (r *ModifyComputeEnvResponse) ToJsonString() string
type ModifyTaskTemplateRequest ¶
type ModifyTaskTemplateRequest struct { *tchttp.BaseRequest // Job template ID TaskTemplateId *string `json:"TaskTemplateId,omitempty" name:"TaskTemplateId"` // Job template name TaskTemplateName *string `json:"TaskTemplateName,omitempty" name:"TaskTemplateName"` // Job template description TaskTemplateDescription *string `json:"TaskTemplateDescription,omitempty" name:"TaskTemplateDescription"` // Job template information TaskTemplateInfo *Task `json:"TaskTemplateInfo,omitempty" name:"TaskTemplateInfo"` }
func NewModifyTaskTemplateRequest ¶
func NewModifyTaskTemplateRequest() (request *ModifyTaskTemplateRequest)
func (*ModifyTaskTemplateRequest) FromJsonString ¶
func (r *ModifyTaskTemplateRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyTaskTemplateRequest) ToJsonString ¶
func (r *ModifyTaskTemplateRequest) ToJsonString() string
type ModifyTaskTemplateResponse ¶
type ModifyTaskTemplateResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyTaskTemplateResponse ¶
func NewModifyTaskTemplateResponse() (response *ModifyTaskTemplateResponse)
func (*ModifyTaskTemplateResponse) FromJsonString ¶
func (r *ModifyTaskTemplateResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyTaskTemplateResponse) ToJsonString ¶
func (r *ModifyTaskTemplateResponse) ToJsonString() string
type MountDataDisk ¶
type MountDataDisk struct { // Mounting point. For Linux, this parameter should be a valid path. For Windows, this parameter should be a system disk letter such as "H:\\" LocalPath *string `json:"LocalPath,omitempty" name:"LocalPath"` // File system type. For Linux, "EXT3" and "EXT4" are supported and the default value is "EXT3". For Windows, only "NTFS" is supported FileSystemType *string `json:"FileSystemType,omitempty" name:"FileSystemType"` }
type NamedComputeEnv ¶
type NamedComputeEnv struct { // Compute environment name EnvName *string `json:"EnvName,omitempty" name:"EnvName"` // Number of desired compute nodes DesiredComputeNodeCount *int64 `json:"DesiredComputeNodeCount,omitempty" name:"DesiredComputeNodeCount"` // Compute environment description EnvDescription *string `json:"EnvDescription,omitempty" name:"EnvDescription"` // Compute environment management type EnvType *string `json:"EnvType,omitempty" name:"EnvType"` // Compute environment's specific parameters EnvData *EnvData `json:"EnvData,omitempty" name:"EnvData"` // Data disk mounting option MountDataDisks []*MountDataDisk `json:"MountDataDisks,omitempty" name:"MountDataDisks"` // Authorization information Authentications []*Authentication `json:"Authentications,omitempty" name:"Authentications"` // Input mapping information InputMappings []*InputMapping `json:"InputMappings,omitempty" name:"InputMappings"` // Agent running mode; applicable for Windows AgentRunningMode *AgentRunningMode `json:"AgentRunningMode,omitempty" name:"AgentRunningMode"` // Notification information Notifications *Notification `json:"Notifications,omitempty" name:"Notifications"` // Inactive node processing policy. Default value: RECREATE, which means that instance resources will be re-created periodically for compute nodes where instance creation fails or is abnormally returned. ActionIfComputeNodeInactive *string `json:"ActionIfComputeNodeInactive,omitempty" name:"ActionIfComputeNodeInactive"` // When the instances are failed to be created or returned because of exceptions, the related compute node will retry to create instances periodically. This parameter specifies the maximum retry attempts. The max value is 11 and the default value is 7. ResourceMaxRetryCount *int64 `json:"ResourceMaxRetryCount,omitempty" name:"ResourceMaxRetryCount"` // Tag list. By setting this parameter, you can bind tags to a compute environment. Each compute environment supports up to 10 tags. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
type Notification ¶
type Notification struct { // CMQ topic name which should be valid and associated with a subscription TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Event configuration EventConfigs []*EventConfig `json:"EventConfigs,omitempty" name:"EventConfigs"` }
type OutputMapping ¶
type OutputMappingConfig ¶
type OutputMappingConfig struct { // Storage type. Only COS is supported Scene *string `json:"Scene,omitempty" name:"Scene"` // Number of parallel workers WorkerNum *int64 `json:"WorkerNum,omitempty" name:"WorkerNum"` // Size of a worker part, in MB. WorkerPartSize *int64 `json:"WorkerPartSize,omitempty" name:"WorkerPartSize"` }
type Placement ¶
type Placement struct { // ID of the availability zone where the instance resides. You can call the [DescribeZones](https://intl.cloud.tencent.com/document/product/213/35071) API and obtain the ID in the returned `Zone` field. Zone *string `json:"Zone,omitempty" name:"Zone"` // ID of the project to which the instance belongs. To obtain the project IDs, you can call [DescribeProject](https://intl.cloud.tencent.com/document/api/378/4400?from_cn_redirect=1) and look for the `projectId` fields in the response. If this parameter is not specified, the default project will be used. ProjectId *int64 `json:"ProjectId,omitempty" name:"ProjectId"` // ID list of CDHs from which the instance can be created. If you have purchased CDHs and specify this parameter, the instances you purchase will be randomly deployed on the CDHs. HostIds []*string `json:"HostIds,omitempty" name:"HostIds"` // Master host IP used to create the CVM HostIps []*string `json:"HostIps,omitempty" name:"HostIps"` // The ID of the CDH to which the instance belongs, only used as an output parameter. HostId *string `json:"HostId,omitempty" name:"HostId"` }
type RedirectInfo ¶
type RedirectInfo struct { // Standard output redirection path StdoutRedirectPath *string `json:"StdoutRedirectPath,omitempty" name:"StdoutRedirectPath"` // Standard error redirection path StderrRedirectPath *string `json:"StderrRedirectPath,omitempty" name:"StderrRedirectPath"` // Standard output redirection file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX} StdoutRedirectFileName *string `json:"StdoutRedirectFileName,omitempty" name:"StdoutRedirectFileName"` // Standard error redirection file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX} StderrRedirectFileName *string `json:"StderrRedirectFileName,omitempty" name:"StderrRedirectFileName"` }
type RedirectLocalInfo ¶
type RedirectLocalInfo struct { // Standard output redirection local path StdoutLocalPath *string `json:"StdoutLocalPath,omitempty" name:"StdoutLocalPath"` // Standard error redirection local path StderrLocalPath *string `json:"StderrLocalPath,omitempty" name:"StderrLocalPath"` // Standard output redirection local file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX} StdoutLocalFileName *string `json:"StdoutLocalFileName,omitempty" name:"StdoutLocalFileName"` // Standard error redirection local file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX} StderrLocalFileName *string `json:"StderrLocalFileName,omitempty" name:"StderrLocalFileName"` }
type RetryJobsRequest ¶
type RetryJobsRequest struct { *tchttp.BaseRequest // List of instance IDs. JobIds []*string `json:"JobIds,omitempty" name:"JobIds"` }
func NewRetryJobsRequest ¶
func NewRetryJobsRequest() (request *RetryJobsRequest)
func (*RetryJobsRequest) FromJsonString ¶
func (r *RetryJobsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RetryJobsRequest) ToJsonString ¶
func (r *RetryJobsRequest) ToJsonString() string
type RetryJobsResponse ¶
type RetryJobsResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewRetryJobsResponse ¶
func NewRetryJobsResponse() (response *RetryJobsResponse)
func (*RetryJobsResponse) FromJsonString ¶
func (r *RetryJobsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RetryJobsResponse) ToJsonString ¶
func (r *RetryJobsResponse) ToJsonString() string
type RunAutomationServiceEnabled ¶
type RunAutomationServiceEnabled struct { // Whether to enable the TAT service. Valid values: <br><li>`TRUE`: yes;<br><li>`FALSE`: no<br><br>Default: `FALSE`. Enabled *bool `json:"Enabled,omitempty" name:"Enabled"` }
type RunMonitorServiceEnabled ¶
type RunMonitorServiceEnabled struct { // Whether to enable [Cloud Monitor](https://intl.cloud.tencent.com/document/product/248?from_cn_redirect=1). Valid values: <br><li>TRUE: enable Cloud Monitor <br><li>FALSE: do not enable Cloud Monitor <br><br>Default value: TRUE. Enabled *bool `json:"Enabled,omitempty" name:"Enabled"` }
type RunSecurityServiceEnabled ¶
type RunSecurityServiceEnabled struct { // Whether to enable [Cloud Security](https://intl.cloud.tencent.com/document/product/296?from_cn_redirect=1). Valid values: <br><li>TRUE: enable Cloud Security <br><li>FALSE: do not enable Cloud Security <br><br>Default value: TRUE. Enabled *bool `json:"Enabled,omitempty" name:"Enabled"` }
type SpotMarketOptions ¶
type StorageBlock ¶
type StorageBlock struct { // Local HDD storage type. Value: LOCAL_PRO. // Note: This field may return null, indicating that no valid value is found. Type *string `json:"Type,omitempty" name:"Type"` // Minimum capacity of local HDD storage // Note: This field may return null, indicating that no valid value is found. MinSize *int64 `json:"MinSize,omitempty" name:"MinSize"` // Maximum capacity of local HDD storage // Note: This field may return null, indicating that no valid value is found. MaxSize *int64 `json:"MaxSize,omitempty" name:"MaxSize"` }
type SubmitJobRequest ¶
type SubmitJobRequest struct { *tchttp.BaseRequest // Location information of the submitted job. This parameter allows you to specify information such as the availability zone of the CVM instance with which the job is associated. Placement *Placement `json:"Placement,omitempty" name:"Placement"` // Job information Job *Job `json:"Job,omitempty" name:"Job"` // The string used to guarantee the idempotency of the request, which is generated by the user and must be unique for different requests. The maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed. ClientToken *string `json:"ClientToken,omitempty" name:"ClientToken"` }
func NewSubmitJobRequest ¶
func NewSubmitJobRequest() (request *SubmitJobRequest)
func (*SubmitJobRequest) FromJsonString ¶
func (r *SubmitJobRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SubmitJobRequest) ToJsonString ¶
func (r *SubmitJobRequest) ToJsonString() string
type SubmitJobResponse ¶
type SubmitJobResponse struct { *tchttp.BaseResponse Response *struct { // When a job is submitted through this API, this parameter is returned and indicates the job ID. Returning the list of job IDs does not mean that the job is parsed/executed successfully. The job state can be queried using the DescribeJob API. JobId *string `json:"JobId,omitempty" name:"JobId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSubmitJobResponse ¶
func NewSubmitJobResponse() (response *SubmitJobResponse)
func (*SubmitJobResponse) FromJsonString ¶
func (r *SubmitJobResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SubmitJobResponse) ToJsonString ¶
func (r *SubmitJobResponse) ToJsonString() string
type SystemDisk ¶
type SystemDisk struct { // System disk type. For more information on limits of system disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952?from_cn_redirect=1). Valid values:<br><li>LOCAL_BASIC: local disk<br><li>LOCAL_SSD: local SSD disk<br><li>CLOUD_BASIC: HDD cloud disk<br><li>CLOUD_SSD: SSD<br><li>CLOUD_PREMIUM: Premium Cloud Storage<br><br>The disk type currently in stock will be used by default. DiskType *string `json:"DiskType,omitempty" name:"DiskType"` // System disk ID. System disks whose type is `LOCAL_BASIC` or `LOCAL_SSD` do not have an ID and do not support this parameter currently. DiskId *string `json:"DiskId,omitempty" name:"DiskId"` // System disk size; unit: GB; default value: 50 GB. DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"` // ID of the dedicated cluster to which the instance belongs. CdcId *string `json:"CdcId,omitempty" name:"CdcId"` }
type Tag ¶
type Tag struct { // Tag key. // Note: This field may return `null`, indicating that no valid value was found. Key *string `json:"Key,omitempty" name:"Key"` // Tag value. // Note: This field may return `null`, indicating that no valid value was found. Value *string `json:"Value,omitempty" name:"Value"` }
type Task ¶
type Task struct { // Application information Application *Application `json:"Application,omitempty" name:"Application"` // Job name, which should be unique within instance TaskName *string `json:"TaskName,omitempty" name:"TaskName"` // Number of running task instances TaskInstanceNum *uint64 `json:"TaskInstanceNum,omitempty" name:"TaskInstanceNum"` // Compute environment information. One (and only one) parameter must be specified for ComputeEnv and EnvId. ComputeEnv *AnonymousComputeEnv `json:"ComputeEnv,omitempty" name:"ComputeEnv"` // Compute environment ID. One (and only one) parameter must be specified for ComputeEnv and EnvId. EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Redirection information RedirectInfo *RedirectInfo `json:"RedirectInfo,omitempty" name:"RedirectInfo"` // Local redirection information RedirectLocalInfo *RedirectLocalInfo `json:"RedirectLocalInfo,omitempty" name:"RedirectLocalInfo"` // Input mapping InputMappings []*InputMapping `json:"InputMappings,omitempty" name:"InputMappings"` // Output mapping OutputMappings []*OutputMapping `json:"OutputMappings,omitempty" name:"OutputMappings"` // Output mapping configuration OutputMappingConfigs []*OutputMappingConfig `json:"OutputMappingConfigs,omitempty" name:"OutputMappingConfigs"` // Custom environment variable EnvVars []*EnvVar `json:"EnvVars,omitempty" name:"EnvVars"` // Authorization information Authentications []*Authentication `json:"Authentications,omitempty" name:"Authentications"` // The processing method after the TaskInstance fails; Value range: TERMINATE (default), INTERRUPT, FAST_INTERRUPT. FailedAction *string `json:"FailedAction,omitempty" name:"FailedAction"` // The maximum number of retries after the task fails. Default value: 0 MaxRetryCount *uint64 `json:"MaxRetryCount,omitempty" name:"MaxRetryCount"` // Timeout period in seconds after the task starts. Defaults value: 86,400 Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"` // The maximum number of concurrent tasks. There is no limit by default. MaxConcurrentNum *uint64 `json:"MaxConcurrentNum,omitempty" name:"MaxConcurrentNum"` // Restarts the compute node after the task is completed. This is suitable for specifying the compute environment for task execution. RestartComputeNode *bool `json:"RestartComputeNode,omitempty" name:"RestartComputeNode"` // Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process. Default value: 0. ResourceMaxRetryCount *uint64 `json:"ResourceMaxRetryCount,omitempty" name:"ResourceMaxRetryCount"` }
type TaskInstanceLog ¶
type TaskInstanceLog struct { // Task instance TaskInstanceIndex *uint64 `json:"TaskInstanceIndex,omitempty" name:"TaskInstanceIndex"` // Standard output log (Base64-encoded) // Note: This field may return null, indicating that no valid values can be obtained. StdoutLog *string `json:"StdoutLog,omitempty" name:"StdoutLog"` // Standard error log (Base64-encoded) // Note: This field may return null, indicating that no valid values can be obtained. StderrLog *string `json:"StderrLog,omitempty" name:"StderrLog"` // Standard output redirection path // Note: This field may return null, indicating that no valid values can be obtained. StdoutRedirectPath *string `json:"StdoutRedirectPath,omitempty" name:"StdoutRedirectPath"` // Standard error redirection path // Note: This field may return null, indicating that no valid values can be obtained. StderrRedirectPath *string `json:"StderrRedirectPath,omitempty" name:"StderrRedirectPath"` // Standard output redirection file name // Note: This field may return null, indicating that no valid values can be obtained. StdoutRedirectFileName *string `json:"StdoutRedirectFileName,omitempty" name:"StdoutRedirectFileName"` // Standard error redirection file name // Note: This field may return null, indicating that no valid values can be obtained. StderrRedirectFileName *string `json:"StderrRedirectFileName,omitempty" name:"StderrRedirectFileName"` }
type TaskInstanceMetrics ¶
type TaskInstanceMetrics struct { // Submitted count SubmittedCount *int64 `json:"SubmittedCount,omitempty" name:"SubmittedCount"` // Pending count PendingCount *int64 `json:"PendingCount,omitempty" name:"PendingCount"` // Runnable count RunnableCount *int64 `json:"RunnableCount,omitempty" name:"RunnableCount"` // Starting count StartingCount *int64 `json:"StartingCount,omitempty" name:"StartingCount"` // Running count RunningCount *int64 `json:"RunningCount,omitempty" name:"RunningCount"` // Succeed count SucceedCount *int64 `json:"SucceedCount,omitempty" name:"SucceedCount"` // FailedInterrupted count FailedInterruptedCount *int64 `json:"FailedInterruptedCount,omitempty" name:"FailedInterruptedCount"` // Failed count FailedCount *int64 `json:"FailedCount,omitempty" name:"FailedCount"` }
type TaskInstanceView ¶
type TaskInstanceView struct { // Task instance index TaskInstanceIndex *int64 `json:"TaskInstanceIndex,omitempty" name:"TaskInstanceIndex"` // Task instance state TaskInstanceState *string `json:"TaskInstanceState,omitempty" name:"TaskInstanceState"` // Exit code after application execution is completed // Note: This field may return null, indicating that no valid values can be obtained. ExitCode *int64 `json:"ExitCode,omitempty" name:"ExitCode"` // Task instance state reason. If the task instance fails, the reason for the failure will be logged. StateReason *string `json:"StateReason,omitempty" name:"StateReason"` // The InstanceId of the compute node (e.g., CVM instance) where the task instance is running. This field is empty if the task instance is not running or has already been completed and will change when the task instance is retried // Note: This field may return null, indicating that no valid values can be obtained. ComputeNodeInstanceId *string `json:"ComputeNodeInstanceId,omitempty" name:"ComputeNodeInstanceId"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Start time // Note: This field may return null, indicating that no valid values can be obtained. LaunchTime *string `json:"LaunchTime,omitempty" name:"LaunchTime"` // Running start time // Note: This field may return null, indicating that no valid values can be obtained. RunningTime *string `json:"RunningTime,omitempty" name:"RunningTime"` // End time // Note: This field may return null, indicating that no valid values can be obtained. EndTime *string `json:"EndTime,omitempty" name:"EndTime"` // Redirection information RedirectInfo *RedirectInfo `json:"RedirectInfo,omitempty" name:"RedirectInfo"` // Task instance state reason details. If the task instance fails, the reason for the failure will be logged StateDetailedReason *string `json:"StateDetailedReason,omitempty" name:"StateDetailedReason"` }
type TaskMetrics ¶
type TaskMetrics struct { // Submitted count SubmittedCount *int64 `json:"SubmittedCount,omitempty" name:"SubmittedCount"` // Pending count PendingCount *int64 `json:"PendingCount,omitempty" name:"PendingCount"` // Runnable count RunnableCount *int64 `json:"RunnableCount,omitempty" name:"RunnableCount"` // Starting count StartingCount *int64 `json:"StartingCount,omitempty" name:"StartingCount"` // Running count RunningCount *int64 `json:"RunningCount,omitempty" name:"RunningCount"` // Succeed count SucceedCount *int64 `json:"SucceedCount,omitempty" name:"SucceedCount"` // FailedInterrupted count FailedInterruptedCount *int64 `json:"FailedInterruptedCount,omitempty" name:"FailedInterruptedCount"` // Failed count FailedCount *int64 `json:"FailedCount,omitempty" name:"FailedCount"` }
type TaskTemplateView ¶
type TaskTemplateView struct { // Task template ID TaskTemplateId *string `json:"TaskTemplateId,omitempty" name:"TaskTemplateId"` // Task template name TaskTemplateName *string `json:"TaskTemplateName,omitempty" name:"TaskTemplateName"` // Task template description TaskTemplateDescription *string `json:"TaskTemplateDescription,omitempty" name:"TaskTemplateDescription"` // Task template information TaskTemplateInfo *Task `json:"TaskTemplateInfo,omitempty" name:"TaskTemplateInfo"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Tag list bound to the task template. // Note: This field may return `null`, indicating that no valid value was found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
type TaskView ¶
type TaskView struct { // Task name TaskName *string `json:"TaskName,omitempty" name:"TaskName"` // Task state TaskState *string `json:"TaskState,omitempty" name:"TaskState"` // Create time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // End time // Note: This field may return null, indicating that no valid values can be obtained. EndTime *string `json:"EndTime,omitempty" name:"EndTime"` }
type TerminateComputeNodeRequest ¶
type TerminateComputeNodeRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // Compute node ID ComputeNodeId *string `json:"ComputeNodeId,omitempty" name:"ComputeNodeId"` }
func NewTerminateComputeNodeRequest ¶
func NewTerminateComputeNodeRequest() (request *TerminateComputeNodeRequest)
func (*TerminateComputeNodeRequest) FromJsonString ¶
func (r *TerminateComputeNodeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateComputeNodeRequest) ToJsonString ¶
func (r *TerminateComputeNodeRequest) ToJsonString() string
type TerminateComputeNodeResponse ¶
type TerminateComputeNodeResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewTerminateComputeNodeResponse ¶
func NewTerminateComputeNodeResponse() (response *TerminateComputeNodeResponse)
func (*TerminateComputeNodeResponse) FromJsonString ¶
func (r *TerminateComputeNodeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateComputeNodeResponse) ToJsonString ¶
func (r *TerminateComputeNodeResponse) ToJsonString() string
type TerminateComputeNodesRequest ¶
type TerminateComputeNodesRequest struct { *tchttp.BaseRequest // Compute environment ID EnvId *string `json:"EnvId,omitempty" name:"EnvId"` // List of compute node IDs ComputeNodeIds []*string `json:"ComputeNodeIds,omitempty" name:"ComputeNodeIds"` }
func NewTerminateComputeNodesRequest ¶
func NewTerminateComputeNodesRequest() (request *TerminateComputeNodesRequest)
func (*TerminateComputeNodesRequest) FromJsonString ¶
func (r *TerminateComputeNodesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateComputeNodesRequest) ToJsonString ¶
func (r *TerminateComputeNodesRequest) ToJsonString() string
type TerminateComputeNodesResponse ¶
type TerminateComputeNodesResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewTerminateComputeNodesResponse ¶
func NewTerminateComputeNodesResponse() (response *TerminateComputeNodesResponse)
func (*TerminateComputeNodesResponse) FromJsonString ¶
func (r *TerminateComputeNodesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateComputeNodesResponse) ToJsonString ¶
func (r *TerminateComputeNodesResponse) ToJsonString() string
type TerminateJobRequest ¶
type TerminateJobRequest struct { *tchttp.BaseRequest // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` }
func NewTerminateJobRequest ¶
func NewTerminateJobRequest() (request *TerminateJobRequest)
func (*TerminateJobRequest) FromJsonString ¶
func (r *TerminateJobRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateJobRequest) ToJsonString ¶
func (r *TerminateJobRequest) ToJsonString() string
type TerminateJobResponse ¶
type TerminateJobResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewTerminateJobResponse ¶
func NewTerminateJobResponse() (response *TerminateJobResponse)
func (*TerminateJobResponse) FromJsonString ¶
func (r *TerminateJobResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateJobResponse) ToJsonString ¶
func (r *TerminateJobResponse) ToJsonString() string
type TerminateTaskInstanceRequest ¶
type TerminateTaskInstanceRequest struct { *tchttp.BaseRequest // Instance ID JobId *string `json:"JobId,omitempty" name:"JobId"` // Task name TaskName *string `json:"TaskName,omitempty" name:"TaskName"` // Task instance index TaskInstanceIndex *int64 `json:"TaskInstanceIndex,omitempty" name:"TaskInstanceIndex"` }
func NewTerminateTaskInstanceRequest ¶
func NewTerminateTaskInstanceRequest() (request *TerminateTaskInstanceRequest)
func (*TerminateTaskInstanceRequest) FromJsonString ¶
func (r *TerminateTaskInstanceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateTaskInstanceRequest) ToJsonString ¶
func (r *TerminateTaskInstanceRequest) ToJsonString() string
type TerminateTaskInstanceResponse ¶
type TerminateTaskInstanceResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewTerminateTaskInstanceResponse ¶
func NewTerminateTaskInstanceResponse() (response *TerminateTaskInstanceResponse)
func (*TerminateTaskInstanceResponse) FromJsonString ¶
func (r *TerminateTaskInstanceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateTaskInstanceResponse) ToJsonString ¶
func (r *TerminateTaskInstanceResponse) ToJsonString() string
type VirtualPrivateCloud ¶
type VirtualPrivateCloud struct { // VPC ID in the format of `vpc-xxx`. To obtain valid VPC IDs, you can log in to the [console](https://console.cloud.tencent.com/vpc/vpc?rid=1) or call the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API and look for the `unVpcId` fields in the response. If you specify `DEFAULT` for both `VpcId` and `SubnetId` when creating an instance, the default VPC will be used. VpcId *string `json:"VpcId,omitempty" name:"VpcId"` // VPC subnet ID in the format `subnet-xxx`. To obtain valid subnet IDs, you can log in to the [console](https://console.cloud.tencent.com/vpc/subnet?rid=1) or call [DescribeSubnets](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) and look for the `unSubnetId` fields in the response. If you specify `DEFAULT` for both `SubnetId` and `VpcId` when creating an instance, the default VPC will be used. SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"` // Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values: <br><li>`TRUE`: yes;<br><li>`FALSE`: no<br><br>Default: `FALSE`. AsVpcGateway *bool `json:"AsVpcGateway,omitempty" name:"AsVpcGateway"` // Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. PrivateIpAddresses []*string `json:"PrivateIpAddresses,omitempty" name:"PrivateIpAddresses"` // Number of IPv6 addresses randomly generated for the ENI. Ipv6AddressCount *uint64 `json:"Ipv6AddressCount,omitempty" name:"Ipv6AddressCount"` }