日志服务查询DataSight控制台实例列表

1. 接口描述

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

查询DataSight控制台实例列表

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

此接口支持如下压缩格式返回：gzip

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeConsoles。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	分页的偏移量，默认值为0。示例值：0
Limit	否	Integer	分页单页限制数目，默认值为100，最大值100。示例值：20
Filters.N	否	Array of Filter	DomainPrefix按照【域名前缀】进行过滤。类型：String必选：否 ConsoleId按照【DataSight实例ID】进行过滤。类型：String必选：否 tagKey按照【标签键】进行过滤。类型：String必选：否 tag:tagKey按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，例如tag:exampleKey。类型：String必选：否

3. 输出参数

参数名称	类型	描述
Consoles	Array of Console	DataSight控制台实例列表
TotalCount	Integer	实例总数示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量查询DataSight控制台实例列表

批量查询DataSight控制台实例列表

输入示例

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

{}

输出示例

{
    "Response": {
        "Consoles": [
            {
                "AccessMode": [
                    "internal"
                ],
                "Accounts": null,
                "AnonymousLogin": null,
                "AuthRoles": [
                    {
                        "RoleName": "rolename",
                        "SecretId": "secretid",
                        "SecretKey": null
                    }
                ],
                "ConsoleId": "clsconsole-xxxxxxxx",
                "DomainPrefix": "datasight",
                "IntranetRegion": "ap-guangzhou",
                "IntranetType": 0,
                "LoginMode": 2,
                "SubnetId": "subnet-xxxxxxxx",
                "VpcId": "vpc-xxxxxxxx"
            }
        ],
        "RequestId": "xxxxxxxx"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。