防护对象 WAF支持的防护对象：域名或IP，云上或云下的Web业务。

接口介绍 此接口用于终止分片上传。 接口约束 无 请求URI DELETE /v1/uploads/{bucket}/{objectName} 路径参数 参数 是否必填 参数类型 说明 示例 bucket 是 String 桶名称 testBucket objectName 是 String 对象名称 test Query参数 参数 是否必填 参数类型 说明 示例 下级对象 uploadId 是 String uploadId用于标识分段上传 请求参数 请求头header参数 此接口涉及的其他公共请求头，例如Host、Date等的更多信息，请参见公共HTTP头。 请求体body参数 无 响应参数 无 请求示例 http DELETE /v1/uploads/testbucket/test?uploadId9GSpv6cxEbmQCXNzLf6mMiCPNQ9nIck 请求头header http Host: gdoss.xstore.ctyun.cn Date: Wed, 28 Oct 2023 09:32:00 GMT Authorization: authorization string 请求体body 无 响应示例 HTTP/1.1 204 No Content xamzrequestid: 996c76696e6727732072657175657374 Date: Mon, 1 Nov 2010 20:34:56 GMT 状态码 HTTP状态 描述 204 操作成功。 403 用户没有权限执行操作。 404 操作指定的桶或对象key或uploadId不存在。

接口功能介绍 查询弹性伸缩组设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在弹性伸缩组设备。 URI POST /v4/monitor/queryscalinglatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID deviceUUIDList Array of String 是 ["scalb474007ec035455bbc683ed6c431bc431992"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 2 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 scalb474007ec035455bbc683ed6c431bc431992 fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID scalb474007ec035455bbc683ed6c431bc431992 itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

接口功能介绍 查询云磁盘设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在云磁盘设备。 URI POST /v4/monitor/querydisklatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 73f321ea62ff11eca8bc005056898fe0 资源池ID deviceUUIDList Array of String 是 ["02a168a3263144deb"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 138 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 73f321ea62ff11eca8bc005056898fe0 fUID String 唯一键 02a168a3263144deb fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID 02a168a3263144deb itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

接口功能介绍 查询云主机设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在云主机设备。 URI POST /v4/monitor/queryvmlatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID deviceUUIDList Array of String 是 ["000f03221f4d8cc8bb2e1c30fb751aa5"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 138 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 3c7b4997ca5148858e530d1a2b37ccc0 fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID 3c7b4997ca5148858e530d1a2b37ccc0 itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

接口功能介绍 删除黑白名单接口 接口约束 请保证ruleId存在 URI POST /vfw/v2blackwhitepolicydelete 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 blackWhiteType 是 String 黑白类型，black:,white: firewallId 是 String 防火墙ID ruleId 是 Long 规则ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "blackWhiteType": "black", "firewallId": "dca4f9ffaca2447aa24310c1e62c4690", "ruleId": 321,"uid": "562b89493b1a40e1b97ea05e50dd8170" }

接口功能介绍 地址簿删除IP 接口约束 传参规范 URI POST /vfw/v2addresscontentremove 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ids 是 Array of Longs ids [1] groupId 是 Integer 地址簿id 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Integer 接口返回结果 1 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "groupId": 9, "ids": [110] } 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj": 1 }

接口功能介绍 查询apr支持的全部应用 接口约束 传参规范 URI GET /vfw/v2appqueryAll 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Array of Objects 接口返回结果 AppInfoEntity 表 AppInfoEntity 参数 参数类型 说明 示例 下级对象 id Long 自增id 1111 name String app名称 迅雷 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body 无 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj": [ { "id" :1, "name": "名称" } ] }

接口功能介绍 更新投递任务状态 接口约束 传参规范 URI POST /vfw/v2logupdatedeliverstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 id 是 Long 任务id deliverStatus 是 Integer 投递状态 0不投递 1投递 firewallId 是 String 防火墙id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "id": 162, "firewallId": "91e76b89efea420595fd859baf4eb2e4", "deliverStatus": false }

接口功能介绍 降配配额最低值 接口约束 传参规范 URI GET /vfw/v2minquota 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 MinQuotaVo 表 MinQuotaVo 参数 参数类型 说明 示例 下级对象 protectIpNum Integer 防护ip最小值 vpcQuota Integer vpc配额最小值 1 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!", "returnObj": [ "protectIpNum": 20, "vpcQuota": 3 } }

接口功能介绍 能否订购防火墙 接口约束 传参规范 URI GET /vfw/v2canbugfirewall 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 CanDowngradeVo 表 CanDowngradeVo 参数 参数类型 说明 示例 下级对象 result Boolean 能否订购 error String 原因 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!", "returnObj": { "result": false, "error": "已有防火墙无需重复开通" } }

接口功能介绍 查询指定时间段内的弹性伸缩组时序指标监控数据。 接口约束 regionID（资源池）、deviceUUIDList（弹性伸缩组资源）、itemNameList（待查监控项名称）存在。 URI POST /v4/monitor/queryscalinghistorymetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID itemNameList Array of String 是 ["cpuutil","memutil"] 待查的监控项名称 startTime String 是 1667815639 查询起始时间戳 endTime String 是 1667817639 查询结束时间戳 deviceUUIDList Array of String 是 ["8c6a2a5d71044e239c47bf8c17c00686240"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID period Integer 否 300 聚合周期，单位：秒，默认300 pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 2 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 14 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 00229aa9ce6bb46f4b7ddf61f48a5903 deviceUUID String 设备ID 00229aa9ce6bb46f4b7ddf61f48a5903 fuserLastUpdated String 最近更新时间 20221107 18:25:12 itemAggregateList Array of Objects 监控项值列表 itemAggregateList 表itemAggregateList 参数 参数类型 说明 示例 下级对象 {itemName} Array of Objects 监控项内容 valueObject 表valueObject 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采样时间 1667815639 value String 监控项值，具体请参考对应监控项文档 524288

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 errorCode String 错误码，为product.module.code三段式码 Openapi.PatternCheck.NotValid error String 错误码，为product.module.code三段式码 Openapi.PatternCheck.NotValid message String 英文描述信息 SUCCESS description String 中文描述信息 成功 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 currentCount Integer 当前页记录数目 1 totalCount Integer 总记录数 1 totalPage Integer 总页数 1 results Array of Objects 分页明细 results 表 results 参数 参数类型 说明 示例 下级对象 decHostStatus String 宿主机状态 up decHostName String 展示给用户的宿主机名称 host01 cpuRatio Float CPU的倍频 1 totalVMs Integer 总的虚机数量 2 usedVCPUs Integer 已用vCPU的数量 3 usedMemSize Integer 已用内存大小，单位MB 154618822656 totalMemSize Integer 总内存大小，单位MB 539182649344 totalVCPUs Object 总CPU数量 autoDeployed Boolean 是否自动部署： True ：自动部署， False ：非自动部署 true runningVMs Integer 运行中的云主机数量 2 decHostID String 宿主机UUID 417cdb4bde54e5e562dab78533a45b38 cpuInfo Object cpu信息 cpuInfo azName String 可用区名称 cnhuadong1jsnj1Apublicctcloud 表 cpuInfo 参数 参数类型 说明 示例 下级对象 vendor String 制造商 intel model String CPU模式 arch String 架构 x86 featureList Array of Strings CPU特性，比如["pku","rtm"]等 topology Object cpu拓扑结构 topology 表 topology 参数 参数类型 说明 示例 下级对象 cores Integer 核数 16 cells Integer cell数 2 threads Integer 线程数 2 sockets Integer 套接字数 2

接口功能介绍 查询NAT网关列表v3 接口约束 无 URI GET /v3/nat/describe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx name 否 String NAT网关名称 pageNum 否 Integer 页码，至少1，默认1 pageSize 否 Integer 每页数量，最大100，默认10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 total Long 总记录数 list Array of Objects 数据列表 list 表 list 参数 参数类型 说明 示例 下级对象 natOid String NAT网关ID XXXXXXXXXXXXX name String NAT网关名称 vpcOid String VPC ID vpcName String VPC名称 subnetName String 子网名称 subnetCidr String 子网网段 spec String 规格（LITTLE小型;LARGE大型） description String 描述 source String 来源（RESOURCEPACK资源包） status String NAT网关状态（CREATING创建中;ACTIVE正常;FROZEN冻结中;DELETING删除中;ERROR异常） createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。

参数 参数说明 协议端口 请选择对应的协议类型和端口，目前支持TCP和UDP协议。 源对象命名空间 选择允许哪个命名空间的对象允许访问。 源对象Pod标签 选择允许带有这个标签的Pod访问。

接口功能介绍 批量休眠云电脑，前提条件：云电脑处于运行中状态。 接口约束 无 URI POST /v3/desktop/batch/suspend 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID XXXXXXXXXXXXX6925 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopList":[{ "desktopOid":"XXXXXXXXXXXXX6925" }] }

接口功能介绍 批量唤醒云电脑，前提条件：云电脑处于休眠状态。 接口约束 无 URI POST /v3/desktop/batch/resume 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID XXXXXXXXXXXXX6925 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopList":[{ "desktopOid":"XXXXXXXXXXXXX6925" }] }

接口功能介绍 查询访问云电脑的IP和MAC限制 接口约束 无 URI GET /v3/desktop/getAccessIpAndMac 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 desktopOid 是 String 云电脑ID D0023092101180485 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据对象 { } returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 externalIpListString String 外网IP地址 ipListString String 客户端IP地址 macListString String MAC地址 hardwareCodeListString String 设备唯一码 routerMacListString String 限制路由器MAC地址 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 {"statusCode":800,"message":"OK.","returnObj":{"externalIpListString":"123.123.123.123"}}

本文介绍使用圆角矩形裁剪图片时所用到的参数及示例。 功能说明 通过圆角矩形参数，可以将存储在媒体存储中的矩形图片的4个角切成圆角。 参数说明 操作名称：roundedcorners 相关参数如下： 参数 描述 取值范围 r 将图片切出圆角，指定圆角的半径。 [1,4096] 注意事项 如果图片的最终格式是PNG、WebP或BMP等支持透明通道的图片，那么图片非圆形区域的部分将会以透明填充。如果图片的最终格式是JPG，那么非圆形区域是以白色进行填充。推荐保存成PNG格式。 如果指定圆角的半径大于原图最大内切圆的半径，则按照图片最大内切圆的半径设置圆角（即r原图最小边÷2） 示例 裁剪半径为100，保存为JPG格式，外围以白色填充，具体图片处理参数为： ?xamzprocessimage/roundedcorners,r100 裁剪半径为100，保存为PNG格式，外围以透明色填充，具体图片处理参数为： ?xamzprocessimage/roundedcorners,r100/format,png

指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） usedprotectionbandwidth 防护带宽使用量 该指标用于统计近5分钟内CFW检测到的互联网带宽使用量。 单位：KB/s ≥ 0 值类型：Float 云防火墙 5分钟 protectionbandwidthusage 防护带宽使用率 该指标用于统计5分钟内CFW检测到的互联网带宽使用率。 单位：百分比 采集方式：带宽使用量/防火墙带宽配额的占比。 ≥ 0 值类型：Float 云防火墙 5分钟 internetprotectionbandwidthusage 互联网防护带宽使用量 该指标为防火墙互联网防护对象带宽使用量。 单位：Bit/s ≥ 0 值类型：Float 云防火墙 每分钟 vpcprotectionbandwidthusage VPC间防护带宽使用量 该指标为防火墙VPC间防护对象带宽使用量。 单位：Bit/s ≥ 0 值类型：Float 云防火墙 每分钟 internetprotectionbandwidthusagerate 互联网防护带宽使用率 该指标为防火墙互联网防护对象带宽使用率。 单位：% ≥ 0 值类型：Float 云防火墙 每分钟 vpcprotectionbandwidthusagerate VPC间防护带宽使用率 该指标为防火墙VPC间防护对象带宽使用率。 单位：% ≥ 0 值类型：Float 云防火墙 每分钟 internetprotectionpps 防火墙互联网方向pps 该指标为防火墙互联网防护对象pps 单位：个 ≥ 0 值类型：Float 云防火墙 每分钟 vpcprotectionpps 防火墙VPC间pps 该指标为防火墙VPC间防护对象pps 单位：个 ≥ 0 值类型：Float 云防火墙 每分钟 ipshitcount IPS规则命中次数 该指标为流量命中IPS规则的次数 ≥ 0 值类型：Int 云防火墙 每分钟 ipsdenycount IPS规则阻断次数 该指标为流量被IPS规则阻断的次数 单位：个 ≥ 0 值类型：Int 云防火墙 每分钟 aclhitcount ACL规则命中次数 该指标为流量命中ACL规则的次数 单位：个 ≥ 0 值类型：Int 云防火墙 每分钟 acldenycount ACL规则阻断次数 该指标为流量被ACL模块阻断的次数 单位：个 ≥ 0 值类型：Int 云防火墙 每分钟 internetprotectionbandwidthusageinbound 入网防护带宽 该指标为防火墙互联网防护对象入方向带宽大小。 单位：Bit/s ≥ 0 值类型：Float 云防火墙 每分钟 internetprotectionbandwidthusageoutbound 出网防护带宽 该指标为防火墙互联网防护对象出方向带宽大小。 单位：Bit/s ≥ 0 值类型：Float 云防火墙 每分钟 internetprotectionbandwidthusagerateinbound 入网防护带宽使用率 该指标为防火墙互联网防护对象入方向带宽/互联网边界防护带宽。 单位：% ≥ 0 值类型：Float 云防火墙 每分钟 internetprotectionbandwidthusagerateoutbound 出网防护带宽使用率 该指标为防火墙互联网防护对象带宽出方向使用率。 单位：% ≥ 0 值类型：Float 云防火墙 每分钟 internetprotectionppsinbound 入网pps 该指标为访问防火墙互联网防护对象pps 单位：个 ≥ 0 值类型：Float 云防火墙 每分钟 internetprotectionppsoutbound 出网pps 该指标为防火墙互联网防护对象访问外网pps 单位：个 ≥ 0 值类型：Float 云防火墙 每分钟

本文介绍如何对无用的文件进行单次或批量的删除。 使用场景 为了节省空间和成本，您可以根据需要删除无用的文件或文件夹。 注意 当桶中未开启多版本控制功能时，删除的文件无法恢复。 删除文件夹的同时会删除文件夹下的文件。 删除的文件不支持取消删除，请谨慎操作。 手动删除和自动删除 您可以随时手动删除对象，也可以通过生命周期管理功能定期自动删除桶中的文件。 单个删除和批量删除 ZOS支持文件的单次和批量删除。 说明 批量删除的性能与单个请求中的文件数量成负相关。对于QPS的计算，删除n个对象，进行n次运算。如果删除的对象数量很大，并且对象前缀按字典顺序排列，可能会导致大量请求访问的对象集中在特定分区，从而产生访问热点。热点分区的请求速率受限，访问延迟增加。 对于并行文件系统目录场景（目录层级深、目录下文件多）的删除，可能会因超时而删除失败。 要解决上述问题，可以考虑减少单次批量删除请求中的文件数量，通过多次请求实现删除更多数量的文件或者目录。您也可以通过生命周期管理功能后台自动删除文件。 多版本控制功能启用时的文件删除 当bucket的多版本控制功能启用时，ZOS将对不同的删除目标采取不同的处理方式： 删除文件或文件夹：文件或文件夹不会立即被完全删除，会作为历史版本保留下来，并且文件会被标记为已删除。 如果您想完全删除它，可以通过彻底删除进行删除。 被删除的文件可以通过“恢复”功能进行恢复。详情请参见恢复文件。 删除指定版本的文件：该版本将被完全删除，并且无法恢复。如果文件的最新版本被删除，则历史版本将成为最新版本。 在启用多版本控制功能的场景下，“已删除文件”中的文件仍然会保留多个版本。

接口功能介绍 查询地址簿列表 接口约束 传参规范 URI GET /vfw/v2addressgroupquery 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 ip 否 String 校验合法 1.1.1.1 addressType 否 String 地址簿类型v4;v6;port v4 addressGroupName 否 String 地址簿名称 name groupId 否 Long 地址簿id 1 page 否 Integer 页码 1 size 否 Integer 页大小 10 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 800 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 total Integer 总记录数 1 list Array of Objects 结果集 AddressGroupQueryView 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 表 AddressGroupQueryView 参数 参数类型 说明 示例 下级对象 groupId Integer 地址簿id 1 addressGroupName String 地址簿名称 name description String 地址簿描述 描述 addressType String 地址簿类型v4;v6;port v4 num Integer ip数量 2 isReferenced Boolean 是否被引用 true

接口功能介绍 查询前端操作日志 接口约束 传参规范 URI GET /vfw/v2operationlogquery 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 action 否 String 操作行为 TURNONFIREWALL beginTime 是 Long 开始时间 1697521149 content 否 String 日志内容 防火墙 endTime 是 Long 结束时间 1697607549 firewallId 是 String 防火墙id 15ad84ceea634d3db01a102faf4b0095 page 否 Integer 当前页页码 1 severities 否 Array of Strings severity严重程度 HIGH size 否 Integer 当前页的list元素数量 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 结果集 OperationLogEntity 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 String 所有导航页号 [1] navigateFirstPage Integer 导航条上的第一页 1 navigateLastPage String 导航条上的最后一页 1 表 OperationLogEntity 参数 参数类型 说明 示例 下级对象 action String 操作行为 content String 日志内容 firewallId String 防火墙ID regionId String 资源池ID severity String severity严重程度 uid String 租户ID

本文介绍防盗链功能的使用场景和方式。 使用场景 一些不良网站为了扩充内容，不惜盗用其他网站的链接，以降低成本。这种行为不仅损害了原网站的合法利益，还加重了服务器的负担。为了解决这一问题，防盗链的技术应运而生。 在HTTP协议中，网站可以通过表头字段"Referer"来检测目标网页访问的来源网页。通过跟踪来源，网站可以采取技术手段进行处理，一旦检测到来源不是本站会进行阻止。防盗链是利用"Referer"设置，去检测请求来源的"Referer"字段信息是否与白名单或黑名单匹配。若与白名单匹配成功，则允许请求访问。否则阻止请求访问。 为了防止其他人在未授权的情况下盗用ZOS的数据，ZOS提供了一种基于HTTP请求头中referer字段的防盗链方法，支持访问白名单和访问黑名单的设置。 Referer规则 Referer可以设置多个，多个Referer换行隔开。 HTTP请求头中的Referer参数用于指定发出请求的资源的URL。该参数可以包含通配符（）和问号（?），通配符可以代替0个或多个字符，而问号可以代替单个字符。 下载文件时，如果Referer头域包含http或https，则必须将Referer设置包含http或https。 空Referer表示HTTP或HTTPS请求中，不带Referer字段或Referer字段为空。如果不允许空Referer，则只有HTTP或HTTPS header中包含Referer字段的请求才能访问ZOS资源。 白名单Referer为空，黑名单Referer不空时，允许所有黑名单中指定网站以外的其他网站的请求访问目标桶中的数据。若对象是私有，黑名单中指定网站以外的其他网站的请求访问时需校验AKSK，有权限的账号才能访问；若对象是公共读，则不校验AKSK权限。 白名单Referer不为空，黑名单Referer为空或不空时，允许在白名单且不在黑名单中的网站的请求访问目标桶中的数据。当请求来源是白名单referer，不管对象是私有还是公共读，无需校验AKSK就能访问。 同时配置白名单和黑名单，当白名单Referer与黑名单Referer内容有交集时，交集部分Referer被禁止。当请求是白名单中非交集的部分，不管对象是私有还是公共读，无需校验AKSK权限就能访问。 黑名单Referer与白名单Referer都为空时，默认允许所有网站的请求访问目标桶中的数据。若对象是私有，需校验AKSK，有权限的账号才能访问；若对象是公共读，则不校验AKSK权限。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 itemList Array of Objects 监控项数据 itemList 表 itemList 参数 参数类型 说明 示例 下级对象 itemName String 监控项名称 cpuutil itemDesc String 监控项中文介绍 CPU使用率 itemUnit String 监控项单位 bit/s value Double 监控项值，具体请参考对应监控项文档 0.2169 timestamp Long 监控数据采样Unix时间戳 1667816712 dimensions Array of Objects 监控项标签 dimension unitRelations Array of Objects 单位转换字典 unitRelation 表 dimension 参数 参数类型 说明 示例 下级对象 name String 监控项标签键 uuid value String 监控项标签键对应的值 9dc489794e1945e2b5235d3c70d516b3 表 unitRelation 参数 参数类型 说明 示例 下级对象 unit String 单位 % weight Double 权重 1

接口功能介绍 查询密钥别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/listAlias 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNumber 是 String 页数 1 pageSize 是 String 每页展示的别名数量 10 instanceId 否 String 实例Id，非必传，当为空时列出所有别名，不为空时列出指定实例下的别名 insX63C8r 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 查询成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount String 别名总数 100 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d pageSize String 每页展示的别名数量 10 pageNumber String 页数 1 aliases String 别名信息 aliases 表 aliases 参数 参数类型 说明 示例 下级对象 alias Array of Strings 别名信息 aliasList 表 aliasList 参数 参数类型 说明 示例 下级对象 aliasName String 别名 addqweqwsd cmkUuid String 密钥id 00f57b8191d54b6590076195528f8a37

接口功能介绍 通过密钥id查询别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/listAliasByUuid 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff pageNumber 是 String 页数 1 pageSize 是 String 每页展示的别名数量 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 查询成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount String 别名总数 100 requestId String 请求id cb3deacae51e489ab7d1ed361bd62292 pageSize String 每页展示的别名数量 10 pageNumber String 页数 1 aliases Array of Strings 别名信息 aliases 表 aliases 参数 参数类型 说明 示例 下级对象 alias Array of Objects 别名信息 aliasList 表 aliasList 参数 参数类型 说明 示例 下级对象 aliasName String 别名 addqweqwsd cmkUuid String 密钥id 00f57b8191d54b6590076195528f8a37

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 itemList Array of Objects 监控项列表 item 表 item 参数 参数类型 说明 示例 下级对象 itemName String 监控项名称 cpuutil itemDesc String 监控项中文介绍 CPU使用率 itemUnit String 监控项单位 bit/s itemData Array of Objects 监控项内容 itemData dimensions Array of Objects 监控项标签 dimension 表 itemData 参数 参数类型 说明 示例 下级对象 value Float 监控项值，具体请参考对应监控项文档 524288 timestamp Integer 监控数据Unix时间戳 1667815639 表 dimension 参数 参数类型 说明 示例 下级对象 name String 监控项标签键 uuid value String 监控项标签键对应的值 9dc489794e1945e2b5235d3c70d516b3

本页展示天翼云TeleDB数据库与Oracle、MySQL和SQL Server的对照信息。 与Oracle对照表 注意 需开启oracle兼容配置。 Oracle TeleDB Number 对应smallint, integer, bigint, numeric(p,s) 等多种数据类型。由于 smallint，Integer，bigint的算术运算效率比numeric高得多，所以要视业务需要转换成对应的smallint, integer, bigint，无法转换时才转换成numeric(p,s) float float（实际按照double precision 或 real存储） binaryfloat binaryfloat（实际按照real存储） binarydouble binarydouble（实际按照double precision存储） char char nchar char varchar2 varchar2 nvarchar2 nvarchar2 rowid rowid urowid urowid（teledb不支持） long long（teledb不支持） clob clob nclob nclob（teledb不支持） blob blob bfile bfile（teledb不支持） long raw long raw（teledb不支持） raw raw（teledb不支持） date date timestamp timestamp interval interval 与MySQL 对照表 MySQL TeleDB int int smallint smallint bigint bigint int AUTOINCREMENT serial smallint AUTOINCREMENT smallserial bigint AUTOINCREMENT bigserial bit bit tinyint smallint float real double double precision decimal numeric char varchar varchar blob text text date date time time datetime timestamp longblob bytea Longtext text ENUM类型 CREATE TABLE TYPE022(COL1 ENUM('S','M','L','XL','XXL','XXXL') ,COL2 INT PRIMARY KEY); 自定义类型CREATE TYPE mood AS ENUM ('S','M','L','XL','XXL','XXXL');CREATE TABLE TYPE022(COL1 mood ,COL2 INT PRIMARY KEY) SET类型 CREATE TABLE TYPE023(COL1 SET('A','B', 'C','D') ,COL2 INT PRIMARY KEY) CREATE TABLE TYPE023(COL1 VARCHAR check(regexpsplittoarray(col1,',') <@ array['A','B','C','D']) ,COL2 INT PRIMARY KEY);

本页展示天翼云TeleDB数据库与Oracle、MySQL和SQL Server的对照信息。 与Oracle对照表 注意 需开启oracle兼容配置。 Oracle TeleDB Number 对应smallint, integer, bigint, numeric(p,s) 等多种数据类型。由于 smallint，Integer，bigint的算术运算效率比numeric高得多，所以要视业务需要转换成对应的smallint, integer, bigint，无法转换时才转换成numeric(p,s) float float（实际按照double precision 或 real存储） binaryfloat binaryfloat（实际按照real存储） binarydouble binarydouble（实际按照double precision存储） char char nchar char varchar2 varchar2 nvarchar2 nvarchar2 rowid rowid urowid urowid（teledb不支持） long long（teledb不支持） clob clob nclob nclob（teledb不支持） blob blob bfile bfile（teledb不支持） long raw long raw（teledb不支持） raw raw（teledb不支持） date date timestamp timestamp interval interval 与MySQL 对照表 MySQL TeleDB int int smallint smallint bigint bigint int AUTOINCREMENT serial smallint AUTOINCREMENT smallserial bigint AUTOINCREMENT bigserial bit bit tinyint smallint float real double double precision decimal numeric char varchar varchar blob text text date date time time datetime timestamp longblob bytea Longtext text ENUM类型 CREATE TABLE TYPE022(COL1 ENUM('S','M','L','XL','XXL','XXXL') ,COL2 INT PRIMARY KEY); 自定义类型CREATE TYPE mood AS ENUM ('S','M','L','XL','XXL','XXXL');CREATE TABLE TYPE022(COL1 mood ,COL2 INT PRIMARY KEY) SET类型 CREATE TABLE TYPE023(COL1 SET('A','B', 'C','D') ,COL2 INT PRIMARY KEY) CREATE TABLE TYPE023(COL1 VARCHAR check(regexpsplittoarray(col1,',') <@ array['A','B','C','D']) ,COL2 INT PRIMARY KEY);

接口功能介绍 查询接入点的资源权限列表 接口约束 无 URI POST /v1/applicationAccessPointManage/listPointResourcePolicy 路径参数 无 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 Objects 资源权限列表 resourcePolicyList 表 resourcePolicyList 参数 参数类型 说明 示例 下级对象 aliasName String 密钥别名 testccmk resourceId String 资源id 908b979ecd964d6499b7856a671ebc82 status Integer 资源状态 0 resourceType String 资源类型 cmk

专属云Kafka包括2个计费项：专属计费资源、专属存储（可选）。