本文说明 AIuse 云电脑 SDK 的主要对象、方法、参数和返回结构。 SDK 方法参考 Client 构造函数 plaintext new Client(options: ClientOptions): Client ClientOptions 参数： 参数名 类型 是否必填 说明 apiKey string 是 控制台创建的 AccessKey ID apiSecret string 是 控制台创建的 AccessKey Secret desktopCode string 是 云电脑桌面编码 serviceURL string 否 服务地址，默认值以 SDK 发布版本为准 示例： plaintext import Client from '@ctyun/desktopagentsdk'; const client new Client({ apiKey: process.env.AIUSEAPIKEY, apiSecret: process.env.AIUSEAPISECRET, desktopCode: process.env.AIUSEDESKTOPCODE, serviceURL: process.env.AIUSESERVICEURL ' }); createSession 创建会话并返回会话对象。 plaintext async createSession(): Promise 返回的 Session 对象包含： 属性名 类型 说明 sessionId string 会话唯一标识 computer ComputerAPI Computer Use 方法集合 filesystem FileSystemAPI FileSystem 方法集合 close Function 关闭会话方法 通用返回结构 SDK 方法通常返回如下结构： plaintext { "code": 0, "data": null, "msg": null } 字段 类型 说明 code number 状态码，0 通常表示成功 data any 成功时的业务结果 msg string 失败时的错误信息 ComputerAPI movemouse 移动鼠标到指定坐标。 plaintext await session.computer.movemouse({ x: 500, y: 300 }); 参数 类型 是否必填 说明 x number 是 目标 X 坐标 y number 是 目标 Y 坐标

本页介绍天翼云TeleDB数据库的复制表功能。 复制表是所有DN 节点都存储一份相同的数据。 plaintext teledb create table trep (id int,mc text) distribute by replication; CREATE TABLE teledb d+ trep Table "public.trep" Column Type Collation Nullable Default Storage Stats target Description +++++++ id integer plain mc text extended Distribute By: REPLICATION Location Nodes: ALL DATANODES 所有节点都会保存一份数据 plaintext teledb insert into trep values(1,'teledb'),(2,'ctyun'); COPY 2 teledb EXECUTE DIRECT ON (dn01) 'select from trep'; id mc + 1 teledb 2 ctyun (2 rows) teledb EXECUTE DIRECT ON (dn02) 'select from trep'; id mc + 1 teledb 2 ctyun (2 rows)

本节介绍了云容器引擎概览的入门指引。 操作场景 概览用于查看用户整体的集群和节点情况。集群部分展示资源使用情况、组件状态、节点状态、资源对象数量和异常Pod。 前提条件 登录云容器引擎控制台。你需要开通集群后才能在概览界面看到相应的数据。若没有集群，请参考：订购集群 进行创建。 集群的CPU使用率、内存使用率、磁盘使用率、Pod使用率需安装监控插件才能呈现。若要安装监控插件，请参考：插件市场 安装插件的内容进行安装，也可以在概览界面上进行快捷安装。 操作步骤 通过切换集群可以展示不同集群的资源使用情况、组件状态、节点状态、资源对象数量和异常Pod。

接口功能介绍 踢用户下线，前提条件：云电脑处于在线运行状态，云电脑类型为并发或共享。 接口约束 无 URI POST /v3/desktop/kickOff 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx desktopOid 是 String 桌面ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 同步资产接口 接口约束 请保证ruleId存在 URI POST /vfw/v2systemvrfbindsync 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!" } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 退订云电脑服务需要该账号下无云电脑资源，包括资源包、云电脑、带宽、VPC等；服务一经退订，无法撤销，请谨慎操作。 接口约束 无 URI POST /v3/desktopService/unsubscribe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数说明 发送通知 配置是否发送邮件、短信、HTTP和HTTPS通知用户。 通知方式 根据需要可选择通知组或主题订阅两种方式。 通知组 需要发送告警通知的通知组。 通知对象 选择主题订阅时设置需要发送告警通知的对象，可选择云账号联系人或主题名称。 云账号联系人为注册时的手机和邮箱。 主题是消息发布或客户端订阅通知的特定事件类型。 生效时间 该告警仅在生效时间段发送通知消息，非生效时段则在隔日生效时段发送通知消息。 如生效时间为08:0020:00，则该告警规则仅在08:0020:00发送通知消息。 触发条件 可以选择“出现告警”、“恢复正常”两种状态，作为触发告警通知的条件。 归属企业项目 告警规则所属的企业项目。只有拥有该企业项目权限的用户才可以查看和管理该告警规则。

字段 说明 AUDIT: 固定前缀，标识一条审计信息。 AUDITTYPE 当前审计类型，SESSION、OBJECT、CLIENTAUTHENTICATION。 STATEMENTID 此会话的唯一语句 ID。 SUBSTATEMENTID 主语句中每个子语句的顺序ID。 CLASS或AUTHENTICATIONRESULT 表示执行的操作类型。 CLASS值：见pgaudit.log选项，包括READ、ROLE。 AUTHENTICATIONRESULT值：SUCCESS、FAIL。 PID 进程ID。 STATEMENTSTARTTIME 语句起始时间戳，以us为单位。 connectionstatus 会话状态，常见为执行语句的错误返回码，普通执行成功返回0。 APPLICATIONNAME 应用名称。PSQL，JDBC等。 USERNAME 登录的用户名。 DATABASENAME 登录的数据库名。 REMOTEHOST 登录的host地址。 COMMAND 执行的SQL命令类型，ALTER TABLE、SELECT等。 OBJECTTYPE 对象类型，TABLE、INDEX、VIEW等。 OBJECTNAME 对象名。 STATEMENT 在后端执行的SQL具体内容。 PARAMETER 参数值。

用户可通过本接口发起一个截图任务。 接口功能介绍 用户可通过本接口发起一个截图任务。 接口约束 本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。 URI POST /xstorevod/snapshot/task 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 originVideoUuid 是 String 源视频videoID。 494df3af1bd04fc28e2f0c5b73a45b6d templateId 是 String 必填参数，截图模板ID。 100000000001 watermarkTemplateId 否 String 选填参数，水印模板ID，截图打水印时传入该入参。 100000000001 clientCallbackUrl 否 String 选填参数，本次截图任务的回调地址。注意，当填入本参数时，后台会优先将回调信息发送至本次指定接收地址。工作流或全局回调地址均不再发送回调。 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 code 是 String 本次请求的结果码。 "0" message 是 String 错误文本信息，发起成功时，为空字符串。 "" data 是 Object 返回的结果。 data 表data 参数 是否必填 参数类型 说明 示例 下级对象 taskId 是 String 截图任务taskId。 0003

接口功能介绍 删除多证书 接口约束 无 URI POST /v4/elb/deletedomaincertlinks 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID domainCertID 是 String 多证书 ID dclxxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 检查结果 见下表 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 domainCertID String 多证书 id dclxxxx 枚举参数 无 请求示例 请求url POST /v4/elb/deletedomaincertlinks 请求头header 无 请求体body { "regionID":"100054c0416811e9a6690242ac110002", "domainCertID":"dclxxxx" }

更新多证书 接口功能介绍 更新多证书 接口约束 无 URI POST /v4/elb/updatedomaincertlinks 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID domainCertID 是 String 多证书 ID dclxxxx description 否 String 支持拉丁字母、中文、数字, 特殊字符：~~!@$%^&()+ <>?:{},./;'[]·~~！@￥%……&（） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 certificateID 否 String 证书 ID certxxxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 检查结果 见下表 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 domainCertID String 多证书 id dclxxxx

此小节介绍企业主机安全基线检查 查看基线检查概览 HSS提供基线检查功能，包括检测复杂策略、弱口令及配置详情，包括对主机配置基线通过率、主机配置风险TOP5、主机弱口令检测、主机弱口令风险TOP5的统计。主动检测主机中的口令复杂度策略，关键软件中含有风险的配置信息，并针对所发现的风险为您提供查看基线检查详情，帮助您正确地处理服务器内的各种风险配置信息。 约束限制 未开启防护不支持基线相关操作。 前提条件 配置检查只有开启了防护且防护配额在企业版及以上的主机数据才会显示在列表中。 检测周期 主机安全服务默认每日凌晨04：00左右将自动进行一次全面的检查。 若您需自定义检测周期及时间，您可购买旗舰版、网页防篡改版、容器版满足需求，自定义检测周期操作详情请参见配置检测。 在“风险预防 > 基线检查”页面右上角，选择目标基线策略，单击“手动检测”，可对基线策略关联的服务器进行一键手动检测。 检查详情 基线检查详情 检查项名称 检查详情说明 口令复杂度策略检测 检测系统中的口令复杂度策略，给出修改建议，帮助用户提升口令安全性。 经典弱口令检测 检测系统帐户口令是否属于常用的弱口令，针对弱口令提示用户修改。 配置检查 对常见的Tomcat配置、Nginx配置、SSH登录配置进行检查，帮助用户识别不安全的配置项。 操作步骤 1、登录管理控制台。 2、在页面左上角单击，选择“区域”，选择“安全 > 企业主机安全”，进入“企业主机安全”页面。 3、在左侧导航树中，选择“风险预防 > 基线检查”，进入基线检查页面。 4、在“基线检查”页面，查看检测数据的统计，选择不同页签，查看HSS检测到的您服务器上存在的配置风险，参数说明如表所示。 基线检查概览 参数名称 参数说明 基线检查策略 选择要查看的基线策略检测的结果，所有可选择的基线检查策略均为已添加的基线检查策略，可进行自定义创建、编辑、删除。 检测主机数 已检测的主机总数。 检测基线数 检测主机时执行的基线数。 主机配置检查项 已检查主机配置项的总数。 主机配置基线通过率 按照基线检测主机配置通过的配置项占总检测项的占比，同时按照不同风险等级分别统计未通过的配置项总数。 主机配置风险TOP5 按照主机的维度统计存在配置风险的主机。 优先按照高危且风险总数最多的前5台主机进行排序，若不存在高危，则依次为中危、低危。 主机弱口令检测统计 统计检测弱口令的主机总数，以及有弱口令、未开启检测、无弱口令检测的主机数。 主机弱口令风险TOP5 按照主机的维度统计存在弱口令风险最多的前5台主机。 配置检查 对所有存在配置风险的主机进行等级告警及风险信息统计。 口令复杂度策略检测 对所有主机存在弱口令复杂度不满足基线标准的进行统计。 经典弱口令检测 按照主机的维度对存在弱口令的主机及涉及的帐号进行统计。 手动执行基线检查 手动检测只针对目标基线策略所关联的服务器。若使用默认策略，请先关联服务器后再执行手动检测。 执行手动检测前，请先确认在“基线检查策略”选框是否可以选择到目标策略，若需新建策略，详情请参见新建基线检查策略。 1、在“风险预防 > 基线检查”概览页选择目标“基线检查策略”。 选择目标基线策略 2、单击页面右上角“手动检测”，执行检测。 3、查看“基线检查策略”下方“最近检测时间”为当前检测时间时，表示检测完成。 执行手动检测后，按钮状态变为检测中，若检测时间超过30分钟，按钮会自动释放为可单击状态，此时仍需等待“最近检测时间”显示为当前检测时间才表示检测完成。 检测结束后可参照查看基线检查详情查看对应检查项结果及修改建议。 2、单击页面右上角“手动检测”，执行检测。 3、查看“基线检查策略”下方“最近检测时间”为当前检测时间时，表示检测完成。 执行手动检测后，按钮状态变为检测中，若检测时间超过30分钟，按钮会自动释放为可单击状态，此时仍需等待“最近检测时间”显示为当前检测时间才表示检测完成。 检测结束后可查看基线检查详情查看对应检查项结果及修改建议。 查看检测状态 导出基线检查报告 根据需要可通过筛选导出基线检测报告。 1、登录管理控制台。 2、在页面左上角选择“区域”，选择“安全 > 企业主机安全”，进入“企业主机安全”页面。 3、在弹窗界面单击“体验新版”，切换至主机安全服务页面。 说明 切换至新版后，在总览页左上角单击“返回旧版”，可切换至主机安全（旧版）。 4、在左侧导航树中，选择“风险预防 > 基线检查”，进入基线检查页面。 5、在“基线检查”页面，查看检测数据的统计，选择不同页签，可查看HSS检测到的风险告警。 注意 当前仅支持“配置检查”和“经典弱口令检测”的报告导出。 6、选择“配置检查”或“经典弱口令检测”页签，在列表右上角单击 ，对筛选的风险告警进行下载。 说明 在“配置检查”页签可单击“风险等级”和“标准类型”对告警信息进行筛选。 在“经典弱口令检测”页签可通过筛选服务器名称、IP地址、帐号名称进行筛选下载。 “配置检查”和“经典弱口令检测”的风险检测报告单次下载最大数量为5000条。

本节介绍了本地盘的简介、创建本地盘、删除本地盘等。 简介 本地盘是虚拟机实例、容器实例或函数服务所在物理机上的本地硬盘设备。本地硬盘能够为实例提供本地存储访问能力，具有低时延、高随机IOPS、高吞吐量和高性价比的优势。 本地盘是将一个或多个硬盘的分区在逻辑上集合，相当于一个大硬盘来使用，当硬盘的空间不够使用的时候，可以继续将其它的硬盘的分区加入其中，这样可以实现磁盘空间的动态管理，相对于普通的磁盘分区有很大的灵活性。同样具备较高的IO性能，同时支持RAID方式提供更高系统可靠性。用户可以按需选择容量规格购买使用本地盘。本地盘目前提供SATA HDD、SATA SSD、NVMe SSD三种类型的介质。本地盘支持提供给虚拟机实例作为系统盘或数据盘，作为系统盘时，开放购买的规格支持为20GB～2048GB，作为数据盘时，开放购买的规格支持为10GB～6144GB。 注意 本地盘不支持快照，云硬盘支持快照，高可用方面也不如云盘。 由于本地盘是随着单台物理机，一旦物理机故障将有丢失数据风险，数据可靠性较低，因此，重要数据建议使用云硬盘。 创建本地硬盘 1. 登录ECX控制台。 2. 单击左侧导航栏【边缘存储>本地盘】进入本地盘列表，单击【购买本地盘】。 3. 【基础配置>计费模式】选择【包年包月】或者【按需计费】。 4. 选择【地域】跟【可用区】，本地盘需要与虚拟机在同一个可用区。 5. 点击【增加一块数据盘】，选择本地盘的类型、大小以及驱动，一次最多可以选择3块磁盘。 6. 本地盘只能选择立即挂载，点击下拉列表【请选择挂载虚机】，列表中显示当前集群运行中和已关机的虚机，点击【选择】需要挂载的虚机。 7. 单击【下单购买】完成支付，即创建成功。 注意 实际可购买的地域和可用区以库存展示为准

2.请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 data 是 List 一张或多张图像Base64编码字符串构成的list。注意：图片需要使用常规safe base64编码方式，不包含前缀 "data:img/jpg;base64," 9j4AAQSkZJRg... 请求代码示例 shell Curl X POST " H "ContentType: application/json" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "appkey:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:aiglobal.ctapi.ctyun.cn" data '{"data":["9j4AAQSkZJRg..."]}' 返回值说明 1.请求成功返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Int 请求响应状态码，返回 0 表示成功，返回错误代码参考下面的错误代码列表 0 message 是 Object 请求信息结构体，message["success"]代表请求list中的成功数量，message["fail"]代表请求list中的失败数量 message returnObj 是 List 识别的结果，按照列表形式排列，每个元素为图片对应的鉴定结果键值对，元素排序按照传入顺序排列，元素中包括身份证正反面信息，以及姓名、性别、身份证号码等信息 returnObj 表message 参数 是否必填 参数类型 说明 示例 下级对象 success 否 Int 成功标识 1 fail 否 Int 错误标识 0 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 note 是 String 身份的正面或反面信息，国徽面为正面：front，人像面为反面：back 包含人像面和国徽面：frontback back detail 是 Object 返回结果键值集合，包含姓名、性别、身份证号码等信息 detail idcardface 是 String 此API无法截取人像面身份证的人像子图，此字段固定为'no face' no face demoimage 是 String 无效字段（可忽略） demoimage risk 是 String 此API无法对身份证复印件进行判断，此字段固定为'normal' normal 表detail 参数 是否必填 参数类型 说明 示例 下级对象 name 是 String 姓名 陈XX sex 是 String 性别 男 nation 是 String 民族 汉 birthday 是 String 出生日期 1995XX25 idn 是 String 身份证号 3101001995XX25XX16 addr 是 String 住址 上海市XX区XX路1号 org 是 String 签发机关 上海市公安局XX分局 validperiod 是 String 有效期限 2007.07.272027.07.27

端口 放通地址段 说明 UDP：53 子网的dns服务器 用于域名解析。 UDP：4789（仅容器隧道网络模型的集群需要） 所有IP地址 容器间网络互访。 TCP：5443 Master节点网段 master的kubeapiserver的监听端口。 TCP：5444 VPC网段、容器网段 kubeapiserver服务端口，提供k8s资源的生命周期管理。 TCP：6443 Master节点网段 TCP：8445 VPC网段 Node节点存储插件访问Master节点。 TCP：9443 VPC网段 Node节点网络插件访问Master节点。

接口功能介绍 获取导入密钥材料 接口约束 请保证账户余额大于0 URI POST /v1/importKey/getParametersForImport 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥唯一标识id 474e569e8814474a948bdbcf6d853eff wrappingAlgorithm 否 String 用于加密密钥材料的算法，取值范围： RSAESPKCS1V15 RSAESOAEPSHA1 RSAESOAEPSHA256 RSAESPKCS1V15 wrappingKeySpec 否 String 用于加密密钥材料的公钥类型，取值范围： RSA2048 CtyunSM2 RSA2048 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 生成导入密钥材料成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 importToken String 导入令牌 Base64String cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff publicKey String 用于加密密钥材料的公钥 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG 84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxux vy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+U rtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08Gr sV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lq n9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV /cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwIDAQAB tokenExpireTime String 令牌过期时间 20180125T00:01:02Z

接口功能介绍 生成数据密钥，不返回明文数据密钥 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/generateDataKeyWithoutPlaintext 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keySpec 否 String 指定生成的数据密钥的长度，取值范围： AES256：256比特的对称密钥 AES128：128比特的对称密钥 （也可通过numberOfByte是参数指定密钥长度，若均为空，默认返回AES256） AES256 numberOfBytes 否 String 生成的数据密钥长度，取值范围：11024，单位：字节 256 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 生成数据密钥成功 data Object 接口返回结果 returnObj 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id，可选对称密钥类型 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob 是 String 数据密钥密文，即被指定CMK的主版本加密后的密文，且经过Base64编码后返回 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba

专属云共享存储包余量提醒分为主动预警和用尽通知两种。 主动预警 当客户购买的资源包用量达到80%，系统发送主动预警信息，通过邮件和短信通知客户。 用尽通知 当客户购买的资源包用量达到100%，系统发送用尽通知，通过邮件和短信通知客户。 余量提醒屏蔽方法 1. 登录天翼云官网 2. 我的未读消息 3. 左侧栏目：消息中心消息订阅消息管理 4. 取消勾选：资源包100%用量预警/资源包80%/90%用量预警

参数 参数说明 发送通知 配置是否发送邮件、短信、HTTP和HTTPS通知用户。 通知方式 根据需要可选择通知组或主题订阅两种方式。 通知组 需要发送告警通知的通知组。 通知对象 需要发送告警通知的对象，可选择“云帐号联系人”或主题。 云帐号联系人：注册帐号时的手机和邮箱。 主题：创建主题后，您需要单击主题列表操作栏的添加订阅按钮，添加通知方式。 生效时间 该告警规则仅在生效时间内发送通知消息。如生效时间为08:0020:00，则该告警规则仅在08:0020:00发送通知消息。 触发条件 可以选择“出现告警”、“恢复正常”两种状态，作为触发告警通知的条件。

参数 类型 是否必填 说明 type string 是 提取器类型，正则提取为regexp mode string 否 名字冲突的结果取值策略，详情参考 pattern Regexp 是 正则表达式 field Field 是 需要提取信息的原字段名称。 输入数据中要包含该字段，类型为varchar，且其值为非null。否则，不执行提取操作。 output Field 否 用于存储提取结果的字段名称

模块 说明 今日数据 展示实时上/下行带宽、实时上/下行流量、各状态设备数/设备总数信息。 今日用量统计 展示设备接入、上/下行带宽、上/下行流量、视频/视图存储和AI服务的今日用量统计。 AI分析路数 展示当前绑定了AI应用的分析路数，以算法类型为维度进行统计。 今日AI告警 实时告警展示最新的AI告警图片，告警统计展示今日AI告警次数的统计图。 资源包 展示用户已购买的资源包数量。

步骤5：通过云主机创建镜像 通过云主机创建正常状态的私有镜像，请参考通过云主机创建Linux系统盘镜像。 清理环境（可选） 以上步骤中，未初始化的镜像文件以及创建的云主机会额外占用存储和计算资源空间，因此建议您在完成镜像注册后清理环境。 删除在步骤2：注册镜像中注册的未初始化镜像。 删除在步骤3：创建云主机中创建的云主机。 删除OBS个人桶中的镜像文件。

本节介绍了文档数据库服务的数据库引擎和版本说明。 文档数据库服务目前支持4.4、4.2、4.0和3.4版本，需要使用兼容MongoDB 3.0以上版本的Driver来访问。您可以根据业务需求在创建实例时选择合适的引擎和版本。 表 DDS支持的引擎和版本 支持的版本 CPU类型 实例类型 存储引擎 4.4 x86 集群 副本集 RocksDB 4.2 x86 集群 副本集 RocksDB 4.0 x86 鲲鹏 集群 副本集 WiredTiger 3.4 x86 鲲鹏 集群 副本集 WiredTiger

参数 说明 <DBHOST> 数据库地址。 <DBPORT> 数据库端口号。 <DBUSER> 数据库用户名。 <AUTHDB> 存储<DBUSER> 信息的数据库，一般为admin。 < FILEPATH > 存放根证书的路径。 < DBNAME > 需要迁移的数据库名称。 < DBCOLLECTION > 需要迁移的数据库中的集合。

接口功能介绍 本接口更新命名空间级别的Sidecar配置设置。如果指定命名空间为istiosystem则表示对所有命名空间生效。 接口约束 无 URI POST /v1/open/sidecar/config/update 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池 ID bb9fdb42056xxxeda1610242ac1xxxxx 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 customProxyConfig 是 Object sidecar配置 CustomProxyConfigReq name 否 String 配置名称 testsidecar namespace 否 String 服务网格命名空间,当scale为NAMESPACE 、WORKLOAD时必填 default scale 是 String sidecar配置作用范围，选择GLOBAL 、NAMESPACE、WORKLOAD GLOBAL,NAMESPACE,WORKLOAD serviceMeshId 是 String 服务网格id e779bd8 表 CustomProxyConfigReq 参数 是否必填 参数类型 说明 示例 下级对象 concurrency 否 Integer IstioProxy线程数 2 enableCoreDump 否 Boolean 核心转存 false enableDnsCapture 否 Boolean 是否开启istio内置dns false enableElegantTermination 否 Boolean 是否开启优雅终止 false excludeIPRanges 否 String 不拦截对外访问的地址范围 127.0.0.1 excludeInboundPorts 否 String 设置端口使入口流量免于经过Sidecar代理 80,8080 excludeOutboundPorts 否 String 设置端口使出口流量免于经过Sidecar代理 80,8080 holdApplicationUntilProxyStarts 否 Boolean 生命周期管理 true includeIPRanges 否 String 拦截对外访问的地址范围 192.168.0.0/16 includeInboundPorts 否 String 设置端口使入口流量经过Sidecar代理 443 includeOutboundPorts 否 String 设置端口使出口流量经过Sidecar代理 443 interceptionMode 否 String Sidecar对入向流量的拦截策略，REDIRECT：默认的拦截策略，Sidecar将使用重定向方式拦截入向流量。TPROXY：透明代理拦截策略，Sidecar将以透明代理的方式拦截入向流量。NONE:不拦截流量 REDIRECT lifecycleStr 否 String Sidecar代理生命周期JSON字符串 logLevel 否 String 日志等级，如果不设置则为warning info outboundTrafficPolicy 否 String 出向流量策略。取值：ALLOWANY：允许访问所有外部服务。REGISTRYONLY：只能访问注册到网格内的服务。 ALLOWANY proxyMetadata 否 Map of String 环境变量 proxyStatsMatcher 否 Object 统计相关指标 CustomProxyConfigProxyStatsMatcher selector 否 Map of String workload的标签选择器 sidecarProxyInitResourceLimit 否 Object Sidecar代理初始化容器资源限制 ResourcesLimitReq sidecarProxyInitResourceRequest 否 Object Sidecar代理初始化容器资源最低申请额度 ResourcesRequestReq sidecarProxyResourceLimit 否 Object Sidecar代理容器资源限制 ResourcesLimitReq sidecarProxyResourceRequest 否 Object Sidecar代理容器资源最低申请额度 ResourcesRequestReq terminationDrainDuration 否 String Istio Proxy终止等待时长 5s 表 CustomProxyConfigProxyStatsMatcher 参数 是否必填 参数类型 说明 示例 下级对象 inclusionprefixes 否 Array of Strings Envoy监控统计的指标前缀 inclusionregexps 否 Array of Strings Envoy监控统计的指标正则表达式 inclusionsuffixes 否 Array of Strings Envoy监控统计的指标后缀 表 ResourcesLimitReq 参数 是否必填 参数类型 说明 示例 下级对象 resourceCPULimit 否 String CPU资源限制 1000m resourceMemoryLimit 否 String 内存资源限制 1024Mi 表 ResourcesRequestReq 参数 是否必填 参数类型 说明 示例 下级对象 resourceCPURequest 否 String CPU资源最低要求 1000m resourceMemoryRequest 否 String 内存资源最低要求 1024Mi

后续处理 如果控制台上云主机列表页，显示弹性云主机已变更规格成功，但是远程登录云主机后，操作系统无法启动，此时，请联系客服进行恢复，或重装操作系统进行恢复。重装系统的操作指导，请参见重装操作系统。 说明 重装操作系统会清除系统盘数据（包括系统盘内存储的快照），但不影响数据盘的数据。 变更规格完成后，如已确认业务恢复正常，请在快照页面手动删除快照。

操作场景 您可以查看并行文件系统的基本信息，支持按文件系统名称关键字过滤条件查看指定的文件系统。 操作步骤 1. 登录天翼云控制中心，单击管理控制台左上角的，选择地域。 2. 选择“存储>并行文件服务HPFS”，进入并行文件服务的控制台页面。 3. 在文件系统列表页查看所有文件系统的基本信息，参数说明如下表所示。 4. 点击文件系统名称，可以跳转至文件系统详情页，查看更多文件系统信息，以及监控图表等页签。 参数 说明 名称 文件系统名称，创建时设置的名称，只能由数字、字母、短横线组成，不能以数字和短横线开头、且不能以短横线结尾。 ID 文件系统ID，自动生成，不支持修改。 状态 文件系统的状态，包含正在创建、可用、已冻结、创建失败，账户欠费可导致资源为已冻结状态。 监控实例ID 监控实例ID，用于此文件系统在云监控服务查询监控数据的ID。 协议类型 文件系统的协议类型，包括HPFSPOSIX。 存储类型 文件系统的类型，包括HPC性能型。 集群 文件系统所属的集群，部分资源池的并行文件服务，需要在创建文件系统的时候指定“集群”。 性能规格 文件系统的性能规格，部分资源池的并行文件服务，需要在创建文件系统的时候指定“性能规格”，如200MB/s/TB。 创建时间 文件系统的创建时间。 总容量 文件系统创建的总容量。 已用容量 文件系统内已写入数据的容量，四舍五入。 付费方式 文件系统的付费方式，目前只支持按量付费。 可用区 文件系统所在的可用区。 企业项目 文件系统归属的企业项目。 操作 对文件系统的具体操作，包括扩容、删除等。

产品架构 通过和其他产品、服务组合，弹性云主机可以实现计算、存储、网络、镜像安装等功能： 弹性云主机在不同可用区中部署（可用区之间通过内网连接），部分可用区发生故障后不会影响同一区域内的其它可用区。 可以通过虚拟私有云建立专属的网络环境，设置子网、安全组，并通过弹性IP实现外网链接（需带宽支持）。 通过镜像服务，可以对弹性云主机安装镜像，也可以通过私有镜像批量创建弹性云主机，实现快速的业务部署。 通过云硬盘服务实现数据存储，并通过云硬盘备份服务实现数据的备份和恢复。 云监控是保持弹性云主机可靠性、可用性和性能的重要部分，通过云监控，用户可以观察弹性云主机资源。 云硬盘备份可为云硬盘创建备份，利用备份数据回滚云硬盘，以最大限度保证用户数据正确性和安全性，确保云硬盘安全。 云主机备份提供对弹性云主机的备份保护服务。支持对弹性云主机中的所有云硬盘（系统盘和数据盘）进行备份，并利用备份数据恢复弹性云主机数据。 图 ECS产品架构 访问方式 公有云提供了Web化的服务管理平台，即管理控制台和基于HTTPS请求的API（Application programming interface）管理方式。 API方式 如果用户需要将公有云平台上的弹性云主机集成到第三方系统，用于二次开发，请使用API方式访问弹性云主机，如有需求，请联系天翼云客户经理。 控制台方式 其他相关操作，请使用管理控制台方式访问弹性云主机。 如果用户已注册公有云，可直接登录管理控制台，从主页选择“弹性云主机”。

本章节主要介绍物理机的安全。 安全组 安全组是一种虚拟防火墙，具备状态检测和数据包过滤功能，用于设置弹性云主机、物理机服务器、负载均衡、数据库等实例的网络访问控制，是重要的网络安全隔离手段。 您可以通过配置安全组规则，允许安全组内的实例对公网或私网的访问。 安全组是一个逻辑上的分组，您可以将同一区域内具有相同安全保护需求的物理机服务器加入到同一个安全组内。 同一安全组内的BMS实例之间默认内网网络互通，不同安全组内的实例之间默认内网不通。 您可以随时修改安全组的规则，新规则立即生效。 密钥对 密钥对概述 密钥对，也称SSH密钥对，是区别于用户名+密码的远程登录Linux实例的认证方式。通过加密算法生成一对密钥，一个对外界公开，称为公钥，另一个由用户自己保留，称为私钥。公钥和私钥组成密钥对。密钥对的工作原理是使用公钥加密某个数据（例如一个密码），用户可以使用私钥解密数据。 天翼云只会存储公钥，您需要存储私钥。拥有您的私钥的任何人都可以解密您的登录信息，因此将您的私钥保存在一个安全的位置非常重要。 密钥对的功能优势 相比用户名+密码认证方式，密钥对在安全性和便捷性上都更具优势，如下表所示。 表 密钥对与密码对比 对比项 密钥对 用户名 + 密码 安全性 安全强度远高于常规用户口令，可以杜绝暴力破解威胁。 可能通过公钥推导出私钥。 安全性较低。 便捷性 便于远程登录大量Linux实例，方便管理。 一次只能登录一台Linux实例，不利于批量维护。

本节主要介绍分布式消息服务Kafka常用的应用场景 分布式消息服务Kafka主要适用于以下几种场景： 日志收集 构建应用系统和分析系统的桥梁，并将它们之间的关联解耦。 支持实时在线分析系统和类似于 Hadoop 的离线分析系统。 Kafka本身的性能是非常高效的，同时Kafka的特性决定它非常适合作为"日志收集中心"，这是因为Kafka在采集日志的时候业务是无感知的，其能够兼容自己的上游，能够直接地通过配置加密消息。当日志数据发送到Kafka集群里面，其实对于业务而言是完全无侵入的。同时其在下游又能够直接地对接Hadoop/ODPS等离线仓库存储和Strom/Spark等实现实时在线分析。在这样的情况之下，使用Kafka，只需要用户去关注整个流程里面的业务逻辑，而无需做更多的开发就能够实现统计、分析以及报表。 流计算处理 构建应用系统和分析系统的桥梁，并将它们之间的关联解耦。 通过支持流计算引擎，可对接开源 Storm/Samza/Spark 流计算引擎。 Kafka能够做到流计算处理，比如股市走向分析、气象数据测控、网站用户行为分析等领域，由于在这些领域中数据产生快、实时性强、数据量大，所以很难统一采集并入库存储后再做处理，这便导致传统的数据处理架构不能满足需求。而Kafka Stream以及Storm/Samza/Spark等流计算引擎的出现，可以根据业务需求对数据进行计算分析，最终把结果保存或者分发给需要的组件。

此小节介绍数据库审计的产品术语。 Agent 本文中所述的Agent指的是审计代理插件，是安装在数据库系统或者业务系统上的插件，其功能是捕获访问数据库系统的数据包，并将数据包发送至数据库审计。 Kafka Kafka是一种高吞吐量的分布式发布订阅消息系统，可以处理消费者规模的网站中所有动作流数据。这些数据通常由于吞吐量要求而通过处理日志和日志聚合来解决。 SNMP SNMP是简单网络管理协议（Simple Network Management Protocol）的简称，是标准IP网络管理协议，支持目前主流的网络管理系统。 SQL SQL是结构化查询语言（Structured Query Language）的简称，是一种数据库查询和程序设计语言，用于存取数据以及查询、更新和管理关系数据库系统；同时也是数据库脚本文件的扩展名。 Syslog Syslog是一种行业标准的协议，可用来记录设备的日志。Syslog日志消息既可以记录在本地文件中，也可以通过网络发送到接收Syslog的服务器。服务器可以对多个设备的Syslog消息进行统一的存储，或者解析其中的内容做相应的处理。常见的应用场景是网络管理工具、安全管理系统、日志审计系统。 数据库 数据库（Database）是用于存放数据的仓库，按照一定的数据结构（即数据的组织形式或数据之间的联系）来组织、存储，用户可以通过数据库提供的多种方法来管理数据库中的数据。 规则 本文中所述的规则是指根据一些特征（如客户端、服务端、SQL语句）定义的危险行为（安全规则）及可以信任的行为（过滤规则）。当系统审计到对数据库的操作匹配安全规则时会触发告警，对于匹配过滤规则的行为则不进行审计。

本页面介绍云数据库ClickHouse创建视图的基本语法。 创建普通视图 语法: sql CREATE [ORREPLACE] VIEW [IFNOTEXISTS] [db.]tablename [ON CLUSTER clustername] AS SELECT ... 普通视图不存储任何数据。 他们只是在每次访问时从另一个表执行读取。换句话说，普通视图只不过是一个保存的查询。 从视图中读取时，此保存的查询用作FROM子句中的子查询。 例如，假设您已经创建了一个视图： sql CREATE VIEW view AS SELECT... 并写了一个查询： sql SELECT a, b, c FROM view 这个查询完全等同于使用子查询： sql SELECT a, b, c FROM (SELECT...) 以下是一些创建普通视图的示例： 示例1：基于查询创建普通视图 CREATE VIEW myview AS SELECT column1, column2 FROM mytable WHERE condition 示例2：基于多个表的JOIN操作创建普通视图 CREATE VIEW myjoinedview AS SELECT t1.column1, t2.column2 FROM table1 AS t1 JOIN table2 AS t2 ON t1.id t2.id 示例3：使用聚合函数创建普通视图 CREATE VIEW myaggregatedview AS SELECT column1, COUNT() AS count FROM mytable GROUP BY column1 示例4：基于子查询创建普通视图 CREATE VIEW mysubqueryview AS SELECT column1, column2 FROM ( SELECT column1, column2, ROWNUMBER() OVER (PARTITION BY column1 ORDER BY column2) AS rn FROM mytable ) subquery WHERE rn 1 这些示例演示了不同类型的普通视图创建，您可以根据具体需求选择适合的创建方式。普通视图仅提供了对查询结果的封装，不会存储实际数据，每次查询视图时都会重新执行视图定义的查询逻辑。