接口功能介绍 导入uk证书 接口约束 无 URI POST /v1/manageCertificate/importCertificateForUK 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 algorithm 是 String 证书算法 SM2 cert 是 String 证书pem格式 ukName 是 String 证书别名 test epId 否 String 企业项目 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 9612627252624b61bf5cd66ca3c7a0b3

告警概览 告警Top实例 接口功能介绍 调用此接口可查询指定资源池下告警Top实例。 接口约束 regionID（资源池）存在。 URI GET /v4/monitor/queryalarmtopresource 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b range 否 String 时间范围，默认值:7d，取值示例：7d，24h，6h 分别代表最近7天，最近24小时，最近6小时。 时间范围最长不能超过3个月 7d 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 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 参数 参数类型 说明 示例 下级对象 service String 产品服务 ecs dimension String 产品维度 ecs serviceDesc String 产品服务描述 云主机 dimensionDesc String 产品维度描述 云主机 resource Array of Objects 告警实例 resource count Integer 告警次数 15 表 resource 参数 参数类型 说明 示例 下级对象 name String 实例名称 instancename value String 实例名称对应的值 test0218

接口功能介绍 调用此接口可根据时间范围查询指定资源池告警次数的变化趋势。 接口约束 regionID（资源池）存在,时间范围不为空，且只接受3个值：7d，24h，6h。 URI GET /v4/monitor/queryalarmtrend 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID timeRange String 是 24h 时间范围，7d，24h，6h代表最近7天，最近24小时，最近6小时 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 timeList Array of Objects 不同间隔告警数量 timeCount times Array of String 计算趋势的时间间隔 ["20221010T11:02:00Z","20221010T15:02:00Z"] 表timeCount 参数 参数类型 说明 示例 下级对象 timeStamp String 时间截至点，说明：timeStamp按升序排列，count数据是按时间区间计算出来的（时间边界下包上不包），timeStamp是取的下区间，他里面统计的是此下区间到他的上区间，他的上区间可参考times里的排序来结合看 20221010T11:02:00Z count Integer 时间间隔内告警数量 0

接口功能介绍 证书列表接口 接口约束 请保证账户余额大于0 URI POST /manageCertificate/listCertifiicate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 hmac 是 String kms鉴权值 B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw requestDate 是 String 时间戳 Wed, 29 Aug 2023 17:05:01 CST accessKey 是 String ctapi鉴权ak ae2cc5cc5e8211ea978a186590d96509 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 regionId 是 Integer 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNumber 否 Integer 页码 1 pageSize 否 Integer 每页显示证书数量 10 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码 取值范围：200 成功 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 证书状态更新成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 content List 证书列表 certInfo pageNumber Integer 当前页码 1 pageSize Integer 本页数量 10 totalCount Integer 证书总数 10 表 certInfo 参数 参数类型 说明 示例 下级对象 certificateId String 证书id c761ed38f58245ca996bd11e9740dec8 keySpec String 证书密钥类型 RSA2048 exportablePrivateKey Integer 证书私钥是否可导出 1：可 0：不可 1 subject String 证书主体 CN"defaultUserNameCNuserName", OUkms, Oaliyun, STBeiJing, CCN createdTime String 证书创建时间 20221107 18:15:34 status Integer 证书状态 1.PENDING待导入 2.ACTIVE启用 3.INACTIVE禁用 4.REVOKED已吊销 2

接口功能介绍 查询地址簿列表 接口约束 传参规范 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

功能说明 Delete Object Tagging从指定的对象中删除整个标记集。 注意事项 要使用此操作，您必须具有执行s3:DeleteObjectTagging操作的权限。要删除特定对象版本的标签，请在请求中添加versionId查询参数。您将需要s3:DeleteObjectVersionTagging操作的权限。 请求消息样式 plaintext DELETE /{Bucket}/{Key}?tagging&versionId{VersionId} HTTP/1.1 Host: xxx.zos.ctyun.cn AcceptEncoding: identity Date: Tue, 12 Apr 2022 11:03:15 GMT ContentLength: 0 Authorization: string 请求消息参数 参数名称 参数描述 类型 是否必须 Bucket 参数解释： Bucket的名称。 String 是 Key 参数解释： Object的名称。 String 是 VersionId 参数解释： 多版本场景下，指定对象的特定版本。不指定时，默认为最新版本的Id，如存在null版本号，并需对其操作，则需指定VersionId'null'。VersionId''等效于指定最新版本的Id。 String 否 请求消息头 该请求使用公共的请求消息头，请参见如何调用API构造请求请求消息头。 请求消息元素 该请求消息中不带消息元素。 响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000001c0062555c7434455default Date: Tue, 12 Apr 2022 11:03:16 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。

Spark整体heap内存是由 spark.executor.memory和spark.driver.memory控制的 Spark将spark.xxxx.memory内存分为 user heap（other）、execution heap、storage heap、system heap（300MB）。 spark.memory.fraction 可以将 spark.xxxx.memory分割出 heap storage 和 heap execution 两部分。 Heap storage Heap storage作用 Spark Heap Storage内存用于存储spark Rdd cache。 在spark SQL中也可以用于存储 view、或存储 cache table的表。 Heap storage不足 Heap storage不足一般发生在executor端。主要是因为 cache RDD 太多了，因为动态占用机制，占用heap execution空间，导致分配到当前executor的heap execution不够用，从而告警。 我们可以通过spark UI 查看 作业的storage 选项卡，定位告警的executor Id，查看cache的大小，与environment 选项卡中的spark.executor.memory做比对。 这种情况下，我们可以酌情，增加spark.executor.memory，或者uncache 或者 drop view 不需要的RDD 或者cached table。 Heap execution Heap execution作用 Heap execution 可以用于存储输入数据。 Spark是内存计算，需要将父RDD的partition读入内存中，这个数据将会被blockManager读入。 在spark shuffle map stage 或者 reduce stage都会发生读入操作。 Heap execution 可以用于shuffle 缓冲区 和 序列化反序列化。 Spark的一些使用heap缓冲区进行shuffle的场景需要分配heap space。 Heap execution空间不足 一般是读入的数据太多或者发生了数据倾斜。 spark shuffle map task读入hdfs文件块数据。 发生在shuffle map stage，spark需要读取hdfs 文件块。 这个文件快太大且不可分割，或者数据压缩密度太大，会导致task memory 急速膨胀，超过1/n 的 executor heap space 和 executor storage space总和。（此处的n是spark executor的running task数目）。 如果hdfs文件块可以分割读入task，尝试使用spark.files.maxPartitionBytes去分割读取的hdfs文件 或者 扩大 spark.executor.memory。但是后者不适用于个别hdfs大文件块情况。 如果hdfs 文件块是gzip这种的不可压缩，可能只能扩大spark.files.maxPartitionBytes，或者 在业务上有控制写入hdfs的文件格式是可分割的。 spark shuffle reduce task读入shuffle block数据太多了，也就是发生数据倾斜。 一般shuffle block 都会连续小幅度的拉入 reduce task侧，此时如果溢出，spark 会将这些数据spill disk。 如果出现reduce task读取超大shuffle block 或者 并发读取太快，会导致数据内存膨胀太快，而直接OOM。 此时spark会有task重启机制，会过滤并发过多情况。如果是读入shuffle block太大，则会反复的发生task failed情况。 此时可以适当降低map侧 shuffle write的shuffle block大小，可以尝试增加 shuffle reduce的并行度 或者 尽量使用sortBaseShuffleWriter，使用sortBaseShuffleWriter 可以实现map combiner。

本页介绍了文档数据库服务参数。 能否调整实例的时区设定 鉴于无法调整文档数据库服务的时区设置，您可以通过在应用程序中获取当前时间并将其插入到表中的方式来处理。 用户需要关注实例的哪些参数 storage.engine 这个参数用于指定 MongoDB 使用的存储引擎，默认为 WiredTiger。可以根据需求选择其他存储引擎，如 InMemory 引擎或 MMAPv1 引擎。 storage.wiredTiger.engineConfig.cacheSizeGB 对于使用 WiredTiger 存储引擎的 MongoDB，这个参数用于配置缓存大小，即存储引擎使用的内存量。根据数据量和可用内存设置合适的值。 net.maxIncomingConnections 这个参数限制 MongoDB 实例可以同时处理的连接数。通过适当设置这个参数，可以控制 MongoDB 的并发连接数量。 security.authorization 使用这个参数可以启用或禁用 MongoDB 的访问控制功能。设置为 true 时，需要进行身份验证才能访问 MongoDB。 MapReduce提示不支持JavaScript MapReduce是一种用于对大型数据集进行处理和分析的功能强大的工具。然而，从安全性和性能方面考虑，在某些情况下可能会限制使用JavaScript代码，包括在MapReduce中执行JavaScript代码。 这种限制的目的是为了减少潜在的安全风险，避免不当的代码执行以及提高执行效率。JavaScript代码的执行可能会引起一些潜在的问题，例如代码注入攻击和性能下降。 为了安全考虑，mongodb默认限制了JavaScript脚本的执行。 文档数据库服务数据一致性策略：writeConcern与readConcern的运用与限制 MongoDB的写入和读取是数据库操作中重要的两个方面。为了确保数据的可靠性和一致性，MongoDB提供了writeConcern和readConcern这两个机制。 当我们谈论writeConcern时，实际上是在谈论写入操作的策略。通过配置writeConcern，我们可以控制数据写入的行为。例如，当我们将writeConcern设置为"majority"级别时，MongoDB会确保数据被写入到大多数节点上，从而降低了数据丢失的风险。这意味着，即使部分节点发生故障，大多数节点仍然保存着相同的数据，保障了数据的可靠性。 而readConcern则是与读取操作相关的策略。当我们设置readConcern为"majority"级别时，MongoDB会确保所读取的数据已经被写入到了大多数节点上。这就消除了因为读取操作而引起的脏读问题，因为我们可以确信读取到的数据已经经过大多数节点的确认。 然而，需要注意的是，目前文档数据库服务并不直接支持设置readConcern为"majority"级别。但这并不妨碍我们保障数据的一致性。通过设置writeConcern为"majority"，我们可以将数据写入到大多数节点，从而实现了大多数节点数据的一致性。随后，通过读取单个节点的数据，仍然可以保证读取到的内容是已经经过多数节点确认的，避免了脏读的问题。

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj

本节介绍如何配置事件归并规则。 事件归并规则是对过滤后的事件，基于归并条件进行归并。可对事件归并规则进行新增、查看、编辑、删除、查询操作。 新增事件归并规则 1. 登录日志审计（原生版）控制台。 2. 在左侧导航栏选择“风险分析 > 事件策略 > 事件归并规则”。 3. 单击“新增规则”，进入“新增事件归并规则”页面。 4. 填写事件归并规则。带“”的为必选参数。 参数 是否必选 参数说明 取值样例 归并规则名称 必选 自定义归并规则名称。 Test 相关采集器 必选 选择日志采集器，目前仅可选择“logp”。 logp 过滤字段选择 必选 根据业务实际情况填写过滤字段。 目标端口等于8080 归并字段选择 必选 根据业务实际情况选择归并字段。 EVENTNAME 归并时间（秒） 必选 选择日志每次归并的时间，时间越长归并的日志越多。 30 归并后事件名 可选 自定义归并后的事件名称。若不配置，则默认为原事件名称。 Event1 归并后事件等级 可选 选择归并后日志事件的等级。若不选择，则默认为原事件等级。 轻微 归并后设置 必选 选择归并后日志数据是选择第一条数据，还是最后一条数据。 第一条 5. 填写完成后，单击“确认”，完成归并规则配置。

接口功能介绍 幂等接口，重复添加会忽略并视为添加成功。 接口约束 无 URI POST /v3/commonDesktopPool/addUsers 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 池化桌面池ID dpucod37vk0gca50kur44j4 pubUserOidList 是 Array of Strings 用户ID列表，长度限制[1,30] upglm1215fkk6v0hf8eo4il1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxxx","pubUserOidList":["puoxxx","puoyyy"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

接口功能介绍 操作不可逆，执行请仔细确认。 接口约束 无 URI POST /v3/customImage/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOid 是 String 镜像ID milm91642m8ukk1r7a6h7l5 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"imageOid":"mixxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 删除用户 接口约束 无 URI POST /v3/user/batchRemove 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOidList 是 Array of Strings 用户ID列表，最大数量50 upg8to5zvs52v2g01h6h8fy2 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"pubUserOidList":["upgfoo","upgbar"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 并发桌面池功能请联系客户经理开通。 接口约束 无 URI POST /v3/concurrentDesktopPool/addDesktops 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 并发桌面池ID dpybiqd3vedlt5u4cspy6vd resourcePackOid 是 String 资源包ID rsp8qvf6t33j2yh97s3t8drc pubUserOidList 是 Array of Strings 用户ID列表，可设置一个或多个，最多30个 upg68xjc1c655mmccohrq1m6 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxxx","resourcePackOid":"resxxx","pubUserOidList":["puoxxx"]}

接口功能介绍 创建对等连接路由v3 接口约束 无 URI POST /v3/peeringRoute/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 peeringOid 是 String 对等连接id vpcOid 是 String vpc id destinationList 是 Array of Strings 目的地址集合 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。 xxx 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "vpcOid":"vpcks38av7mklcehgu674ead", "peeringOid":"peer556a8qkcihe5qci4e79lq", "destinationList":["192.168.1.0/24","192.168.2.0/24"] } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"xxx" }

接口功能介绍 修改用户信息 接口约束 无 URI POST /v3/user/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOid 是 String 用户ID upg2lck6loc5swjlg2x6e16e userName 是 String 用户名称。字符数限制：[1,20]。 xiemushuxiugai email 否 String 邮箱。字符数限制：[1,50]。 email@foo.com gender 否 String 性别。枚举值范围：[男,女]。 null telephone 否 String 固定电话。字符数限制：[0,20]。 null position 否 String 职位。字符数限制：[0,50]。 null 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj

接口功能介绍 将基础策略克隆到账号的其它资源池下。 接口约束 无 URI POST /v3/strategy/cloneStrategy 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 sourceStrategyOid 是 String 待克隆的基础策略 targetRegionId 是 String 目标资源池 targetOrgOid 是 String 目标部门 targetStrategyName 是 String 目标策略名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "sourceStrategyOid":"dsyxxxxxx", "targetRegionId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "targetOrgOid":"orgxxxxxx", "targetStrategyName":"xxxxxx" }

接口功能介绍 VIP解绑弹性IPv3 接口约束 无 URI POST /v3/vip/unbindFip 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vipOid 是 String vip id fipOid 是 String 弹性ip id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。 jobtaskxxx 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "vipOid":"vipxxyrk3utggvmmyeiunfic", "fipOid":"fip9x9t48ate9ht07d7hceo5" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"jobtaskxxx" } 状态码 请参考 状态码

接口功能介绍 更新报表订阅列表 接口约束 传参规范 URI PUT /vfw/v2reportsubscribeput 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 reportType 是 Array of Strings 报表类型 ["DAY"] subscribeUserIds 是 Array of Strings 选中的用户ids ["100054c0416811e9a6690242ac110002"] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "reportType":["","WEEK","DAY","MONTH"], "subscribeUserIds":["913d6b7d9a1b46769af6c1de79046a06","fe07604ff0804488816d2ab5a33fec7d"] }

接口功能介绍 修改防火墙名称 接口约束 传参规范 URI POST /vfw/v2firewallupdatename 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙ID firewallName 是 String 防火墙名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "firewallId":"c7cfe772fd3f482da630132e6548a19a", "firewallName":"CFW9d6b" } 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!" }

接口功能介绍 删除NAT网关v3 接口约束 无 URI POST /v3/nat/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 natOid 是 String NAT网关ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "natOid":"xxxxxxxxxxx" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 创建安全组v3 接口约束 无 URI POST /v3/securityGroup/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 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]

接口功能介绍 修改部门属性 接口约束 无 URI POST /v3/org/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 orgOid 是 String 部门ID orgudptjl8j3kifkb7uj54jq orgName 是 String 部门名称。字符数限制：[1,20]。 testxdfvs description 是 String 部门描述。字符数限制：[0,255]。 null 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"orgOid":"orgmod","orgName":"mod","description":""} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

接口功能介绍 修改云电脑别名 接口约束 无 URI POST /v3/desktop/modifyNickname 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023101301183998 nickname 是 String 别名（最大长度20，只能包含数字、字母、汉字） xiemushuapi 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOid":"XXXXXXXXXXXXX6925","nickname":"fooupdate3I8SiEaM"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

接口功能介绍 取消部门资源包配额 接口约束 无 URI POST /v3/resourcePack/orgQuota/cancel 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 orgOid 是 String 部门ID org18qnu7l41v8fr2xif6jdq 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"orgOid":"orgdel"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

指标 指标名称 指标含义 取值范围 测量对象&维度 监控周期（原始指标） cpuutil CPU使用率 该指标用于统计弹性伸缩组的CPU使用率。 计算公式：伸缩组中的所有云服务器的CPU使用率之和/伸缩组实例数 单位：百分比 ≥0% 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 memutil 内存使用率 该指标用于统计弹性伸缩组的内存使用率，以百分比为单位。 计算公式：伸缩组中的所有云服务器内存使用率之和/伸缩组实例数 单位：百分比 说明 如果用户使用的镜像未安装vmtools，则无法获取该监控指标。 ≥0% 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 instancenum 实例数 该指标用于统计弹性伸缩组中可用的云服务器云主机数量。 计算公式：弹性伸缩组内生命周期状态为“已启用”的云服务器云主机数量之和 ≥0 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 networkincomingbytesrateinband 带内网络流入速率 该指标用于统计每秒流入弹性伸缩组的网络流量。 计算公式：伸缩组中所有云服务器的带内网络流入速率之和 / 伸缩组实例数 单位：字节/秒 ≥0 Byte/s 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 networkoutgoingbytesrateinband 带内网络流出速率 该指标用于统计每秒流出弹性伸缩组的网络流量。 计算公式：伸缩组中所有云服务器的带内网络流出速率之和 / 伸缩组实例数 单位：字节/秒 ≥0 Byte/s 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 diskreadbytesrate 磁盘读速率 该指标用于统计每秒从弹性伸缩组读出的数据量。 计算公式：伸缩组中所有云服务器的磁盘读速率之和 / 伸缩组实例数 单位：字节/秒 ≥0 Byte/s 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 diskwritebytesrate 磁盘写速率 该指标用于统计每秒写到弹性伸缩组的数据量。 计算公式：伸缩组中所有云服务器的磁盘写速率之和 / 伸缩组实例数 单位：字节/秒 ≥0 Byte/s 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 diskreadrequestsrate 磁盘读操作速率 该指标用于统计每秒从弹性伸缩组读取数据的请求次数。 计算公式：伸缩组中所有云服务器的磁盘读操作速率之和 / 伸缩组实例数 单位：请求/秒 ≥0 request/s 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟 diskwriterequestsrate 磁盘写操作速率 该指标用于统计每秒往弹性伸缩组写数据的请求次数。 计算公式：伸缩组中的所有云服务器的磁盘写操作速率之和 / 伸缩组实例数 单位：请求/秒 ≥0 request/s 测量对象：弹性伸缩组 测量维度： AutoScalingGroup 5分钟

一键告警 一键告警：产品列表 接口功能介绍 此接口用于获取一告报警支持的产品及规则初始化信息。 接口约束 无。 URI GET /v4/monitor/alertonekey/describeservices 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 EnablingServices Object 启用中的产品 EnablingService allServiceSeriesInitRules Array of Objects 各个产品的初始化规则 ServiceSeriesInitRules allServiceEventInitRules Array of Objects 各个产品的初始化规则 ServiceEventInitRules 表EnablingService 参数 参数类型 说明 示例 下级对象 series Array of Strings 启用中的series产品 ecs event Array of Strings 启用中的event产品 ecs 表ServiceSeriesInitRules 参数 参数类型 说明 示例 下级对象 alertInitConfigList Array of Objects 初始化规则列表 alertInitConfig service String 服务。取值范围：ecs：云主机。evs：云硬盘。...详见“[一键报警：产品列表]”接口返回。 ecs 表ServiceEventInitRules 参数 参数类型 说明 示例 下级对象 alertInitConfigList Array of Objects 初始化规则列表 alertInitConfig service String 服务。取值范围：ecs：云主机。evs：云硬盘。...详见“[一键报警：产品列表]”接口返回。 ecs 表 alertInitConfig 参数 参数类型 说明 示例 下级对象 dimension String 维度。值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 disk name String 规则名 cpu使用率一键报警 metric String 指标名 cpuutil evaluationCount Integer 连续出现次数 5 operator String 注意：一键告警规则的告警类型（alarmType）为事件类型（event）时，没有此返回参数。 此参数表示比较符： eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于 。 eq value String 注意：一键告警规则的告警类型（alarmType）为事件类型（event）时，没有此返回参数。 此参数表示告警阈值，可以是整数、小数或百分数格式字符串 20 unit String 单位 %

本文介绍对图片进行格式转换时所用到的参数及示例。 功能说明 通过格式转换参数，可以转换存储在媒体存储内原图的格式。 参数说明 操作名称：format 参数说明如下： 取值范围 描述 jpg 将原图保存成JPG格式，如果原图是PNG、WebP、BMP等存在透明通道的格式，默认会把透明填充成白色。 png 将原图保存成PNG格式。 webp 将原图保存成WebP格式。 bmp 将原图保存成BMP格式。 gif 原图为GIF图片则继续保存为GIF格式；原图不是GIF图片，则按原图格式保存。 tiff 将原图保存成TIFF格式。 注意事项 图片处理包含缩放操作时，建议将格式转换参数放到处理参数的最后。 例如 image/resize,w100/format,jpg 图片处理包含缩放和水印操作时，建议将格式转换参数添加在缩放参数之后。 例如 image/reisze,w100/format,jpg/watermark,... 示例 将图片转换为PNG格式，具体图片处理参数为： ?xamzprocessimage/format,png 图片设置为渐进显示：interlace,1，图片转换为JPG格式：format,jpg，具体图片处理参数为： ?xamzprocessimage/interlace,1/format,jpg 图片转换为WebP格式：format,webp，图片缩放为宽200 px：resize,w200，具体图片处理参数为： ?xamzprocessimage/format,webp/resize,w200

接口功能介绍 调用此接口可查询通知套餐包限流。 接口约束 参见请求参数说明。 URI GET /v4/monitor/order/noticepacklimitdetail 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 method 是 String 本参数表示通知套餐包类型。取值范围： sms：短信通知套餐包。 voice：语音通知套餐包。 根据以上范围取值。 voice 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 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 参数 参数类型 说明 示例 下级对象 monthLimit Integer 月限流数量 1000 枚举参数 无

接口功能介绍 获取证书 接口约束 无 URI POST /v1/manageCertificate/getCertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取证书成功 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificate String 证书本体 BEGIN CERTIFICATE (X.509 Certificate PEM Content) END CERTIFICATE requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 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 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff csr String 证书csr BEGIN CERTIFICATE REQUESTMIICxjCCAa4CAQAwPzELMAkGA1UEBhMCQ04xDzANBgNVBAoTBmFsaXl1bjEMMAoGA1UECxMDa21zMREwDwYEND CERTIFICATE REQUEST

接口功能介绍 参见请求参数说明。 接口约束 资源池ID、任务ID不为空。 URI POST /v4/monitor/taskcenter/deletetask 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b taskID 是 Array of Strings 任务ID列表 ['TASKtacd8b6b4610b97d202306301808'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数，参考returnObj对象结构 returnObj error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true 枚举参数 无 请求示例 请求url /v4/monitor/taskcenter/deletetask 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "taskID": [ "TASKtacd8b6b4610b97d202306301808" ] }