tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateEnvironment

最后更新时间：2023-12-04 16:38:18

    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
    Description No String Environment description
    Vpc No String VPC name
    SubnetIds.N No Array of String List of subnets
    K8sVersion No String Kubernetes version
    SourceChannel No Integer Source channel
    EnableTswTraceService No Boolean Whether to enable the TSW service
    Tags.N No Array of Tag Tag
    EnvType No String Environment type. Values: test, pre, prod
    CreateRegion No String The region to create the environment
    SetupVpc No Boolean Whether to create a VPC
    SetupPrometheus No Boolean Whether to create a TMP instance
    PrometheusId No String TMP instance ID
    ApmId No String APM ID

    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 environment (namespace)

    This example shows you how to create an environment (namespace).

    Input Example

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

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

    Output Example

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

    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
    FailedOperation.DefaultInternalError The server is busy. Retry later.
    InternalError.CreateEksClusterError Failed to create the underlayer cluster
    InternalError.DefaultInternalError The server is busy. Retry later.
    InvalidParameter.UnauthorizedOrMissingRole Not authorized or role not configured
    InvalidParameter.VpcOverQuota Auto-creation failed because the VPC upper limit is reached.
    InvalidParameterValue.CreateNamespaceUnsupportRegionError
    InvalidParameterValue.DailyCreateNamespaceReachMaximum Reached the upper limit of environment created every day
    InvalidParameterValue.NamespaceDuplicateError The environment already exists.
    InvalidParameterValue.NamespaceReachMaximum Failed to create the environment. The upper limit of environment is reached.
    MissingParameter.EnvironmentNameNull The environment name is required.
    OperationDenied.BalanceNotEnough Insufficient account balance.
    UnauthorizedOperation.UnauthorizedOperation Not authorized
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款