tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateEnvironment

Last updated: 2024-07-26 15:26:31

1. API Description

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

This API is used to create an environment for Tencent Healthcare Omics Platform.

A maximum of 20 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: CreateEnvironment.
Version Yes String Common Params. The value used for this API: 2022-11-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Name Yes String Environment name
Config Yes EnvironmentConfig Environment configuration information
Description No String Environment description
IsDefault No Boolean Whether it is the default environment.

3. Output Parameters

Parameter Name Type Description
EnvironmentId String Environment ID
WorkflowUuid String Workflow UUID
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating an Environment

This example shows you how to create an environment.

Input Example

POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEnvironment

{
    "Name": "omics env",
    "Description": "env description",
    "Config": {
        "VPCOption": {
            "SubnetZone": "ap-guangzhou-6",
            "VPCCIDRBlock": "10.8.0.0/16",
            "SubnetCIDRBlock": "10.8.16.0/20"
        },
        "ClusterOption": {
            "Zone": "ap-guangzhou-6",
            "Type": "KUBERNETES"
        },
        "DatabaseOption": {
            "Zone": "ap-guangzhou-4"
        },
        "StorageOption": {
            "StorageType": "SD",
            "Zone": "ap-guangzhou-6"
        },
        "CVMOption": {
            "Zone": "ap-guangzhou-6",
            "InstanceType": "SA3.MEDIUM8"
        }
    }
}

Output Example

{
    "Response": {
        "RequestId": "946e07f8-f487-46ab-b486-65e362b4a38b",
        "EnvironmentId": "env-lljckw12",
        "WorkflowUuid": "bc5b790b-407e-42c7-b488-a252fee1dcc7"
    }
}

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
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
InvalidParameterValue.DuplicateName Duplicated name.
LimitExceeded Exceeded the quota limit.
OperationDenied Operation rejected.
ResourceInsufficient Insufficient resources.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy