tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2023-05-09 15:39:21

    Activity

    Information of the creation/termination activity of a compute node

    Used by actions: DescribeComputeEnvActivities.

    Name Type Description
    ActivityId String Activity ID
    ComputeNodeId String Compute node ID
    ComputeNodeActivityType String Activity type. Values: CREATE_COMPUTE_NODE, TERMINATE_COMPUTE_NODE
    EnvId String Compute environment ID
    Cause String Cause of the activity
    ActivityState String Activity state
    StateReason String Reason of going to this state
    StartTime String Activity start time
    EndTime String Activity end time
    Note: This field may return null, indicating that no valid value was found.
    InstanceId String CVM instance ID
    Note: This field may return null, indicating that no valid value was found.

    AgentRunningMode

    Agent running mode

    Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    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

    AnonymousComputeEnv

    Compute environment

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    EnvType String No Compute environment management type
    EnvData EnvData No Compute environment's parameters
    MountDataDisks Array of MountDataDisk No Data disk mounting option
    AgentRunningMode AgentRunningMode No Agent running mode; applicable for Windows

    Application

    Application information

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    Command String Yes Task execution command
    DeliveryForm String Yes Delivery form of the application. Values: PACKAGE (package stored in a remote location), LOCAL (local computer).
    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

    Authentication information

    Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    Scene String Yes Authentication scenario such as COS
    SecretId String Yes SecretId
    SecretKey String Yes SecretKey

    ComputeEnvCreateInfo

    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 value was found.
    EnvDescription String Compute environment description
    Note: This field may return null, indicating that no valid value was found.
    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 value was found.
    InputMappings Array of InputMapping Input mapping
    Note: This field may return null, indicating that no valid value was found.
    Authentications Array of Authentication Authorization information
    Note: This field may return null, indicating that no valid value was found.
    Notifications Array of Notification Notification information
    Note: This field may return null, indicating that no valid value was found.
    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.

    ComputeEnvData

    Compute environment attributes

    Used by actions: ModifyComputeEnv.

    Name Type Required Description
    InstanceTypes Array of String Yes List of CVM instance types

    ComputeEnvView

    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. Values: CVM, CPM (Bare Metal)
    NextAction String Next action
    AttachedComputeNodeCount Integer Number of compute nodes added to the compute environment
    Tags Array of Tag Tag list bound to the compute environment.
    Note: This field may return null, indicating that no valid value was found.

    ComputeNode

    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. Values: CVM, CPM (Bare Metal)
    ResourceOrigin String Source of compute environment resources.
    BATCH_CREATED: Instances created by BatchCompute.

    USER_ATTACHED: Instances added to the compute environment by the user.

    ComputeNodeMetrics

    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

    DataDisk

    Describes data disk information.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    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:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • LOCAL_NVME: local NVME disk, specified in the InstanceType
  • LOCAL_PRO: local HDD disk, specified in the InstanceType
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_PREMIUM: Premium Cloud Storage
  • CLOUD_SSD: SSD
  • CLOUD_HSSD: Enhanced SSD
  • CLOUD_TSSD: Tremendous SSD
  • CLOUD_BSSD: Balanced SSD

    Default value: LOCAL_BASIC.

    This parameter is invalid for the ResizeInstanceDisk API.
    		•
    DiskId String No Data disk ID. Note that it’s not available for LOCAL_BASIC and LOCAL_SSD disks.
    It is only used as a response parameter for APIs such as DescribeInstances, and cannot be used as a request parameter for APIs such as RunInstances.
    DeleteWithInstance Boolean No Whether to terminate the data disk when its CVM is terminated. Valid values:
  • 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.
  • FALSE: retain the data disk when its CVM is terminated.

    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:
  • TRUE: encrypted
  • FALSE: not encrypted

    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.
    CdcId String No ID of the dedicated cluster to which the instance belongs.
    Note: this field may return null, indicating that no valid values can be obtained.

    Dependence

    Dependency

    Used by actions: DescribeJob, DescribeJobSubmitInfo.

    Name Type Required Description
    StartTask String Yes Dependency start task name
    EndTask String Yes Dependency end task name

    Docker

    Docker container information

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    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"
    MaxRetryCount Integer No Maximum retry attempts to load docket images. Range: 0 - 10. Default: 0
    DelayOnRetry Integer No Docker image loading timeout period (in seconds). Range: 1 - 360
    DockerRunOption String No Docker command execution parameter
    Note: This field may return null, indicating that no valid value was found.

    EnhancedService

    Describes the configuration of enhanced services, such as Cloud Security and Cloud Monitor.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    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.
    AutomationService RunAutomationServiceEnabled No Whether to enable the TAT service. If this parameter is not specified, the TAT service is enabled for public images and disabled for other images by default.

    EnvData

    Compute environment information

    Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    InstanceType String No CVM instance type. It cannot be specified together with InstanceTypes or InstanceTypeOptions.
    ImageId String No CVM image ID
    SystemDisk SystemDisk No System disk configuration of the instance
    DataDisks Array of DataDisk No Data disk configuration of the instance
    VirtualPrivateCloud VirtualPrivateCloud No Information of the VPC configuration. It cannot be specified together with Zones and VirtualPrivateClouds.
    InternetAccessible InternetAccessible No Public network bandwidth configuration
    InstanceName String No CVM instance display name
    LoginSettings LoginSettings No Instance login settings
    SecurityGroupIds Array of String No Security groups associated with the instance
    EnhancedService EnhancedService No Whether to activate CWPP agent and Cloud Monitor. CWPP agent and Cloud Monitor are activated by default.
    InstanceChargeType String No CVM instance billing method
  • POSTPAID_BY_HOUR (default): Hourly-billed pay-as-you-go
  • SPOTPAID: Spot instance
    • InstanceMarketOptions InstanceMarketOptionsRequest No Market-related options for instances, such as parameters related to spot instances.
    InstanceTypes Array of String No Types of CVM instances to create (up to 10). The system creates compute nodes of types specified in this list from top to down till the creation is successful. It cannot be specified together with InstanceType or InstanceTypeOptions.
    InstanceTypeOptions InstanceTypeOptions No CVM instance model configuration. It cannot be specified together with InstanceType or InstanceTypes.
    Zones Array of String No List of availability zones. You can create CVM cross AZs in the same region. It cannot be specified together with VirtualPrivateCloud or VirtualPrivateClouds.
    VirtualPrivateClouds Array of VirtualPrivateCloud No List of VPCs (creation of CVM instances across VPCs is supported). It cannot be specified together with VirtualPrivateCloud or Zones.

    EnvVar

    Environment variable

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    Name String Yes Environment variable name
    Value String Yes Environment variable value

    EventConfig

    Event configuration

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    EventName String Yes Event type. Value range:
  • JOB_RUNNING: The job is running, applicable to SubmitJob.
  • JOB_SUCCEED: The job succeeded, applicable to SubmitJob.
  • JOB_FAILED: The job failed, applicable to SubmitJob.
  • JOB_FAILED_INTERRUPTED: The job failed and the instance is retained, applicable to SubmitJob.
  • TASK_RUNNING: The task is running, applicable to SubmitJob.
  • TASK_SUCCEED: The task succeeded, applicable to SubmitJob.
  • TASK_FAILED: The task failed, applicable to SubmitJob.
  • TASK_FAILED_INTERRUPTED: The task failed and the instance is retained, applicable to SubmitJob.
  • TASK_INSTANCE_RUNNING: The task instance is running, applicable to SubmitJob.
  • TASK_INSTANCE_SUCCEED: The task instance succeeded, applicable to SubmitJob.
  • TASK_INSTANCE_FAILED: The task instance failed, applicable to SubmitJob.
  • TASK_INSTANCE_FAILED_INTERRUPTED: The task instance failed and the instance is retained, applicable to SubmitJob.
  • COMPUTE_ENV_CREATED: the compute environment has been created, applicable to "CreateComputeEnv".
  • COMPUTE_ENV_DELETED: The compute environment has been deleted, applicable to CreateComputeEnv.
  • COMPUTE_NODE_CREATED: The compute node has been created, applicable to CreateComputeEnv and SubmitJob.
  • COMPUTE_NODE_CREATION_FAILED: The compute node creation failed, applicable to CreateComputeEnv and SubmitJob.
  • COMPUTE_NODE_RUNNING: The compute node is running, applicable to CreateComputeEnv and SubmitJob.
  • COMPUTE_NODE_ABNORMAL: The compute node is exceptional, applicable to "CreateComputeEnv" and "SubmitJob".
  • COMPUTE_NODE_DELETING: The compute node has been deleted, applicable to CreateComputeEnv and SubmitJob.
    • EventVars Array of EventVar Yes Custom key-value pair

    EventVar

    Custom key-value pair

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    Name String Yes Custom key
    Value String Yes Custom value

    Externals

    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:
  • BASIC: classic network
  • VPC1.0: VPC1.0
    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.

    Filter

    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 logical AND operator.
    • If a Filter contains multiple Values, they are evaluated using the logical OR 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.

    InputMapping

    Input mapping

    Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    SourcePath String Yes Source path
    DestinationPath String Yes Destination path
    MountOptionParameter String No Mounting configuration item parameter

    Instance

    Describes information of 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.

    InstanceCategoryItem

    List of instance categories

    Used by actions: DescribeInstanceCategories.

    Name Type Description
    InstanceCategory String Instance type name
    InstanceFamilySet Array of String List of instance families

    InstanceMarketOptionsRequest

    Options related to bidding requests

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    SpotOptions SpotMarketOptions Yes Spot-related options
    Note: This field may return null, indicating that no valid values can be obtained.
    MarketType String No Market type. Valid value: spot.
    Note: This field may return null, indicating that no valid values can be obtained.

    InstanceTypeConfig

    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.

    InstanceTypeOptions

    Instance model configuration.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    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. Values: ALL (default), GENERAL, GENERAL_2, GENERAL_3, COMPUTE, COMPUTE_2, and COMPUTE_3.

    InstanceTypeQuotaItem

    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:
  • POSTPAID_BY_HOUR: pay after use. You are billed for your traffic by the hour.
  • 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:
  • SELL: available
  • SOLD_OUT: sold out
    		•
    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.
    GpuCount Float
    Frequency String CPU clock rate of the instance

    InternetAccessible

    Describes the accessibility of an instance in the public network, including its network billing method, maximum bandwidth, etc.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    InternetChargeType String No Network connection billing plan. Valid value:
  • TRAFFIC_POSTPAID_BY_HOUR: pay after use. You are billed for your traffic, by the hour.
    		•
    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:
  • TRUE: Assign a public IP
  • FALSE: Do not assign a public IP

    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.

    ItemPrice

    Describes pricing information.

    Used by actions: DescribeCvmZoneInstanceConfigInfos.

    Name Type Description
    UnitPrice Float The original unit price for pay-as-you-go mode in USD.
  • 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.
    		•
    ChargeUnit String Billing unit for pay-as-you-go mode. Valid values:
  • HOUR: billed on an hourly basis. It's used for hourly postpaid instances (POSTPAID_BY_HOUR).
  • 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.
    		•
    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.
  • 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.
    		•
    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.

    JobView

    Job information

    Used by actions: DescribeJobs.

    Name Type Description
    JobId String Job ID
    JobName String Job name
    JobState String Job state
    Priority Integer Job priority
    Placement Placement Location information
    Note: This field may return null, indicating that no valid value was found.
    CreateTime String Creation time
    EndTime String End time
    Note: This field may return null, indicating that no valid value was found.
    TaskMetrics TaskMetrics Task statistical metrics
    Tags Array of Tag List of tags bound with the job.
    Note: This field may return null, indicating that no valid value was found.

    LocalDiskType

    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:
  • REQUIRED: required
  • OPTIONAL: optional
    		•

    LoginSettings

    Describes login settings of an instance.

    Used by actions: AttachInstances, CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    Password String No Login password of the instance.
  • Linux instances: 8-16 characters, containing at least two of the following categories: [a-z, A-Z], [0-9] and [()`~!@#$%^&*-+=
    		•
    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. Values: TRUE (default), FALSE. It cannot be specified together with Password or KeyIds.N. You can specify this parameter as TRUE only when you create an instance using a custom image, a shared image, or an imported image.

    MountDataDisk

    Data disk mounting option

    Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    LocalPath String Yes Mounting point. A valid path (for Linux) for a drive (for Windows, such as "H:\")
    FileSystemType String No File system type. Linux: EXT3 (default) and EXT4. Windows: NTFS

    NamedComputeEnv

    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 Array of Notification No Notification information
    ActionIfComputeNodeInactive String No Policy for inactive nodes. Default: 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 100 and the default value is 7.
    Tags Array of Tag No List of tags to bind with a compute environment. Each compute environment can have up to 10 tags.
    NotificationTarget String No Target of the notification
    Values: CMQ, TDMQ_CMQ
    CMQ: Tencent Cloud CMQ (default)
    TDMQ_CMQ: Tencent Cloud TDMQ_CMQ.
    Note: CMQ has been discontinued. Please use TDMQ_CMQ. See CMQ Queue Migration to TDMQ for CMQ

    Notification

    Notification information

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos.

    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

    OutputMapping

    Output mapping

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    SourcePath String Yes Source path
    DestinationPath String Yes Destination path
    OutputMappingOption OutputMappingOption No Output mapping options
    Note: This field may return null, indicating that no valid value was found.

    OutputMappingConfig

    Output mapping configuration

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    Scene String Yes Storage type. Only COS is supported.
    WorkerNum Integer Yes Number of concurrent workers
    WorkerPartSize Integer Yes Size of a worker part, in MB.

    OutputMappingOption

    Output mapping options

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    Workspace String No The mapped output workspace on the container side for the instance.
    BATCH_WORKSPACE (Default): The workspace is the workspace defined for the usage of Batch Compute. Batch Compute ensures the isolation between jobs.
    GLOBAL_WORKSPACE: The workspace is the instance OS space..
    Note: This field may return null, indicating that no valid value was found.

    Placement

    Placement of an instance, including its availability zone, project, host (for CDH products only), master host IP, etc.

    Used by actions: CreateComputeEnv, DescribeComputeEnv, DescribeComputeEnvs, DescribeJobs.

    Name Type Required Description
    Zone String Yes ID of the availability zone where the instance resides. You can call the DescribeZones API and obtain the ID in the returned Zone field.
    ProjectId Integer No ID of the project to which the instance belongs. This parameter can be obtained from the projectId returned by DescribeProject. If this is left empty, the default project is used.
    HostIds Array of String No 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.
    HostIps Array of String No IPs of the hosts to create CVMs
    HostId String No The ID of the CDH to which the instance belongs, only used as an output parameter.

    RedirectInfo

    Redirection information

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTask, ModifyTaskTemplate.

    Name Type Required Description
    StdoutRedirectPath String No Standard output redirection path
    StderrRedirectPath String No Standard error redirection path
    StdoutRedirectFileName String No Standard output redirection file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX}
    StderrRedirectFileName String No Standard error redirection file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX}

    RedirectLocalInfo

    Local redirection information

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate.

    Name Type Required Description
    StdoutLocalPath String No Standard output redirection local path
    StderrLocalPath String No Standard error redirection local path
    StdoutLocalFileName String No Standard output redirection local file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX}
    StderrLocalFileName String No Standard error redirection local file name, which supports three placeholders: ${BATCH_JOB_ID}, ${BATCH_TASK_NAME}, and ${BATCH_TASK_INSTANCE_INDEX}

    RunAutomationServiceEnabled

    Describes the TAT service information.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    Enabled Boolean No Whether to enable the TAT service. Valid values:
  • TRUE: yes;
  • FALSE: no

    Default: FALSE.
    		•

    RunMonitorServiceEnabled

    Describes information related to the Cloud Monitor service.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    Enabled Boolean No Whether to enable Cloud Monitor. Valid values:
  • TRUE: enable Cloud Monitor
  • FALSE: do not enable Cloud Monitor

    Default value: TRUE.
    		•

    RunSecurityServiceEnabled

    Describes information related to the Cloud Security service.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    Enabled Boolean No Whether to enable Cloud Security. Valid values:
  • TRUE: enable Cloud Security
  • FALSE: do not enable Cloud Security

    Default value: TRUE.
    		•

    SpotMarketOptions

    Options related to bidding.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    MaxPrice String Yes Bidding price
    SpotInstanceType String No Bidding request type. Currently only "one-time" is supported.

    StorageBlock

    Information on local HDD storage.

    Used by actions: DescribeCvmZoneInstanceConfigInfos.

    Name Type Description
    Type String Local HDD storage type. Value: LOCAL_PRO.
    Note: This field may return null, indicating that no valid value is found.
    MinSize Integer Minimum capacity of local HDD storage
    Note: This field may return null, indicating that no valid value is found.
    MaxSize Integer Maximum capacity of local HDD storage
    Note: This field may return null, indicating that no valid value is found.

    SystemDisk

    Describes information on the block device where the operating system is stored, i.e., the system disk.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    DiskType String No System disk type. For more information about the limits of system disk types, please see Storage Overview. Valid values:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_SSD: SSD cloud disk
  • CLOUD_PREMIUM: Premium cloud storage
  • CLOUD_BSSD: Balanced SSD

    The disk currently in stock will be used by default.
    		•
    DiskId String No System disk ID. System disks whose type is LOCAL_BASIC or LOCAL_SSD do not have an ID and do not support this parameter.
    It is only used as a response parameter for APIs such as DescribeInstances, and cannot be used as a request parameter for APIs such as RunInstances.
    DiskSize Integer No System disk size; unit: GB; default value: 50 GB.
    CdcId String No ID of the dedicated cluster to which the instance belongs.

    Tag

    Information on tags

    Used by actions: CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeComputeEnvs, DescribeJob, DescribeJobSubmitInfo, DescribeJobs, DescribeTaskTemplates.

    Name Type Required Description
    Key String Yes Tag key
    Note: This field may return null, indicating that no valid value was found.
    Value String Yes Tag value
    Note: This field may return null, indicating that no valid value was found.

    Task

    Task

    Used by actions: CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate.

    Name Type Required Description
    Application Application Yes Application information
    TaskName String No Task name, which should be unique within a job
    TaskInstanceNum Integer No Number of running task instances
    ComputeEnv AnonymousComputeEnv No Compute environment information. One (and only one) parameter must be specified for ComputeEnv and EnvId.
    EnvId String No Compute environment ID. One (and only one) parameter must be specified for ComputeEnv and EnvId.
    RedirectInfo RedirectInfo No Redirection information
    RedirectLocalInfo RedirectLocalInfo No Local redirection information
    InputMappings Array of InputMapping No Input mapping
    OutputMappings Array of OutputMapping No Output mapping
    OutputMappingConfigs Array of OutputMappingConfig No Output mapping configuration
    EnvVars Array of EnvVar No Custom environment variable
    Authentications Array of Authentication No Authorization information
    FailedAction String No The processing method after the TaskInstance fails; Value range: TERMINATE (default), INTERRUPT, FAST_INTERRUPT.
    MaxRetryCount Integer No The maximum number of retries after the task fails. Range: 0 - 5. Default value: 0
    Timeout Integer No Timeout period of the task in seconds. Defaults value: 86400
    MaxConcurrentNum Integer No The maximum number of concurrent tasks. Range: 0 - 200000. There is no limit by default.
    RestartComputeNode Boolean No Restarts the compute node after the task is completed. This is suitable for specifying the compute environment for task execution.
    ResourceMaxRetryCount Integer No Maximum number of retry attempts after failing to create computing resources such as the CVM in the task launch process. Default: 0; Maximum: 100.

    TaskInstanceLog

    Task instance log details.

    Used by actions: DescribeTaskLogs.

    Name Type Description
    TaskInstanceIndex Integer Task instance
    StdoutLog String Standard output log (Base64-encoded, up to 2048 bytes after decompression)
    Note: This field may return null, indicating that no valid value was found.
    StderrLog String Standard error log (Base64-encoded, up to 2048 bytes after decompression)
    Note: This field may return null, indicating that no valid value was found.
    StdoutRedirectPath String Standard output redirection path
    Note: This field may return null, indicating that no valid value was found.
    StderrRedirectPath String Standard error redirection path
    Note: This field may return null, indicating that no valid value was found.
    StdoutRedirectFileName String Standard output redirection file name
    Note: This field may return null, indicating that no valid value was found.
    StderrRedirectFileName String Standard error redirection file name
    Note: This field may return null, indicating that no valid value was found.

    TaskInstanceMetrics

    Task instance statistical metrics

    Used by actions: DescribeJob, DescribeTask.

    Name Type Description
    SubmittedCount Integer Number of submitted tasks
    PendingCount Integer Number of pending tasks
    RunnableCount Integer Number of Runnable tasks
    StartingCount Integer Number of starting tasks
    RunningCount Integer Number of running tasks
    SucceedCount Integer Number of successful tasks
    FailedInterruptedCount Integer Number of failed and interrupted tasks
    FailedCount Integer Number of failed tasks

    TaskInstanceView

    Task instance view information

    Used by actions: DescribeTask.

    Name Type Description
    TaskInstanceIndex Integer Task instance index
    TaskInstanceState String Task instance state
    ExitCode Integer Exit code after application execution is completed
    Note: This field may return null, indicating that no valid value was found.
    StateReason String Task instance state reason. If the task instance fails, the reason for the failure will be logged.
    ComputeNodeInstanceId String 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 value was found.
    CreateTime String Creation time
    LaunchTime String Start time
    Note: This field may return null, indicating that no valid value was found.
    RunningTime String Running start time
    Note: This field may return null, indicating that no valid value was found.
    EndTime String Task end time
    Note: This field may return null, indicating that no valid value was found.
    RedirectInfo RedirectInfo Redirection information
    StateDetailedReason String Task instance state reason details. If the task instance fails, the reason for the failure will be logged

    TaskMetrics

    Task statistical metrics

    Used by actions: DescribeJob, DescribeJobs.

    Name Type Description
    SubmittedCount Integer Number of submitted tasks
    PendingCount Integer Number of pending tasks
    RunnableCount Integer Number of Runnable tasks
    StartingCount Integer Number of starting tasks
    RunningCount Integer Number of running tasks
    SucceedCount Integer Number of successful tasks
    FailedInterruptedCount Integer Number of failed and interrupted tasks
    FailedCount Integer Failed count

    TaskTemplateView

    Task template information

    Used by actions: DescribeTaskTemplates.

    Name Type Description
    TaskTemplateId String Task template ID
    TaskTemplateName String Task template name
    TaskTemplateDescription String Task template description
    TaskTemplateInfo Task Task template information
    CreateTime String Creation time
    Tags Array of Tag Tag list bound to the task template.
    Note: This field may return null, indicating that no valid value was found.

    TaskView

    Task view information

    Used by actions: DescribeJob.

    Name Type Description
    TaskName String Task name
    TaskState String Task status
    CreateTime String Start time
    EndTime String End time
    Note: This field may return null, indicating that no valid value was found.

    VirtualPrivateCloud

    Describes information on VPC, including subnets, IP addresses, etc.

    Used by actions: CreateComputeEnv, DescribeComputeEnvCreateInfo.

    Name Type Required Description
    VpcId String Yes VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the console or call the DescribeVpcEx 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.
    SubnetId String Yes VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the console or call DescribeSubnets 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.
    AsVpcGateway Boolean No 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:
  • TRUE: yes;
  • FALSE: no

    Default: FALSE.
    		•
    PrivateIpAddresses Array of String No 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.
    Ipv6AddressCount Integer No Number of IPv6 addresses randomly generated for the ENI.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy