tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
문서

DescribeConfigData

마지막 업데이트 시간:2023-12-04 16:38:19

    1. API Description

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

    This API is used to query details of a configuration.

    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: DescribeConfigData.
    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.
    EnvironmentId Yes String Environment ID
    Name Yes String Configuration name
    SourceChannel No Integer Source channel. Please keep the default value.

    3. Output Parameters

    Parameter Name Type Description
    Result ConfigData Configuration
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying configuration details

    This example shows you how to query the configuration details.

    Input Example

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

{
    "EnvironmentId": "xx",
    "Name": "xx",
    "SourceChannel": 0
}

    Output Example

    {
    "Response": {
        "Result": {
            "RelatedApplications": [
                {
                    "ApplicationName": "xx",
                    "EnvironmentId": "xx",
                    "ModifyDate": "2020-09-22 00:00:00",
                    "Description": "xx",
                    "Creator": "xx",
                    "InstanceId": "xx",
                    "CreateDate": "2020-09-22 00:00:00",
                    "ActiveVersions": [
                        {
                            "Status": "xx",
                            "CurrentInstances": 0,
                            "LogOutputConf": {
                                "ClsLogTopicId": "xx",
                                "ClsLogsetName": "xx",
                                "ClsLogsetId": "xx",
                                "ClsLogTopicName": "xx",
                                "OutputType": "xx"
                            },
                            "EnableEs": 0,
                            "PodList": {
                                "TotalCount": 0,
                                "Limit": 0,
                                "RequestId": "xx",
                                "PodList": [
                                    {
                                        "Webshell": "xx",
                                        "Status": "xx",
                                        "RestartCount": 0,
                                        "StartTime": "xx",
                                        "Zone": "xx",
                                        "PodId": "xx",
                                        "NodeInfo": {
                                            "SubnetId": "xx",
                                            "Cidr": "xx",
                                            "AvailableIpCount": "xx",
                                            "Name": "xx",
                                            "Zone": "xx"
                                        },
                                        "VersionId": "xx",
                                        "UnhealthyWarningMsg": "xx",
                                        "DeployVersion": "xx",
                                        "PodIp": "xx",
                                        "ContainerState": "xx",
                                        "Ready": true,
                                        "ApplicationName": "xx",
                                        "CreateTime": "xx",
                                        "Unhealthy": true
                                    }
                                ],
                                "Offset": 0
                            },
                            "EnvironmentId": "xx",
                            "CreateDate": "xx",
                            "BuildTaskId": "xx",
                            "DeployMode": "xx",
                            "WorkloadInfo": {
                                "ApplicationName": "xx",
                                "UpdateRevision": "xx",
                                "UpdatedReadyReplicas": 0,
                                "Replicas": 0,
                                "ClusterId": "xx",
                                "UpdatedReplicas": 0,
                                "VersionName": "xx",
                                "CurrentRevision": "xx",
                                "ReadyReplicas": 0
                            },
                            "Zones": [
                                "xx"
                            ],
                            "VersionId": "xx",
                            "UnderDeploying": true,
                            "BatchDeployStatus": "xx",
                            "VersionName": "xx",
                            "ExpectedInstances": 0,
                            "NodeInfos": [
                                {
                                    "SubnetId": "xx",
                                    "Cidr": "xx",
                                    "AvailableIpCount": "xx",
                                    "Name": "xx",
                                    "Zone": "xx"
                                }
                            ],
                            "ApplicationId": "xx",
                            "EnvironmentName": "xx",
                            "ApplicationName": "xx"
                        }
                    ],
                    "DeployMode": "xx",
                    "RepoType": 0,
                    "RepoName": "xx",
                    "EnableTracing": 1,
                    "Tags": [
                        {
                            "TagKey": "xx",
                            "TagValue": "xx"
                        }
                    ],
                    "Modifier": "xx",
                    "ApplicationId": "xx",
                    "CodingLanguage": "xx",
                    "EnvironmentName": "xx"
                }
            ],
            "Data": [
                {
                    "Config": "xx",
                    "Secret": "xx",
                    "Type": "xx",
                    "Value": "xx",
                    "Key": "xx"
                }
            ],
            "Name": "xx",
            "CreateTime": "xx"
        },
        "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.DescribeConfigDataError Failed to query the configuration details.
    InvalidParameterValue.TemIdInvalid The TEM ID is incorrect.
    ResourceNotFound.ConfigDataNotFound Configuration does no exist
    UnauthorizedOperation.UnauthorizedOperation Not authorized
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    개인정보 처리방침서비스 약관쿠키 정책