接口功能介绍 幂等接口，已存在用户账号重复创建会忽略并视为创建成功。 接口约束 无 URI POST /v3/user/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 activationType 是 Integer 激活类型(1邮件通知激活；2管理员激活) 2 createUserList 是 Array of Objects 需要创建的用户列表, 最大数量50 createUserList orgOid 是 String 部门ID orgadhij4zha35v3knu9irlg 表 createUserList 参数 是否必填 参数类型 说明 示例 下级对象 userAccount 是 String 用户账号 xiemushutest3 email 否 String 通知邮箱。激活方式为邮件通知时，必填。 null password 否 String 用户账号密码 abc!ABC0927 userName 否 String 用户名称。字符数限制：[0,20]。 null gender 否 String 性别。枚举值范围：[男,女]。 null telephone 否 String 固定电话。字符数限制：[0,20]。 null position 否 String 职位。字符数限制：[0,50]。 null

接口功能介绍 修改角色信息 接口约束 无 URI POST /v3/role/updSystemRole 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 sysRoleName 是 String 角色名称 liut555updated sysRoleDesc 否 String 角色描述 更新后的角色描述 status 是 Integer 角色状态（1有效） 1 shareFlag 否 Integer 角色是否共享（0私有，1共享） 0 sysRoleCode 否 String 角色标识（不可修改） liut555 orgOid 是 String 部门ID(不可修改) orgtest 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "sysRoleName":"liut555updated", "sysRoleDesc":"更新后的角色描述", "status":1, "shareFlag":0, "sysRoleCode":"liut555", "orgOid":"orgtest" }

接口功能介绍 确认手动引流配置完成 接口约束 传参规范 URI POST /vfw/v2assertopenprotect 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 是 String 开启防护的vpc scenarioType 是 String 类型nat;vpcPeer对等连接;cda云专线;ec云间高速 scenarioId 是 String 场景id，列表获取 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "vpcId": "vpcr5ka3qk24m", "scenarioType": "nat", "scenarioId": "natgwc4gcnb45fn" }

接口功能介绍 查询日志内容 接口约束 传参规范 URI POST /vfw/200000004263/v2getrawlog 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI loggroup 是 String 日志组id(防火墙id) fdfe9f25826949beb88cf0bc9df3e125 logunit 是 String 日志单元id(FLOW；IPS；AC；AV) fdfe9f25826949beb88cf0bc9df3e125FLOW page 是 Integer 页数 size 是 Integer 每页数量 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 startTime 是 String 开始时间 endTime 是 String 结束时间 keys 是 Array of Objects 查询条件 Key 表 Key 参数 是否必填 参数类型 说明 示例 下级对象 key 是 String 查询条件 ipproto value 是 String 查询条件的值 1 value1 否 String 查询条件的值（judgeMode6需要传） 1 judgeMode 是 Integer 比较模式 1：value；2：>value；3： value；5： value 且

来自：

帮助文档

云防火墙（原生版）

API参考

API

2023-10-16

日志管理

查询云墙日志内容

接口功能介绍 关闭vpc资产防护 接口约束 传参规范 URI POST /vfw/v2assertcloseprotect 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 是 String 开启防护的vpc scenarioType 是 String 类型nat;vpcPeer对等连接;cda云专线;ec云间高速 scenarioId 是 String 场景id，列表获取 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "vpcId": "vpcr5ka3qk24m", "scenarioType": "nat", "scenarioId": "natgwc4gcnb45fn" }

接口功能介绍 修改安全组规则v3 接口约束 无 URI POST /v3/securityGroup/rule/update 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 securityGroupOid 是 String 安全组ID securityGroupName 是 String 安全组名称 remark 否 String 安全组备注 strategynetworkDTOList 否 Array of Objects 该安全组下全量规则信息，需要传所有安全组规则参数 strategynetworkDTOList 表 strategynetworkDTOList 参数 是否必填 参数类型 说明 示例 下级对象 direction 是 Integer 规则方向。[入方向：15，出方向：10] ipAddressField 是 String IP地址 protocolType 是 String 端口协议。[10：自定义TCP，15：自定义UDP，20：全部ICMP，25：GRE，30：全部TCP非自定义，35：全部UDP非自定义，99：全部放通] portRange 是 String 端口范围，例如 20000,20006，如果是全部端口则填 ALL authPolicy 是 Integer 规则类型。[拒绝：15，允许：10]

前提条件 备份副本数据为“可用”状态。 操作步骤 1.备份页签下，在备份副本列表找到对应的备份，点击备份所在行的“申请云主机”。 2.在打开的页面中地域，镜像，数据盘，系统盘等配置和信息不能修改，需保持一致。配置主机的名称，主机规格，网络信息、登录方式，计费模式等，同意并勾选相关服务协议，点击“立即购买”即可。配置信息选择，请参考创建弹性云主机 删除备份 操作场景 备份数据通常需要占用存储资源，尤其对于大规模的备份和长期保留的备份策略，可能会导致较高的存储成本。用户可以根据实际情况删除无用的备份，以节省存储空间和成本。 注意 该操作将彻底删除所选备份，删除后将无法用于数据恢复，请谨慎操作。 前提条件 至少存在一个备份。 备份的状态为“可用”或者“错误”。 操作步骤 1.备份页签下，在备份副本列表找到对应的备份，点击备份所在行的“删除”。 2.根据界面提示，点击“确定”，完成备份删除。

本文主要介绍节点须知。 简介 节点是容器集群组成的基本元素。节点取决于业务，既可以是虚拟机，也可以是物理机。每个节点都包含运行Pod所需要的基本组件，包括Kubelet、Kubeproxy 、Container Runtime等。 说明 CCE创建的Kubernetes集群包含master节点和node节点，本章讲述的节点特指 node节点 ，node节点是集群的计算节点，即运行容器化应用的节点。 在云容器引擎CCE中，主要采用高性能的弹性云主机ECS或物理机BMS作为节点来构建高可用的Kubernetes集群。 支持的节点规格 不同区域支持的节点规格（flavor）不同，且节点规格存在新增、售罄下线等情况，建议您在使用前登录CCE控制台，在创建节点界面查看您需要的节点规格是否支持。 Docker容器底层文件存储系统说明 1.15.6及之前集群版本docker底层文件存储系统采用xfs格式。 1.15.11及之后版本集群新建节点或重置后docker底层文件存储系统全部采用ext4格式。 对于之前使用xfs格式容器应用，需要注意底层文件存储格式变动影响（不同文件系统格式文件排序存在差异：如部分java应用引用某个jar包，但目录中存在多个版本该jar包，在不指定版本时实际引用包由系统文件排序决定）。 查看当前节点使用的docker底层存储文件格式可采用docker info grep "Backing Filesystem"确认。 节点paas用户/用户组说明 在CCE集群中创建节点时，默认会在节点上创建paas用户/用户组。节点上的CCE组件和CCE插件在非必要时会以非root用户（paas用户/用户组）运行，以实现运行权限最小化，如果修改paas用户/用户组可能会影响节点上CCE组件和业务Pod正常运行。 注意 CCE组件正常运行依赖paas用户/用户组，您需要注意以下几点要求： 请勿自行修改节点内目录权限、容器目录权限等。 请勿自行修改paas用户/用户组的GID和UID。 请勿在业务中直接使用paas用户/用户组设置业务文件的所属用户和组。

接口介绍 删除指定Bucket未锁定的合规保留策略。 接口约束 无 请求URI DELETE /v1/worm/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 bucket 是 String 桶名。 test1 regionCode 是 String 区域编码。 00001 请求参数 请求头参数 无 请求体参数 无 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Integer 本次请求的结果码。 0 error 是 String 错误码，创建成功时，不返回该字段。 message 是 String 错误文本信息，创建成功时，为空字符串。 returnObj 是 String of Object 返回结果。 returnObj 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 code 是 String 业务返回码，0表示业务成功。 0 message 是 String 业务消息。 请求示例 DELETE /v1/worm/delete?regionCode0001&buckettestBucketName 请求头header 无 请求体body 无 响应示例 json { "statusCode": "0", "message": "", "returnObj": { "code": "0", "message": "" } } 状态码 状态码 描述 0 表示业务成功。 400 请求参数有误。 403 用户鉴权失败，用户无操作权限。 404 请求的资源不存在，输入错误的URL。 500 业务执行异常。

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

场景示例：核对资源用量是否与实际相符 假设用户在2023/04/08 10:09:06购买了一个按需计费GeminiDB Influx实例，并在2023/04/08 12:09:06时刻将其删除。 GeminiDB Influx实例流水账单 按需计费GeminiDB Influx实例按秒计费，每一个小时整点结算一次费用，您可以在流水账单中核对每一个计费周期的信息是否和实际相符，流水账单中计费资源是分开计费的，以“GeminiDB Influx存储”为例，具体如表1所示。 表1 GeminiDB Influx流水账单 产品类型 GeminiDB Influx 产品 GeminiDB Influx存储 计费模式 按需 消费时间 2023/04/08 10:09:06 ~ 2023/04/08 12:09:06时段计费系统将生成6笔流水账单，对应每一个计费周期，分别如下： 2023/04/08 10:09:06 ~ 2023/04/08 11:00:00 2023/04/08 11:00:00 ~ 2023/04/08 12:00:00 2023/04/08 12:00:00 ~ 2023/04/08 12:09:06 官网价 官网价使用量单价容量本例中，在第一个计费周期内GeminiDB Influx的使用量为3054秒，单价可在云数据库 GeminiDB价格详情中查询，以0.00378元/GB/小时为例，容量为40GB，那么官网价(3054 ÷ 3600) 0.00378 40 0.128262 元。同理，您可以计算剩余计费周期内资源的官网价。 优惠金额 用户使用云服务享受折扣优惠如商务折扣、伙伴授予折扣以及促销优惠等减免的金额。基于官网价的优惠金额。 抹零金额 天翼云产品定价精度为小数点后8位（单位：元），因此在计费过程中会产生小数点后8位的资源使用费用。而在实际扣费时，仅扣除到小数点后2位，小数点后第3位到第8位部分金额会被舍弃，这种舍弃部分的金额称作抹零金额。以第一个计费周期为例，抹零金额为：0.008268 元 应付金额 应付金额官网价优惠金额抹零金额以第一个计费周期为例，假设优惠金额为0，那么应付金额0.128262 0 0.008262 0.12 元。 GeminiDB Influx实例明细账单 明细账单可以通过多维度展示客户账单的详细信息。一般通过设置统计维度为“按使用量”，统计周期为“按账期”来统计资源在某个月份的总开销，以“GeminiDB Influx存储”为例，建议您核对下表所示的信息是否和实际相符。 表2 GeminiDB Influx明细账单 产品类型 GeminiDB Influx 产品 GeminiDB Influx存储 计费模式 按需 资源名称/ID GeminiDB Influx的名称和ID例如：nosqlb388，21e8811a64bf4de88bc2e2556da17983in12 规格 GeminiDB Influx存储 使用量类型 按需计费GeminiDB Influx的使用量类型为“时长” 单价 按需计费模式为简单定价（使用量单价）时提供单价信息，其他的定价（如EIP公网带宽的阶梯定价）等不提供单价。按需计费GeminiDB Influx属于简单定价，您可以在云数据库 GeminiDB价格详情中查中查询单价。 单价单位 在云数据库GeminiDB价格详情中查中查询到的单价单位：元/GB/小时 使用量 按产品单价单位显示使用量，GeminiDB Influx的单价单位为元/GB/小时，因此使用量以小时为单位。本例中，2023/04/08 10:09:06 ~ 2023/04/08 12:09:06时段总计使用量为2小时。 使用量单位 小时 官网价 官网价使用量单价容量本例中，使用量为2小时，单价可在云数据库 GeminiDB价格详情中查中查询，以0.00378元/GB/小时为例，容量为40GB，那么官网价 0.00378 40 0.3024 元。 优惠金额 用户使用云服务享受折扣优惠如商务折扣、伙伴授予折扣以及促销优惠等减免的金额。基于官网价的优惠金额。 应付金额 用户使用云服务享受折扣优惠后需要支付的费用金额。

本页介绍天翼云TeleDB数据库定时任务管理。 操作场景 TeleDB支持对数据库实例执行定时任务，该功能主要通过内置如下函数对数据库实例执行定时任务管理。用户可自行调整对定时任务的执行频率以及查看执行记录。 TeleDB内置了如下函数，所有函数会根据执行频率自动执行任务。 collectdbstatistic：用于数据库实例更新统计信息。 pgcleantwophase：用于数据库实例清理两阶段残留事务。 pgunlockdeadlock：用于处理死锁。 deleteossstatistics：用于删除配置库存储过期的节点监控数据。 deleteslowquery：用于删除过期的慢日志数据。 deleteerrlog：用于删除过期的错误日志数据。 checkxlogbkp：用于检查备份的增量日志的连续性。 deleteaudit：用于删除管控配置库中过期的审计日志数据。 checkfgaaudit：用于检查细粒度审计是否采集到数据。 deletehighfrequencyquery：用于删除管控配置库中存储过期的高频SQL数据。 deletesnapshot：用于删除管控的实例配置库中存储过期的实例运行快照数据。 queryindexadvice：用于对慢sql查询生成相应的索引优化建议。 操作步骤 1. 切换至TeleDB控制台，在左侧导航单击实例列表。 2. 单击目标实例所在行的详情 ，进入实例详情页面。 3. 进入实例详情页面，单击定时任务 。 4. 您可通过控制定时任务开关管理是否定时执行该任务。 5. 单击实例详情操作列的配置 ，出现配置执行频率对话框。 6. 在配置执行频率对话框，输入频率 和周期 ，单击确定 ，完成执行频率的修改。 7. 单击历史记录 可以查看以往执行该任务详情。 8. 单击立即执行 ，出现提示信息对话框。 9. 在提示对话框中，单击确定 可立即执行定时任务。

本文帮助您了解创建云硬盘相关的场景、约束及操作步骤。 操作场景 系统盘在创建云主机或物理机时自动添加，无需单独创建。数据盘可以在创建云主机或物理机时创建，由系统自动挂载给云主机或物理机，也可以在创建了云主机或物理机之后，单独创建云硬盘并挂载给云主机或物理机。 约束与限制 系统盘只能在购买云主机或物理机时自动创建并挂载，云硬盘创建页面只能创建数据盘。 随云主机或物理机创建的云硬盘，计费模式与云主机或物理机保持一致。 共享盘或磁盘模式为SCSI或磁盘类型为极速型SSD的云硬盘不支持加密模式。 随云主机或物理机一起创建的云硬盘会自动挂载至云主机或物理机上，不可卸载，无法再挂载至其他云主机或物理机中使用。 随云主机一起创建的云硬盘，磁盘类型可以在VBD或SCSI中进行选择，随着物理机一起创建的云硬盘磁盘类型默认为VBD类型。 云硬盘只能被挂载在同一个可用区的云主机或物理机上，可用区在创建完成后不支持修改。 创建云硬盘时若选择“立即挂载”，则无法批量创建，一次只能创建一个云硬盘。 操作步骤 1. 登录控制中心。 2. 单击控制中心左上角的，选择地域，此处我们选择华东1。 3. 单击“存储>云硬盘”，进入云硬盘主页面。 4. 单击“创建云硬盘”，进入云硬盘创建页面。 5. 根据界面提示，配置云硬盘的基本信息。各配置项说明如下： 参数 是否必选 说明 地域 是 请选择云硬盘的地域，尽量选择距离您更近的区域以提高访问速度。 可用区 是 在拥有多个可用区的资源池中，选择其中一个可用区创建云硬盘。 云硬盘只能挂载至同一个可用区的云主机上。云硬盘创建完成后不支持修改可用区。 付费方式 是 云硬盘支持的计费类型有包年/包月和按需计费两种。 包年包月是一种先付费后使用的计费方式，按订单的购买周期结算。 按需计费是一种先使用后付费的计费方式，按照云硬盘的实际使用时长计费，每小时结算一次。 是否挂载 是 选择是否在云硬盘创建完成后自动挂载到弹性云主机。 暂不挂载（默认）：云硬盘创建完成后不自动挂载至云主机。 立即挂载：云硬盘创建完成后自动挂载至用户选择的云主机。 注意 挂载到云主机的云硬盘，您还需要登录云主机进行数据盘初始化才可以正常使用。 数据源 否 云硬盘支持从快照、备份或镜像创建云硬盘。 从快照创建： 从快照创建云硬盘可选择目标地域目标可用区下的快照。 从快照创建云硬盘所创建的云硬盘磁盘模式、磁盘类型、加密属性、所在地域可用区与源快照保持一致，不支持修改。 从快照创建云硬盘创建磁盘容量不小于快照容量。 从备份创建： 从备份创建云硬盘可选择目标地域下的备份副本。 从备份创建云硬盘所创建的云硬盘磁盘模式、加密属性和备份源云硬盘保持一致。 从备份创建云硬盘所创建的云硬盘支持切换磁盘类型、支持跨可用区创建。 从备份创建云硬盘创建磁盘容量不小于备份容量。 从镜像创建： 从镜像创建云硬盘可选择目标地域下的镜像。 从镜像创建云硬盘仅支持VBD模式、且不支持磁盘加密。 从镜像创建云硬盘所创建的云硬盘支持切换磁盘类型、支持跨可用区创建。 从镜像创建云硬盘创建磁盘容量不小于镜像容量。 仅支持“正常”状态的私有镜像或“已接受”状态的共享镜像。 注意 无论是从快照、备份或镜像创建，都不支持一次性创建多个云硬盘。 磁盘规格 是 云硬盘的类型：普通IO，高IO，通用型SSD，超高IO，极速型SSD，XSSD0，XSSD1，XSSD2。具体规格可参见产品规格。 云硬盘的容量范围可参考云硬盘使用限制。 说明 从备份创建云硬盘时，容量大小不小于备份源盘大小，默认容量为备份源盘大小。 从快照创建云硬盘时，容量大小不小于快照源盘大小，默认容量为快照源盘大小。 未选择数据源时，XSSD2默认容量大小为512GB，其他类型云硬盘的默认容量大小为40GB。 当前配置 用于显示当前所选磁盘类型和容量计算出来的基础IOPS上限及IOPS突发上限。具体计算方式可参见磁盘类型及性能介绍。 云硬盘备份 否 创建云硬盘时支持同时订购云硬盘备份服务。可以选择暂不配置、使用已有、现在购买。 使用已有：若您想要配置备份且已有可用的存储库，可以选择“使用已有”。 现在购买：若您想要配置备份但没有可用的存储库，可以选择“现在购买”。 配置存储库和备份策略并成功购买云硬盘后，系统会按此备份策略定期对云硬盘进行备份。云硬盘备份服务的计费说明请参考云硬盘备份服务计费说明。 共享盘 否 勾选“共享盘”，则创建的是共享云硬盘，共享云硬盘最多可同时挂载至16台云主机或物理机。 不勾选“共享盘”，则默认为非共享云硬盘，只能挂载至1台云主机或物理机。 是否编辑标签 否 标签用于标识资源，可通过标签管理功能对云硬盘进行分类和筛选。 勾选后需要输入标签键和标签值，具体操作可参考标签功能概述。 磁盘模式 否 VBD（默认）：VBD类型的云硬盘仅支持简单的读写命令。 SCSI：支持SCSI指令透传，允许云主机操作系统直接访问存储介质。 FCSAN：FCSAN云硬盘仅适用于物理机。 磁盘加密 否 支持创建加密云硬盘，磁盘加密能够最大限度的为您的数据提供安全防护。 加密磁盘生成的快照/备份及通过这些快照/备份创建的磁盘将自动继承加密属性。 释放设置 否 支持设置释放策略。 可设置云硬盘释放时是否同步释放该盘的全部快照。 磁盘名称 是 自定义所创建的磁盘名称。 不能使用中文，且长度为263字符。 企业项目 是 支持为云硬盘选择企业项目。 数量 是 创建云硬盘的数量，默认为“1”，表示只创建一个云硬盘。 注意 目前一次最多可批量创建100个云硬盘。 创建时长 是 如果计费类型选择“包年/包月”，则需要选择购买时长，可选取的时间范围为1个月到5年。 自动续订 否 启用自动续订，包年/包月订购的云硬盘到期后会自动续订。 6. 确定云硬盘的配置信息后，点击“下一步”。 7. 在“资源详情”页面，您可以再次核对云硬盘信息。确认无误后，阅读并勾选服务协议，单击“确认下单”，开始创建云硬盘。如果还需要修改，点击“上一页”，修改参数。 8. 在云硬盘主页面，查看云硬盘状态。待云硬盘状态变为“未挂载”时，表示创建成功。

接口功能介绍 获取导入密钥材料 接口约束 请保证账户余额大于0 URI POST /v1/importKey/getParametersForImport 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥唯一标识id 474e569e8814474a948bdbcf6d853eff wrappingAlgorithm 是 String 用于加密密钥材料的算法 RSAESPKCS1V15 wrappingKeySpec 是 String 用于加密密钥材料的公钥类型 RSA2048 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 生成导入密钥材料成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 importToken String 导入令牌 Base64String requestId String 请求id 7116be15b4c743d5a334bacf95585b38 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff publicKey String 用于加密密钥材料的公钥 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwIDAQAB tokenExpireTime String 令牌过期时间 20180125T00:01:02Z

接口功能介绍 获取导入密钥材料 接口约束 请保证账户余额大于0 URI POST /v1/importKey/getParametersForImport 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥唯一标识id 474e569e8814474a948bdbcf6d853eff wrappingAlgorithm 是 String 用于加密密钥材料的算法 RSAESPKCS1V15 wrappingKeySpec 是 String 用于加密密钥材料的公钥类型 RSA2048 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 生成导入密钥材料成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 importToken String 导入令牌 Base64String requestId String 请求id 7116be15b4c743d5a334bacf95585b38 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff publicKey String 用于加密密钥材料的公钥 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwIDAQAB tokenExpireTime String 令牌过期时间 20180125T00:01:02Z

接口功能介绍 创建应用接入点 接口约束 无 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 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 url String 调用地址 < endpointId String 终端节点id endpointtmncs8h97b vpcId String vpc id vpchu189akjd subnetId String 子网id subnetqc90zmk12u jobId String 3.0资源池返回共享vpc创建任务id jobdjewhc39xe applicationStatus String 应用接入点状态 2

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

介绍媒体存储的视频截帧能力。 通过视频截帧功能，用户可以在GetObject请求中携带视频截帧处理参数对视频文件进行处理，服务默认会保存视频截帧的图片，图片会保存在视频所在 bucket 的 snapshot 目录下面。 本文介绍视频截帧操作涉及的参数说明及使用示例。 适用区域 本功能目前仅部分资源池支持，具体可参考：资源池与区域节点。 如需使用，可联系客户经理或提交工单申请。 注意事项 仅支持对视频编码格式为H264和H265的视频文件进行视频截帧。 媒体存储默认会保存视频截帧的图片，图片会保存在视频所在 bucket 的 snapshot 目录下面。 参数说明 操作分类：video 操作名称：snapshot 参数 描述 取值范围 t 指定截图时间。 [0,视频时长] 单位：ms w 指定截图宽度，如果指定为0，则自动计算。 [0,视频宽度] 单位：像素（px） h 指定截图高度，如果指定为0，则自动计算; 如果w和h都为0，则输出为原视频宽高。 [0,视频高度] 单位：像素（px） m 指定截图模式，不指定则为默认模式，根据时间精确截图。如果指定为fast，则截取该时间点之前的最近的一个关键帧。 枚举值：fast f 指定输出图片的格式。 枚举值：jpg、png

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

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

接口功能介绍 创建iplistener 接口约束 无 URI POST /v4/iplistener/create 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 gwLbID 是 String 网关负载均衡 ID gwlbxxx name 是 String 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 test description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:"{},./;'[]·！@ ￥%……&（） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc action 是 Object 动作配置 action 表 action 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 默认规则动作类型。取值范围：forward forward forwardConfig 是 Object 转发配置，当type为forward时，此字段必填 fowardConfig 表 forwardConfig 参数 是否必填 参数类型 说明 示例 下级对象 targetGroups 是 Array of Objects 后端服务组 targetGroup 表 targetGroup 参数 是否必填 参数类型 说明 示例 下级对象 targetGroupID 是 String 后端服务组ID tg0xxx weight 否 Integer 权重，当前只支持配置100 100

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

接口功能介绍 获取非对称密钥公钥 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/getPublicKey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id 2ab1a98370724bbca5826387f05ae0d8 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取非对称公钥成功 returnObj Array of Objects 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 93744738dc6d4f90b2d20d537b5d64e1 publicKey String 非对称密钥公钥 BEGIN PUBLIC KEY MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAERveD+oLdkLEqGVJ5Me/3pf5cnhda j1S/3n0qjm1Zokp1RuU60C9nZxVbsQi8KEII9f5h0ZpGMsYpgW4rsCwRhg END PUBLIC KEY cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792

自定义事件 自定义事件：删除 接口功能介绍 调用此接口可删除自定义事件。 接口约束 资源池ID，自定义事件ID列表不能为空。 URI POST /v4/monitor/deletecustomevents 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b customEventIDList 是 Array of Strings 自定义事件ID列表 ['EVENT78901234t678a901202306301809'] 响应参数 参数 参数类型 说明 示例 下级对象 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/deletecustomevents 请求头header 无 请求体body json { "regionID":"81f7728662dd11ec810800155d307d5b", "customEventIDList":["EVENT78901234t678a901202306301809"] }

监控看板 监控看板：批量删除 接口功能介绍 删除监控看板。 接口约束 参见请求参数说明。 URI POST /v4/monitor/monitorboard/delete 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b boardIDs 是 Array of Strings 要删除的监控看板ID ['ab6fe00f971dd17ff5db493f0cb628e6'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否删除成功 true 请求示例 请求url /v4/monitor/monitorboard/delete 请求头header 无 请求体body json { "regionID": "1234567890", "boardIDs": ["868b84d01a6fb6b28b7f26bdf85f96ab"] }

接口功能介绍 获取接入点的接口权限详情 接口约束 无 URI POST /v1/applicationAccessPointManage/listPointUriPolicy 路径参数 无 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 参数 参数类型 说明 示例 下级对象 list Array of Strings 接口权限详情 ["kms:cmk:create","kms:cmk:create"] 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" } 响应示例 plaintext { "statusCode": 200, "message": "获取Uri权限详情成功", "returnObj": { "list": [ "kms:cmk:create", "kms:cmk:create" ] } } 状态码 请参考状态码章节 错误码 请参考错误码章节

参数名 类型 名称 code int 状态码 message str 信息描述 SnapshotInfoList list 截图列表 SnapshotInfoList:OssObjectPrefix dict 截图存储信息 OssBucket str OSS的Bucket名称 OssRegion str OSS的Region名称 OssEndpoint str OSS的服务地址

介绍分布式消息服务Kafka与天翼云其他服务关系。 虚拟私有云(CTVPC ，Virtual Private Cloud) 虚拟私有云为分布式消息服务Kafka提供一个逻辑隔离的区域，构建一个安全可靠、 可配置和管理的虚拟网络环境。更多信息请参见虚拟私有云。 弹性云主机（CTECS，Elastic Cloud Server） 分布式消息服务Kafka订购后，默认按照用户选择的实例规格开通弹性云主机，云主机由 CPU、内存、镜像、云硬盘组成，同时结合VPC、安全组、数据多副本保存等能力，打造一个既高效又可靠安全的计算环境，确保分布式消息服务Kafka持久稳定运行。更多信息请参见弹性云主机。 云硬盘（CTEVS，Elastic Volume Service） 分布式消息服务Kafka订购后，默认按照用户选择的存储大小开通云硬盘。云硬盘是一种可弹性扩展的块存储设备，可以为分布式消息服务Kafka提供高性能、高可靠的块存储服务。更多信息请参见云硬盘。 弹性IP（Elastic IP，EIP） 弹性IP是可以独立申请的公网 IP 地址，包括公网IP地址与公网出口带宽服务。可以与分布式消息服务Kafka动态绑定和解绑，实现云资源的互联网访问。针对需要公网访问分布式消息服务Kafka实例的需求，用户可开通弹性IP后，在Kafka实例开通页面进行绑定。更多信息请参见弹性IP。

操作步骤 1. 登录管理控制台。 2. 单击服务列表，选择“存储 > 存储容灾服务 SDRS”。进入“存储容灾服务”页面。 3. 在“异步复制”页面，单击待创建保护实例所在站点复制对所在行操作列的“创建保护实例”。进入创建保护实例页面。 4. 在“创建保护实例”页面，根据界面提示配置保护实例的信息。 5. 单击“下一步”，进入容灾配置信息确认界面，配置信息确认后，单击“提交”。 6. 当保护实例状态从“创建中”变为“已保护”，说明保护实例创建成功，此时已开始初始数据同步。 7. 等待12分钟，保护实例状态更改为“同步中”，并显示剩余待同步数据量以及预估剩余时间。 8. 当保护实例状态显示为“同步完成”，并在操作栏可选择“切换”时，说明初始同步已完成。 说明 1. 初始同步会将服务器所有磁盘数据全量复制到容灾端磁盘，同步完成时间与磁盘的总容量相关，容量越大同步完成所花的时间越长。 2. 初始同步速率由多种因素决定，包括服务器业务负载、网络质量、网络带宽，通常业务负载越小、网络质量越好同步速率更快，单实例同步带宽最大可达60MB/s。 3. 在保护实例页面查看到的保护实例数据上传带宽为数据压缩后的带宽，通常会小于实际的数据传输带宽。 4. 同步过程中显示的进度百分比，由于故障同步断开或手动停止开启后，百分比计算当前同步周期的进度，不累计上次的同步进度，因此可能会出现进度重新从0%开始。 表 参数说明 参数 说明 取值样例 生产站点服务器 选择需要保护的生产站点服务器； 容灾站点云硬盘类型 为生产站点服务器的每块硬盘，根据需求选择对应的容灾站点云硬盘的类型。 说明 创建的容灾站点云硬盘，系统盘为VBD模式，数据盘为SCSI模式。 保护实例名称 设置保护实例的名称。名称只能由中文字符、英文字母、数字、“”、“”和“.”组成，且不能有空格，长度不能大于64个字符。 protectedinstance01 保护组 为保护实例选择一个保护组。 首次创建保护实例或者当前的保护组不满足要求时，可以单击“创建保护组”创建新的保护组。 建议将某类业务相关的服务器放到一个保护组进行保护，可以对整个保护组进行开启保护、切换和容灾演练等操作。 protectedgroup01

接口功能介绍 查询云专线列表 接口约束 传参规范 URI GET /vfw/v2assertcdaquery 路径参数 无 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 资产列表 CdaView 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 总记录数 表 CdaView 参数 参数类型 说明 示例 下级对象 id Long id vrfName String 专线网关ID vrfId String 专线网关名字 vpcId String vpc id vpcName String vpc名称 vpcCidr String vpc的网段 subnets String 子网信息 remoteConnectIp String 远端互联IP remoteConnectIpv6 String 远端互联IPv6 protectStatus Boolean 防护状态false;true syncStatus String 同步状态 add, delete, unchanged firewallId String 防火墙id firewallEdition String 防火墙版本号 cdaId String 物理专线id cdaName String 物理专线名称 endpoint Object 终端节点 GwlbeInfoVo 表 GwlbeInfoVo 参数 参数类型 说明 示例 下级对象 endpointName String 终端节点名称 endpointId String 终端节点id vpcName String Vpc名称 subnetName String 子网名称 description String 描述

基准 优化前 优化后 加载时间（11张表） 341584ms 257241ms 占用存储 StoreSales 42GB 14GB DateDim 11MB 27MB Store 232kB 4352kB Item 110MB 259MB TimeDim 11MB 14MB Promotion 256kB 3200kB CustomerDemographics 171MB 11MB CustomerAddress 170MB 27MB HouseholdDemographics 504kB 1280kB Customer 441MB 111MB IncomeBand 88kB 896kB 总存储空间 42GB 15GB 查询执行时间 查询1 14552.05ms 1783.353ms 查询2 27952.36ms 14247.803ms 查询3 17721.15ms 11441.659ms 总执行时间 60225.56ms 27472.815ms

接口功能介绍 虚机弹性IP绑定或者解绑v3 接口约束 无 URI POST /v3/fip/action 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 虚机ID fipOid 是 String 弹性IP ID portOid 否 String 虚机网卡ID，操作类型为绑定时必填 action 是 String 操作类型，绑定：bind，解绑：unbind 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopOid":"D0025042501321534", "fipOid":"fipuwk3p534tu2kti3uxt0cz", "portOid":"portjvwzy8cyp3ji5vqaei7t3", "action":"bind" }