API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 微服务引擎 TSE > 北极星-配置中心-配置文件相关接口 > 查询配置文件列表

查询配置文件列表

最近更新时间：2024-04-18 01:32:36

我的收藏

1. 接口描述

接口请求域名： tse.tencentcloudapi.com 。

根据命名空间、组名、名称、标签查询配置文件列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeConfigFiles。
Version 是 String 公共参数，本接口取值：2020-12-07。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, eu-frankfurt, na-siliconvalley, na-toronto, sa-saopaulo 。
Namespace 是 String 命名空间名称
示例值：namespace
InstanceId 否 String TSE实例id
示例值：ins-d734da06
Group 否 String 组名
示例值：group
Name 否 String 名称
示例值：name
Tags.N 否 Array of ConfigFileTag 标签列表
Limit 否 Integer 返回数量，默认为20，最大值为100。
示例值：20
Offset 否 Integer 偏移量，默认为0。
示例值：1

3. 输出参数

参数名称 类型 描述
TotalCount Integer 分页总数量
示例值：125
ConfigFiles Array of ConfigFile 配置文件列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询配置文件列表

根据命名空间、组名与文件名查询

输入示例

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

{
    "InstanceId": "ins-d734da06",
    "Namespace": "Polaris",
    "Group": "group-test-jayhjxu",
    "Name": "config-file-test",
    "Limit": 10,
    "Offset": 0
}

输出示例

{
    "Response": {
        "ConfigFiles": [
            {
                "Id": 4,
                "Name": "config-file-test",
                "Namespace": "Polaris",
                "Group": "group-test-jayhjxu",
                "Content": "test for ModifyConfigFiles",
                "Format": "text",
                "Comment": "ModifyConfigFiles comment after modified",
                "Status": "success",
                "Tags": [],
                "CreateTime": "",
                "CreateBy": "",
                "ModifyTime": "",
                "ModifyBy": "",
                "ReleaseTime": "",
                "ReleaseBy": ""
            }
        ],
        "RequestId": "jayhjxu-DescribeConfigFiles-test-1024",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.GovernanceFailure 访问治理中心引擎内部错误。
InternalError.IOError 内部服务调用异常。
InvalidParameterValue.BadRequestFormat 请求格式不正确。
InvalidParameterValue.QueryError 无效请求参数，查询失败。
ResourceNotFound 资源不存在。
中国站