Data Types

Last updated: 2021-03-23 16:26:31

    Activity

    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.

    AgentRunningMode

    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

    AnonymousComputeEnv

    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

    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

    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

    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 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.

    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. 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.

    ComputeNode

    Compute node