Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to create the DataSight Console
A maximum of 20 requests can be initiated per second for this API.
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: CreateConsole. |
| 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. |
| AccessMode.N | Yes | Array of String | Access method: public - public network, internal - private network |
| LoginMode | Yes | Integer | Login method Enumeration value:
|
| DomainPrefix | Yes | String | Custom domain name prefix |
| Accounts.N | No | Array of ConsoleAccount | User account information "Account password authentication" is required for login method |
| AnonymousLogin | No | AnonymousLoginInfo | Anonymous login account information "Anonymous login" is a required login method. |
| IntranetType | No | Integer | Private network type, defaults to 0 |
| IntranetRegion | No | String | Private network region |
| VpcId | No | String | Private network VpcId |
| SubnetId | No | String | Private subnet SubnetId |
| AuthRoles.N | No | Array of AuthRoleInfo | Auth role information "Third-party authentication login" is a required login method. |
| Tags.N | No | Array of Tag | Tag description list. By specifying this parameter, you can simultaneously bind tags to the corresponding log topic. Supports up to 10 tag key-value pairs. The same resource can only be bound to the same tag key. |
| HideParams.N | No | Array of String | Custom hidden parameter |
| AccessControlRules.N | No | Array of AccessControlRule | Access Control Rule The "third-party authentication login" login method requires the AccessMode: internal && Action: ACCEPT rule. |
| Remarks | No | String | Remark |
| Menus.N | No | Array of String | Customize menu |
| Parameter Name | Type | Description |
|---|---|---|
| ConsoleId | String | DataSight Console Id |
| 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. |
Create a DataSight Console instance
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConsole
<Common request parameters>
{
"AccessMode": [
"public"
],
"LoginMode": 0,
"DomainPrefix": "datasight",
"Accounts": [
{
"UserName": "username",
"Password": "xxxxxxxx",
"SecretId": "secretid",
"SecretKey": "secretkey"
}
]
}
{
"Response": {
"RequestId": "xxxx-xxxxx",
"ConsoleId": "clsconsole-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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| FailedOperation.SearchTimeout | The query timed out. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
피드백