接口功能介绍 云硬盘功能请联系客户经理开通。 接口约束 无 URI POST /v3/cloudVolume/expand 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 volumeOid 是 String 云硬盘ID volumeSize 是 Integer 扩容后的云硬盘大小 autoPay 否 Boolean 是否自动支付（仅单独付费云硬盘有效），默认false。取值范围： true:是。（仅订购类型为包周期类型有效，需账号有足够金额） false:否。（仅订购类型为包周期类型有效） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 operationId String 扩容云硬盘操作ID，可用于查询操作状态（相关接口：异步操作查询操作详情,仅资源包创建云硬盘有效）。 newOrderNo String 订单号（仅创建单独付费云硬盘有效）。 newOrderId String 订单id（仅创建单独付费云硬盘有效）。 totalPrice String 总价格（仅创建单独付费云硬盘有效）。

本页介绍了基于Java开发文档数据库服务应用程序的基本流程。 应用程序对接文档数据库服务的基本流程如下： 1. 添加文档数据库服务驱动程序依赖：在应用程序中添加文档数据库服务驱动程序的依赖，以便在应用程序中使用文档数据库服务的API。 2. 创建文档数据库服务客户端：使用文档数据库服务驱动程序提供的 Client 类创建一个文档数据库服务客户端，用于连接到文档数据库服务。可以在 Client 构造函数中指定文档数据库服务服务器的地址和端口号，以及其他认证信息和配置参数。 3. 获取数据库和集合对象：使用Client实例获取一个或多个数据库对象，并使用数据库对象获取集合对象。可以使用文档数据库服务提供的API或者文档数据库服务的查询语言来对集合中的文档进行操作。 4. 执行 CRUD 操作：使用集合对象执行 CRUD（创建、读取、更新、删除）操作，以对文档进行操作。可以使用文档数据库服务提供的 API 或者文档数据库服务的查询语言来执行查询操作。 5. 创建索引：使用集合对象创建索引以提高查询效率和性能。可以使用文档数据库服务提供的 API 或者文档数据库的命令行工具来创建索引。 6. 处理错误和异常：在 Java 应用程序中处理文档数据库服务操作可能出现的错误和异常，以便及时发现和修复问题。可以使用 trycatch 块或其他错误处理机制来捕获和处理异常。 7. 关闭文档数据库服务客户端：在应用程序中关闭与文档数据库服务的连接，释放资源并避免连接泄漏。可以使用Client 的 close() 方法来关闭客户端。

接口功能介绍 查看iplistener列表 接口约束 无 URI GET /v4/iplistener/list 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 ipListenerID 否 String 监听器 ID listenerxxx pageNumber 否 Integer 列表的页码，默认值为 1。 1 pageSize 否 Integer 分页查询时每页的行数，最大值为 50，默认值为 10。 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 requestID String 请求ID eeef00f6dee511f085ae525400fa2048 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 results Array of Objects 接口业务数据 results totalCount Integer 列表条目数 1 currentCount Integer 分页查询时每页的行数。 1 totalPage Integer 总页数 1 表 results 参数 参数类型 说明 示例 下级对象 gwElbID String 网关负载均衡 ID gwlbxxx name String 名字 tset description String 描述 desc ipListenerID String 监听器 id listenerxxxx action Object 转发配置 action tcpIdleTimeout Integer TCP连接空闲时间 900 表 action 参数 参数类型 说明 示例 下级对象 type String 默认规则动作类型: forward / redirect forward forwardConfig Array of Objects 转发配置 forwardConfig 表 forwardConfig 参数 参数类型 说明 示例 下级对象 targetGroupID String 后端服务组ID tgxxx weight String 权重 100

目前只支持升配询价:增加带宽和连接数。 接口功能介绍 VPN网关升配询价，目前只支持升配询价:增加带宽和连接数。 接口约束 有已经下单成功VPN网关。 URI POST /v4/vpn/gateway/querypriceupgrade 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID, 例:100054c0416811e9a6690242ac110002 bandwidth 是 Integer 带宽，单位为Mbps connectionLimit 是 Integer VPN网关连接数限制 resourceID 是 String VPN网关资源ID linkResourceID 是 String VPN连接资源ID 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码(800为成功，900为失败) message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj errorCode 否 String 业务细分码，为product.module.code三段式码 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 totalPrice 否 Float 所有订单总共价格 finalPrice 否 Float 所有订单最终价格 isSucceed 否 Boolean 是否成功 subOrderPrices 否 Array of Objects 子订单价格列表 orderPrice 表 orderPrice 参数 是否必填 参数类型 说明 示例 下级对象 serviceTag 否 String 产品标签 totalPrice 否 Float 订单总共价格 finalPrice 否 Float 订单最终价格 orderItemPrices 否 Array of Objects 订单资源价格列表 orderItemPrice cycleType 否 Integer 订单周期 表 orderItemPrice 参数 是否必填 参数类型 说明 示例 下级对象 itemId 否 String 订单资源ID resourceType 否 String 本参数表示订单资源类型。 取值范围： VPNGETWAY VPNLINK totalPrice 否 Float 订单资源总共价格 finalPrice 否 Float 订单资源最终价格

VPN用户服务查看。 接口功能介绍 vpn用户服务查看 接口约束 支持集群模式资源池。 URI GET /v4/vpn/ipsecuserservice/list 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 get请求包含body参数,报文头指定application/json,且body结构对象需要转json。 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 queryContent 否 String Query Content模糊查询 ipsec111 projectID 否 String project ID 0 ipsecServiceName 否 String IPSCE 服务名称 ipsec111 ipsecServiceID 否 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 pageSize 否 Integer 每页行数 1 pageNo 否 Integer 页码 1 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 totalCount 否 Integer 查询的总记录数 3 currentCount 否 Integer 当前页记录数 2 totalPage 否 Integer 总页数 2 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96 results 否 Array of Objects 列表 results 表results 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 否 String IPSCE SERVICE名称 ipsec111 ipsecServiceID 否 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 ipAddress 否 String IPAddress 111.0.0.1 createTime 否 String create time 20230621 01:39:01 vpnConnectionID 否 String vpn connection ID 908dhfa99c0404bb0806a8be317cc4d89

事件监控 事件监控：查询详情 接口功能介绍 根据指定时间段查询事件发生情况。 接口约束 regionID、startTime、endTime、eventName，dimension、service存在。 URI POST /v4/monitor/events/querydetail 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID 81f7728662dd11ec810800155d307d5b startTime 是 Integer 查询起始时间戳 1647424660 endTime 是 Integer 查询截止时间戳 1647424660 eventName 是 String 本参数表示事件指标，事件指标见查询事件接口返回。 migrationeventstart service 是 String 服务，见事件监控：查询服务维度接口返回。 ecs dimension 是 String 维度，见事件监控：查询服务维度接口返回。 ecs pageNo 否 Integer 页码，默认为1 1 pageSize 否 Integer 页大小，默认为20 2 resGroupID 否 String 资源分组ID，在资源分组事件时传入 9cb2b3301dd85ec49c6db07fe65a9aca 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount Integer 获取对象数据条数 14 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 eventDetail Array of Objects 事件详情列表 eventDetailObj 表 eventDetailObj 参数 参数类型 说明 示例 下级对象 deviceUUID String 设备ID 000f03221f4d8cc8bb2e1c30fb751aa5 deviceName String 设备名称 ecm1234 deviceTime Integer 设备事件发生时间，秒级时间戳 1647424660

自定义监控项 自定义监控项：查询 接口功能介绍 调用此接口可查询自定义监控项。 接口约束 资源池ID不能为空。 URI GET /v4/monitor/querycustomitems 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b customItemID 否 String 自定义监控项ID ITEM793d5923652be6ce202306291409 name 否 String 监控项名称，支持模糊搜索 我的CPU使用率 pageNo 否 Integer 页码，不传默认为1 1 pageSize 否 Integer 每页大小，不传默认为10 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 customItemList Array of Objects 自定义监控项列表 customItem totalCount Integer 总记录数 2 totalPage Integer 总页数 1 currentCount Integer 当前记录数 2 表 customItem 参数 参数类型 说明 示例 下级对象 regionID String 资源池ID 81f7728662dd11ec810800155d307d5b customItemID String 自定义监控项ID ITEM793d5923652be6ce202306291409 name String 监控项名称 我的CPU使用率 unit String 自定义监控项的单位 % interval Integer 数据上报间隔，单位秒 60 dimensions Array of Strings 用于查询监控数据的维度 ['uuid','usage'] dimension 表 dimension 参数 参数类型 说明 示例 下级对象 name String 维度名称，支持英文、下划线 uuid description String 维度描述，支持中文、英文、下划线 主机的唯一标识

智能边缘云(Edge Cloud X,简称ECX)是天翼云分布式云的重要组成部分,将计算、存储、网络等云能力从中心云下沉到电信网络边缘,为您提供低延时、高可用、属地化的云服务。

接口功能介绍 新增标签接口 接口约束 无 URI POST /v1/lebalControl/addLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 key 是 String key值 123 value 是 String value值 123 labelId 否 String 标签ID 562b89493b1a40e1b97ea05e50dd8170 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 requestId error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 requestId 参数 参数类型 说明 示例 下级对象 requestId String 请求ID 56495f1608e845a7871844941bcc8350 枚举参数 无 请求示例 请求url 请求头header { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "key": "123", "value":"123" }

接口功能介绍 创建密钥版本 接口约束 请保证账户余额大于0 URI POST /v1/versionControl/createKeyVersion 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 6b1f657c816b4534a41a903e7a60e703 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 用戶主密钥创建成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 creationDate String 密钥创建时间 Tue Oct 25 15:06:52 CST 2022 keyVersionId String 密钥版本id 6b1f657c816b4534a41a903e7a60e703 cmkUuid String 密钥唯一标识 474e569e8814474a948bdbcf6d853eff requestId String 请求id 2a56124813ed4ef7a359e818dce118d8

接口功能介绍 删除Ukey证书 接口约束 无 URI POST /v1/manageCertificate/deleteCertificateForUk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d 枚举参数 无 请求示例 请求url 请求头header { "regionId": "200000001852" } 请求体body { "certificateId": "159dd453911f4d32a4fa6e9f61cbd483" }

接口功能介绍 删除标签接口 接口约束 无 URI POST /v1/lebalControl/deleteLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 56495f1608e845a7871844941bcc8350 枚举参数 无 请求示例 请求url 请求头header { "regionId": "200000001852" } 请求体body { "key": "xyz", "value": "777" }

接口功能介绍 生成随机数 接口约束 无 URI POST /v1/certificateCompute/getRandom 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 randomDataLength 是 String 随机数的byte位长度 18 protectLevel 是 String 创建等级（0硬件、1软件） 0 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0519 message String 调用结果信息 随机数生成成功 returnObj String 接口返回结果 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 randomData String 16进制随机数 5791C223E87120BE4B98D168F47A58BB2A88834EEADC requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "randomDataLength": "18" }

SSL VPN客户端密码修改。 接口功能介绍 SSL VPN客户端密码修改 接口约束 无 URL POST /v4/vpn/sslclientkeyword/update 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b sslClientID 是 String SSL客户端ID 9c5bd3333d5847e8b62dfa719f797d12 keyword 是 String 密码 12345678 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 616797965481

接口功能介绍 获取监控/告警服务的维度列表。 接口约束 无。 URI GET /v4/monitor/queryalarmdimensions 请求参数 Query参数 无。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 dimensions Array of Objects 维度列表 dimension 表dimension 参数 参数类型 说明 示例 下级对象 dimensionName String 服务名 ecs description String 描述 云主机 请求示例 GET /v4/monitor/queryalarmdimensions 响应示例 json { "statusCode": 800, "returnObj": { "dimensions": [ {"dimensionName": "ecs", "description": "云主机"}, {"dimensionName": "evs", "description": "云硬盘"}, {"dimensionName": "netbag", "description": "云间高速"} ] }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

接口功能介绍 将指定资源池下指定的一个监控面板删除。 接口约束 regionID（资源池）和templateID（监控面板）存在。 URI POST /v4/monitor/deletemonitor 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 2ad61e2e504611ed8fb7005056897257 监控面板ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 请求示例 POST /v4/monitor/deletemonitor 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "templateID": "2ad61e2e504611ed8fb7005056897257" }

监控看板 监控看板：查看详情 接口功能介绍 查看监控看板详细信息，包括视图信息，不包含监控数据信息。 接口约束 参见请求参数说明。 URI GET /v4/monitor/monitorboard/describe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b boardID 是 String 监控看板ID 0bf803e8504911ed8fb7005056897257 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 views Array of Objects 监控视图列表 view viewQuota Integer 监控视图配额剩余数量 10 表 view 参数 参数类型 说明 示例 下级对象 viewID String 监控视图ID 0a84e6da9fabfcd115526ab6a0b7ac88 name String 监控视图名称 name service String 云监控服务 ecs dimension String 云监控维度 ecs viewType String 视图类型。取值范围:timeSeries：折线图。gauge：仪表盘。barChart：柱状图。table：表格。pieChart：饼状图。根据以上范围取值。 timeSeries orderIndex Integer 排序次序，相同则按照updateTime降序。 0 itemNameList Array of Strings 监控指标，指标项最多支持20个 ['cpuutil'] compares Array of Strings 同比环比比较时间配置，格式为“数字+单位”，单位为空时默认为秒。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 ['1d'] resources Array of Objects 监控资源实例，监控资源实例最多支持20个 resource gaugePattern Object 仪表盘配置，仅当viewType为gaugePattern时有效 gaugePattern createTime Integer 创建时间，时间戳，精确到秒 1667459789 updateTime Integer 最近更新时间, 时间戳，精确到秒 1667459789 表 resource 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源 obj 表 obj 参数 参数类型 说明 示例 下级对象 key String 资源键 uuid value String 资源键对应的值 xxxx 表 gaugePattern 参数 参数类型 说明 示例 下级对象 minVal Integer 仪表盘最小值 0 maxVal Integer 仪表盘最大值 100 threshold Array of Integers 仪表盘中间分段取值 [30,80]

使用场景 企业拥有大量技术文档、标准操作流程（SOP）和产品资料，分散在各部门和员工的本地电脑或邮件中。新员工入职时需要花费大量时间查找资料，而老员工在编写技术方案时也常因缺乏最新资料而反复询问。部门间的文档共享和版本控制也存在问题，经常出现使用旧版文件导致的生产事故或质量问题。 用户痛点 文档分散在不同部门和个人手中，缺乏统一的存储和检索机制，员工需要花费大量时间搜索文件，降低了工作效率。 版本控制困难，多人协作修改同一文档时容易出现版本不一致，导致决策失误或返工。 知识沉淀不足，随着人员流动和离职，重要的操作指南、经验分享可能随之流失，新员工难以快速获取关键知识，影响了团队整体能力。 产品优势 云空间为企业提供了统一的文件存储空间，所有文档、资料集中存储在云端，支持按账号设置访问权限，提高了文档安全性和访问便利性。 在线文档编辑功能允许多人同时编辑同一文档，实时保存并自动生成版本历史。提供版本对比功能，使管理者可以追溯并审核，提高了文档管理的规范性。 场景4：构建活水知识库 使用场景 在传统办公模式下，办公消息分散在不同的聊天窗口中，上传的文件也可能存放在员工个人电脑、不同的云盘文件夹或邮件附件里，造成很多隐形知识的流失。

参数名称 说明 导入类型 可选择sql或CSV。 文件来源 DAS支持从本地选取文件导入，同时也支持从OBS桶中直接选择文件进行导入操作。 上传文件选择文件来源为“上传文件”、需要设置附件存放位置，并上传文件。出于数据隐私性保护目的，DAS需要您提供一个自己的OBS存储，用来接收您上传的附件信息，DAS会自动连接到该OBS文件，进行内存式读取，整个过程您的数据内容不会存储在DAS的任何存储介质上。创建OBS桶免费，但是保存文件将产生一定的费用。导入完成后若勾选删除上传的文件选项，则该文件导入目标数据库成功后，将从OBS桶中自动删除。 OBS桶选择文件来源为“从OBS中选择”，需要在OBS中选择待导入文件。从OBS桶中直接选择文件导入，导入目标数据库成功后，OBS桶不会删除该文件。 数据库 选择导入的目标数据库。 字符集 按需设置字符集。 选项 勾选选项“忽略报错，即SQL执行失败时跳过”时，则在数据导入目标数据库的过程中，如果有SQL执行出错，系统将忽略执行错误，继续往下执行。勾选“导入完成后删除上传的文件”时，则该文件导入目标数据库成功后，将从OBS桶中自动删除。该选项仅适用于本地上传的文件。 备注 自定义备注信息。

参数名称 说明 导入类型 可选择sql或CSV。 文件来源 DAS支持从本地选取文件导入，同时也支持从OBS桶中直接选择文件进行导入操作。 上传文件选择文件来源为“上传文件”、需要设置附件存放位置，并上传文件。出于数据隐私性保护目的，DAS需要您提供一个自己的OBS存储，用来接收您上传的附件信息，DAS会自动连接到该OBS文件，进行内存式读取，整个过程您的数据内容不会存储在DAS的任何存储介质上。创建OBS桶免费，但是保存文件将产生一定的费用。导入完成后若勾选删除上传的文件选项，则该文件导入目标数据库成功后，将从OBS桶中自动删除。 OBS桶选择文件来源为“从OBS中选择”，需要在OBS中选择待导入文件。从OBS桶中直接选择文件导入，导入目标数据库成功后，OBS桶不会删除该文件。 数据库 选择导入的目标数据库。 字符集 按需设置字符集。 选项 勾选选项“忽略报错，即SQL执行失败时跳过”时，则在数据导入目标数据库的过程中，如果有SQL执行出错，系统将忽略执行错误，继续往下执行。勾选“导入完成后删除上传的文件”时，则该文件导入目标数据库成功后，将从OBS桶中自动删除。该选项仅适用于本地上传的文件。 备注 自定义备注信息。

接口功能介绍 获取vpc的子网列表 接口约束 传参规范 URI GET /vfw/v2firewallsubnetlist 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 filterNotValid 否 Boolean 过滤无效子网 trafficSubnet 是 Boolean 是否查询业务子网 true vpcId 是 String vpc id 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 SubnetInfo 表 SubnetInfo 参数 参数类型 说明 示例 下级对象 availabilityZones Array of Strings 子网所在的可用区名称 availableIpCount Integer 子网内可用 IPv4 数目 1 cidr String 子网网段，掩码范围为 1628 位 createdAt String 创建时间 description String 描述 dnsList Array of Strings DNS 服务器地址:默认为空；必须为正确的 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 end String 子网网段结束 IP gatewayIp String 子网网关 ipv6Cidr String 子网 Ipv6 网段，掩码范围为 1628 位 ipv6End String 子网内可用的结束 IPv6 地址 ipv6GatewayIp String v6 网关地址 ipv6Start String 子网内可用的起始 IPv6 地址 name String 名称 networkAclId String 子网 acl ID ntpList Array of Strings NTP 服务器地址: 默认为空，必须为正确的域名或 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 routeTableId String 子网路由表 ID start String 子网网段起始 IP subnetId String 子网ID type Integer 子网类型 :当前仅支持：0（普通子网） 0 updatedAt String 更新时间 vpcId String VpcId

约束与限制 容器运行时限制：Docker、Containerd。 集群类型限制：CCE标准版、CCE Turbo版。 节点资源剩余要求：内存必须50MiB及以上，CPU必须200m及以上。 在集群上安装Agent时，HSS会在集群上创建HSS的命名空间。 安装步骤 1. 登录管理控制台。 2. 在页面左上角单击，选择“区域”，选择“安全 > 企业主机安全”，进入“企业主机安全”页面。 3. 在左侧导航栏，选择“安装与配置 > 容器安装与配置”，进入“容器安装与配置”页面。 4. 在“集群”页签，单击“安装容器安全Agent”，弹出“容器资产接入与安装”对话框。 5. 选择“CCE集群安装”，并单击“开始配置”。 6. 勾选目标集群，并单击“下一步”。 7. 配置Agent相关参数。参数说明如下表示。 参数名称 参数说明 配置规则 选择Agent配置规则。 默认规则：容器运行时的sock地址为通用地址，Agent将默认安装在没有配置污点的节点上。 自定义规则：如果您的容器运行时sock地址非通用地址需要修改，或仅需要在指定的节点上安装Agent，可选择该规则。 说明 如果容器运行时的sock地址不正确，可能导致集群接入HSS后，部分HSS功能不能正常使用。 在进行容器运行时配置时，建议全选所有运行时类型。 高级配置（可选） 配置规则选择“自定义规则”时，支持配置。 单击展开所有高级配置项，“开启Agent自动升级”项，默认为展开状态。 开启Agent自动升级 是否开启Agent自动升级，勾选即开启，开启后，每日00:00～06:00，企业主机安全将自动升级低版本的Agent为最新版，以便为您提供更好的服务。 节点选择器配置 单击“引用节点标签”，可选择需要安装Agent的节点标签。不选择，默认在所有没有配置污点的节点上安装Agent。 容忍度配置 如果在进行“节点选择器配置”时，选择了污点节点标签，需要在该污点节点上安装Agent，可单击“引用节点污点”，选择容忍节点污点。 8. 配置完成，单击“确定”，开始安装HSS Agent。 9. 在集群列表中，查看集群状态为“运行中”，表示集群接入HSS成功。

手动续订 单个续订 1. 登录控制中心。 2. 单击控制中心左上角的，选择地域。 3. 单击“存储>云硬盘”，进入云硬盘页面。 4. 单击需要续订的包年/包月云硬盘，进入云硬盘详情页后，点击右上角“续订”。 5. 填写“续订时长”，确认无误后，点击“确定”。 6. 点击“确定”后，跳转到“费用中心>我的订单”，点击“立即支付”以完成续订操作。 注意 续订将会产生续订订单，请您于48小时内支付订单，否则续订操作失败数据将被清空。 批量续订 1. 登录控制中心。 2. 单击控制中心左上角的，选择地域。 3. 单击“存储>云硬盘”，进入云硬盘页面。 4. 勾选所有需要续订的包年/包月云硬盘，点击云硬盘列表上方“续订”。 5. 填写“续订时长”，确认无误后，点击“确定”。 6. 点击“确定”后，跳转到“费用中心>我的订单”，点击“立即支付”以完成续订操作。

如何清理点播实例。 前提条件 已开通云点播产品。 至少创建了一个点播实例。 操作步骤 当您需要彻底清空点播实例存储的媒体数据和配置信息时，您可以进行如下操作： 进入云点播控制台，选择左侧导航栏的【实例管理】可进入区域管理页面。通过点击对应点播实例操作栏的【清空】按钮，按照提示内容进行操作即可。 由于清理操作涉及用户敏感信息清理，且操作过程不可逆，因此需要用户使用天翼云注册手机号码进行身份验证，请保持手机通讯畅通。 注意 1. 以上清理操作仅涉及到该点播实例下相关三个存储桶数据及媒资数据信息的清理。 2. 若用户同时开通了多个点播实例，每个区域需要分别清理。 3. 在点播实例清理过程中，请勿使用提交新的媒体处理任务，否则可能造成清理不彻底。 4. 云点播默认需保持至少一个点播实例。如您对点播实例执行了清空操作，并不会自动注销删除该实例。但不会影响您后续产品注销服务。

本文主要介绍验证数据库备份结果 (Linux)。 使用自定义脚本实现数据库备份完成后，可以通过如下操作验证应用一致性备份结果是否成功。本章节以MY SQL数据库为例进行验证。 步骤1、登录MY SQL数据库，创建新的数据库。 步骤2、创建数据库成功后，创建存储过程，可以参考下图。 创建存储过程 步骤3、进入服务备份控制台，对目标弹性云主机创建数据库备份，并勾选数据库备份。 步骤4、待备份完成后，进入/home/rdadmin/Agent/log/rdagent.log，查看冻结、解冻日志，确定冻结解冻时间。 步骤5、使用新创建的数据库备份恢复目标弹性云主机。恢复成功后，登录云主机和数据库，查看表中最后一条插入数据对应的时间。 步骤6、对比步骤5日志显示的VSS冻结成功时间和步骤4的时间。冻结成功之前会停止插入数据，所以步骤5的时间比步骤4早。若步骤5的时间比步骤4早，则表示引用一致性备份成功。

本文主要介绍分布式消息服务RabbitMQ的相关概念。 天翼云分布式消息服务RabbitMQ作为消息引擎，RabbitMQ是一个生产者和消费者模型，主要负责接收、存储和转发消息。以下概念基于RabbitMQ进行描述。 消息 消息一般分为两部分，消息体和标签，标签主要用来描述这条消息，消息体是消息的内容，是一个JSON体或者数据等。 生产者发送消息，消费者消费消息，生产者与消费者彼此并无直接关系。 生产者（Producer） 即向队列发送消息的一方。发布消息的最终目的在于将消息内容传递给其他系统/模块，使对方按照约定处理该消息。 消费者（Consumer） 接收消息的一方。消费者订阅RabbitMQ的队列，当消费者消费一条消息时，只是消费消息的消息体。在消息路由的过程中，会丢弃标签，存入到队列中的只有消息体。 队列（Queue） 队列是用于存储消息的，生产者将消息送到队列，消费者从队列中获取和消费消息。多个消费者可以同时订阅同一个队列，队列里的消息分配给不同的消费者。 代理（Broker） 消息中间件的服务节点。

事件名称 事件ID 事件级别 事件说明 处理建议 事件影响 创建备份失败 backupFailed 紧急 创建备份失败 尝试手动创建备份或者联系技术支持 可能造成数据丢失 使用备份恢复资源失败 restorationFailed 紧急 使用备份恢复资源失败 尝试使用其他备份恢复或者联系技术支持 可能造成数据丢失 备份删除失败 backupDeleteFailed 紧急 备份删除失败 稍后重试删除或者联系技术支持 可能造成计费异常 存储库删除失败 vaultDeleteFailed 紧急 储存库删除失败 稍后重试或联系技术支持 可能造成计费异常 复制失败 replicationFailed 紧急 备份复制失败 稍后重试或联系技术支持 可能造成数据丢失 创建备份成功 backupSucceeded 重要 创建备份成功 无 无 使用备份恢复资源成功 restorationSucceeded 重要 使用备份恢复资源成功 观察数据是否已成功恢复。 无 备份删除成功 backupDeletionSucceeded 重要 备份删除成功 无 无 存储库删除成功 vaultDeletionSucceeded 重要 储存库删除成功 无 无 复制成功 replicationSucceeded 重要 备份复制成功 无 无 客户端离线 agentOffline 紧急 客户端离线 请确保客户端状态正常且能够正常连接。 可能造成备份任务失败。 客户端上线 agentOnline 重要 客户端上线 无。 无。

本章节主要介绍翼MapReduce服务的产品定义、架构与优势。 产品定义 翼MapReduce（简称：“翼MR”），基于当前开源新版本大数据组件进行产品化封装，为客户提供快速部署、易维护的HDFS、YARN、Spark、Flink、Hive、Doris、Kafka、HBase等高性能的大数据组件以及运维管理平台，同时产品默认提供强安全验证能力，具备高安全、高扩展、快捷运维等特色，支持批量数据处理、流式数据处理、离线数据分析、在线查询等场景。 产品架构 翼MR架构包括了基础设施和大数据处理流程各个阶段的能力，详见下图： ● 基础设施 基于天翼云主机构建大数据集群，集群的高可靠与高安全能力得到底层的充分保证。 弹性云主机（CTECS）提供的弹性可扩展虚拟服务器，结合CTVPC、安全组、CTEVS数据多副本和灾备能力为客户打造一个高效、可靠、安全的业务集群环境。 物理机服务（CTDPS）是基于天翼云软硬结合技术研发的一款拥有极致性能的裸金属服务器，兼具云主机的灵活弹性、物理机的稳定，提供算力强劲的计算类服务，提供专属的云上物理服务器，为大数据、核心数据库、高性能计算等业务提供服务稳定、数据安全、性能卓越的算力服务。 云硬盘（CTEVS）提供不同规格和性能表现的高可靠存储能力。 虚拟私有云（CTVPC）为每个租户提供虚拟的内部网络，默认与其他网络隔离，同时通过配套的安全组访问控制确保网络层面的安全性。 ● 数据集成 数据集成层提供了客户的数据集成进翼MR集群的能力，包括：Kafka、SeaTunnel、Flume、Sqoop，支持各种数据源导入数据到翼MR大数据集群中。 ● 数据存储 翼MR提供多种存储形式，如HDFS、Hudi、Iceberg、Paimon、Lance等，支持结构化和非结构化数据在集群中的存储，并且支持多种高效的格式来满足不同计算引擎的要求。 ● 数据调度和计算处理 – 翼MR提供多种主流计算引擎：MapReduce（批处理）、 Spark（内存计算）、Flink（流计算）等，满足多种离线或实时大数据应用场景，将数据进行结构和逻辑的转换，转化成满足业务目标的数据模型。 – 基于预设的数据模型，使用易用SQL的数据分析，用户可以选择Hive（数据仓库），SparkSQL以及Trino交互式查询引擎。 ● 翼MR Manager 为确保大数据组件服务的高可用性，以Hadoop为基础的大数据生态的各种组件均需要以分布式的方式进行部署，涉及其中的部署、管理和运维复杂度要求较高。翼MR提供了统一的运维管理平台翼MR Manager，包括可视化引导式部署集群能力。同时翼MR Manager还提供了租户与资源管理能力，支持对翼MR中各类大数据组件的运维管理，提供监控、告警、配置等一站式运维能力。

接口功能介绍 对称密钥解密接口 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/decrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ciphertextBlob 是 String 待解密密文 DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjKy5nl 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 解密成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 plaintext String base64加密之后的明文数据 U0dWc2JHOGdkMjl5MWVhOQ requestId String 请求id dbd061a89d8b4a4894b58aac0b938992

接口功能介绍 更新密钥描述接口 接口约束 请保证账户余额大于0 URI POST /v1/keyManage/updateKeyDescription 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff description 否 String 描述 abcd 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 更新密钥描述成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id de4138537a8b42c3a1a80ce1898f3476 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "cmkUuid": "27e658cf3b904987adfdfe8700ee4f59", "description": "描述更改1" }

vpn用户服务修改。 接口功能介绍 vpn用户服务修改 接口约束 支持集群模式资源池。 URI POST /v4/vpn/ipsecuserservice/update 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 是 String IPSCE 服务名称 ipsec111 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 ipsecServiceID 是 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96

接口功能介绍 查询接入点的终端节点白名单 接口约束 无 URI POST /v1/userEndpointControl/showEndpointWhitelist 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d endpointId 是 String 终端节点id endpointwlp72qh2bd 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 enableWhitelist Boolean 是否开启白名单 true ips Array of Strings ip列表 ["1.1.1.1"] applicationId String 接入点id b2160c2c9c704ca9b8080d186c97280d 请求示例