参数 参数类型 说明 示例 下级对象 PageNum Integer 第几个分页。 1 PageSize Integer 分页大小。 10 TotalPage Integer 分页总数。 1 TotalNum Integer 模板总数。 10 CallbackTemplates Array of Objects 模板列表。 CallbackTemplate RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 68561b784a2944a7a713186f5cb20d34

构造请求 本节介绍REST API请求的组成，以调用云主机产品的"根据regionID查询用户资源"举例说明如何调用该API。 请求示例 POST ContentType:application/json ctyuneoprequestid:0ffb9b07d5a84e19b3ce12dfb9705a1d EopAuthorization:4a4bdc57e06542199b5f98d4cd107be2 Headersctyuneoprequestid;eopdate Signatureb2WEo4nh9ewn6SWOP0ii5g8L0z9CT5gprpDWntlCX9I Eopdate:20221107T093029Z 请求URI {URIscheme}://{Endpoint}/{resourcepath}?{querystring} 参数 描述 URIscheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。例如云主机产品服务在某个区域的Endpoint为“ctecsxxx.ctapi.ctyun.cn” resourcepath 资源路径，即API访问路径。从具体API的URI模块获取，例如"根据regionID查询用户资源"API的resourcepath为“/v4/region/customerResources” querystring 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名参数取值”，例如“?limit10”，表示查询不超过10条数据 示例： 云主机根据regionID查询用户资源，则需使用云主机产品在对应区域的Endpoint（ctecsxxx.ctapi.ctyun.cn），并在"根据regionID查询用户资源"的URI部分找到resourcepath（/v4/region/customerResources），拼接起来如下所示。 < 说明： 为方便查看，在每个具体API的URI部分，只给出resourcepath部分，并将请求方法写在一起。这是因为URIscheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。 {resourcepath}资源路径，使用编码的规范URI示例： 前： /v4/region/customerResources api/code 后： /v4/region/customerResources%20api/code 说明： 资源路径{resourcepath}是从HTTP Host结束到查询字符串参数（如果有）的问号字符（“?”）中间的部分。 需要根据RFC 3986标准化URI路径规范移除冗余和相对路径部分。路径中每个部分都必须进行URI编码。 {querystring}查询参数，使用规范查询字符串示例： 前： prodInstId11&startTime20210404T06:01:46Z 后： prodInstId11&startTime20210404T06%3A01%3A46Z 说明： {querystring}为键值对，使用等号字符()拼接。值需进行URI编码，同样需要满足RFC 3986关于URL编码规范的定义要求。键则不需要。对没有值的参数使用空字符串。 在每个参数值后追加与字符(&)，列表中最后一个值除外。 使用 %XY 对所有其他字符进行百分比编码，其中“X”和“Y”为十六进制字符（09和大写字母AF）。例如，空格字符必须编码为 %20（不像某些编码方案那样使用“+”)，扩展UTF8字符必须采用格式 %XY%ZA%BC。 RFC 3986规范的具体要求： 字符AZ、az、09 以及字符、、.、不编码。 对其它ASCII码字符进行编码。编码格式为%加上16进制的ASCII码。例如半角双引号（"）将被编码为%22。空格编码成%20，而不是加号（+）。 非ASCII码通过UTF8编码。

响应示例 {"statusCode": 200,"message": "请求成功","requestId": "f10722935d7e48feaf9d84d65c93ddd2","returnObj": {"RequestId": "f10722935d7e48feaf9d84d65c93ddd2"}} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996

接口功能介绍 本接口用于删除目录。 接口约束 删除目录前确保存在该目录。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI DELETE /v2/dirs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DirId 是 String 目录ID。 897098424844288 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 8ce18739d4e34d51ab260fc551228a5c 枚举参数 无 请求示例 请求url DELETE '/v2/dirs/700835918517108736' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "8ce18739d4e34d51ab260fc551228a5c","returnObj": {"RequestId": "8ce18739d4e34d51ab260fc551228a5c"}}

参数 是否必填 参数类型 说明 示例 下级对象 DirName 是 String 目录名称，长度不超过64个字符。 openapidir Description 否 String 目录描述，长度不超过255个字符。 description

枚举参数 无 请求示例 请求url GET '/v2/callbackTemplate/739943519892963328' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "aac5a1a85bf94d6a904139e1dc1d19ab","returnObj": {"TemplateId": "739943519892963328","TemplateName": "设备状态回调模板","Description": "","CallbackKey": "123","DeviceStatusNotifyUrl": " "","RecordNotifyUrl": "","AiEventNotifyUrl": "","CreateTime": "1691992586","UpdateTime": "1691992586","RequestId": "aac5a1a85bf94d6a904139e1dc1d19ab"}} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 ParentDirId 否 String 上级目录ID。 29941936081076293 DirName 是 String 目录名称，长度不能超过64个字符。 openapidir Description 否 String 目录描述.长度不能超过255个字符。 description

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996

枚举参数 无 请求示例 请求url GET '/v2/dirs?PageNum1&PageSize1' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "ba41650f6da84a20bc386c87285cebe6","returnObj": {"PageNum": "1","PageSize": "1","TotalPage": "94","TotalNum": "94","Dirs": [{"DirId": "693323900457467904","DirName": "openapidir","DirType": "common","Description": "","DirCode": "0087","ParentDirId": "1","CreatedTime": "1679641940225","UpdatedTime": "1680513927459","TotalSize": "0","OnlineSize": "0","OrderSequence": "1680514055943"}],"RequestId": "ba41650f6da84a20bc386c87285cebe6"}} 状态码 请参考 状态码 错误码 请参考 错误码

枚举参数 无 请求示例 请求url GET '/v2/dirs/693323900457467904' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "8041c7552510454f924211a3540ea3e6","returnObj": {"DirId": "693323900457467904","DirName": "openapidir","DirType": "common","Description": "","DirCode": "0087","ParentDirId": "1","CreatedTime": "1679641940225","UpdatedTime": "1680513927459","RequestId": "8041c7552510454f924211a3540ea3e6"}} 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 920844e56e6944e193da622fe222bcbc

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

接口功能介绍 本接口用于查询GB28181凭证信息。 接口约束 查询凭证前请确保存在该凭证。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/gb28181Certs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 UserName String 凭证用户名。 cert UserType String 凭证类型。 normal Description String 凭证描述。 描述 CreatedTime String 凭证创建时间。 1681370054426 UpdatedTime String 凭证更新时间。 1681370054426 RequestId String 请求ID。 b9d13f607bc14907815a8fd131ab0dbf

参数 是否必填 参数类型 说明 示例 下级对象 TemplateId 是 String 模板ID。 739943519892963328

参数 参数类型 说明 示例 下级对象 ChannelNum String 通道号。 1 ChannelName String 通道名称。 通道1 WorkOrderNo String 订单号。 202211031607018234 WorkOrderId String 订单ID。 workorder20723343 BillingMode String 计费模式。取值：packages(资源包)，onDemand(按需计费)，unBinding(停用)。 packages ResourceId String 资源ID。 resource20723343 RecordNum String 录制配置，取值：0：无录制；1：录制。 1 TemplateId String 录制模板ID。 717074786139029504 TotalDeviceCount String 设备总路数。 100 RemainDeviceCount String 设备剩余路数。 100 CodeRate String 码率。 8 StorageTime String ST天数 。 ST3 BandWidth String 总带宽。 100 IsTrialOrder String 是否试用。取值：0(代表商用)，1(代表试用)。 0 CreateTime String 创建时间。 20221125 16:03:04 ExpireTime String 失效时间。 20241201 10:55:04

本文介绍如何使用ECX部署OpenClaw钉钉机器人。 注意 配置钉钉机器人之前，请先确保已经购买ECX虚拟机并配置大模型服务。具体操作步骤，可参考指引：使用ECX部署OpenClaw。 创建钉钉机器人并获取配置 1、登录++钉钉开发者平台++。 2、创建应用。 3、创建机器人应用能力。 点击应用能力添加应用能力，选择机器人。 配置相关信息，消息接受模式选择Stream模式。 点击凭证与基础信息，获取并保存钉钉的Clinet ID 和 Client Secret 用于配置云主机信息。 注意 钉钉机器人有重名校验，若因名称不合法导致提交失败，可通过钉钉客服机器人进行名称校验及名称生成。 配置OpenClaw 钉钉助手 1、登录虚拟机，执行以下命令，将钉钉配置录入OpenClaw。 plaintext openclaw config set gateway.http.endpoints.chatCompletions.enabled true plaintext openclaw config set channels.dingtalkconnector '{ "gatewayToken": " ", "clientId": " ", "clientSecret": " ", "enabled": true }' 2、执行以下命令，重启gateway。 plaintext openclaw gateway restart 3、进入版本管理与发布，发布刚刚创建的应用及机器人配置。 4、点击开发配置权限管理，添加权限Card.Streaming.Write、Card.Instance.Write。

本文介绍如何使用ECX部署OpenClaw飞书机器人。 注意 配置飞书机器人之前，请先确保已经购买ECX虚拟机并配置大模型服务。具体操作步骤，可参考指引：使用ECX部署OpenClaw。 创建飞书机器人并获取配置 1、登录++飞书开放平台++，创建企业自建应用。 2、添加机器人能力。 在左侧目录树选择“应用能力 > 添加应用能力”。 选择“按能力添加”页签，单击“机器人”能力卡片的“添加”按钮。 3、配置权限。 在左侧目录树选择“开发配置 > 权限管理”，单击“批量导入/导出权限”按钮。 在“导入”页签中，将如下权限替换原有示例，单击“下一步，确认新增权限”按钮。 plaintext { "scopes": { "tenant": [ "im:chat:read", "im:chat:update", "im:message.groupatmsg:readonly", "im:message.p2pmsg:readonly", "im:message.pins:read", "im:message.pins:writeonly", "im:message.reactions:read", "im:message.reactions:writeonly", "im:message:readonly", "im:message:recall", "im:message:sendasbot", "im:message:sendmultiusers", "im:message:sendsysmsg", "im:message:update", "im:resource" ], "user": [ "contact:user.employeeid:readonly" ] } } 在弹窗中确认权限无误后，单击“申请开通”按钮，完成操作。 4、获取配置信息。 在左侧目录树选择“基础信息 > 凭证与基础信息”。 在“应用凭证”模块中，获取并记录App ID与App Secret信息。 5、发布应用。 单击顶部的“创建版本”按钮。 按需配置应用版本号、默认能力及更新说明等信息。 单击页面底部的“保存”按钮，创建版本。 点击确认发布。

配置OpenClaw QQ助手 1、登录虚拟机，执行以下命令，配置QQ机器人信息。 plaintext op enclaw config set channels '{ "qqbot": { "enabled": true, "appId": "你的AppID", "clientSecret": "你的AppSecret" } }' 2、重启gateway，使配置生效。 plaintext openclaw gateway restart 3、检查gateway状态，确认为running，表示配置已更新成功。 plaintext openclaw gateway status 使用QQ，与你的OpenClaw开始聊天 1、登录QQ开放平台，通过开发沙箱配置，找到在消息列表配置，找到二维码扫描并进行聊天。 2、开启与QpenClaw AI助手的对话。

驱动类型 适配芯片 操作系统 NVIDIA Data Center/Tesla A10 T4 Ubuntu 18.04 Ubuntu 20.04 Ubuntu 22.04 Ubuntu 24.04

本节介绍如何批量设置有序的虚拟机名称。 目前边缘虚拟机支持批量开通并在开通时指定虚拟机名称，具体操作如下： 1. 登录ECX控制台。 2. 单击左侧【边缘虚拟机>实例】导航栏。 3. 点击【+新建实例】。 4. 在【系统配置】项可设置虚拟机名称。 目前批量设置虚拟机自定义名称遵循以下规则： 允许重名。 支持自动增加数字后缀命名，名称自动按序增加4位数字后缀。例如：输入ecx，从ecx0001开始命名，若客户名下已有ecx0001的虚拟机，则从ecx0002开始命名。

本文为查看历史对话的方式介绍。 用户可以通过点击侧边栏的“历史对话”直接进入对应的对话详情页。也可以点击“历史对话”中的“查看全部”，进入最近对话页面。 在最近对话页面，用户可以查看所有历史对话。点击具体对话后，用户将跳转至对应的对话详情页。

菜单 权限说明 权限申请方式 基础管理公共文档库管理 租户管理员可见、可操作； 配置了该页面权限的角色用户可见、可操作。 由租户管理员配置对应角色授权；具体授权方式详见 基础管理基座模型配置 租户管理员可见、可操作； 配置了该页面权限的角色用户可见、可操作。 由租户管理员配置对应角色授权；具体授权方式详见 基础管理联网搜索配置 租户管理员可见、可操作； 配置了该页面权限的角色用户可见、可操作。 由租户管理员配置对应角色授权；具体授权方式详见 权限管理用户管理 仅租户管理员可见、可操作。 由租户管理员进行租户管理员角色授权；具体授权方式详见 权限管理角色管理 仅租户管理员可见、可操作。 由租户管理员进行租户管理员角色授权；具体授权方式详见 日志管理对话记录管理 租户管理员可见、可操作； 配置了该页面权限的角色用户可见、可操作。 由租户管理员配置对应角色授权；具体授权方式详见 日志管理管理员操作日志 租户管理员可见、可操作； 配置了该页面权限的角色用户可见、可操作。 由租户管理员配置对应角色授权；具体授权方式详见

本文为产品反馈的方式介绍。 用户可以通过两种方式进行产品反馈，平台将在 3 个工作日内给予回复。 方案一：一键投诉 1. 点击左下角的一键投诉按钮。 2. 输入问题描述，点击确定，即可提交产品反馈。 方案二：邮件反馈 用户可以通过发送邮件至 huizeproduct@chinatelecom.cn 进行反馈。

本文为公共文档库的配置方式介绍。 概览 用户可以在公共文档库管理页面进行文档库的创建和管理操作。 准备工作 1. 在产品页左侧导航栏中，选择【系统管理 基础管理 公共文档库管理】。 创建文档库 1. 点击左上角的【+】按钮。 2. 在弹窗中填写文档库名称，点击确认，即可新建文档库。 上传文档 1. 在新建的文档库内，点击左上角的【上传】按钮。 2. 在弹窗中选择或添加新的分类。 3. 通过拖拽或点击上传的方式添加文件。 4. 当文件状态显示为“上传完成”时，该文件将出现在产品页面的公共文档库中。 文档查询与编辑 文档库创建完成后，您可以对文档库内的文档进行查询、删除和编辑操作。 查询文档 文档库创建完成后，您可以对文档库内的文档进行查询、删除和编辑操作。 删除文档 单个删除：点击操作栏内的【删除】按钮，即可删除指定文档。 批量删除： 勾选想要删除的文档。 点击【操作已选项删除】，即可批量删除指定文档。

本节介绍负载均衡实例规格的升配操作。 使用说明 只允许在开通时有指定规格的负载均衡实例修改实例规格。 暂只支持对负载均衡实例规格升配，不支持规格降配。 说明 2024年1月16日后开通的负载均衡实例才有指定实例规格。 负载均衡实例实例升配 1. 登录ECX控制台。 2. 单击左侧导航栏的【边缘网络>弹性负载均衡>负载均衡器】，切换至要操作的地域，选择要升配的负载均衡实例，单击操作下的【规格变更】，进入规格变更页面。 3. 选择实例规格，只允许选择比原实例规格更大的规格，如原实例规格已为当前支持的最大规格，则不允许变更。 4. 单击【立即创建】，进入订单支付页面，支付成功后，后台对规格进行升配，升配成功后在负载均衡实例详情页可以查看规格已完成变更。

参数 说明 策略组名称 设置策略组名称 策略组类型 支持白名单和黑名单两种类型。 白名单：仅允许策略组内的IP地址/网段访问负载均衡监听器。 黑名单：不允许策略组内的IP地址/网段访问负载均衡监听器。 IP地址/网段 支持填写IP地址或网段，目前暂仅支持IPv4地址/网段。 一个IP地址或网段一行，以回车键换行。 描述 可选，备注长度范围是0到255字符。

参数 说明 名称 修改监听器的名称；同时也可以单击【添加描述】按需为该监听器添加相关的描述信息。 前端协议端口 该信息为不可修改项。 服务器证书 监听器的前端协议选择HTTPS时，可为监听器选择其他已有的SSL服务器证书。 后端服务器组 可为监听器选择其他的后端服务器组。