有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: tem.tencentcloudapi.com 。

查询配置列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeConfigDataList。
Version String 公共参数,本接口取值:2021-07-01。
Region String 公共参数,详见产品支持的 地域列表
EnvironmentId String 环境 ID
示例值:env-xxx
SourceChannel Integer 来源渠道
示例值:0
ContinueToken String 查询游标
示例值:xxx
Limit Integer 分页 limit
示例值:10

3. 输出参数

参数名称 类型 描述
Result DescribeConfigDataListPage 配置列表
示例值:[]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询配置列表

查询配置列表

输入示例

POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigDataList
<公共请求参数>

{
    "EnvironmentId": "xx",
    "ContinueToken": "xx",
    "Limit": 0,
    "SourceChannel": 0
}

输出示例

{
    "Response": {
        "Result": {
            "Records": [
                {
                    "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"
                }
            ],
            "RemainingCount": 0,
            "ContinueToken": "xx"
        },
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DefaultInternalError 服务器繁忙,请稍后再试。
InternalError.DescribeConfigDataListError 查询配置列表失败。
InvalidParameterValue.NamespaceNotBelongToAppid 命名空间不属于用户。
InvalidParameterValue.TemIdInvalid 不是合法的TEM ID。
ResourceNotFound.VersionNamespaceNotFound 找不到版本对应的环境。
UnauthorizedOperation.UnauthorizedOperation 未授权。