tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeEnvironmentStatus

Last updated: 2023-12-04 16:38:18

    1. API Description

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

    This API is used to obtain the environment status.

    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: DescribeEnvironmentStatus.
    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.
    EnvironmentIds.N Yes Array of String ID of the environment
    SourceChannel No Integer Source channel

    3. Output Parameters

    Parameter Name Type Description
    Result Array of NamespaceStatusInfo List of environment status
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining the environment status

    Obtaining the environment status

    Input Example

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

{
    "EnvironmentIds": [
        "xx"
    ],
    "SourceChannel": 0
}

    Output Example

    {
    "Response": {
        "Result": [
            {
                "EnvironmentId": "xx",
                "EnvironmentName": "xx",
                "ClusterId": "xx",
                "EnvironmentStoppingStatus": {
                    "StoppedApplicationNum": 0,
                    "ApplicationNumNeedToStop": 0
                },
                "ClusterStatus": "xx",
                "EnvironmentStartingStatus": {
                    "ApplicationNumNeedToStart": 0,
                    "StartedApplicationNum": 0
                }
            }
        ],
        "RequestId": "xx"
    }
}

    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
    InternalError.ActionReadTimeout Request timed out
    InternalError.DefaultInternalError The server is busy. Retry later.
    ResourceNotFound.MicroserviceOffline The target microservice is offline.
    ResourceNotFound.NamespaceNotFound The environment does not exist.
    UnauthorizedOperation.UnauthorizedOperation Not authorized
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy