tencent cloud

APIs

DescribeConsoles

下载
聚焦模式
字号
最后更新时间: 2026-06-10 15:02:35

1. API Description

Domain name for API request: cls.intl.tencentcloudapi.com.

Query the DataSight console instance list

A maximum of 20 requests can be initiated per second for this API.

This action accepts http content encodings: gzip

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: DescribeConsoles.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Offset No Integer

Pagination offset. Default value: 0.

Limit No Integer

Number of entries per page. Default value: 100. Maximum value: 100.

Filters.N No Array of Filter
  • DomainPrefix filters by [domain name prefix]. Type: String Required: No
  • ConsoleId filters by [DataSight instance ID]. Type: String Required: No
  • tagKey filters by [tag key]. Type: String Required: No
  • tag:tagKey filters by [tag key-value pair]. Replace tagKey with a specific tag key, such as tag:exampleKey. Type: String Required: No
  • 3. Output Parameters

    Parameter Name Type Description
    Consoles Array of Console

    DataSight Console Instance List

    TotalCount Integer

    Total number of instances

    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Batch query the console instance list in DataSight

    Batch query the console instance list in DataSight

    Input Example

    POST / HTTP/1.1
    Host: cls.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeConsoles
    <Common request parameters>
    
    {}
    

    Output Example

    {
        "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. 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 Internal error.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈