1. 接口描述
接口请求域名： tse.tencentcloudapi.com 。
根据条件分页查询配置文件组
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConfigFileGroups。 |
| 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 。 |
| InstanceId | 是 | String | tse实例id 示例值：ins-df344df5 |
| Namespace | 否 | String | 根据命名空间过滤 示例值：namespace |
| Group | 否 | String | 根据配置文件组名过滤 示例值：group |
| FileName | 否 | String | 根据配置文件组名过滤 示例值：filename |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。 示例值：20 |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：5 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 列表总数量 示例值：125 |
| ConfigFileGroups | Array of ConfigFileGroup | 配置文件组列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询配置文件组列表
根据条件查询配置文件组列表
输入示例
POST / HTTP/1.1
Host: tse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigFileGroups
<公共请求参数>
{
"InstanceId": "janice-test",
"Limit": 1,
"Namespace": "namespace_test",
"Offset": 1
}输出示例
{
"Response": {
"TotalCount": 125,
"ConfigFileGroups": [
{
"Id": 1,
"Name": "configFileGroupName",
"Namespace": "namespace1",
"Comment": "test config",
"CreateTime": "2023-03-08 00:00:00",
"CreateBy": "jayhjxu",
"ModifyTime": "2023-03-08 12:00:00",
"ModifyBy": "jayhjxu",
"FileCount": 1,
"UserIds": [
"user_1"
],
"GroupIds": [
"group_1"
],
"RemoveUserIds": [
"user_2"
],
"RemoveGroupIds": [
"group_2"
],
"Editable": true,
"Owner": "jayhjxu"
}
],
"RequestId": "63d46143-c731-4aff-b0c9-edce7401db32"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.GovernanceFailure | 访问治理中心引擎内部错误。 |
| InternalError.IOError | 内部服务调用异常。 |
| InternalError.UnknownError | 未知错误。 |
| InvalidParameterValue.BadRequestFormat | 请求格式不正确。 |
| InvalidParameterValue.QueryError | 无效请求参数，查询失败。 |
| ResourceNotFound | 资源不存在。 |