接口功能介绍 服务器列表设置配额自动绑定开关 接口约束 无 URI POST /v1/host/autoBindQuota 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 quotaBindSwitch 是 Boolean 是否自动绑定 true 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200 枚举参数 无 请求示例 请求url 无 请求头header {"ContentType": "application/json"} 请求体body {"quotaBindSwitch": "true"}

接口功能介绍 用户管理是否签约 接口约束 无 URI GET /v1/index/isSign 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 isSigned Boolean 是否签约 true accountId String 账号ID 10001 userId String 用户ID 10002 枚举参数 无 请求示例 请求url 无 请求头header {"ContentType": "application/json"} 请求体body {}

接口功能介绍 更改接入点的资源权限 接口约束 无 URI POST /v1/applicationAccessPointManage/changePointResourcePolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d policyType 是 String 权限类型 allow cmkList 否 Array of Strings 密钥资源列表 ["908b979ecd964d6499b7856a671ebc82"] certList 否 Array of Strings 证书资源列表 ["908b979ecd964d6499b7856a671ebc82"] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 13e2aeb065364db1a8cc611f3edd63ee

接口功能介绍 获取接入点的接口权限详情 接口约束 无 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 请求头header { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" }

接口功能介绍 更新密钥描述接口 接口约束 请保证账户余额大于0 URI POST /v1/keyManage/updateKeyDescription 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff description 否 String 描述 abcd 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 更新密钥描述成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id de4138537a8b42c3a1a80ce1898f3476 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "cmkUuid": "27e658cf3b904987adfdfe8700ee4f59", "description": "描述更改1" }

vpn用户服务修改。 接口功能介绍 vpn用户服务修改 接口约束 支持集群模式资源池。 URI POST /v4/vpn/ipsecuserservice/update 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 是 String IPSCE 服务名称 ipsec111 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 ipsecServiceID 是 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96

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

本页介绍了基于Java开发文档数据库服务应用程序的基本流程。 应用程序对接文档数据库服务的基本流程如下： 1. 添加文档数据库服务驱动程序依赖：在应用程序中添加文档数据库服务驱动程序的依赖，以便在应用程序中使用文档数据库服务的API。 2. 创建文档数据库服务客户端：使用文档数据库服务驱动程序提供的 Client 类创建一个文档数据库服务客户端，用于连接到文档数据库服务。可以在 Client 构造函数中指定文档数据库服务服务器的地址和端口号，以及其他认证信息和配置参数。 3. 获取数据库和集合对象：使用Client实例获取一个或多个数据库对象，并使用数据库对象获取集合对象。可以使用文档数据库服务提供的API或者文档数据库服务的查询语言来对集合中的文档进行操作。 4. 执行 CRUD 操作：使用集合对象执行 CRUD（创建、读取、更新、删除）操作，以对文档进行操作。可以使用文档数据库服务提供的 API 或者文档数据库服务的查询语言来执行查询操作。 5. 创建索引：使用集合对象创建索引以提高查询效率和性能。可以使用文档数据库服务提供的 API 或者文档数据库的命令行工具来创建索引。 6. 处理错误和异常：在 Java 应用程序中处理文档数据库服务操作可能出现的错误和异常，以便及时发现和修复问题。可以使用 trycatch 块或其他错误处理机制来捕获和处理异常。 7. 关闭文档数据库服务客户端：在应用程序中关闭与文档数据库服务的连接，释放资源并避免连接泄漏。可以使用Client 的 close() 方法来关闭客户端。

本节介绍了如何通过备份文件恢复云数据库GaussDB 实例。 操作场景 云数据库GaussDB 支持使用已有的自动备份和手动备份，将实例数据恢复到备份被创建时的状态。该操作恢复的为整个实例的数据。 限制条件 恢复时目标实例异常、实例磁盘满将会导致恢复失败。 不支持跨大版本恢复。例如：1.4.x的实例仅可以恢复到1.4.y版本的实例。 操作步骤 步骤 1 登录管理控制台。 步骤 2 在左侧导航栏单击“备份恢复管理”，选择需要恢复的备份，单击操作列的“恢复”。 您也可在“实例管理”页面，单击指定的实例名称，在左侧导航栏单击“备份恢复”，在“全量备份”页签下单击目标备份对应的操作列中的“恢复”。 步骤 3 单击“确定”，恢复实例。 说明 如果打开并行恢复功能，那么恢复过程中，所有主、备副本会同时从OBS服务器下载备份数据，与默认的串行恢复相比，OBS带宽消耗量增加到N倍（N等于每个分片的副本个数）。因此，为了防止OBS带宽达到上限导致恢复速度反而下降的情况，当待恢复集群的分片个数大于5个时，建议先咨询运维当前OBS服务器空闲带宽，然后再决定是否开启并行恢复功能。 主备版实例只支持并行恢复。 数据库内核版本小于1.4时，不支持开启并行恢复。 全量备份和增量备份除了备份数据文件之外，也会备份这个过程中的增量日志文件，用于保证该备份集恢复以后数据的一致性。由于增量日志文件的备份和上传需要一定时间（受网络、OBS存储介质流控等影响），因此，需要注意的是，备份结束时间并不代表该备份集恢复后的数据一致性时间点（该恢复一致性点一般在备份结束时刻之前的几分钟以内）。如果用户对于恢复后数据的一致性时刻点有严格要求，请使用指定时间点恢复。 恢复到新实例： − 数据库大版本与原实例相同。例如：1.4.x的实例仅可以恢复到1.4.y版本的实例。 − 存储空间大小默认和备份时实例磁盘空间相同，且必须大于或等于备份时实例存储空间大小。 − 数据库密码需重新设置。 − 新实例的规格默认和原实例相同，如果需要修改规格，新实例的规格必须大于或等于原实例的规格。 − 新实例的节点配置需要与备份时保持一致。 步骤 4 查看恢复结果。 恢复到新实例 为用户重新创建一个和该备份数据相同的实例。可看到实例由“创建中”变为“正常”，说明恢复成功。 恢复成功的新实例是一个独立的实例，与原有实例没有关联。

天翼云性能测试服务等级协议，详情请参见这里。

天翼云应用编排服务用户指南.pdf

接口功能介绍 统计列表信息 接口约束 传参规范 URI GET /vfw/v2reportstatistics 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 startTime 是 String 开始时间 20240925T05:36:13Z endTime 是 String 结束时间 20240925T05:36:13Z 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 ReportStatisticsView 表 ReportStatisticsView 参数 参数类型 说明 示例 下级对象 dailyCount Integer 日报个数 1 dailyLastUpdated String 日报最后更新日期 20241024T16:00:24Z weeklyCount Integer 周报个数 2 weeklyLastUpdated String 周报最后更新日期 20241023T16:00:00Z monthlyCount Integer 月报个数 3 monthlyLastUpdated String 月报最后更新日期 20241024T16:00:24Z

接口功能介绍 查看iplistener列表 接口约束 无 URI GET /v4/iplistener/list 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 ipListenerID 否 String 监听器 ID listenerxxx pageNumber 否 Integer 列表的页码，默认值为 1。 1 pageSize 否 Integer 分页查询时每页的行数，最大值为 50，默认值为 10。 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 requestID String 请求ID eeef00f6dee511f085ae525400fa2048 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 results Array of Objects 接口业务数据 results totalCount Integer 列表条目数 1 currentCount Integer 分页查询时每页的行数。 1 totalPage Integer 总页数 1 表 results 参数 参数类型 说明 示例 下级对象 gwElbID String 网关负载均衡 ID gwlbxxx name String 名字 tset description String 描述 desc ipListenerID String 监听器 id listenerxxxx action Object 转发配置 action tcpIdleTimeout Integer TCP连接空闲时间 900 表 action 参数 参数类型 说明 示例 下级对象 type String 默认规则动作类型: forward / redirect forward forwardConfig Array of Objects 转发配置 forwardConfig 表 forwardConfig 参数 参数类型 说明 示例 下级对象 targetGroupID String 后端服务组ID tgxxx weight String 权重 100

接口功能介绍 单台服务器切换配额版本中待绑定的企业版配额列表。 接口约束 确认已经购买系统配额。 URI POST /v1/quota/unBindList 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 quotaVersion 是 Integer 配额版本 1基础版 2企业版 3旗舰版 1 currentPage 是 Integer 分页当前页码 1 pageSize 是 Integer 每页大小 10 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId 211111111111111111111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 total Integer 总数 100 list Array of Objects 结果集 list pageNum Integer 当前页 1 pageSize Integer 每页的数量 10 表 list 参数 参数类型 说明 示例 下级对象 virusDatabaseUpdateTime String 病毒数据库更新时间 20220704 00:00:00 agentGuid String agentGuid testid publicIp String 公网IP 192.168.1.1 agentIp String 私网IP 192.168.1.1 custName String 主机名称 testhostname unHandle Integer 未处理告警数量 0 hostNum Integer 病毒查杀风险主机数量 0 quotaVersion Integer 配额版本 1基础版 2企业版 3旗舰版 1 quotaId String 防护配额ID 6c8caaa32418441c8c164e3f43d76791 expirationDate String 防护配额到期时间 20220704 10:00:00

目前只支持升配询价:增加带宽和连接数。 接口功能介绍 VPN网关升配询价，目前只支持升配询价:增加带宽和连接数。 接口约束 有已经下单成功VPN网关。 URI POST /v4/vpn/gateway/querypriceupgrade 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID, 例:100054c0416811e9a6690242ac110002 bandwidth 是 Integer 带宽，单位为Mbps connectionLimit 是 Integer VPN网关连接数限制 resourceID 是 String VPN网关资源ID linkResourceID 是 String VPN连接资源ID 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码(800为成功，900为失败) message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj errorCode 否 String 业务细分码，为product.module.code三段式码 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 totalPrice 否 Float 所有订单总共价格 finalPrice 否 Float 所有订单最终价格 isSucceed 否 Boolean 是否成功 subOrderPrices 否 Array of Objects 子订单价格列表 orderPrice 表 orderPrice 参数 是否必填 参数类型 说明 示例 下级对象 serviceTag 否 String 产品标签 totalPrice 否 Float 订单总共价格 finalPrice 否 Float 订单最终价格 orderItemPrices 否 Array of Objects 订单资源价格列表 orderItemPrice cycleType 否 Integer 订单周期 表 orderItemPrice 参数 是否必填 参数类型 说明 示例 下级对象 itemId 否 String 订单资源ID resourceType 否 String 本参数表示订单资源类型。 取值范围： VPNGETWAY VPNLINK totalPrice 否 Float 订单资源总共价格 finalPrice 否 Float 订单资源最终价格

VPN用户服务查看。 接口功能介绍 vpn用户服务查看 接口约束 支持集群模式资源池。 URI GET /v4/vpn/ipsecuserservice/list 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 get请求包含body参数,报文头指定application/json,且body结构对象需要转json。 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 queryContent 否 String Query Content模糊查询 ipsec111 projectID 否 String project ID 0 ipsecServiceName 否 String IPSCE 服务名称 ipsec111 ipsecServiceID 否 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 pageSize 否 Integer 每页行数 1 pageNo 否 Integer 页码 1 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 totalCount 否 Integer 查询的总记录数 3 currentCount 否 Integer 当前页记录数 2 totalPage 否 Integer 总页数 2 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96 results 否 Array of Objects 列表 results 表results 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 否 String IPSCE SERVICE名称 ipsec111 ipsecServiceID 否 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 ipAddress 否 String IPAddress 111.0.0.1 createTime 否 String create time 20230621 01:39:01 vpnConnectionID 否 String vpn connection ID 908dhfa99c0404bb0806a8be317cc4d89

事件监控 事件监控：查询详情 接口功能介绍 根据指定时间段查询事件发生情况。 接口约束 regionID、startTime、endTime、eventName，dimension、service存在。 URI POST /v4/monitor/events/querydetail 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID 81f7728662dd11ec810800155d307d5b startTime 是 Integer 查询起始时间戳 1647424660 endTime 是 Integer 查询截止时间戳 1647424660 eventName 是 String 本参数表示事件指标，事件指标见查询事件接口返回。 migrationeventstart service 是 String 服务，见事件监控：查询服务维度接口返回。 ecs dimension 是 String 维度，见事件监控：查询服务维度接口返回。 ecs pageNo 否 Integer 页码，默认为1 1 pageSize 否 Integer 页大小，默认为20 2 resGroupID 否 String 资源分组ID，在资源分组事件时传入 9cb2b3301dd85ec49c6db07fe65a9aca 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount Integer 获取对象数据条数 14 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 eventDetail Array of Objects 事件详情列表 eventDetailObj 表 eventDetailObj 参数 参数类型 说明 示例 下级对象 deviceUUID String 设备ID 000f03221f4d8cc8bb2e1c30fb751aa5 deviceName String 设备名称 ecm1234 deviceTime Integer 设备事件发生时间，秒级时间戳 1647424660

自定义监控项 自定义监控项：查询 接口功能介绍 调用此接口可查询自定义监控项。 接口约束 资源池ID不能为空。 URI GET /v4/monitor/querycustomitems 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b customItemID 否 String 自定义监控项ID ITEM793d5923652be6ce202306291409 name 否 String 监控项名称，支持模糊搜索 我的CPU使用率 pageNo 否 Integer 页码，不传默认为1 1 pageSize 否 Integer 每页大小，不传默认为10 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 customItemList Array of Objects 自定义监控项列表 customItem totalCount Integer 总记录数 2 totalPage Integer 总页数 1 currentCount Integer 当前记录数 2 表 customItem 参数 参数类型 说明 示例 下级对象 regionID String 资源池ID 81f7728662dd11ec810800155d307d5b customItemID String 自定义监控项ID ITEM793d5923652be6ce202306291409 name String 监控项名称 我的CPU使用率 unit String 自定义监控项的单位 % interval Integer 数据上报间隔，单位秒 60 dimensions Array of Strings 用于查询监控数据的维度 ['uuid','usage'] dimension 表 dimension 参数 参数类型 说明 示例 下级对象 name String 维度名称，支持英文、下划线 uuid description String 维度描述，支持中文、英文、下划线 主机的唯一标识

本文主要介绍节点DNS检查. 检查项内容 当前检查项包括以下内容： 检查当前节点DNS配置是否能正常解析OBS地址 检查当前节点是否能访问存储升级组件包的OBS地址 解决方案 节点升级过程中，需要从OBS拉取升级组件包。此项检查失败，请联系技术人员支持。

请参见：天翼云DDoS高防IP服务协议

接口功能介绍 查询检测任务运行状态。 接口约束 此功能为收费功能。确认已经购买系统配额，并且开启基线扫描配置。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护 URI POST /v1/sca/event/isrun/check 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 scaRuleId 是 Integer 基线策略id 1 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 taskStatus Integer 任务状态 0:未开始 1:执行中 2:已完成 4:取消执行 6:超时取消执行 1 taskStatusDesc String 状态描述 执行中 taskId String 任务id testtaskid policy Integer 扫描的基线策略id 1

接口功能介绍 下续订订单 接口约束 无 URI POST /v1/eop/reneworder 请求参数 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cycleType 是 Integer 取值范围：3表示按月订购，5表示按一年订购，6表示按两年订购、7表示按三年订购。与cycleCount配合使用，cycleCount属性为1，cycleType取值为3 表示订购1个月。 3 cycleCount 是 Integer 续订周期数量。 2表示续订2个月（值需大于零，不超过384个月） 1 resourceIds 是 Array String数组，主虚拟资源ID（批量续订时资源不能超过10个）可通过【根据主订单id查询订单详情】接口返回的masterResourceId字段获取 [ "48cd3a5e9b964657a1f31c58a8b98ae4"] 响应参数 参数 参数类型 说明 示例 下级对象 : statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 OrderResponse OrderResponse 参数 参数类型 说明 示例 下级对象 errorMessage String 错误信息 "" submitted Boolean 全部资源是否续订成功 true orderPlacedEvents Array 每个资源的续订结果列表 OrderResult OrderResult 参数 参数类型 说明 示例 下级对象 errorMessage String 错误信息 "" submitted Boolean 当前单个资源是否下续订单成功 true newOrderId String 当前资源续订订单的masterOrderId 7f3766d6fd9c4aec8f807ab07c4b2d72 newOrderNo String 当前资源续订订单的流水号 20221028161914843904 totalPrice Double 续订订单的价格 542.0

接口功能介绍 查询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。

接口功能介绍 查询应用接入点列表 接口约束 无 URI POST /v1/applicationAccessPointManage/listApplicationAccessPoint 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNum 否 Integer 当前页码 1 pageSize 否 Integer 页码大小 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Objects 应用接入点列表 applicationList totalCount Integer 总数量 5 pageNum Integer 当前页码 1 pageSize Integer 页码大小 10 表 applicationList 参数 参数类型 说明 示例 下级对象 vpcId String vpc id vpcr5ka3qk24m subnetId String 子网id subnet6mojt0h30o endpointId String 终端节点id 9612627252624b61bf5cd66ca3c7a0b3 url String 接入地址 < vpcName String vpc名称 vpccfwusertest subnetName String 子网名称 subnetcfwserver applicationStatus String 接入点状态 1 applicationId String 接入点id 1234589018 applicationName String 接入点名称 test description String 接入点描述 aaa

参数名 说明 国密加密回源 国密算法，即国家商用密码算法，是由国家密码管理局认定和公布的密码算法标准及其应用规范。国密加密回源，即回源时的HTTPS协议采用国密加密算法。 国际加密回源 国际加密回源，即采用国际标准的密码算法回源，如果没有特殊配置，我们通常回源时使用的加密算法都是国际加密算法。 跟随客户端加密算法回源 若客户端使用国际加密算法接入天翼云AOne安全与加速平台，则回源时也使用国际加密算法回源；若客户端使用国密加密算法接入天翼云AOne安全与加速平台，则回源时也使用国密加密算法回源。

修改扩展域名证书配置 具体操作如下： 1. 登录天翼云控制中心。 2. 选择“网络>弹性负载均衡>负载均衡器”。 3. 单击已创建的负载均衡器实例名称。 4. 在监听器列表中，选择需要操作的HTTS监听器，在操作列点击 “更多>扩展域名证书管理”。 5. 在列表中选择要修改的条目，点击“修改”。 6. 在弹框中可以修改域名关联的证书，然后点击“确定”，完成修改。 删除扩展域名证书配置 具体操作如下： 1. 登录天翼云控制中心。 2. 选择“网络>弹性负载均衡>负载均衡器”。 3. 单击已创建的负载均衡器实例名称。 4. 在监听器列表中，选择需要操作的HTTS监听器，在操作列点击 “更多>扩展域名证书管理”。 5. 在列表中选择要删除的条目，点击“删除”。 6. 在弹框中点击“确定”，完成删除。

本节介绍如何续订网页防篡改（原生版）。 您可对已订购的网页防篡改（原生版）配额进行续费，需要此配额此时的状态为未到期、已到期。 操作步骤 1. 登录网页防篡改（原生版）控制台。 2. 在左侧导航栏，选择“网页防篡改（原生版） > 防护配额”，进入防护配额页面。 3. 在页面下方配额列表中，对需要续订的配额，单击操作列的“续订”。 4. 在“续订”页面选择该配额需续订的时长。 5. 阅读《天翼云网页防篡改（原生版）服务协议》，并勾选“我已阅读并同意相关协议《天翼云网页防篡改（原生版）服务协议》“，单击“立即购买”。 6. 进入“付款”页面，完成付款。

参数名 类型 是否必填 名称 说明 domain string 是 域名 单次调用仅支持一个域名查询 startTime string 是 开始时间 格式为：YYYYMMDDThh: mm:ssZ 支持最近30天的数据 endTime string 是 结束时间 格式为：YYYYMMDDThh: mm:ssZ 支持最近30天的数据 type string 是 查询类型 取值： 1、IP：攻击IP 2、URL：被攻击的URL 3、AREA：攻击来源 4、ATTACKTYPE：攻击类型 pageSize string 否 查询每页的数量 不传默认30，pageSize以及pageNumber的乘积不得超过2000 pageNumber string 否 查询的页数 不传默认30，pageSize以及pageNumber的乘积不得超过2000

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 []

产品服务协议请查看： 天翼云分布式消息服务协议

接口功能介绍 更新转发规则 接口约束 仅支持更新策略名称和描述，未见策略名称字段；域名和URL字段不支持修改。 URI POST /v4/elb/updaterule 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b ID 否 String 转发规则ID, 该字段后续废弃 xxxx policyID 否 String 转发规则ID, 推荐使用该字段, 当同时使用 ID 和 policyID 时，优先使用 policyID xxxx priority 否 Integer 优先级，数字越小优先级越高，取值范围为：1100(目前不支持配置此参数,只取默认值100) 100 description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:'{},./;'[,]·！@ ￥%……&（） —— +{},《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc conditions 否 Array of Objects 匹配规则数据 conditions action 否 Object 规则目标 action 表 conditions 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 类型。取值范围：servername（服务名称）、urlpath（匹配路径） urlpath serverNameConfig 否 Object 服务名称 serverNameConfig urlPathConfig 否 Object 匹配路径 urlPathConfig 表 serverNameConfig 参数 是否必填 参数类型 说明 示例 下级对象 serverName 否 String 服务名称 xxxx 表 urlPathConfig 参数 是否必填 参数类型 说明 示例 下级对象 urlPaths 否 String 匹配路径 /// matchType 否 String 匹配类型。取值范围：ABSOLUTE，PREFIX，REG REG 表 action 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 默认规则动作类型。取值范围：forward、redirect、deny(目前暂不支持配置为deny) forward forwardConfig 否 Object 转发配置 forwardConfig redirectListenerID 否 String 重定向监听器ID，当type为redirect时，此字段必填 xxzzzz 表 forwardConfig 参数 是否必填 参数类型 说明 示例 下级对象 targetGroups 否 Array of Objects 后端服务组 targetGroup 表 targetGroup 参数 是否必填 参数类型 说明 示例 下级对象 targetGroupID 是 String 后端服务组ID tgxxx weight 否 Integer 权重，取值范围：1256。默认为100 100

天翼云分布式消息服务Kafka 用户使用指南.pdf