tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeComputeEnvCreateInfo

Last updated: 2023-05-04 15:47:11

1. API Description

Domain name for API request: batch.tencentcloudapi.com.

This API is used to query the compute environment creation information.

A maximum of 2 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeComputeEnvCreateInfo.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
EnvId Yes String Compute environment ID

3. Output Parameters

Parameter Name Type Description
EnvId String Compute environment ID
EnvName String Compute environment name
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 is supported
EnvData EnvData Compute environment parameter
MountDataDisks Array of MountDataDisk Data disk mounting option
InputMappings Array of InputMapping Input mapping
Authentications Array of Authentication Authorization information
Notifications Array of Notification Notification information
DesiredComputeNodeCount Integer Number of desired compute nodes
Tags Array of Tag Tag list bound to the compute environment.
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the creation information of the compute environment

Input Example

https://batch.tencentcloudapi.com/?Action=DescribeComputeEnvCreateInfo
&EnvId=env-lcpcej85
&<Common request parameters>

Output Example

{
    "Response": {
        "EnvId": "env-qleawxzt",
        "EnvType": "MANAGED",
        "DesiredComputeNodeCount": 2,
        "MountDataDisks": [
            {
                "FileSystemType": "xx",
                "LocalPath": "xx"
            }
        ],
        "EnvName": "test compute env",
        "EnvDescription": "test compute env",
        "InputMappings": [
            {
                "SourcePath": "cos://bucket-appid.cos.ap-hongkong.myqcloud.com/",
                "DestinationPath": "/mnt/disk/"
            },
            {
                "SourcePath": "cos://bucket-appid.cos.ap-hongkong.myqcloud.com/test/",
                "DestinationPath": "/mnt/input/"
            }
        ],
        "Notifications": [
            {
                "TopicName": "topic name",
                "EventConfigs": [
                    {
                        "EventName": "ComputeEnvCreated",
                        "EventVars": [
                            {
                                "Name": "name1",
                                "Value": "value1"
                            },
                            {
                                "Name": "name2",
                                "Value": "value2"
                            }
                        ]
                    }
                ]
            }
        ],
        "EnvData": {
            "VirtualPrivateCloud": {
                "SubnetId": "subnet-8axej2jc",
                "VpcId": "vpc-cg18la4l"
            },
            "SystemDisk": {
                "DiskSize": 50,
                "DiskType": "CLOUD_BASIC"
            },
            "InternetAccessible": {
                "PublicIpAssigned": "TRUE",
                "InternetMaxBandwidthOut": 50
            },
            "ImageId": "img-bd78fy2t",
            "InstanceType": "S1.SMALL2",
            "DataDisks": [
                {
                    "DiskSize": 50,
                    "DiskType": "CLOUD_BASIC"
                }
            ]
        },
        "Tags": [
            {
                "Key": "batch-test-tag-env-key",
                "Value": "batch-test-tag-env-value1"
            }
        ],
        "Authentications": [
            {
                "SecretKey": "xx",
                "SecretId": "xx",
                "Scene": "xx"
            }
        ],
        "RequestId": "578f3fae-6908-4521-ac07-17c2cffcd5ae"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter.EnvIdMalformed Invalid compute environment ID format.
ResourceNotFound.ComputeEnv The specified compute environment does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy