接口功能介绍 取消一个备份任务 接口约束 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

密钥是由用户自己远程创建，且创建过程需要仅用户持有的Ukey参与认证。 加密机的配置和内部密钥的准备，都必须要使用这一组Ukey作为鉴权凭证才能操作。 用户作为设备使用者完全控制密钥的产生、存储和访问授权，Dedicated HSM只负责监控和管理设备及其相关网络设施。

例行维护周期 任务场景 例行维护内容 每天 检查集群服务状态 l 检查每个服务的运行状态和配置状态是否正常，是否为绿色。 l 检查每个服务中，角色实例的运行状态和配置状态是否正常，是否为绿色。 l 检查每个服务中，角色实例的主备状态是否可以正常显示。 l 检查服务与角色实例的“概览”显示结果是否正常。 每天 检查集群主机状态 l 检查每个主机当前的运行状态是否正常，是否为绿色。 l 检查每个主机当前的磁盘使用率、内存使用率和CPU使用率。关注当前内存与CPU使用率是否处于上升趋势。 每天 检查集群告警信息 检查前一天是否生成了未处理异常告警，包含已自动恢复的告警。 每天 检查集群审计信息 检查前一天是否有“高危”和“危险”的操作，是否已确认操作的合法性。 每天 检查集群备份情况 检查前一天OMS、LDAP、DBService和NameNodeOMS、LDAP和DBServiceOMS、LDAP是否自动备份。 每天 检查健康检查结果 在FusionInsight Manager执行健康检查，下载健康检查报告确认当前集群是否存在异常状态。建议启用自动健康检查，并及时导出最新的集群健康检查结果，根据检查结果修复不健康项目。 每天 检查网络通讯 检查集群网络工作状态，节点之间的网络通讯是否存在延时。 每天 检查存储状态 检查集群总体数据存储量是否出现了突然的增长： l 磁盘使用量是否已接近阈值，排查原因，例如是否有业务留下的垃圾数据或冷数据需要清理。 l 业务是否有增长需求，磁盘分区是否需要扩容。 每天 检查日志情况 l 检查是否有失败、失去响应的MapReduce、Spark任务，查看HDFS中“/tmp/logs/${username}/logs/${application id}”日志文件并排除问题。 l 检查Yarn的任务日志，查看失败、失去响应的任务日志，并删除重复数据。 l 检查Storm的worker日志。 l 备份日志到存储服务器。 每周 用户管理 检查用户密码是否将要过期并通知修改。“机机用户”用户修改密码需要重新下载keytab文件。 每周 分析告警 导出指定周期内产生的告警并分析。 每周 扫描磁盘 对磁盘健康状态进行检查，建议使用专门的磁盘检查工具。 每周 统计存储 分批次排查集群节点磁盘数据是否均匀存储，筛选出明显数据增加或不足的硬盘，并确认硬盘是否正常。 每周 记录变更 安排并记录对集群配置参数和文件实施的操作，为故障分析处理场景提供依据。 每月 分析日志 l 收集集群节点服务器的硬件日志，例如BMC系统日志，并进行分析。 l 收集集群节点服务器的操作系统日志，并进行分析。 l 收集集群日志，并进行分析。 每月 诊断网络 对集群的网络健康状态进行分析。 每月 管理硬件 检查设备运行的机房环境，安排清洁设备。

本节介绍了专属云（存储独享型）的到期规则。 天翼云将会在您的专属云到期前 7 天、3 天、1 天向您发送提醒短信和邮件，如果您希望继续使用专属云资源，及时与您的专属客户经理沟通续订。如您未及时续订，您在专属云开通的云主机将自动关机。到期后您的资源将保留15天，15天内您可进行续费，15天后专属云资源将完全销毁，无法恢复。

本文为您介绍如何使用ECI实例扩容云硬盘数据卷。 背景信息 天翼云硬盘是一种可弹性扩展的块存储设备，可以为ECI提供高性能、高可靠的块存储服务。天翼云硬盘规格丰富，满足不同场景的业务需求，适用于文件系统、数据库、开发测试等场景。 前期准备 1. 已开通天翼云弹性容器实例服务。 2. 仅状态为运行中（Running）的 ECI 实例支持数据卷扩容。 3. 仅支持云硬盘类型的数据卷扩容。 4. ext 文件系统的云硬盘数据卷多次扩容时需要重启容器 (不建议多次扩容)。 操作步骤 天翼云弹性容器实例ECI支持用户通过OpenAPI对ECI实例的云硬盘数据卷进行扩容。

本文为您介绍如何使用ECI实例扩容云硬盘数据卷。 背景信息 天翼云硬盘是一种可弹性扩展的块存储设备，可以为ECI提供高性能、高可靠的块存储服务。天翼云硬盘规格丰富，满足不同场景的业务需求，适用于文件系统、数据库、开发测试等场景。 前期准备 1. 已开通天翼云弹性容器实例服务。 2. 仅状态为运行中（Running）的 ECI 实例支持数据卷扩容。 3. 仅支持云硬盘类型的数据卷扩容。 4. ext 文件系统的云硬盘数据卷多次扩容时需要重启容器 (不建议多次扩容)。 操作步骤 天翼云弹性容器实例ECI支持用户通过OpenAPI对ECI实例的云硬盘数据卷进行扩容。

本文为您介绍如何使用ECI实例扩容云硬盘数据卷。 背景信息 天翼云硬盘是一种可弹性扩展的块存储设备，可以为ECI提供高性能、高可靠的块存储服务。天翼云硬盘规格丰富，满足不同场景的业务需求，适用于文件系统、数据库、开发测试等场景。 前期准备 1. 已开通天翼云弹性容器实例服务。 2. 仅状态为运行中（Running）的 ECI 实例支持数据卷扩容。 3. 仅支持云硬盘类型的数据卷扩容。 4. ext 文件系统的云硬盘数据卷多次扩容时需要重启容器 (不建议多次扩容) 操作步骤 天翼云弹性容器实例ECI支持用户通过OpenAPI对ECI实例的云硬盘数据卷进行扩容。

查询伸缩组内的云主机的可用区分布 接口功能介绍 查询伸缩组内的云主机的可用区分布 接口约束 无 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 /v1/emr/doctor/openapi/meta/hive/overview 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 clusterId 是 String 集群id da595eb1d81503b323fdc01d9bf786b7 timestamp 是 Long 要查询的时间点，以 Unix 时间戳表示（单位：秒） 1700000000 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 200 / message String 用来简述当前接口调用状态以及必要提示信息 success / error String 错误码，请求成功时，不返回该字段 EMR400001 / returnObj Object 返回结果 returnObj 表 returnObj（请求成功） 参数 参数类型 说明 示例 下级对象 databaseCnt Long 数据库总数 5 tableCnt Long 表总数 237 storageCnt Long 总存储量（单位：字节） 10240000 fileCnt Long 文件总数 12223 表 returnObj（请求失败） 参数 参数类型 说明 示例 下级对象 timestamp String timestamp参数错误时返回该字段 时间戳不能为null clusterId String clusterId参数错误时返回该字段 不能为空

接口功能介绍 调用此接口可查询告警联系人组的配置详情。 接口约束 无。 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

接口功能介绍 删除监控视图中的指定监控项。 一个监控视图包含一个或多个监控项，监控项内容为keyvalue格式。 不能删除该视图下的所有监控项，必须保证有实际的监控项内容，否则请使用监控视图删除。 接口约束 regionID（资源池）、templateID（监控面板）、viewID（监控视图）、itemKeys（监控项Key）存在。 URI POST /v4/monitor/deletemonitoritem 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID viewID String 是 4cb790ae489411edb386005056897257 监控视图ID itemKeys Array of String 是 ["tcKey1"] 要删除的监控项内容Key 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 deleteCount Integer 删除成功的监控项数目 1

一次性拨测 拨测任务：创建 接口功能介绍 调用此接口可创建拨测任务。 接口约束 拨测地址，拨测任务类型，拨测点列表不为空，且拨测节点应可用。 URI POST /v4/monitor/createinstantdetectiontask 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 address 是 String 目标拨测地 www.ctyun.cn pointID 是 Array of Strings 拨测点列表 ['910c3625d5f0ebe505d44d4f257d6ae9'] type 是 String 本参数表示拨测任务类型。取值范围：http：http探测。ping：ping探测。mtr：mtr探测。traceroute：traceroute探测。根据以上范围取值。 http 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 taskID String 拨测任务ID acd8b6b4610b97d202306301808

通知模板 通知模板：删除 接口功能介绍 调用此接口可批量删除通知模板。 接口约束 通知模板存在。 URI POST /v4/monitor/deletenoticetemplates 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 noticeTemplateIDList 是 Array of Strings 通知模板ID列表 ['312b56b43e4311ed8ef2005056898fe0','318cc4a83e4311ed8ef2005056898fe0'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true 请求示例 请求url /v4/monitor/deletenoticetemplates 请求头header 无 请求体body json { "noticeTemplateIDList":[ "315c7f8c3e4311ed8ef2005056898fe0", "318cc4a83e4311ed8ef2005056898fe0" ] }

模块 参数 参数说明 取值样例 数据预览 监控项配置 类型 选择单实例/单指标，对应单实例多指标/单指标多实例 单指标 监控项配置 服务 所关注指标对应的服务名称。 云主机 监控项配置 维度 所关注指标的维度名称。 云主机 监控项配置 监控对象 所关注指标对应的监控对象。类型为单指标：可支持一次勾选多个监控对象；类型为单实例：仅支持勾选单个监控对象。 监控项配置 指标 所关注指标的名称。类型为单指标：仅支持勾选单个指标名称；类型为单实例：可支持一次勾选多个指标名称。 CPU使用率 监控项配置 对比 复选环比昨日、同比上周。非必选 基础信息 名称 自定义监控视图名称，2~40个字符 基础信息 图表类型 选择图表类型，包括：折线图/仪表盘/柱状图/表格/饼状图 仪表盘 基础信息 阈值 图表类型选择“仪表盘”时，需定义阈值。当值≥最小值时，图表为绿色；当值 ≤ 最大值时，图表为红色；单值介于最小值及最大值时，图表为橙色

监控看板 监控看板：复制视图 接口功能介绍 复制已有监控视图。 接口约束 参见请求参数说明。 URI POST /v4/monitor/monitorboard/copyview 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b viewID 是 String 要复制的监控视图ID 58631437d4897105d9ac9bc044d7b6ab destBoardID 是 String 目标监控看板ID 80a23e824f0fe2c5564c3d8736d0c23c viewName 否 String 监控视图副本名称，默认为原监控视图名称加"copy" viewcopy 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 viewID String 复制的新viewID 2dbd8967000debcbc6841f4dedd35387

接口功能介绍 查看报表列表 接口约束 传参规范 URI GET /vfw/v2reportlist 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 startTime 是 String 开始时间 20240925T05:36:13Z endTime 是 String 结束时间 20240925T05:36:13Z reportType 是 String 报表类型 DAY selectedTime 否 String 选择时间 20240925T05:36:13Z page 否 Integer 页码 1 size 否 Integer 条数 10 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 total Integer 总记录数 1 list Array of Objects 结果集 ReportDetail pageNum Integer 当前页的页码 1 pageSize Integer 每页的数量 10 size Integer 当前页的数量 1 startRow Long 当前页面第一个元素在数据库中的行号 1 endRow Long 当前页面最后一个元素在数据库中的行号 1 pages Integer 总页数 1 prePage Integer 前一页 0 nextPage Integer 下一页 0 isFirstPage Boolean 是否为首页 true isLastPage Boolean 是否为末页 true hasPreviousPage Boolean 是否有前一页 false hasNextPage Boolean 是否有下一页 false navigatePages Integer 导航页码数 8 navigatepageNums Array of Integers 所有导航页号 [1] navigateFirstPage Integer 导航条上的第一页 1 navigateLastPage String 导航条上的最后一页 1 表 ReportDetail 参数 参数类型 说明 示例 下级对象 reportId String 报表id f9d5b6bd408f48c2a3d986c6f0fa1d0b reportName String 报表名称 10月24号日报(2024) reportType String 报表类型 DAY reportStartTime String 报表开始时间 20241023T16:00:00Z reportEndTime String 报表结束时间 20241024T15:59:59Z createdTime String 报表创建时间 20241024T16:00:24Z

接口功能介绍 查询云间高速列表 接口约束 传参规范 URI GET /vfw/v2assertexpressConnectquery 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 endRow Long 当前页面最后一个元素在数据库中的行号 hasNextPage Boolean 是否有下一页 hasPreviousPage Boolean 是否有前一页 isFirstPage Boolean 是否为首页 isLastPage Boolean 是否为末页 list Array of Objects 资产列表 ExpressConnectView navigateFirstPage Integer 导航条上的第一页 1 navigateLastPage Integer 导航条上的最后一页 1 navigatePages Integer 导航页码数 1 navigatepageNums Array of Integers 所有导航页号 1 nextPage Integer 下一页 1 pageNum Integer 当前页的页码 1 pageSize Integer 每页的数量 1 pages Integer 总页数 1 prePage Integer 前一页 1 size Integer 当前页的数量 1 startRow Long 当前页面第一个元素在数据库中的行号 total Long 总记录数 表 ExpressConnectView 参数 参数类型 说明 示例 下级对象 id Long id ecName String 云间高速实例名称 ecId String 云间高速实例ID cgwId String 云网关ID cgwName String 云网关名称 vpcId String vpc id vpcName String vpc名称 vpcCidr String vpc的网段 subnets String 子网信息 status String 状态creating加载中;running已连接removing卸载中;flushing路由待更新;error失败 protectStatus Boolean 防护状态false;true syncStatus String 同步状态 add, delete, unchanged firewallId String 防火墙id firewallEdition String 防火墙版本号 protectId String 项目ID endpoint Object 终端节点 GwlbeInfoVo 表 GwlbeInfoVo 参数 参数类型 说明 示例 下级对象 endpointName String 终端节点名称 endpointId String 终端节点id vpcName String Vpc名称 subnetName String 子网名称 description String 描述

本页介绍天翼云TeleDB数据库元数据pgxcshardmap的内容。 存储shard分片映射信息。 名称 类型 定义 disgroup Oid 分布组的OID shardgroupid int32 分片组的ID ncopy int16 复制份数 primarycopy Oid 主副本的数据节点OID copy1 Oid 第一个副本的数据节点OID copy2 Oid 第二个副本的数据节点OID primarystatus char 主副本的状态 status1 char 第一个副本的状态 status2 char 第二个副本的状态 extended int16 扩展信息 ntuples int32 分片中的元组数

编号 操作 相关文档 1 配置测评对象 2 下发测评任务

编号 操作 相关文档 1 配置测评对象 2 下发测评任务

花卷慧办是一款面向现代企业的一体化协同办公平台,依托息壤算力,以多模态AI智能引擎为核心驱动为客户提供企业级智能办公平台。本产品集成了消息、日程管理、待办任务、在线会议、文档协作、空间存储、知识库管理和办公智能体等核心功能模块,形成一个一站式的智能办公解决方案。

接口功能介绍 查询日志内容 接口约束 传参规范 URI POST /vfw/bb9fdb42056f11eda1610242ac110002/v2getrawlog 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI loggroup 是 String 日志组id logunit 是 String 日志单元id page 是 Integer 页数 size 是 Integer 每页数量 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 startTime 是 String 开始时间 endTime 是 String 结束时间 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 GetRawLogView 表 GetRawLogView 参数 参数类型 说明 示例 下级对象 resultcode String 返回码 pages String 页数 total Long 总数 realtotal Long 真实数量 rawlogs Array of Objects 日志列表 rawLogView 表 rawLogView 参数 参数类型 说明 示例 下级对象 hostid String 主机名 time String 时间 ipproto Integer IP协议 1:v4; 2:v6 proto Integer 协议 1:icmp; 6:tcp; 17:udp sip String 源IP dip String 目的IP sport Integer 源端口 dport Integer 目的端口 dir Integer 方向 1:in2out; 2:out2in appid Integer 应用id action Integer 动作, 1:pass; 2:drop ruleid Long 规则id（入侵防御/访问控制/流量日志有） level String 事件等级, 1:Low; 2:Middle; 3:High （入侵防御/访问控制日志有） origin Integer 来源, 1:基础防御 2:虚拟补丁 3:访问控制 4:黑名单 5:白名单 （入侵防御/访问控制日志有） originbytes Long 正向字节数（流量日志有） originpackets Long 正向报文数（流量日志有） responsebytes Long 应答字节数（流量日志有） responsepackets Long 应答报文数（流量日志有） origintime String 发起时间（流量日志有） terminaltime String 终止时间（流量日志有） gwlbeid String gwlbe id（入侵防御日志有） className String 攻击类型（入侵防御日志有） virus String 病毒名称 (病毒日志有) md5 String md5值 (病毒日志有)