Compute environment creation or termination activities
Used by actions: DescribeComputeEnvActivities.
Name | Type | Description |
---|---|---|
ActivityId | String | Activity ID |
ComputeNodeId | String | Compute node ID |
ComputeNodeActivityType | String | Compute node activity type: creation or termination |
EnvId | String | Compute environment ID |
Cause | String | Cause |
ActivityState | String | Active status |
StateReason | String | State reason |
StartTime | String | Activity start time |
EndTime | String | Activity end time Note: This field may return null, indicating that no valid values can be obtained. |
InstanceId | String | CVM instance ID Note: This field may return null, indicating that no valid values can be obtained. |
Agent running mode
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
Scene | String | Yes | Scenario type. Windows is supported |
User | String | Yes | The user that runs the Agent |
Session | String | Yes | The session that runs the Agent |
Compute environment
Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
EnvType | String | No | Compute environment management type |
EnvData | EnvData | No | Compute environment's specific parameters |
MountDataDisks | Array of MountDataDisk | No | Data disk mounting option |
AgentRunningMode | AgentRunningMode | No | Agent running mode; applicable for Windows |
Application information
Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
Command | String | Yes | Task execution command |
DeliveryForm | String | Yes | Delivery form of the application. Value range: PACKAGE, LOCAL, which refer to remotely stored software package and local compute environment, respectively. |
PackagePath | String | No | Remote storage path of the application package |
Docker | Docker | No | 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. |
Authentication information
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
Scene | String | Yes | Authentication scenario such as COS |
SecretId | String | Yes | SecretId |
SecretKey | String | Yes | SecretKey |
Compute environment creation information
Used by actions: DescribeComputeEnvCreateInfos.
Name | Type | Description |
---|---|---|
EnvId | String | Compute environment ID |
EnvName | String | Compute environment name Note: This field may return null, indicating that no valid values can be obtained. |
EnvDescription | String | Compute environment description Note: This field may return null, indicating that no valid values can be obtained. |
EnvType | String | Compute environment type. Only "MANAGED" type is supported |
EnvData | EnvData | Compute environment parameter |
MountDataDisks | Array of MountDataDisk | Data disk mounting option Note: This field may return null, indicating that no valid values can be obtained. |
InputMappings | Array of InputMapping | Input mapping Note: This field may return null, indicating that no valid values can be obtained. |
Authentications | Array of Authentication | Authorization information Note: This field may return null, indicating that no valid values can be obtained. |
Notifications | Array of Notification | Notification information Note: This field may return null, indicating that no valid values can be obtained. |
DesiredComputeNodeCount | Integer | Number of desired compute nodes |
Tags | Array of Tag | Tag list of the compute environment. Note: This field may return null , indicating that no valid value was found. |
Compute environment attributes
Used by actions: ModifyComputeEnv.
Name | Type | Required | Description |
---|---|---|---|
InstanceTypes | Array of String | Yes | List of CVM instance types |
Compute environment information
Used by actions: DescribeComputeEnvs.
Name | Type | Description |
---|---|---|
EnvId | String | Compute environment ID |
EnvName | String | Compute environment name |
Placement | Placement | Location information |
CreateTime | String | Creation time |
ComputeNodeMetrics | ComputeNodeMetrics | Compute node statistical metrics |
EnvType | String | Compute environment type |
DesiredComputeNodeCount | Integer | Number of desired compute nodes |
ResourceType | String | Compute environment resource type. Valid values: CVM , CPM (Bare Metal) |
NextAction | String | Next action |
AttachedComputeNodeCount | Integer | Number of compute nodes added to the compute environment by the user |
Tags | Array of Tag | Tag list bound to the compute environment. Note: This field may return null , indicating that no valid value was found. |
Compute node
Used by actions: DescribeComputeEnv.
Name | Type | Description |
---|---|---|
ComputeNodeId | String | Compute node ID |
ComputeNodeInstanceId | String | Compute node instance ID. In a CVM scenario, this parameter is the CVM InstanceId |
ComputeNodeState | String | Compute node state |
Cpu | Integer | Number of CPU cores |
Mem | Integer | Memory size in GiB |
ResourceCreatedTime | String | Resource creation time |
TaskInstanceNumAvailable | Integer | Available capacity of the compute node when running TaskInstance. 0 means that the compute node is busy. |
AgentVersion | String | BatchCompute Agent version |
PrivateIpAddresses | Array of String | Private IP of the instance |
PublicIpAddresses | Array of String | Public IP of the instance |
ResourceType | String | Compute environment resource type. Valid values: CVM , CPM (Bare Metal) |
ResourceOrigin | String | Source of compute environment resources. BATCH_CREATED: instance resources created by BatchCompute. USER_ATTACHED: instance resources added by users to the compute environment. |
Compute node statistical metrics
Used by actions: DescribeComputeEnv, DescribeComputeEnvs.
Name | Type | Description |
---|---|---|
SubmittedCount | Integer | Number of compute nodes that have been submitted |
CreatingCount | Integer | Number of compute nodes that are being created |
CreationFailedCount | Integer | Number of compute nodes that failed to be created |
CreatedCount | Integer | Number of compute nodes that have been created |
RunningCount | Integer | Number of running compute nodes |
DeletingCount | Integer | Number of compute nodes that are being terminated |
AbnormalCount | Integer | Number of exceptional compute nodes |
Describes data disk information.
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
DiskSize | Integer | Yes | 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. The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation. |
DiskType | String | No | Data disk type. For more information about limits on different data disk types, see Storage Overview. Valid values: InstanceType InstanceType Default value: LOCAL_BASIC. This parameter is invalid for the ResizeInstanceDisk API. |
DiskId | String | No | Data disk ID. Data disks of the type LOCAL_BASIC or LOCAL_SSD do not have IDs and do not support this parameter. |
DeleteWithInstance | Boolean | No | Whether to terminate the data disk when its CVM is terminated. Valid values: Default value: TRUE Currently this parameter is only used in the RunInstances API.Note: This field may return null, indicating that no valid value is found. |
SnapshotId | String | No | 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. |
Encrypt | Boolean | No | Specifies whether the data disk is encrypted. Valid values: Default value: FALSE This parameter is only used with RunInstances .Note: this field may return null , indicating that no valid value is obtained. |
KmsKeyId | String | No | 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. |
ThroughputPerformance | Integer | No | Cloud disk performance, in MB/s Note: this field may return null , indicating that no valid values can be obtained. |
Dependency
Used by actions: DescribeJob, DescribeJobSubmitInfo, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
StartTask | String | Yes | Dependency start task name | |
EndTask | String | Yes | Dependency end task name | |
Docker container information
Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
User | String | Yes | Docker Hub username or Tencent Registry username |
Password | String | Yes | Docker Hub password or Tencent Registry password |
Image | String | Yes | For Docker Hub, enter "[user/repo]:[tag]"; for Tencent Registry, enter "ccr.ccs.tencentyun.com/[namespace/repo]:[tag]" |
Server | String | No | 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" |
Describes the configuration of enhanced services, such as Cloud Security and Cloud Monitor.
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
SecurityService | RunSecurityServiceEnabled | No | Enables cloud security service. If this parameter is not specified, the cloud security service will be enabled by default. |
MonitorService | RunMonitorServiceEnabled | No | Enables cloud monitor service. If this parameter is not specified, the cloud monitor service will be enabled by default. |
Compute environment information
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
InstanceType | String | No | CVM instance type, which cannot be present together with InstanceTypes or InstanceTypeOptions at the same time. |
ImageId | String | No | CVM image ID |
SystemDisk | SystemDisk | No | Information of the instance's system disk configuration |
DataDisks | Array of DataDisk | No | Information of the instance's data disk configuration |
VirtualPrivateCloud | VirtualPrivateCloud | No | Information of the VPC configuration, which cannot be specified together with Zones and VirtualPrivateClouds. |
InternetAccessible | InternetAccessible | No | Information of the public network bandwidth configuration |
InstanceName | String | No | CVM instance display name |
LoginSettings | LoginSettings | No | Instance login settings |
SecurityGroupIds | Array of String | No | Security group of the instance |
EnhancedService | EnhancedService | No | 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. |
InstanceChargeType | String | No | CVM instance billing method Default value: POSTPAID_BY_HOUR. |
InstanceMarketOptions | InstanceMarketOptionsRequest | No | Market-related options of the instance, such as parameters related to spot instance |
InstanceTypes | Array of String | No | 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. |
InstanceTypeOptions | InstanceTypeOptions | No | CVM instance model configuration, which cannot be present together with InstanceType or InstanceTypes at the same time. |
Zones | Array of String | No | 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. |
VirtualPrivateClouds | Array of VirtualPrivateCloud | No | List of VPCs (creation of CVM instances across VPCs is supported), which cannot be specified together with VirtualPrivateCloud or Zones at the same time. |
Environment variable
Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Environment variable name |
Value | String | Yes | Environment variable value |
Event configuration
Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
EventName | String | Yes | Event type. Value range: |
EventVars | Array of EventVar | Yes | Custom key-value pair |
Custom key-value pair
Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Custom key |
Value | String | Yes | Custom value |
Additional data
Used by actions: DescribeCvmZoneInstanceConfigInfos.
Name | Type | Required | Description |
---|---|---|---|
ReleaseAddress | Boolean | No | Release address Note: This field may return null, indicating that no valid value is found. |
UnsupportNetworks | Array of String | No | Not supported network. Value: Note: This field may return null, indicating that no valid value was found. |
StorageBlockAttr | StorageBlock | No | Attributes of local HDD storage Note: This field may return null, indicating that no valid value is found. |
Key-value pair filters used for conditional queries, such as filtering results by ID, name, and state.
- If there are multiple
Filter
parameters, they are evaluated using the logicalAND
operator.- If a
Filter
contains multipleValues
, they are evaluated using the logicalOR
operator.Take DescribeInstances as an example. You can use the following filters to query the instances in availability zone (
zone
) Guangzhou Zone 1 and whose billing plan (instance-charge-type
) is pay-as-you-go:
Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.0=POSTPAID_BY_HOUR
Used by actions: DescribeAvailableCvmInstanceTypes, DescribeComputeEnvActivities, DescribeComputeEnvCreateInfos, DescribeComputeEnvs, DescribeCvmZoneInstanceConfigInfos, DescribeJobs, DescribeTask, DescribeTaskTemplates.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filters. |
Values | Array of String | Yes | Filter values. |
Input mapping
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
SourcePath | String | Yes | Source path |
DestinationPath | String | Yes | Destination path |
MountOptionParameter | String | No | Mounting configuration item parameter |
Describes information on an instance
Used by actions: AttachInstances.
Name | Type | Required | Description |
---|---|---|---|
InstanceId | String | Yes | Instance ID. |
ImageId | String | No | Image ID. |
LoginSettings | LoginSettings | No | Instance login settings. |
List of instance categories
Used by actions: DescribeInstanceCategories.
Name | Type | Description |
---|---|---|
InstanceCategory | String | Instance type name |
InstanceFamilySet | Array of String | List of instance families |
Options related to bidding requests
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
SpotOptions | SpotMarketOptions | Yes | Options related to bidding |
MarketType | String | No | Market option type. Currently spot is the only supported value. |
Information of InstanceTypeConfig available to BatchCompute
Used by actions: DescribeAvailableCvmInstanceTypes.
Name | Type | Description |
---|---|---|
Mem | Integer | Memory size in GB. |
Cpu | Integer | Number of CPU cores. |
InstanceType | String | Instance model. |
Zone | String | Availability zone. |
InstanceFamily | String | Instance model family. |
Instance model configuration.
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
CPU | Integer | Yes | Number of CPU cores. |
Memory | Integer | Yes | Memory size in GB. |
InstanceCategories | Array of String | No | Instance model category. Value range: "ALL", "GENERAL", "GENERAL_2", "GENERAL_3", "COMPUTE", "COMPUTE_2", and "COMPUTE_3". Default value: "ALL". |
Describes instance model quota.
Used by actions: DescribeCvmZoneInstanceConfigInfos.
Name | Type | Description |
---|---|---|
Zone | String | Availability zone. |
InstanceType | String | Instance model. |
InstanceChargeType | String | Instance billing plan. Valid values: CDHPAID : CDH billing plan. Applicable to CDH only, not the instances on the host. |
NetworkCard | Integer | ENI type. For example, 25 represents an ENI of 25 GB. |
Externals | Externals | Additional data. Note: This field may return null, indicating that no valid value is found. |
Cpu | Integer | Number of CPU cores of an instance model. |
Memory | Integer | Instance memory capacity; unit: GB . |
InstanceFamily | String | Instance model family. |
TypeName | String | Model name. |
LocalDiskTypeList | Array of LocalDiskType | List of local disk specifications. If the parameter returns null, it means that local disks cannot be created. |
Status | String | Whether an instance model is available. Valid values: |
Price | ItemPrice | Price of an instance model. |
SoldOutReason | String | Details of out-of-stock items Note: this field may return null, indicating that no valid value is obtained. |
InstanceBandwidth | Float | Private network bandwidth, in Gbps. |
InstancePps | Integer | The max packet sending and receiving capability (in 10k PPS). |
StorageBlockAmount | Integer | Number of local storage blocks. |
CpuType | String | CPU type. |
Gpu | Integer | Number of GPUs of the instance. |
Fpga | Integer | Number of FPGAs of the instance. |
Remark | String | Descriptive information of the instance. |
Describes the accessibility of an instance in the public network, including its network billing method, maximum bandwidth, etc.
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
InternetChargeType | String | No | Network connection billing plan. Valid value: |
InternetMaxBandwidthOut | Integer | No | 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. |
PublicIpAssigned | Boolean | No | Whether to assign a public IP. Valid values: 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. |
BandwidthPackageId | String | No | Bandwidth package ID. To obatin the IDs, you can call DescribeBandwidthPackages and look for the BandwidthPackageId fields in the response. |
Describes pricing information.
Used by actions: DescribeCvmZoneInstanceConfigInfos.
Name | Type | Description |
---|---|---|
UnitPrice | Float | The original unit price for pay-as-you-go mode in USD. 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. |
ChargeUnit | String | Billing unit for pay-as-you-go mode. Valid values: POSTPAID_BY_HOUR ). TRAFFIC_POSTPAID_BY_HOUR ).Note: this field may return null, indicating that no valid value is obtained. |
OriginalPrice | Float | The original price of a pay-in-advance instance, in USD. Note: this field may return null, indicating that no valid value is obtained. |
DiscountPrice | Float | Discount price of a prepaid instance, in USD. Note: this field may return null, indicating that no valid value is obtained. |
Discount | Float | 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. |
UnitPriceDiscount | Float | The discounted unit price for pay-as-you-go mode in USD. 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. |
UnitPriceSecondStep | Float | 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. |
UnitPriceDiscountSecondStep | Float | 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. |
UnitPriceThirdStep | Float | 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. |
UnitPriceDiscountThirdStep | Float | 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. |
OriginalPriceThreeYear | Float | 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. |
DiscountPriceThreeYear | Float | 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. |
DiscountThreeYear | Float | 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. |
OriginalPriceFiveYear | Float | 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. |
DiscountPriceFiveYear | Float | 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. |
DiscountFiveYear | Float | 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. |
OriginalPriceOneYear | Float | 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. |
DiscountPriceOneYear | Float | 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. |
DiscountOneYear | Float | 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. |
Instance
Used by actions: SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
Tasks | Array of Task | Yes | Job information |
JobName | String | No | Instance name |
JobDescription | String | No | Instance description |
Priority | Integer | No | Instance priority. Tasks (Task) and task instances (TaskInstance) inherit the priority of the instance |
Dependences | Array of Dependence | No | Dependency information |
Notifications | Array of Notification | No | Notification information |
TaskExecutionDependOn | String | No | 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. |
StateIfCreateCvmFailed | String | No | 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. |
Tags | Array of Tag | No | Tag list. By setting this parameter, you can bind tags to a job. Each job supports up to 10 tags. |
Instance information
Used by actions: DescribeJobs.
Name | Type | Description |
---|---|---|
JobId | String | Instance ID |
JobName | String | Instance name |
JobState | String | Instance state |
Priority | Integer | Instance priority |
Placement | Placement | Location information Note: This field may return null, indicating that no valid values can be obtained. |
CreateTime | String | Creation time |
EndTime | String | End time Note: This field may return null, indicating that no valid values can be obtained. |
TaskMetrics | TaskMetrics | Task statistical metrics |
Tags | Array of Tag | Tag list bound to the job. Note: This field may return null , indicating that no valid value was found. |
Describes local disk specifications.
Used by actions: DescribeCvmZoneInstanceConfigInfos.
Name | Type | Description |
---|---|---|
Type | String | Type of a local disk. |
PartitionType | String | Attributes of a local disk. |
MinSize | Integer | Minimum size of a local disk. |
MaxSize | Integer | Maximum size of a local disk. |
Required | String | Whether a local disk is required during purchase. Valid values: |
Describes the configuration and information related to instance login.
Used by actions: AttachInstances, CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
Password | String | No | Login password of the instance. The password requirements vary among different operating systems: ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]. <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 [( ) ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]. If this parameter is not specified, a random password will be generated and sent to you via the Message Center. |
KeyIds | Array of String | No | 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. |
KeepImageLogin | String | No | 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: Default value: FALSE. |
Data disk mounting option
Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
LocalPath | String | Yes | Mounting point. For Linux, this parameter should be a valid path. For Windows, this parameter should be a system disk letter such as "H:\" |
FileSystemType | String | No | File system type. For Linux, "EXT3" and "EXT4" are supported and the default value is "EXT3". For Windows, only "NTFS" is supported |
Compute environment
Used by actions: CreateComputeEnv.
Name | Type | Required | Description |
---|---|---|---|
EnvName | String | Yes | Compute environment name |
DesiredComputeNodeCount | Integer | Yes | Number of desired compute nodes |
EnvDescription | String | No | Compute environment description |
EnvType | String | No | Compute environment management type |
EnvData | EnvData | No | Compute environment's specific parameters |
MountDataDisks | Array of MountDataDisk | No | Data disk mounting option |
Authentications | Array of Authentication | No | Authorization information |
InputMappings | Array of InputMapping | No | Input mapping information |
AgentRunningMode | AgentRunningMode | No | Agent running mode; applicable for Windows |
Notifications | Notification | No | Notification information |
ActionIfComputeNodeInactive | String | No | 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. |
ResourceMaxRetryCount | Integer | No | 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. |
Tags | Array of Tag | No | Tag list. By setting this parameter, you can bind tags to a compute environment. Each compute environment supports up to 10 tags. |
Notification information
Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
TopicName | String | Yes | CMQ topic name which should be valid and associated with a subscription |
EventConfigs | Array of EventConfig | Yes | Event configuration |
Output mapping
Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob.
Name | Type | Required | Description |
---|---|---|---|
SourcePath | String | Yes | Source path< |