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
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 |
| 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. |
Batch query the console instance list in DataSight
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConsoles
<Common request parameters>
{}
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback