接口功能介绍 查询接入点的终端节点白名单 接口约束 无 URI POST /v1/userEndpointControl/showEndpointWhitelist 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 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 枚举参数 无

接口功能介绍 创建租户身份凭证aksk 接口约束 无 URI POST /v1/userAkControl/createUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 userAk String 租户ak 02baad12e63c471c85400df031e18520 userSk String 租户sk 11111111111111111111111111111111 userId String 租户id 562b89493b1a40e1b97ea05e50dd8170 policy String 权限 full applicationId String 接入点id b2160c2c9c704ca9b8080d186c97280d 请求示例

接口功能介绍 实例退订 接口约束 无 URI POST /v3/api/cancelInstance 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 响应参数 参数 参数类型 说明 示例 下级对象 message String 描述状态 statusCode String 800成功 其他失败 error String 错误码 returnObj Object 返回对象 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body { "prodInstId": "123" } 响应示例 { "statusCode": 800 } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 查询全部订阅信息 接口约束 无 URI GET /v3/api/listAllSubscriptions 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 445d30ce3d5d40a2a79dc444a8c83859 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 华东1 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 returnObj Array of Objects returnObj returnObj message String 错误信息 statusCode String 800成功 其他失败 error String 错误码 表 returnObj 参数 参数类型 说明 示例 下级对象 clientid String 客户端id mqtta qos Integer 取值为0到2，通信等级，默认为0 0 topic String 订阅的单个topic t/a 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body 无

接口功能介绍 查看接入点信息 接口约束 无 URI GET /v3/api/getEndpoint 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 445d30ce3d5d40a2a79dc444a8c83859 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 华东1 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 message String 错误信息 statusCode String 800成功 其他失败 returnObj Object returnObj returnObj error String 错误码 表 returnObj 参数 参数类型 说明 示例 下级对象 tcpEndpoint String tcp接入点信息 sslEndpoint String tls接入点信息 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body 无 响应示例 { "statusCode": 800, "returnObj": { "tcpEndpoint": "192.168.0.3:1883", "sslEndpoint": "192.168.0.3:8883" } }

接口功能介绍 查询日志配置详情 接口约束 传参规范 URI GET /vfw/v2logsettinginfo 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙ID 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 LogSttingEntity 表 LogSttingEntity 参数 参数类型 说明 示例 下级对象 auditAttackId String 攻击日志单元ID auditAttackName String 攻击日志单元名称 auditEventId String 事件日志单元ID auditEventName String 事件日志名称 auditFlowId String 流量日志单元ID auditFlowName String 流量日志单元名称 auditGroupId String 日志组id auditGroupName String 日志组名称 firewallId String 防火墙ID logUserId String 日志用户id regionId String 资源池ID uid String 租户ID auditAvId String 防病毒日志单元ID auditAvName String 防病毒日志单元名称

接口功能介绍 为监控视图新增监控项，原有监控项保留。 如果新增监控项与原有监控项key相同，则以新增监控项值为准。 一个监控视图包含一个或多个监控项,监控项为keyvalue格式。 接口约束 regionID（资源池）、templateID（监控面板）、viewID（监控视图）存在。 URI POST /v4/monitor/createmonitoritem 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID viewID String 是 f750ec8a487c11eda9b7005056897257 监控视图ID itemContent Object 是 要添加的监控项内容，为keyvalue格式 itemContent 表itemContent 参数 参数类型 是否必填 示例 说明 下级对象 {itemName} String 是 tcKey11 监控项名称 {value} Object 是 tcVal11 监控项值，与监控项名称组成keyvalue格式，可以为任意内容 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否创建成功 true

通知模板 通知模板：更新 接口功能介绍 调用此接口可更新通知模板。 接口约束 1. 通知模板存在。 2. 其他参见请求参数说明。 URI POST /v4/monitor/updatenoticetemplate 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 noticeTemplateID 是 String 通知模板ID 312b56b43e4311ed8ef2005056898fe0 name 是 String 通知模板名称，长度240个字符。 xsZSu contents 是 Array of Objects 通知模板 content 表 content 参数 是否必填 参数类型 说明 示例 下级对象 content 是 String 通知模板内容，长度不能超过400个字符。 this is content notifyType 是 String 本参数表示通知方式。取值范围：sms：短信。email：邮件。 根据以上范围取值。 sms 响应参数 参数 参数类型 说明 示例 下级对象 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

操作步骤 步骤 1 在“实时同步管理”页面，单击“创建同步任务”。 步骤 2 在“同步实例”页面，填选任务名称、描述、同步实例信息，单击“开始创建”。 任务信息 表 任务和描述 参数 描述 任务名称 任务名称在4到50位之间，必须以字母开头，可以包含字母、数字、中划线或下划线，不能包含其他的特殊字符。 描述 描述不能超过256位，且不能包含! & ' " 特殊字符。 同步实例信息 表同步实例信息 参数 描述 数据流动方向 选择“入云”。 源数据库引擎 选择“DRDS”。 目标数据库引擎 选择“DRDS”。 网络类型 此处以公网网络为示例。目前支持可选公网网络、VPC网络、VPN和专线网络。 目标数据库实例 用户所创建的DRDS实例。 同步实例所在子网 请选择同步实例所在的子网。也可以单击“查看子网”，跳转至“网络控制台”查看实例所在子网帮助选择。默认值为当前所选数据库实例所在子网，请选择有可用IP地址的子网。为确保同步实例创建成功，仅显示已经开启DHCP的子网。 IP类型 选择迁移实例的IP类型，目前支持选择“IPv4”或“IPv4&IPv6双栈”。只有所选择的VPC及子网都开启了IPv6双栈功能，才能选择IP类型为“IPv4&IPv6双栈”。 同步模式 全量+增量该模式为数据持续性实时同步，通过全量过程完成目标端数据库的初始化后，增量同步阶段通过解析日志等技术，将源端和目标端数据保持数据持续一致。 说明 选择“全量+增量”同步模式，增量同步可以在全量同步完成的基础上实现数据的持续同步，无需中断业务，实现同步过程中源业务和数据库继续对外提供访问。 源端数据库实例个数 源端DRDS绑定的实例个数，默认值2，输入值在1到64之间，您需要根据源端实际情况设置该值大小。 标签 表标签 参数 描述 标签 可选配置，对同步任务的标识。使用标签可方便管理您的任务。每个任务最多支持10个标签配额。 任务创建成功后，您可以单击任务名称，在“标签”页签下查看对应标签。关于标签的详细操作，请参见标签管理。 说明 对于创建失败的任务，DRS默认保留3天，超过3天将会自动结束任务。 步骤 3 在“源库及目标库”页面，同步实例创建成功后，填选源库信息和目标库信息，单击“源库和目标库”处的“测试连接”，分别测试并确定与源库和目标库连通后，勾选协议，单击“下一步”。 表源库信息 参数 描述 中间件IP地址或域名 源数据库DRDS中间件的IP地址或域名。 端口 源数据库DRDS中间件服务端口，可输入范围为1~65535间的整数。 中间件用户名 源数据库DRDS中间件的用户名。 中间件密码 源数据库DRDS中间件用户名所对应的密码。 SSL安全连接 通过该功能，用户可以选择是否开启对迁移链路的加密。如果开启该功能，需要用户上传SSL CA根证书。 说明 最大支持上传500KB的证书文件。 如果不启用SSL安全连接，请自行承担数据安全风险。 数据库实例 根据源库实际的分片数据库，填写对应的数据库信息。 说明 源数据库的IP地址或域名、数据库用户名和密码，会被系统加密暂存，直至删除该迁移任务后自动清除。 表 目标库信息 参数 描述 数据库实例名称 默认为创建同步任务时选择的DRDS实例，不可进行修改。 数据库用户名 目标数据库对应的数据库用户名。 数据库密码 数据库用户名和密码将被系统加密暂存，直至该任务删除后清除。 步骤 4 在“设置同步”页面，选择同步对象，单击“下一步”。 表 同步模式和对象 参数 描述 增量阶段冲突策略 该冲突策略特指增量同步中的冲突处理策略，全量阶段的冲突默认忽略。冲突策略目前支持如下形式： l 忽略 当同步数据与目标数据库已有数据冲突时（主键/唯一键存在重复等），将跳过冲突数据，继续进行后续同步。 l 覆盖 当同步数据与目标数据库已有数据冲突时（主键/唯一键存在重复等），将覆盖原来的冲突数据。 同步对象 左侧框是源数据库对象，右侧框是已经选择的对象，可选表级同步、库级同步，您可以根据业务场景选择对应的数据进行同步。 在同步对象右侧已选对象框中，可以使用对象名映射功能进行源数据库和目标数据库中的同步对象映射，具体操作可参考对象名映射。 说明 选择对象的时候支持对展开的库进行搜索，以便您快速选择需要的数据库对象。 如果有切换源数据库的操作或源库同步对象变化的情况，请在选择同步对象前单击右上角的，以确保待选择的对象为最新源数据库对象。 当对象名称包含空格时，名称前后的空格不显示，中间如有多个空格只显示一个空格。 选择的同步对象名称中不能包含空格。 步骤 5 在“预检查”页面，进行同步任务预校验，校验是否可进行实时同步。 查看检查结果，如有不通过的检查项，需要修复不通过项后，单击“重新校验”按钮重新进行任务预校验。 预检查完成后，且所有检查项结果均通过时，单击“下一步”。 说明 所有检查项结果均通过时，若存在待确认项，需要阅读并确认详情后才可以继续执行下一步操作。 步骤 6 在“任务确认”页面，设置同步任务的启动时间，并确认同步任务信息无误后，单击“启动任务”，提交同步任务。 表 任务启动设置 参数 描述 启动时间 同步任务的启动时间可以根据业务需求，设置为“立即启动”或“稍后启动”。 说明 预计同步任务启动后，会对源数据库和目标数据库的性能产生影响，建议选择业务低峰期，合理设置同步任务的启动时间。 步骤 7 同步任务提交后，您可在“管理”页面，查看并管理自己的任务。 您可查看任务提交后的状态，状态请参见任务状态说明。 在任务列表的右上角，单击刷新列表，可查看到最新的任务状态。 对于未启动、状态为配置中的任务，DRS默认保留3天，超过3天DRS会自动删除后台资源，当前任务状态不变。当用户再次配置时，DRS会重新申请资源。

机房管理员没有超级管理权限，Ukey是Dedicated HSM提供给您的身份识别卡，此卡仅创建专属加密实例的用户持有。 敏感数据（密钥）存储在硬件加密卡中，即使加密机制造商也无法读取内部密钥信息。

本文介绍在使用AK和SK访问媒体存储过程中，密钥AK和SK是否可以更换。 主账号、子账号使用AKSK访问时可以替换。在使用过程中，密钥AK和SK可以随时更换。 使用临时凭证访问时可以替换，需要注意的是，临时凭证具有有效期，需核实该密钥是否在有效期内。

接口功能介绍 修改安全组v3 接口约束 无 URI POST /v3/securityGroup/update 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 securityGroupOid 是 String 安全组ID securityGroupName 是 String 安全组名称 remark 否 String 安全组备注 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。安全组id。 sg41f5rni5zu4oufa85xwob 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "securityGroupOid":"sg41f5rni5zu4oufa85xwob", "securityGroupName":"securityapitest", "remark":"qqq" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"sg41f5rni5zu4oufa85xwob" }

在任务列表中可查看敏感数据识别任务的详细信息 前提条件 已添加OBS、数据库、大数据源资产或MRS，具体操作请参见资产列表。 查看识别任务列表 1. 登录管理控制台。 2. 单击左上角的，选择区域或项目。 3. 在左侧导航树中，单击，选择选择“安全 > 数据安全中心”，进入数据安全中心总览界面。 4. 在左侧导航树中，单击“敏感数据识别（新） > 识别任务”，进入识别任务界面查看任务详情，相关参数如下表。 参数 说明 任务名称 识别任务名称。 单击任务名称前方的，查看任务下各个对象执行扫描的具体时间以及识别状态，并在具体对象所在行的“操作”列，可执行以下操作： 单击“停止”，停止对该任务下具体对象的扫描。 单击“立即识别”，立即执行对该任务下具体对象的扫描。 单击“识别结果”，查看该任务下具体对象的扫描结果。 单击“删除”，删除该任务下具体对象。 识别模板 识别模板名称。 执行周期 识别任务的具体执行周期。说明如下： 单次：识别任务仅执行一次。 每天：每天固定时间执行一次识别任务。 每周：每周固定时间执行一次识别任务。 每月：每月固定时间执行一次识别任务。 状态 识别任务的执行状态。 待识别：识别任务在队列中，等待识别。 识别中：正在执行的识别任务。 识别完成：目标任务下的所有识别对象都已成功完成了扫描。 识别异常：目标任务下至少存在一个识别对象执行识别任务失败。 识别终止：正在识别中的任务，被强行停止。 上次识别时间 上一次执行该任务的具体时间。 上次识别结果 上一次该任务扫描的结果，包含内置级别和自定义级别，详情参见新增分级章节。 操作 用户可以在操作栏中，执行以下操作： 立即执行识别任务，具体的参见启动识别任务章节。 查看识别结果，单击“识别结果”，跳转到“ 结果明细”页面，DSC为您提供了详细的结果分析报告，具体的参见查看识别结果章节。 开启任务，当该任务处于关闭状态时，单击“更多> 开启任务”，具体请参见启动识别任务章节。 编辑扫描任务，单击“更多>编辑”，具体请参见配置识别任务。 删除扫描任务，单击“更多>删除”，具体请参见删除识别任务。

本文为您介绍DRDS实例的全局日志(全局Binlog),以及使用流程。 注意 仅V5.1.9.6020.2533及以后版本的实例，支持该功能。 全局Binlog介绍 DRDS实例的全局日志（全局Binlog）是一种二进制日志文件，内容包括该DRDS实例所有的DML操作以及DDL操作，同时为了便于一致性恢复，全局Binlog中也包含DRDS实例元数据和全局一致性位点信息。DRDS全局Binlog兼容MySQL Binlog格式，由CDC（Change Data Capture）节点生成。CDC节点完全兼容MySQL的Binlog dump协议，第三方程序可以像消费（即使用工具实时解析或处理全局Binlog，或进行数据同步等）单个MySQL实例的Binlog一样消费全局Binlog。 工作原理 DRDS由计算节点（Compute Node，简称CN）和存储节点（Data Node，简称DN）组成，存储节点为独立的RDS实例。CDC会存储DRDS实例的元信息，例如逻辑库和逻辑表的对应关系、物理库与物理表的对应关系、白名单表等。CDC使用dump协议，以slave的角色从各DN节点拉取Local Binlog（即RDS产生的Binlog），然后对Local Binlog进行整形、去重、合并等，最终生成全局Binlog。DRDS实例全局Binlog架构如下： 全局Binlog完全采用单机MySQL Binlog的格式，能够提供与单机MySQL数据库相同的使用体验。同时CDC支持dump协议，无论是将全局Binlog日志同步到下游的大数据系统，还是作为DRDS实例的的备份，均可通过直接订阅全局Binlog来实现。您只需在创建DRDS实例后，创建日志节点并完成初始化（也可以在创建DRDS实例时同步创建日志节点，待创建完毕后，再进行日志节点初始化操作），即可生成全局Binlog日志。 注意 开启日志节点后，当您续订或删除DRDS实例时，会同步续订或删除日志节点。

本章节会介绍函数工作流的购买时常见问题。 在创建函数时创建失败，并提示“您当前的权限不足，请联系您的管理员为您开通相关权限”时该如何处理？ 使用FunctionGraph是否需要开通计算、存储、网络等服务？ 使用FunctionGraph开发程序之后是否需要部署？ FunctionGraph函数支持哪些编程语言？ FunctionGraph函数分配磁盘空间有多少？ FunctionGraph函数是否支持版本控制？ 在创建函数时创建失败，并提示“您当前的权限不足，请联系您的管理员为您开通相关权限”时该如何处理？ 用户在未进行实名认证或者账号余额不足100元时，会弹出“您当前的权限不足，请联系您的管理员为您开通相关权限”的提示，且无法开通按需资源。请用户进行实名认证并保障账号余额大于100元。 使用FunctionGraph是否需要开通计算、存储、网络等服务？ 用户使用FunctionGraph时，不需要开通或者预配置计算、存储、网络等服务，由FunctionGraph提供和管理底层计算资源，包括服务器CPU、内存、网络和其他配置/资源维护、代码部署、弹性伸缩、负载均衡、安全升级、资源运行情况监控等，用户只需要按照FunctionGraph支持的编程语言提供程序包，上传即可运行。 使用FunctionGraph开发程序之后是否需要部署？ 用户在本地开发程序之后打包，必须是ZIP包（Java、Node.js、Python、Go）或者JAR包（Java），上传至FunctionGraph即可运行，无需其它的部署操作。 制作ZIP包的时候，单函数入口文件必须在根目录，保证解压后，直接出现函数执行入口文件，才能正常运行。 对于Go runtime，必须在编译之后打zip包，编译后的动态库文件名称必须与函数执行入口的插件名称保持一致，例如：动态库名称为testplugin.so，则“函数执行入口”命名为testplugin.Handler。

方案类型 适用场景 注意事项 使用docker命令迁移镜像至SWR 待迁移的镜像数量较少 依赖磁盘存储，需要及时进行本地镜像的清理，而且落盘形成多余的时间开销，难以胜任生产场景中大量镜像的迁移。 依赖docker 程序，docker daemon 对 pull/push 的并发数进行了严格的限制，没法进行高并发同步 一些功能只能经过HTTP api 进行操作，单纯使用 docker cli 没法做到，使脚本变得复杂 使用imagesyncer迁移镜像至SWR 待迁移的镜像数量庞大 支持多对多镜像仓库同步 支持基于Docker Registry V2 搭建的 docker 镜像仓库服务 (如 Docker Hub、 Quay、 Harbor等) 同步只通过内存和网络，不依赖磁盘存储，同步速度快 增量同步, 经过对同步过的镜像 blob 信息落盘，不重复同步已同步的镜像 并发同步，能够经过配置文件调整并发数Ÿ 自动重试失败的同步任务，能够解决大部分镜像同步中的网络抖动问题 不依赖docker 以及其余程序

本文介绍使用CDN加速后访问HTML页面弹出下载界面的处理方案。 问题现象 域名使用CDN加速后访问HTML页面未正常响应，弹出下载界面。 处理方案 通过本地电脑绑定host（host文件地址：C:WindowsSystem32driversetc下的hosts文件），添加方式如下图： 测试CDN加速源站是否正常，同时检查源站响应头： 如源站直接返回响应头ContentType: application/octetstream，则需要将其修改为ContentType:text/html，并在CDN控制台刷新缓存；如源站为媒体存储，可参考如下文档进行处理：使用CDN和媒体存储后访问文件被强制下载。 如源站并未返回上述响应头，则检查是否CDN特殊设置了ContentType: application/octetstream响应头。如果是，需要针对HTML文件将ContentType值修改为text/html。详情请见：HTTP响应头。

接口功能介绍 新增标签接口 接口约束 无 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" }

接口功能介绍 新增标签接口 接口约束 无 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" }

接口功能介绍 关闭接入点的权限控制 接口约束 无 URI POST /v1/applicationAccessPointManage/closePolicyCheck 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d 枚举参数 无 请求示例 请求url 请求头header { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" }

接口功能介绍 创建密钥版本 接口约束 请保证账户余额大于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" }

接口功能介绍 创建密钥版本 接口约束 请保证账户余额大于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

接口功能介绍 删除标签接口 接口约束 无 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" }

接口功能介绍 更新证书状态 接口约束 无 URI POST /v1/manageCertificate/updateCertificateStatus 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff status 是 String 证书状态（ACTIVE 启用，INACTIVE 禁用，REVOKED 吊销） ACTIVE 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 证书状态更新成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "200000001852" } 请求体body { "certificateId": "e961bd8237ee4c1fa9965cf37b4fbd01", "status": "INACTIVE" }

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 POST /v3/api/ssl/cert/delete 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 实例的资源池ID。 bb9fdb42056f11eda1610242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certId 是 String 实例ID 123 响应参数 参数 参数类型 说明 示例 下级对象 message String 描述状态 statusCode String 800成功 其他失败 error String 错误码 returnObj Object 返回对象 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body { "certId": "123" } 响应示例 { "statusCode":800 } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 认证用户授权 接口约束 无 URI POST /v3/api/addMqttUserAcl 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例Id userName 是 String 认证用户 topic 是 String 主题 action 是 String 权限 sub/pub/pubsub 响应参数 参数 参数类型 说明 示例 下级对象 message String 描述状态 statusCode String 800成功 其他失败 error String 错误码 returnObj Object 返回对象 枚举参数 参数名 action 枚举值 类型 说明 pub String 发布权限 sub String 订阅权限 pubsub String 发布+订阅权限 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body { "prodInstId": "123", "userName": "test", "topic": "tt/ ", "action": "sub" }