tencent cloud



最后更新时间:2022-10-12 15:58:58

1. API Description

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

This API is used to query the list of environments under a service. All environments and their statuses under the queried service will be returned.

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: DescribeServiceEnvironmentList.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ServiceId Yes String Unique ID of the service to be queried.
Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100.
Offset No Integer Offset. Default value: 0.

3. Output Parameters

Parameter Name Type Description
Result ServiceEnvironmentSet Details of environments bound to service.
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 DescribeServiceEnvironmentList

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "Result": {
            "TotalCount": 3,
            "EnvironmentList": [
                    "EnvironmentName": "test",
                    "Url": "service-ody35h5e-1251006373.cq.apigw.tencentcs.com/test",
                    "Status": 1,
                    "VersionName": "202002161926124aa59df4-7198-4f7a-acc7-887ab7ee0215"
                    "EnvironmentName": "prepub",
                    "Url": "service-ody35h5e-1251006373.cq.apigw.tencentcs.com/prepub",
                    "Status": 0,
                    "VersionName": ""
                    "EnvironmentName": "release",
                    "Url": "service-ody35h5e-1251006373.cq.apigw.tencentcs.com/release",
                    "Status": 0,
                    "VersionName": ""
        "RequestId": "86bacb87-47ca-4295-b1e1-280956f2803b"

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
InvalidParameter.FormatError Incorrect parameter format.
ResourceNotFound.InvalidService The corresponding service is invisible.




7x24 电话支持