参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 {} message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数scriptname为必填，且不能为空

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 {} message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数scriptname为必填，且不能为空

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 returnObj message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数name为必填，且不能为空

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 {} message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数scriptname为必填，且不能为空

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 {} message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数scriptname为必填，且不能为空

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 {} message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数scriptname为必填，且不能为空

接口功能介绍 创建应用接入点 接口约束 无 URI POST /v1/applicationAccessPointManage/createApplicationAccessPoint 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 是 String vpc id vpchu189akjd subnetId 是 String 子网id subnetqc90zmk12u epId 是 String 企业项目id 1 applicationName 是 String 应用接入点名称 aaa email 是 String 账户邮箱 123456@chinatelecom.cn description 否 String 应用接入点描述 test instanceId 否 String 实例id，非必传，当为空时应用接入点创建在最早开通且启用中的实例中 insX63C8r 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 vpcId String vpc id vpchu189akjd subnetId String 子网id subnetqc90zmk12u applicationStatus String 应用接入点状态 2 url String 访问地址 endpointId String 终端节点id 1d6d65ac761d4276ad0f1b94ef2ea29d

6、请求代码示例 plaintext 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 '{"Action": "TTS", "TextData": "今晚去吃火锅吗", "VoiceType":2}' 7、返回值说明 请求成功返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Int 返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表 0 message 是 String 如果statusCode 为 0，返回 success；如果 statusCode非 0，则返回对应的可读错误信息 success returnObj 是 Object 返回结果对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 Audio 是 String 语音编码数据。Base64 编码的 wav 格式音频数据 "9j4AAQSkZJRgA......Zuv9k" 请求失败返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Int 错误码，放置API对应的错误码 500001 message 是 String 返回对应的错误信息 服务接口异常，请联系管理员 details 是 String 返回对应的错误描述 需要联系管理员处理 error 是 String 返回对应的错误码 AIOP500001

本章节介绍故障演练服务中环境管理功能。 概述 在故障演练服务 中，环境 是用于隔离不同应用 和资源 的逻辑单元，例如您可以创建生产环境 和测试环境，对不同环境下的资源进行分组管理和演练。 创建环境 1. 登录应用高可用服务控制台。 2. 在左侧导航栏中，选择 故障演练 > 环境概览 ，进入环境概览页面。 3. 单击页面中的创建环境 按钮，打开新增环境对话框。 4. 填写环境名称 和描述 等内容，然后单击确定按钮完成创建。 5. 返回环境列表，可以看到新创建的环境对象。 修改环境 1. 进入环境概览页面。 2. 在环境列表 中找到需要修改的环境对象，单击其对应的编辑图标。 3. 在弹出的修改环境 对话框中，更新环境名称 或描述 信息，然后单击确定按钮。 4. 返回环境列表，可以看到环境信息已更新。 删除环境 1. 进入环境概览页面。 2. 在环境列表 中找到需要删除的环境对象，单击其对应的删除图标。 3. 在弹出的确认对话框中，单击确定按钮，完成删除操作。 4. 返回环境列表，确认该环境对象已被成功移除。 注意 需要先移除当前环境关联的所有应用，才能执行环境删除操作。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 issues Array of Objects 告警事件列表 issue totalCount Integer 记录总数 1 page Integer 页码 1 pageSize Integer 页大小 20 表issue 参数 参数类型 说明 示例 下级对象 triggerID String 监控平台规则ID 634fac0339fa5e04c4a33648 status Integer 本参数表示状态。取值范围：0：正常。1：告警。根据以上范围取值。 1 lastChange String 更新时间 20221019T07:53:36Z name String 规则名称 告警规则lyc123 service String 服务 ecs dimension String 维度 ecs level Integer 本参数表示报警级别。取值范围：1：灾难告警。2：严重告警。3：一般告警。4：警告告警。根据以上范围取值。 1 deviceUUID String 设备唯一ID 000f03221f4d8cc8bb2e1c30fb751aa5 instanceName String 实例名 000f03221f4d8cc8bb2e1c30fb751aa5 instanceID String 实例ID 000f03221f4d8cc8bb2e1c30fb751aa5 clock String 触发时间 20221019T07:51:32Z notifyType Array of String 告警接收策略 ["email"]

接口功能介绍 取消一个备份任务 接口约束 1、只能取消进行中的备份任务，其他状态的任务无法取消 URI POST /v4/backup/canceltaskbackup 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 41f64827f25f468595ffa3a5deb5d15d backupTaskID 是 String 备份任务ID 41f64827000559879c86bea5deb5d15d isCloud 否 Boolean 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。推荐使用sourceType参数，该参数后续即将下线 true sourceType 否 String 产品服务类型(默认CTECS)，CTECS：弹性云主机，CTDPS：裸金属物理机，CTLS：本地客户主机 CTECS 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功，900为失败) 800 message String 成功或失败时的描述，一般为英文描述 SUCCESS description String 成功或失败时的描述，一般为中文描述 成功 returnObj Object 成功时返回对象 returnObj errorCode String 业务细分码，为product.module.code三段式码。 backup.regionInfo.empty error String 业务细分码，为product.module.code三段式大驼峰码 Backup.RegionInfo.Empty 表 returnObj 参数 参数类型 说明 示例 下级对象 backupTaskID String 任务ID 参考响应示例

接口功能介绍 生成数据密钥，不反悔明文数据密钥 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/generateDataKeyWithoutPlaintext 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥id，如果为空的话，会使用用户的默认主密钥，为不可控状态 474e569e8814474a948bdbcf6d853eff keySpec 否 String 生成数据密钥类型 AES256 numberOfBytes 否 String 生成的数据密钥长度 256 projectId 否 String 项目id 95e17b31e41e4d509687398baf91c260 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 生成数据密钥成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 数据密钥密文 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba plaintext String 数据密钥明文 csedLEchgF5ijFx9nEc5Y0DpzWb dataKeyID String 数据密钥id 012ea0d1862a488b956e107ffae5059f

接口功能介绍 生成数据密钥，不反悔明文数据密钥 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/generateDataKeyWithoutPlaintext 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥id，如果为空的话，会使用用户的默认主密钥，为不可控状态 474e569e8814474a948bdbcf6d853eff keySpec 否 String 生成数据密钥类型 AES256 numberOfBytes 否 String 生成的数据密钥长度 256 projectId 否 String 项目id 95e17b31e41e4d509687398baf91c260 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 生成数据密钥成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 数据密钥密文 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba plaintext String 数据密钥明文 csedLEchgF5ijFx9nEc5Y0DpzWb dataKeyID String 数据密钥id 012ea0d1862a488b956e107ffae5059f

服务内容 服务描述 交付物 现状调研 业务现状、业务架构、客户目标调研 健康检查 检查业务网络架构、弹性计算架构、存储架构、数据库架构、中间件架构、安全架构的健康情况 优化建议 依据健康检查结果，给出优化建议 优化方案 技术支持 在交付期内，为优化方案落地提供技术支持

应用场景 合规性要求 ：在特定行业规范或监管要求中，企业或机构的关键数据需要满足在相隔一定距离的地方存储备份，如金融、医疗等行业，以满足合规性要求。 数据备份 ：作为数据备份策略的一部分，将数据复制到另一个区域以提供额外的保护。 降低访问延迟 ：对于需要在多地访问相同云存储资源的用户，跨域复制功能可以在离访问点较近的区域中创建副本，从而缩短访问时延，提升用户体验。 容灾恢复 ：在发生自然灾害、人为错误或技术故障时，通过在不同区域的备份数据快速恢复服务。提高系统的容错能力，确保在单个区域发生故障时，保障业务连续性。

状态 描述信息 创建中 创建开发机的配置信息 已创建 开发机任务已提交 运行中 开发机已创建完成并正常运行，需等到“访问”按钮可点击后能远程访问 停止 开发机已停止，停止实例后未保存到持久化存储中的数据将丢失

调用API 企业或开发者如何获取并调用他人在API网关开放的API，减少开发时间与成本。 图 调用API基本流程 1. 获取API 获取API的请求信息，包括访问域名、请求协议、请求方法、请求路径以及认证方式等信息。 2. 创建凭据 使用APP认证的API，需要在API网关中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，使用APP认证调用API。 3. 获取SDK 可通过SDK对AK/SK生成签名，并调用API。 4. 调用API 通过获取API及API访问地址，调用API。根据API使用认证方式的不同，调用API时需要进行不同的认证鉴权操作。

本章节主要介绍如何删除增强型跨源连接。 操作场景 本节操作介绍在控制台删除不再使用的增强型跨源连接的操作步骤。 操作步骤 1. 登录DLI管理控制台。 2. 在左侧导航栏中，选择“跨源管理 > 增强型跨源 ”。 3. 选择待删除的增强型跨源连接，单击操作列的“删除”。 4. 单击“是”，删除增强型跨源连接。

通过弹性云主机控制台查看GPU监控项 1. 登录控制中心。 2. 单击控制中心顶部的，选择“地域”。 3. 选择“计算 > 弹性云主机”。 4. 在弹性云主机列表页点击某一GPU云主机的主机名称进入主机详情页。 5. 点击“监控”tab，选择“GPU使用率”或"显存使用率"即可查看该台GPU云主机下全部显卡的这两个GPU监控项。 通过云监控控制台查看GPU监控项 目前有两种方式可以进入云监控控制台查看GPU监控项，具体如下： 方式一 1. 登录控制中心。 2. 单击控制中心顶部的，选择“地域”。 3. 单击左侧导航栏“产品服务列表”，选择“计算 > 弹性云主机”。 4. 在弹性云主机列表页点击某一GPU云主机的主机名称进入主机详情页。 5. 点击“监控”tab，点击"查看更多监控指标详情"跳转至云主机监控控制台。 6. 点击“操作系统监控>GPU”,查看全量的GPU监控项。若该台GPU云主机挂载了多块显卡，则可在下拉框中选择对应的GPU查看该GPU的GPU使用率、GPU显存使用量、GPU显存使用率、GPU温度、GPU功耗。 方式二 1. 登录控制中心。 2. 单击控制中心顶部的，选择“地域”。 3. 选择“管理与部署> 云监控服务”。 4. 单击"主机监控>云主机监控"，进入云主机监控列表页。 5. 选中所要查看的GPU云主机，点击“操作>查看监控图标”，进入云主机监控详情页。 6. 若该台GPU云主机挂载了多块显卡，则可在下拉框中选择对应的GPU查看该GPU的GPU使用率、GPU显存使用量、GPU显存使用率、GPU温度、GPU功耗。 注意 1. 如未安装驱动则GPU监控项将为空，请您安装驱动。 2. 目前图形加速基础型GPU云主机的GPU温度、GPU功率为空，无法提供监控告警。

本文为您介绍多活容灾服务的应用场景。 同城主备 同城主备容灾是一种在同城或相近区域内（通常距离小于或等于100KM）建立的容灾策略。包括一个主数据中心，负责日常生产运行和实时数据存储，以及一个备用的数据中心，作为灾难备份中心。当主数据中心因各种原因（如火灾、建筑物破坏、供电故障、计算机系统及人为破坏等）发生故障时，备份数据中心能够快速接管业务，继续提供服务。 同城多活 同城多活容灾是在同城或相近区域内建立多个活跃的数据中心，这些数据中心在日常运行中均处于活跃状态，能够独立对外提供服务和处理业务操作。每个数据中心都存储有数据的副本，并实时更新，以确保在任何一个数据中心发生故障时，其他数据中心可以迅速接管其流量和业务，保证整体服务不受影响。 异地主备 异地主备容灾是在不同地理区域建立主备两个数据中心，主数据中心负责日常的生产运行和数据处理，而备份数据中心在主数据中心发生故障时接管服务。

DRDS支持通过隐式序列功能（创建表时添加AUTOINCREMENT关键字，启用隐式序列功能）为列设置自增属性，能够自动为列填充全局唯一值。 背景信息 什么是隐式序列 在传统的单库环境中，AUTOINCREMENT是用于生成主键自增值的常用机制，能够保证主键在单实例数据库中的唯一性。然而，在分布式数据库DRDS中，数据被分片存储在多个存储节点中，原有的自增机制将无法保证全局唯一性，因此DRDS引入了基于全局序列的隐式序列机制，用于替代传统的AUTOINCREMENT功能。 隐式序列与AUTOINCREMENT的关系 在DRDS中，虽然通过添加AUTOINCREMENT关键字实现自增，但实际不是调用数据库原生的自增逻辑，而是通过隐式的全局序列实现唯一值生成。 注意 隐式序列由系统自动维护，无需用户手动干预。 隐式序列的生命周期 隐式序列由系统在建表时自动创建，并在DROP表时自动删除。 注意 不推荐用户手动创建或删除隐式序列，可能会造成ID冲突或数据一致性问题。 HINT路由下的行为差异 当使用HINT路由 + INSERT语句时，DBProxy无法改写SQL，因此不会自动填充自增ID： 注意 不推荐在需要使用AUTOINCREMENT功能的表中使用HINT路由。 以/+TDDL:node('group1')/ INSERT INTO test(value) VALUES(1); 为例，该命令将直接透传到物理库。若该表中的自增列未显式给值，数据库可能会使用默认值（例如0），若该值不唯一，则会报错（例如Duplicate entry）。

全局索引是一组非分片键和分片键的映射关系，通过非分片键查询到分片键，直接计算出数据所在的分片节点，从而提升非分片键查询（select语句）时的效率，避免广播查询。本文对分布式关系数据库DRDS全局索引功能进行说明。 核心特性 全局索引的核心特性说明如下： 增量索引追加 解析binlog数据，提取非分片键和分片键的映射关系。 支持全量索引重建 通过JDBC从数据库中获取全量数据。 以单索引单分片为最小任务单元分配重建任务。 索引存储 索引数据以keyvalue方式存储在分布式缓存中。 索引配置 索引项相关的配置与DRDS实例共用，配置修改实时同步。 库表信息变更自动同步更新。 索引延时 正常情况下，索引与数据库延时在秒级以内。 注意事项 DRDS实例版本不同全局索引的管理入口可能存在差异，具体版本说明如下，请以控制台实际情况为准： V5.1.20.0.13及以后版本：Giserver与DBProxy合并部署，不再区分DBProxy和Giserver两种实例，即购买DRDS实例时，将自动为该实例部署Giserver与DBProxy，且两者之间底层服务与进程互相隔离、故障互相隔离，更具安全性和性价比。 说明 您可以在控制台的左侧导航栏选择DRDS > 实例管理 ，进入实例列表页面，再单击目标DRDS实例操作 列的管理 ，进入实例基本信息 页面，然后单击目录树的全局索引，管理您的GiServer。 V5.1.20.0.13以前的版本：存在DBProxy和Giserver两种实例，存量GiServer实例不影响使用。 说明 您可以在控制台的左侧导航栏选择DRDS > 全局索引，进入全局索引管理页面，管理您的GiSever实例。

查询伸缩组内的云主机的可用区分布 接口功能介绍 查询伸缩组内的云主机的可用区分布 接口约束 无 URI POST /v4/scaling/group/instanceaz 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 471 响应参数 参数 参数类型 说明 示例 下级对象 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 表 returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 云主机可用区信息 instanceInfo 表 instanceInfo 参数 参数类型 说明 示例 下级对象 instanceID String 云主机ID 46e927efc85df729a3bb20a84224701e instanceName String 云主机名称 ecme1841 azName String 可用区名称，非多可用区资源池的azName返回空字符串 az1

智能巡检 巡检项：禁用 接口功能介绍 调用此接口可禁用巡检项。 接口约束 巡检项不为空。 URI POST /v4/monitor/intelligentinspection/disableinspectionitem 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 inspectionItem 是 Integer 本参数表示巡检项。取值范围：1：云主机性能评估。2：监控数据健康评估。3：云主机闲置资源检查。4：云主机磁盘使用预警评估根据以上范围取值。 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 禁用成功标识 true 请求示例 请求url /v4/monitor/intelligentinspection/disableinspectionitem 请求头header 无 请求体body json { "inspectionItem": 1 }

接口功能介绍 为指定云主机安装备份客户端 接口约束 1、在一个地域下，每个用户最多保留20个备份客户端(可依据配额动态调整) 2、云主机处于运行中状态 3、备份服务已开通 4、云主机未安装过备份客户端 URI POST /v4/backup/installclientbackup 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b instanceID 是 String 云主机ID 82e2defb3bc8aa3f99c7ccb0aba0fcb0 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功，900为失败) 800 message String 成功或失败时的描述，一般为英文描述 SUCCESS description String 成功或失败时的描述，一般为中文描述 成功 returnObj Object 成功时返回对象 returnObj errorCode String 业务细分码，为product.module.code三段式码。 backup.regionInfo.empty error String 业务细分码，为product.module.code三段式大驼峰码 Backup.RegionInfo.Empty 表 returnObj 参数 参数类型 说明 示例 下级对象 installStatus Boolean 备份客户端安装命令下发状态 true

接口功能介绍 非对称密钥加密接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricEncrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 解密算法，取值范围为：RSAESOAEPSHA256、RSAESOAEPSHA1、RSAESPKCS1V15、SM2 RSAPSSSHA256 plaintext 是 String 待加密明文 ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 加密成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 密文数据 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba requestId String 请求id 6ab05860ad5a11f0b287ca6f5b1ddba5

接口功能介绍 生成数据密钥 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/generateDataKey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥id，如果为空的话，会使用用户的默认主密钥，为不可控状态 474e569e8814474a948bdbcf6d853eff keySpec 否 String 生成数据密钥类型 AES256 numberOfBytes 否 String 生成的数据密钥长度 256 projectId 是 String 项目id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 生成数据密钥成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 plaintext String 数据密钥明文 csedLEchgF5ijFx9nEc5Y0DpzWb requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 数据密钥密文 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba dataKeyId String 数据密钥id 012ea0d1862a488b956e107ffae5059f

接口功能介绍 导出证书私钥 接口约束 无 URI POST /v1/manageCertificate/exportCertificatePrivatkey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff passPhrase 是 String 导出证书密码 12345 exportFormat 是 String 证书算法类型:PKCS12 PKCS12 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 导出证书成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 pkcs12Blob String 证书导出格式私钥 f2ffbff9940a41a4ba9afe1fd8f22792 privateKey String 证书私钥 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba certificate String 证书 BEGIN CERTIFICATE (X.509 Certificate PEM Content) END CERTIFICATE certificateChain String 证书链 BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Root CA Certificate PEM Content) END CERTIFICATE

接口功能介绍 生成数据密钥 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/generateDataKey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥id，如果为空的话，会使用用户的默认主密钥，为不可控状态 474e569e8814474a948bdbcf6d853eff keySpec 否 String 生成数据密钥类型 AES256 numberOfBytes 否 String 生成的数据密钥长度 256 projectId 是 String 项目id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 生成数据密钥成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 plaintext String 数据密钥明文 csedLEchgF5ijFx9nEc5Y0DpzWb requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 数据密钥密文 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba dataKeyId String 数据密钥id 012ea0d1862a488b956e107ffae5059f

接口功能介绍 本接口用于调节镜头聚焦或光圈。 接口约束 1. 需要支持云台的gb28181设备或ehome设备，保持设备在线。 2. 请求参数Focus和Iris至少填写一个，且不能同时填写。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/devices//ptz/startAdjust 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 Focus 否 Integer 聚焦速度参数，正值表示焦距变远。取值: 255~255。 255 Iris 否 Integer 光圈速度参数，正值表示光圈放大。取值: 255~255。 255 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 DeviceId String 设备ID。 752657499261403136 RequestId String 请求ID。 20be6a0c4b0f42a288fb563c561d0a4c

接口功能介绍 调用此接口可查询告警联系人组的配置详情。 接口约束 无。 URI GET /v4/monitor/describecontactgroup 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 contactGroupID String 是 a6fb570f22995bde989cdf0819c687d0 告警联系人组ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID cf21ea17e31d5f47bf106c489a86f67d name String 组名 group3 desc String 组备注 test contactList Array of Objects 告警联系人列表 contact lastUpdate String 最近更新时间 20220929T09:51:33Z 表contact 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 name String 用户名 gxlupdate phone String 手机号 18919128910 email String 邮箱 864307365@qq.com lastUpdate String 最近更新时间 20220929T09:51:33Z

接口功能介绍 调用此接口可对通知套餐包设置自定义限流，只适用于收费通知套餐包。 接口约束 参见请求参数说明。 URI POST /v4/monitor/order/noticepacksetlimit 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 method 是 String 本参数表示通知套餐包类型。取值范围： sms：短信通知套餐包。 voice：语音通知套餐包。 根据以上范围取值。 voice monthLimit 是 Integer 本参数表示月限流数量。取值范围：05000，0代表不限流。 1000 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Array of Objects 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true