本文介绍 AIuse 云电脑 SDK 中的核心对象和调用模型,帮助开发者理解 SDK 接入时的基本概念。 Client Client 是 SDK 的入口对象，用于保存服务地址、AccessKey、桌面编码等连接配置，并负责创建会话。 创建 Client 时通常需要传入以下参数： 参数 说明 apiKey 控制台 AccessKey ID apiSecret 控制台 AccessKey Secret desktopCode 云电脑桌面编码 serviceURL 服务地址，可选 示例： plaintext import Client from '@ctyun/desktopagentsdk'; const client new Client({ apiKey: process.env.AIUSEAPIKEY, apiSecret: process.env.AIUSEAPISECRET, desktopCode: process.env.AIUSEDESKTOPCODE }); Session Session 表示一次与云电脑的操作会话。创建会话后，可以通过会话对象调用 Computer Use 或 FileSystem 能力。 plaintext const session await client.createSession(); 任务结束后，应主动关闭会话： plaintext await session.close(); ComputerAPI ComputerAPI 用于执行 GUI 操作，典型方法包括： movemouse clickmouse pressmouse releasemouse dragmouse scroll presskey typetext screenshot getcursorposition FileSystemAPI FileSystemAPI 用于执行文件操作，当前版本开放的接口包括： createdirectory readfile writefile movefile searchfiles 会话生命周期 推荐的会话生命周期如下： 1. 创建 Client。 2. 创建 Session。 3. 调用工具方法。 4. 捕获并处理异常。 5. 在 finally 中关闭 Session。 plaintext let session; try { session await client.createSession(); await session.computer.typetext({ text: 'hello' }); } finally { if (session) { await session.close(); } }

请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 nextCursor String 下一游标。此值为空串时，代表无更多数据。 ZWNwYzpudW1iZXI6MQ list Array of Objects 数据列表。 list 表 list 参数 参数类型 说明 示例 下级对象 desktopOid String 云电脑ID。 fooId pubUserOid String 用户ID。 fooId userName String 用户名称。 fooName userAccount String 用户账号。 fooAccount orgOid String 部门ID。 fooName orgName String （云电脑）部门名称。 fooName completeOrgName String （云电脑）部门完整名称。由从根部门到当前部门的名称，以半角斜线号（/）为分隔符拼接而成。 fooRoot/fooName startConnectTime String 开始连接时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 20231122T08:36:27Z endConnectTime String 结束连接时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 20231122T08:36:28Z deviceType String 终端类型。可能值： ArmThinClient：瘦终端ARM。 X86ThinClient：瘦终端X86。 Iptv：IPTV。 AndroidThinClient：Android 瘦终端。 AndroidPhone：Android Phone。 Windows：Windows客户端。 Iphone：iPhone。 AndroidPad：Android Pad。 Ipad：iPad。 Mac：Mac客户端。 Windows subnetIpAddress String （云电脑）子网IP地址。 192.168.0.242 deviceIpAddress String 终端IP地址。 66.66.66.66 devicePrivateIpAddress String 终端内网IP地址。 66.66.66.66 deviceMacAddress String 终端MAC地址。 CC:CC:CC:CC:CC:CC deviceSnCode String 终端SN码。 cccccccccccccccccccccccccccccccc

本文介绍在函数计算中Context的相关概念和使用示例。 上下文 当函数计算运行您的函数时，会将上下文（context.Context）对象传递到执行方法中。该对象包含有关调用、服务、函数和执行环境等信息。 示例 您可以 import gitee.com/ctyunfaas/cfruntimegosdk/fccontext，通过fccontext.FromContext方法获取fccontext。如下示例将输出上下文相关信息： package main import ( "context" "encoding/json" "gitee.com/ctyunfaas/cfruntimegosdk/cf" "gitee.com/ctyunfaas/cfruntimegosdk/fccontext" ) func main() { cf.Start(HandleRequest) } func HandleRequest(ctx context.Context) (string, error) { fctx, : fccontext.FromContext(ctx) res, : json.Marshal(fctx) return string(res), nil }

操作步骤 支持按照模型ID、模型名称、参数规模、最近连通测试时间、创建时间对测评对象进行筛选。

本章节主要介绍物理机的安全。 安全组 安全组是一种虚拟防火墙，具备状态检测和数据包过滤功能，用于设置弹性云主机、物理机服务器、负载均衡、数据库等实例的网络访问控制，是重要的网络安全隔离手段。 您可以通过配置安全组规则，允许安全组内的实例对公网或私网的访问。 安全组是一个逻辑上的分组，您可以将同一区域内具有相同安全保护需求的物理机服务器加入到同一个安全组内。 同一安全组内的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等流计算引擎的出现，可以根据业务需求对数据进行计算分析，最终把结果保存或者分发给需要的组件。

本节主要介绍产品定义。 什么是云容器引擎？ 云容器引擎(CT Cloud Container Engine，简称CCE)提供高可靠、高性能的企业级Kubernetes集群托管服务，支持运行Docker容器，帮助用户在云上轻松部署、管理和扩展容器化应用程序。 为什么选择云容器引擎？ 云容器引擎深度整合高性能的计算（ECS）、网络（VPC/EIP/ELB）、存储（EVS/OBS/SFS）等服务，支持多可用区（Available Zone，简称AZ）、多区域（Region）容灾等技术构建Kubernetes高可用集群。 产品形态 云容器引擎包含多种产品形态。 集群类型 CCE Standard CCE Turbo 产品定位 标准版本集群，提供高可靠、安全的商业级容器集群服务。 面向云原生2.0的新一代容器集群产品，计算、网络、调度全面加速。 使用场景 面向有云原生数字化转型诉求的用户，期望通过容器集群管理应用，获得灵活弹性的算力资源，简化对计算、网络、存储的资源管理复杂度。 适合对极致性能、资源利用率提升和全场景覆盖有更高诉求的客户。 网络模型 云原生网络1.0：面向性能和规模要求不高的场景。 容器隧道网络模式 VPC网络模式 云原生网络2.0：面向大规模和高性能的场景。 组网规模最大支持2000节点 hostPort 支持 不支持 网络性能 VPC网络叠加容器网络，性能有一定损耗 VPC网络和容器网络融合，性能无损耗 容器网络隔离 容器隧道网络模式：集群内部网络隔离策略，支持NetworkPolicy。 VPC网络模式：不支持 Pod可直接关联安全组，基于安全组的隔离策略，支持集群内外部统一的安全隔离。 容器资源隔离 普通容器：Cgroups隔离 安全容器：当前仅物理机支持，提供虚机级别的隔离 普通容器：Cgroups隔离 边缘基础设施管理 不支持 支持管理智能边缘小站

本页介绍天翼云TeleDB数据库定时任务管理。 操作场景 TeleDB支持对数据库实例执行定时任务，该功能主要通过内置如下函数对数据库实例执行定时任务管理。用户可自行调整对定时任务的执行频率以及查看执行记录。 TeleDBX内置了如下函数，所有函数会根据执行频率自动执行任务。 collectdbstatistic：用于数据库实例更新统计信息。 pgcleantwophase：用于数据库实例清理两阶段残留事务。 deleteossstatistics：用于删除配置库存储过期的节点监控数据。 checkxlogbkp：用于检查备份的增量日志的连续性。 checkfgaaudit：用于检查细粒度审计是否采集到数据。 deletesnapshot：用于删除管控的实例配置库中存储过期的实例运行快照数据。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台，在左侧导航单击实例列表。 2. 单击目标实例所在行的详情 ，进入实例详情页面。 3. 进入实例详情页面，单击定时任务 。 4. 您可通过控制定时任务开关管理是否定时执行该任务。 5. 单击实例详情操作列的配置 ，出现配置执行频率对话框。 6. 在配置执行频率对话框，输入频率 和周期 ，单击确定 ，完成执行频率的修改。 7. 单击历史记录 可以查看以往执行该任务详情。 8. 单击立即执行 ，出现提示信息对话框。 9. 在提示对话框中，单击确定 可立即执行定时任务。

本页介绍天翼云TeleDB数据库定时任务管理。 操作场景 TeleDB支持对数据库实例执行定时任务，该功能主要通过内置如下函数对数据库实例执行定时任务管理。用户可自行调整对定时任务的执行频率以及查看执行记录。 TeleDBX内置了如下函数，所有函数会根据执行频率自动执行任务。 collectdbstatistic：用于数据库实例更新统计信息。 pgcleantwophase：用于数据库实例清理两阶段残留事务。 deleteossstatistics：用于删除配置库存储过期的节点监控数据。 checkxlogbkp：用于检查备份的增量日志的连续性。 checkfgaaudit：用于检查细粒度审计是否采集到数据。 deletesnapshot：用于删除管控的实例配置库中存储过期的实例运行快照数据。 操作步骤 1. 以用户名和密码登录分布式数据库 TeleDB控制台，在左侧导航单击实例列表。 2. 单击目标实例所在行的详情，进入实例详情页面。 3. 进入实例详情页面，单击定时任务。 4. 您可通过控制定时任务开关管理是否定时执行该任务。 5. 单击实例详情操作列的配置，出现配置执行频率对话框。 6. 在配置执行频率对话框，输入频率 和周期 ，单击确定，完成执行频率的修改。 7. 单击历史记录可以查看以往执行该任务详情。 8. 单击立即执行，出现提示信息对话框。 9. 在提示对话框中，单击确定可立即执行定时任务。

此小节介绍数据库审计的产品术语。 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 这些示例演示了不同类型的普通视图创建，您可以根据具体需求选择适合的创建方式。普通视图仅提供了对查询结果的封装，不会存储实际数据，每次查询视图时都会重新执行视图定义的查询逻辑。

参数 是否必填 参数类型 说明 示例 下级对象 website 是 String 固定参数

通过本接口向云点播开启视频封面上传初始化流程。 接口功能介绍 用户可在点播模式下通过本接口向云点播开启视频封面上传初始化流程。在初始化视频封面上传中，您将会得到一个地址，该地址是一个预签名的标准 S3 协议的 Restful URL，您需要将您的文件通过 PUT 的方式上传到该地址。该地址相关的参数请参考 S3 put object 相关的文档。 封面图片支持 5M 以内的 JPG/PNG 格式的图片。 由于封面图片都不大，请不要在此业务中使用multipartupload。 接口约束 本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。 URI POST /video/cover/upload/init 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 videoId 是 String 必填参数，视频id。 34c71dbaf2804f5ea05ff4daed837fef 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 code 是 String 本次请求的结果码。 "0" message 是 String 错误文本信息，创建成功时，为空字符串。 "" data 是 Object 返回结果 data 表data 参数 是否必填 参数类型 说明 示例 下级对象 presignedUrl 是 String 用以上传的地址

接口功能介绍 检查Server证书合法性 接口约束 无 URI POST /v4/elb/checkcertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificate 是 String 证书内容 privateKey 是 String 服务器证书私钥 响应参数 参数 参数类型 说明 示例 下级对象 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 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 isValid Boolean 是否合法 false 枚举参数 无 请求示例 请求url POST /openapi/v4/elb/checkcertificate 请求头header 无 请求体body {"certificate": "BEGIN CERTIFICATEMIIDIjCCAougAwIBAgIJALV96mEtVF4EMA0GCSqGSIb3DQEBBQUAMGoxCzAJBgNVBAYTAnh4MQswCQYDVQQIEwJ4eDELMAkGA1UEBxMCeHgxCzAJBgNVBAoTAnh4MQswCQYDVQQLEwJ4eDELMAkGA1UEAxMCeHgxGjAYBgkqhkiG9w0BCQEWC3h4eEAxNjMuY29tMB4XDTE3MTExMzAyMjYxM1oXDTIwMTExMjAyMjYxM1owajELMAkGA1UEBhMCeHgxCzAJBgNVBAgTAnh4MQswCQYDVQQHEwJ4eDELMAkGA1UEChMCeHgxCzAJBgNVBAsTAnh4MQswCQYDVQQDEwJ4eDEaMBgGCSqGSIb3DQEJARYLeHh4QDE2My5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMU832iM+d3FILgTWmpZBUoYcIWVcAAYE7FsZ9LNerOyjJpyi256oypdBvGs9JAUBN5WaFk81UQx29wAyNixX+bKa0DBWpUDqr84V1f9vdQc75v9WoujcnlKszzpV6qePPC7igJJpu4QOI362BrWzJCYQbg4Uzo1KYBhLFxl0TovAgMBAAGjgc8wgcwwHQYDVR0OBBYEFMbTvDyvE2KsRy9zPq/JWOjovG+WMIGcBgNVHSMEgZQwgZGAFMbTvDyvE2KsRy9zPq/JWOjovG+WoW6kbDBqMQswCQYDVQQGEwJ4eDELMAkGA1UECBMCeHgxCzAJBgNVBAcTAnh4MQswCQYDVQQKEwJ4eDELMAkGA1UECxMCeHgxCzAJBgNVBAMTAnh4MRowGAYJKoZIhvcNAQkBFgt4eHhAMTYzLmNvbYIJALV96mEtVF4EMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAASkC/1iwiALa2RU3YCxqZFEEsZZvQxikrDkDbFeoa6Tk49Fnb1f7FCW6PTtY3HPWl5ygsMsSy0Fi3xp3jmuIwzJhcQ3tcK5gC99HWp6Kw37RL8WoB8GWFU0Q4tHLOjBIxkZROPRhH+zMIrqUexv6fsb3NWKhnlfh1Mj5wQE4LdoEND CERTIFICATE","privateKey": "BEGIN RSA PRIVATE KEYMIICXQIBAAKBgQDFPN9ojPndxSC4E1pqWQVKGHCFlXAAGBOxbGfSzXqzsoyacotueqMqXQbxrPSQFATeVmhZPNVEMdvcAMjYsV/mymtAwVqVA6q/OFdX/b3UHO+b/VqLo3J5SrM86Veqnjzwu4oCSabuEDiN+tga1syQmEG4OFM6NSmAYSxcZdE6LwIDAQABAoGBAJvLzJCyIsCJcKHWL6onbSUtDtyFwPViD1QrVAtQYabF14g8CGUZG/9fgheuTXPtTDcvu7cZdUArvgYW3I9F9IBb2lmF3a44xfiAKdDhzr4DK/vQhvHPuuTeZA41r2zp8Cu+Bp40pSxmoAOK3B0/peZAka01Ju7c7ZChDWrxleHZAkEA/6dcaWHotfGSeW5YLbSms3f0m0GH38nRl7oxyCW6yMIDkFHURVMBKW1OhrcuGo8u0nTMi5IH9gRg5bH8XcujlQJBAMWBQgzCHyoSeryD3TFieXIFzgDBw6Ve5hyMjUtjvgdVKoxRPvpOkclc39QHP6Dm2wrXXHEej+9RILxBZCVQNbMCQQC42i+Ut0nHvPuXN/UkXzomDHdeh1ySsOAO4H+8Y6OSI87l3HUrByCQ7stX1z3L0HofjHqV9Koy9emGTFLZEzSdAkB7Ei6cUKKmztkYe3rr+RcATEmwAw3tEJOHmrW5ErApVZKr2TzLMQZ7WZpIPzQRCYnY2ZZLDuZWFFG3vW+wKKktAkAaQ5GNzbwkRLpXF1FZFuNF7erxypzstbUmU/31b7tSi5LmxTGKL/xRYtZEHjya4Ikkkgt40q1MrUsgIYbFYMf2END RSA PRIVATE KEY"}

接口功能介绍 查询策略地址组详情，访问控制采用黑、白名单方式实现，此接口为查询黑、白名单的地址组。 接口约束 无 URI GET /v4/elb/showaccesscontrol 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 区域ID id 否 String 访问控制ID, 该字段后续废弃 accessControlID 否 String 访问控制ID, 推荐使用该字段, 当同时使用 id 和 accessControlID 时，优先使用 accessControlID 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 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 返回结果 见下表 returnObj error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 azName String 可用区名称 projectID String 项目ID ID String 访问控制ID name String 访问控制名称 description String 描述 sourceIps Array of Strings IP地址的集合或者CIDR createTime String 创建时间，为UTC格式

接口功能介绍 更新证书 接口约束 无 URI POST /v4/elb/updatecertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b projectID 否 String 企业项目ID，默认为0 0 ID 否 String 证书ID, 该字段后续废弃 xxx certificateID 否 String 证书ID, 推荐使用该字段, 当同时使用 ID 和 certificateID 时，优先使用 certificateID（至少填一个） xxxxx name 否 String 唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 test description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:"{},./;'[]·！@ ￥%……&（） —— +{} 《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc 响应参数 参数 参数类型 说明 示例 下级对象 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 Array of Objects 返回结果 见下表 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 证书ID cert4xvz5g2y5h

接口功能介绍 调用此接口可发送自定义消息。 接口约束 无。 URI POST /v4/monitor/sendmessage 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 method 是 Array of Strings 发送方式 本参数表示发送方式，取值范围： 1.email：邮箱 2.sms：短信 3.voice：语音 token 是 String token 1411668ec8c13f57472576d5d1603226 subject 否 String 主题 method包含email时：该字段为邮件主题 method包含voice时：该字段为语音播报内容 webhookURL 否 Array of Strings webhook推送url [' content 是 String 发送内容 method包含email时：该字段为邮件内容 method包含voice时：该字段为非空任意值 method包含sms时：该字段为短信内容 webhookURL非空时：该字段为webhook发送内容 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

告警联系人/组 告警联系人：修改 接口功能介绍 调用此接口可修改告警联系人配置，支持全量字段修改。 接口约束 告警联系人ID存在，告警联系人名称不可重复，可包含字母、中文、数字，250个字符。 URI POST /v4/monitor/updatecontacts 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactID 是 String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 name 是 String 用户名 moCEN phone 否 String 手机号，手机号和邮箱二选一必填，手机号填了，邮箱可不填，反之一样，二者不能全为空。 13309310049 email 否 String 邮箱， 手机号和邮箱二选一必填，邮箱填了，手机号可不填，反之一样，二者不能全为空。 123323@qq.com 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0

本文介绍如何配置镜像安全策略。 默认策略 有一个默认策略，默认为“启用”状态。默认策略应用对象为所有仓库、所有镜像，仅报警，不阻断。 添加策略 1. 登录容器安全卫士控制台。 2. 在左侧导航栏，选择“镜像安全 > 镜像策略”，进入镜像策略页面。 3. 单击“添加策略”，进入添加策略页面。 4. 输入策略的基本信息。 5. 选择策略对象，即指定该策略应用的镜像。 6. 对指定仓库中的镜像添加规则，通过添加这些规则来查看镜像、仓库中有哪些漏洞。 说明 需要先输入策略的基本信息、选择策略对象后，才能添加具体规则。 7. 配置完成后单击“保存”，保存策略配置。 批量设置策略 还支持批量对策略进行处理，包括启用、禁用、删除。 1. 登录容器安全卫士控制台。 2. 在左侧导航栏选择“镜像安全 > 镜像策略”，进入镜像策略页面。 3. 勾选策略名称前的复选框，选择要操作的策略。 4. 单击选择列表上方的“批量”按钮，展开批量操作。 5. 根据需要选择执行的操作，支持批量启用、禁用、删除。

本章节主要介绍集群扩容。 扩容集群 用户需要更多的计算资源或存储资源以满足业务需要时，可以在管理控制台对已有集群，通过增加节点进行扩容操作。 说明 如果当前集群是包年/包月计费模式，那么新增节点也是按照包年包月模式进行计费。 标准数仓集群扩容时使用与当前集群相同的存储规格。 如果子网IP数量不足，允许执行跨子网扩容操作。 如果您是因集群存储容量不足而扩容集群，建议您在扩容前先执行VACUUM清理和回收存储空间，DWS 数据仓库中保存的数据在删除后，可能没有释放占用的磁盘空间形成脏数据，导致磁盘浪费。如果执行VACUUM后，已使用存储容量仍然占用过高，您再进行扩容。VACUUM的语法请参见《数据仓库服务SQL语法参考》中的“VACUUM”章节。 扩容对系统的影响 扩容前，需退出创建了临时表的客户端连接，因为在扩容过程中及扩容成功之前创建的临时表将会失效，操作临时表也会失败。但是扩容后创建的临时表不受影响。 在执行“扩容”操作后，集群会进行一次自动快照，快照创建成功后进行集群扩容。 正在扩容的集群将禁用重启集群、扩容集群、创建快照、重置数据库管理员密码和删除集群的功能。 离线扩容过程中，集群会自动重启，因此集群会有一段时间变为“不可用”状态，重启成功后集群变回“可用”状态。然后在扩容结束阶段，系统会将集群中用户数据在全部节点重新动态分布。

接口功能介绍 创建策略地址组，策略地址组为被访问控制的黑白名单调用的地址组。 接口约束 无 URI POST /v4/elb/createaccesscontrol 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b name 是 String 唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 test description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:,.,/;'[]·！@ ￥%……&（） ——+{} acl sourceIps 是 Array of Strings IP地址的集合或者CIDR ["10.0.0.46","10.0.0.47"] 响应参数 参数 参数类型 说明 示例 下级对象 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 返回结果 见下表 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 访问控制ID xxxx

接口功能介绍 查询策略地址组，访问控制采用黑、白名单方式实现，此接口为查询黑、白名单的地址组。 接口约束 无 URI GET /v4/elb/listaccesscontrol 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b IDs 否 String 访问控制ID列表 acv08ki7xz2i name 否 String 访问控制名称,只能由数字，字母，组成不能以数字和开头，最大长度32 test 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 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 Array of Objects 返回结果 见下表 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 azName String 可用区名称 az1 projectID String 项目ID 0 ID String 访问控制ID xxx name String 访问控制名称 test description String 描述 desc sourceIps Array of Strings IP地址的集合或者CIDR [] createTime String 创建时间，为UTC格式 20221003T09: 44: 22Z

创建一个定时策略 接口功能介绍 在伸缩组中创建一个定时策略。 接口约束 无 URI POST /v4/scaling/rule/createscheduled 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d groupID 是 Integer 伸缩组ID 471 name 是 String 伸缩策略名称请注意不能与当前伸缩组内的其他策略冲突 aspolicyxudcdcfccd executionTime 是 String 定时策略执行时间 20221017 10:44:00 action 是 Integer 执行动作。取值范围：1：增加2：减少3：设置为 1 operateUnit 是 Integer 操作单位。 取值范围：1：个数。2：百分比。 1 operateCount 是 Integer 调整值 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.RuleNameConflict 错误码 message String 失败时的错误描述，一般为英文描述 the name of scaling rule conflicts description String 失败时的错误描述，一般为中文描述 伸缩策略名称冲突 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149

修改一个定时策略 接口功能介绍 修改一个定时策略 接口约束 停用伸缩策略后，可以进行修改操作 URI POST /v4/scaling/rule/updatescheduled 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 489 ruleID 是 Integer 伸缩策略ID 87 name 否 String 伸缩策略名称，长度范围[2, 50] aspolicyad40 operateUnit 否 Integer 操作单位。 取值范围：1：个数。2：百分比。 1 operateCount 否 Integer 调整值 1 action 否 Integer 执行动作。取值范围：1：增加2：减少3：设置为 2 executionTime 否 String 执行时间，格式为：%Y%m%d %H:%M:%S 20221013 23:56:00 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 87

接口功能介绍 解绑弹性 IP 接口约束 无 URI POST /v4/elb/disassociateeipfrom 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 否 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID ID 否 String 负载均衡ID, 该字段后续废弃 elbID 是 String 负载均衡ID, 推荐使用该字段, 当同时使用 ID 和 elbID 时，优先使用 elbID eipID 是 String 弹性公网IP的ID 响应参数 参数 参数类型 说明 示例 下级对象 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 Array of Objects 返回结果 见下表 returnObj error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 负载均衡ID lbf1vo2qd2js

接口功能介绍 删除负载均衡实例 接口约束 无 URI POST /v4/elb/deleteloadbalancer 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID projectID 否 String 企业项目 ID，默认为'0' 0 ID 否 String 负载均衡ID, 该字段后续废弃 elbID 否 String 负载均衡ID, 推荐使用该字段, 当同时使用 ID 和 elbID 时，优先使用 elbID 响应参数 参数 参数类型 说明 示例 下级对象 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 Array of Objects 返回结果 见下表 returnObj error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 负载均衡ID lbf1vo2qd2js

接口功能介绍 非对称密钥验签接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricVerify 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 验签算法，取值范围： RSAPSSSHA256 SM2 RSAPSSSHA256 digest 是 String 消息摘要，使用algorithm对应的哈希算法，对原始消息生成摘要 说明：需进行Base64编码 ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuyjfzw value 是 String 待验证的签名值 说明：需进行Base64编码 ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 响应参数 参数 参数类型 说明 示例 下级对象 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 value Boolean 验签结果 true

接口功能介绍 非对称密钥解密接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricDecrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 解密算法，取值范围： RSAESOAEPSHA256 RSAESOAEPSHA1 RSAESPKCS1V15 SM2 RSAESOAEPSHA256 ciphertextBlob 是 String 待解密密文 说明：需进行Base64编码 ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 响应参数 参数 参数类型 说明 示例 下级对象 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 plaintext String 解密后明文经过Base64编码后的值 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002

参数 是否必填 参数类型 说明 示例 下级对象 cors 是 String 固定参数 cors