日志服务编辑DataSight控制台

1. 接口描述

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

本接口用于编辑DataSight控制台

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyConsole。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
ConsoleId	是	String	DataSight控制台ConsoleId 示例值：clsconsole-xxxxxxxx
AccessMode.N	否	Array of String	访问方式：public - 公网，internal - 内网示例值：["public"]
LoginMode	否	Integer	登录方式：0 - 账号密码鉴权，1 - 匿名登陆，2 - 第三方认证登录示例值：0
DomainPrefix	否	String	自定义域名前缀示例值：datasight
Accounts.N	否	Array of ConsoleAccount	用户账号信息 “账号密码鉴权“登录方式必传
AnonymousLogin	否	AnonymousLoginInfo	匿名登录账号信息 “匿名登录”登录方式必传
IntranetType	否	Integer	内网类型，默认为0 示例值：0
IntranetRegion	否	String	内网地域示例值：ap-guangzhou
VpcId	否	String	内网私有网络VpcId 示例值：vpc-xxxxxxxx
SubnetId	否	String	内网子网SubnetId 示例值：subnet-xxxxxxxx
AuthRoles.N	否	Array of AuthRoleInfo	Auth用户角色信息 “第三方认证登录”登录方式必传
HideParams.N	否	Array of String	自定义隐藏参数示例值：["hideTopNav"]
AccessControlRules.N	否	Array of AccessControlRule	访问控制规则 “第三方认证登录”登录方式必传 AccessMode: internal && Action: ACCEPT 规则
Remarks	否	String	备注示例值：remarks
Menus.N	否	Array of String	自定义显示菜单示例值：["/cls/search","/cls/dashboard"]

3. 输出参数

参数名称	类型	描述
ConsoleId	String	DataSight控制台Id 示例值：clsconsole-xxxxxxxx
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改DataSight控制台实例

修改DataSight控制台实例

输入示例

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

{
    "ConsoleId": "clsconsole-xxxxxxxx",
    "DomainPrefix": "datasight",
    "AccessMode": [
        "public"
    ],
    "LoginMode": 0,
    "Accounts": [
        {
            "UserName": "username",
            "Password": "xxxxxxxx",
            "SecretId": "AKIDxxxxxxxxxCIAi4V",
            "SecretKey": "xxxxxxxxxxx"
        }
    ]
}

输出示例

{
    "Response": {
        "ConsoleId": "clsconsole-xxxxxxxx",
        "RequestId": "xxxx-xxxx"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
FailedOperation.SearchTimeout	查询超时。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。
ResourceNotFound	资源不存在。

编辑DataSight控制台

本页目录：