tencent cloud



Last updated: 2022-09-23 18:16:47

1. API Description

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

This API is used to create an environment.

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: 2021-07-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
EnvironmentName Yes String Environment name
Vpc Yes String VPC name
SubnetIds.N Yes Array of String List of subnets
Description No String Environment description
K8sVersion No String Kubernetes version
SourceChannel No Integer Source channel
EnableTswTraceService No Boolean Whether to enable the TSW service

3. Output Parameters

Parameter Name Type Description
Result String Environment ID in case of success and null in case of failure
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an environment

This example shows you how to create an environment.

Input Example

Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEnvironment
<Common request parameters>

    "EnvironmentName": "xx",
    "Description": "xx",
    "K8sVersion": "xx",
    "SubnetIds": [
    "EnableTswTraceService": true,
    "SourceChannel": 0,
    "Vpc": "xx"

Output Example

    "Response": {
        "RequestId": "81f74023-563c-437d-abf7-8139449ef178",
        "Result": "env-xxxx"

5. Developer Resources


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
InternalError.CreateEksClusterError Failed to create the underlayer cluster
InternalError.DefaultInternalError The server is busy. Retry later.
InvalidParameterValue.NamespaceDuplicateError The environment already exists.
InvalidParameterValue.NamespaceReachMaximum Failed to create the environment. The upper limit of environment is reached.
OperationDenied.BalanceNotEnough Insufficient account balance.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support