接口功能介绍 调用此接口可查看告警联系人的配置详情。 接口约束 告警联系人ID存在。 URI GET /v4/monitor/describecontact 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 contactID String 是 a6fb570f22995bde989cdf0819c687d0 告警联系人ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 name String 用户名 gxlupdate phone String 手机号 18919128910 email String 邮箱 864307365@qq.com contactGroupList Array of Objects 所属组信息 contactGroup lastUpdate String 最近更新时间 20220929T09:51:33Z 表contactGroup 参数 参数类型 说明 示例 下级对象 contactGroupID String 联系人组ID b6fb5df3gasd5bde989cdf0819c687d0 name String 联系人组名称 testgroup

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

通知模板 通知模板：标记自定义默认通知模板 接口功能介绍 调用此接口可标记自定义默认通知模板。 接口约束 1. 通知模板存在。 2. 同一服务和维度下，自定义默认通知模板只能设置一个。 URI POST /v4/monitor/marknoticetemplateisdefault 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 noticeTemplateID 是 String 通知模板ID 312b56b43e4311ed8ef2005056898fe0 isDefault 是 Boolean 是否为自定义默认通知模板 false 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true

站点监控 站点监控任务：启用 接口功能介绍 调用此接口可启用站点监控任务。 接口约束 站点监控任务ID列表不能为空。 URI POST /v4/monitor/enablesitemonitor 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 taskIDList 是 Array of Strings 站点监控任务ID列表 ['64ea16644347558e9bc6651341c2fa15'] 响应参数 参数 参数类型 说明 示例 下级对象 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/enablesitemonitor 请求头header 无 请求体body json { "taskIDList":["64ea16644347558e9bc6651341c2fa15"] }

监控看板 监控看板：删除视图 接口功能介绍 删除监控视图。 接口约束 参见请求参数说明。 URI POST /v4/monitor/monitorboard/deleteview 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b viewIDs 是 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/deleteview 请求头header 无 请求体body json { "regionID": "1234567890", "viewIDs": ["868b84d01a6fb6b28b7f26bdf85f96ab"] }

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

站点监控 站点监控任务：删除 接口功能介绍 调用此接口可删除站点监控任务。 接口约束 站点监控任务ID列表不能为空。 URI POST /v4/monitor/deletesitemonitor 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 taskIDList 是 Array of Strings 站点监控任务ID列表 ['64ea16644347558e9bc6651341c2fa15'] 响应参数 参数 参数类型 说明 示例 下级对象 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/deletesitemonitor 请求头header 无 请求体body json { "taskIDList":["64ea16644347558e9bc6651341c2fa15"] }

站点监控 站点监控任务：禁用 接口功能介绍 调用此接口可禁用站点监控任务。 接口约束 站点监控任务ID列表不能为空。 URI POST /v4/monitor/disablesitemonitor 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 taskIDList 是 Array of Strings 站点监控任务ID列表 ['64ea16644347558e9bc6651341c2fa15'] 响应参数 参数 参数类型 说明 示例 下级对象 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/disablesitemonitor 请求头header 无 请求体body json { "taskIDList":["64ea16644347558e9bc6651341c2fa15"] }

本节介绍了配置CloudInit工具的操作场景、前提条件、配置步骤说明等内容。 操作场景 CloudInit工具安装完成后，请参考本节操作配置CloudInit工具。 前提条件 已安装CloudInit工具。 已为云主机绑定弹性公网IP。 已登录云主机。 云主机的网卡属性为DHCP方式。 配置步骤说明 包含如下两步操作： 1. 配置CloudInit工具。 具体操作请参考下文“配置CloudInit工具”。 2. 检查CloudInit工具相关配置是否成功。 具体操作请参考下文“检查CloudInit工具相关配置是否成功”。 配置CloudInit工具 1. 用户可以根据需要根据用户类型配置登录云主机的用户权限。使用root账户登录，需要开启root用户的ssh权限，并开启密码远程登录。 − 若用户选择注入密码，则通过自己注入的密码进行远程SSH或noVNC登录。 − 若用户选择注入密钥，则通过自己注入的密钥进行远程SSH登录。 执行以下命令，在vi编辑器中打开“/etc/cloud/cloud.cfg”。 vi /etc/cloud/cloud.cfg 2. （可选）在“/etc/cloud/cloud.cfg”中配置“applynetworkconfig”为“false”。 对于使用CloudInit 18.3及以上版本的用户，需执行本操作。 配置示例 3. 设置开放root密码远程登录并开启root用户的ssh权限。以CentOS 6.7系列操作系统为例，配置文件中的“disableroot”字段为“1”表示为禁用，为“0”表示不禁用（部分OS的CloudInit配置使用“true”表示禁用，“false”表示不禁用）。设置“disableroot”值为“0”，“sshpwauth”为“1”，“lockpasswd”设置为“false”，“false”表示不锁住用户密码。 users: name: root lockpasswd: False disableroot: 0 sshpwauth: 1 4. 开启机器名更新机制，请勿注释或删除“ updatehostname”语句。 cloudinitmodules: migrator bootcmd writefiles growpart resizefs sethostname updatehostname updateetchosts rsyslog usersgroups ssh 5. 执行以下命令，在vi编辑器中打开“/etc/ssh/sshdconfig”。 vi /etc/ssh/sshdconfig 6. 将“sshdconfig”中的“PasswordAuthentication”的值修改为“yes”。 说明： 如果是SUSE和openSUSE操作系统，需要同时配置“sshdconfig”文件中的以下两个参数为“yes”。 PasswordAuthentication ChallengeResponseAuthentication 7. 确保删除镜像模板中已经存在的linux账户和“/home/linux”目录。 userdel linux rm fr /home/linux 8. 配置agent访问OpenStack数据源。 在“/etc/cloud/cloud.cfg”最后一行添加如下内容，配置agent访问OpenStack数据源。 datasourcelist: [ OpenStack ] datasource: OpenStack: metadataurls: [' maxwait: 120 timeout: 5 说明： maxwait和timeout可由用户自定义是否需要配置，上述回显信息中maxwait和timeout的取值仅供参考。 当操作系统版本低于Debian8、CentOS 5时，不支持配置agent访问OpenStack数据源。 CentOS、EulerOS操作系统云主机必须要禁用默认的zeroconf路由，以便精确访问OpenStack数据源。 echo "NOZEROCONFyes" >> /etc/sysconfig/network 9. 在配置文件“/etc/cloud/cloud.cfg”中禁用CloudInit接管网络。 当CloudInit版本等于或高于0.7.9版本时，在配置文件“/etc/cloud/cloud.cfg”中增加如下内容，禁用CloudInit接管网络。 network: config: disabled 说明： 增加的内容需严格按照yaml格式进行配置。 禁用CloudInit接管网络 10. 在配置文件“/etc/cloud/cloud.cfg”中补充如下内容。 manageetchosts: localhost 防止启动云主机时，系统长时间卡在“Waiting for cloudResetPwdAgent”状态。 新增manageetchosts:localhost 11. 修改配置文件“cloudinitmodules”。 在“cloudinitmodules”中将ssh从最后提前到第一位处理，提高云主机ssh登录速度。 提高云主机ssh登录速度 12. 修改以下配置使得镜像创建的云主机主机名不带“.novalocal”后缀且主机名称中可以带点号。 a. 执行如下命令，修改 “init.py”文件。 vi /usr/lib/python2.7/sitepackages/cloudinit/sources/init.py 按“i”进入编辑模式，根据关键字toks查询，修改内容如下回显信息所示。 if toks: toks str(toks).split('.') else: toks ["ip%s" % lhost.replace(".", "")] else: toks lhost.split(".novalocal") if len(toks) > 1: hostname toks[0]

ECS自建库(MySQL)连接失败怎么办 1. 报错信息：“Access denied for user 'username'@'100.xxx.xx.xx' (using password: YES)”。 a. 报错原因：ECS自建库用户名或密码不对。 解决方法：请确认数据库用户名和密码是否正确。如果确认帐户名和密码正确，可以通过客户端或命令行工具登录数据库，执行select from mysql.user where user 'username'命令查看用户信息，如果存在100.%网段的用户，则DAS只能通过100.%网段的数据库用户去连接数据库。username @%与username @100.%是两个用户，其密码和权限都是独立的，请确认输入的密码是否是username @100.%用户的密码。 b. 报错原因：DAS服务器的IP地址不在您输入用户的白名单中。 解决方法：使用客户端或命令行工具登录到数据库，创建DAS可以访问的数据库用户。 create user 'username'@'100.%' identified by 'password'; grant all privileges on . to 'username'@'100.%'; 说明 lDAS服务器IP地址所在网段为100.%，请根据实际使用需要添加白名单。 l请根据实际使用需要给username@100.%用户赋予权限。 c. 报错原因：使用SSL用户登录，服务端没有开启SSL功能。 解决方法：请执行如下语句查询用户是否是SSL用户，如果是，则在RDS实例详情页面，将SSL开关打开。其中，ssltype字段有值即表示此用户是SSL用户。 select user, host, ssltype from mysql.user where user 'username'; 2. 报错信息：Host 'xxx.xxx.xx.xx' is not allowed to connect to this MySQL server。 报错原因：您输入的数据库用户不允许远程登录MySQL（如root用户，mysql.user表中只设置了root@localhost用户，指定用户只能本地登录）。 解决方法：使用客户端工具或命令行登录MySQL，创建可以远程登录的用户。 create user 'username'@'100.%' identified by 'password'; grant all privileges on . to 'username'@'100.%'; 说明 lDAS服务器IP地址所在网段为100.%，请根据实际使用需要添加白名单。 l请根据实际使用需要给username@100.%用户赋予权限。 3. 报错信息：Communications link failure The last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server。 a. 报错原因：ECS设置的安全组规则不支持此端口被访问 解决方法：请参考3.2.12 如何查看并放通ECS实例安全组规则。 b. 报错原因：ECS虚拟机设置的防火墙策略不允许此端口被访问。 解决方法：请参考3.2.13 如何查看并放通防火墙。 c. 报错原因：远程访问MySQL数据库，服务端侧进行的DNS解析动作，耗时太长导致连接实例超时。 解决方法：请按照以下操作进行修复。 i. 在/etc/my.cnf路径下查找MySQL数据库的配置文件，在“[mysqld]”下，输入如下内容，并保存退出。 skipnameresolve 说明 lMySQL数据库的配置文件，默认位置为“/etc/my.cnf”，若您将配置文件指定位置存放时，需对应调整。 ii. 重启数据库服务"systemctl restart mysqld"，尝试再次连接。 4. 报错信息：Communications link failure The last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server 报错原因：DAS服务器与实例网络不通。 解决方法：请检查实例的防火墙配置是否正常、是否开放对应端口，如防火墙配置异常或未开放对应端口请修复后再次尝试连接实例。修复后还无法解决，请联系技术支持协助处理 5. 报错信息：Instance connect timeout, please login again. 报错原因：DAS服务器连接超时。 解决方案：请按照以下方法进行检查并尝试修复。 a. 请远程登录ECS虚拟机，执行“iptables S grep input”命令检查实例的防火墙配置是否正常。如果自建库端口号没在开放的白名单中，您可以新增一条iptables规则或通过“systemctl stop iptables”命令关闭防火墙，保证端口能被访问后再次尝试连接实例。 b. 请远程登录ECS虚拟机，执行“ps ef grep mysql”命令检查数据库进程是否正常，mysqldsafe进程与mysqld进程均存在则为正常。如进程不存在请执行“systemctl start mysqld”命令重启数据库后再次尝试连接实例。 c. 如上述方法均无法解决，请联系技术支持协助处理。

本节主要介绍数据订阅 AOM支持用户订阅指标或者告警信息，订阅后可以将数据转发到用户配置的kafka或DMS的Topic中，供消费者消费转发的订阅的信息。 说明 最多可创建10个数据订阅规则。 创建订阅规则 步骤 1 在左侧导航栏中选择“配置管理 > 数据订阅”。 步骤 2 单击“创建订阅规则”，设置相关参数后，单击“确定”。 您可根据实际需求，选择订阅目标类型为“自定义Kafka”或“分布式消息服务DMS”。 1、订阅目标类型为“自定义Kafka”。 数据订阅规则参数说明 参数 说明 示例 规则名称 订阅规则名称。 输入：aomkafkatest。 订阅内容 支持“指标”和“告警”。 选择：指标。 订阅目标类型 选择“自定义Kafka”或“分布式消息服务DMS”。 自定义Kafka 订阅目标连接地址 用户自己的kafka地址，需要打通网络。格式为逗号分割的ipv4:port。例如: 192.168.0.1:9092,192.168.0.2:9092 根据实际情况填写。 a.（可选）进入到“规则详情”，单击 ，配置Kafka SASLSSL，参数如下表所示。 说明 AOM当前仅支持Kafka SASLSSL安全认证配置，如果目前实例已经开启Kafka SASLSSL，请打开此开关。 配置Kafka SASLSSL参数 参数 说明 示例 用户名 SASL用户名用于实例访问认证。 demo 密码 SASL密码用于实例访问认证，请妥善管理密码，系统无法获取您设置的密码内容。 客户端证书 请采用.pem格式的客户端证书 b.单击“验证并保存自定义Kafka配置信息”，验证自定义Kafka实例连通性。 c.选择数据发送topic后，单击“确定”。 2、订阅目标类型选择“分布式消息服务DMS”，请参考下表配置参数。 数据订阅规则参数说明 参数 说明 示例 规则名称 订阅规则名称 输入：aomkafkatest。 订阅内容 支持“指标”和“告警”。 选择：指标。 订阅目标类型 选择“自定义Kafka”或“分布式消息服务DMS”。 分布式消息服务DMS 实例 选择DMS实例，如没有DMS实例，请单击“创建DMS实例”，创建DMS实例。 kafkaaom7160 a. 进入到“规则详情”，单击“创建网络连接通道”。 b. 验证DMS实例连通性。 您需要确保在安全组"入方向规则"中，放通9011端口，源地址为"198.19.128.0/20"的网络流量。设置安全组规则操作如下： i. 登录管理控制台。 ii. 在左侧导航栏，单击 ，选择“网络 > 虚拟私有云 VPC”。 iii. 在左侧导航栏单击“访问控制 > 安全组”，在使用DMS所在的安全组右侧，单击“配置规则”。 iv. 在“入方向规则”页签下，单击“添加规则”，放通9011端口、源地址为“198.19.128.0/20”的网络流量。 c. 单击“验证并保存DMS配置信息”。 d. 选择数据发送topic后，单击“确定”。 数据订阅格式说明 AOM格式的指标JSON格式代码片断 package metric type MetricDatas struct { Metrics []Metrics json:"metrics" ProjectId string json:"projectid" } type Metrics struct { Metric Metric json:"metric" Values []Value json:"values" CollectTime int64 json:"collecttime" } type Metric struct { Namespace string json:"namespace" Dimensions []Dimension json:"dimensions" } type Value struct { Value interface{} json:"value" Type string json:"type" Unit string json:"unit" StatisticValues string json:"statisticvalues" MetricName string json:"metricname" } type Dimension struct { Name string json:"name" Value string json:"value" } kafka消息示例 key:, value:{"metrics":[{"metric":{"namespace":"PAAS.NODE","dimensions":[{"name":"nodeName","value":"testvsscopmaster1"},{"name":"nodeIP","value":"1.1.1.1"},{"name":"hostID","value":"75d9711147344c6cae9ef6111111111"},{"name":"nameSpace","value":"default"},{"name":"clusterId","value":"46a7bc0d1d8b11ea9b04333333333333333"},{"name":"clusterName","value":"testvss111"},{"name":"diskDevice","value":"vda"},{"name":"master","value":"true"}]},"values":[{"value":0,"type":"","unit":"Kilobytes/Second","statisticvalues":"","metricname":"diskReadRate"},{"value":30.267,"type":"","unit":"Kilobytes/Second","statisticvalues":"","metricname":"diskWriteRate"}],"collecttime":1597821030037}],"projectid":"111111111111111111111"} 告警数据格式说明 示例： { "events": [{ "id": "4346299651651991683", "startsat": 1597822250194, "endsat": 0, "arrivesat": 1597822250194, "timeout": 300000, "resourcegroupid": "312313123112222222222232131312131", "metadata": { "kind": "Pod", "eventseverity": "Major", "resourcetype": "service", "clusterId": "6add4ef5135811eaa5bf111111111", "eventtype": "alarm", "clusterName": "cceief4516140c96ca4a5f8d851111111", "namespace": "PAAS.NODE", "name": "test15769793809553052f5557bd7fqnfkm", "eventname": "调度失败

接口功能介绍 操作日志excel导出 接口约束 传参规范 URI POST /vfw/v2logmanagerexportoperatelog 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id beginTime 是 Long 开始时间 endTime 是 Long 结束时间 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "firewallId": "4f12ffeaed354b77971952870c2ceacf", "severities": [ "HIGH" ], "action": "UPDATEASSERTPROTECT", "beginTime": 1731554784, "endTime": 1731641184, "regionId": "81f7728662dd11ec810800155d307d5b" }

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

接口功能介绍 至少指定一项待修改的属性。 接口约束 无 URI POST /v3/customImage/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOid 是 String 镜像ID mijdf39e1579j44bcrpa4hg imageName 否 String 镜像名称。只能由数字、英文字母、中划线、下划线和小数点组成，字符数限制[1,50]。 description 否 String 描述。字符数限制[0,200]。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"imageOid":"mixxx","imageName":"abb","description":null} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

接口功能介绍 修改VPC属性 接口约束 无 URI POST /v3/vpc/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 0dadb73d1cfa475687ed7c852d704c09 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcOid 是 String VPC ID vpc3z109ivhsly4j73nm4k6l vpcName 是 String VPC名称（只能包含中文、英文、数字、下划线、中划线和点，长度限制:[2,64]） fooNewName 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"vpcOid":"vpcmod","vpcName":"fooNewName"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

接口功能介绍 修改VPC子网DNS 接口约束 无 URI POST /v3/vpc/subnet/modifyDns 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 subnetOid 是 String 子网ID snfdvgm1exbhxbyvhh4eg2f dnsList 是 Array of Strings 子网DNS服务器列表（最少1个，最多5个） 115.115.115.115 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"subnetOid":"subnetmod","dnsList":["114.114.114.114"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

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

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

接口功能介绍 操作前请确保池化桌面池中没有云电脑 接口约束 无 URI POST /v3/commonDesktopPool/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 池化桌面池ID dpucod37vk0gca50kur44j4 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 快照策略功能请联系客户经理开通。 接口约束 无 URI POST /v3/snapshotPolicy/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotPolicyOid":"sspxxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

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

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

接口功能介绍 提供切换黑白名单或白名单防护状态接口 接口约束 无 URI POST /vfw/v2blackwhitepolicyswitchprotectstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙ID a6449feab4db11e9a6b40242ac110007 regionId 是 String 资源池ID ruleId 是 Long 规则ID 321 status 是 String 规则开关；disable；enable； disable uid 是 String 租户ID 6ee4c9fa71c3403eab8af44e29c3e4c1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果

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

接口功能介绍 云硬盘快照功能请联系客户经理开通。 接口约束 无 URI POST /v3/cloudVolumeSnapshot/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotOid 是 String 云硬盘快照ID snapshotName 是 String 云硬盘快照名称（不能超过64个字符） description 是 String 云硬盘快照描述（不能超过250个字符"） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "snapshotOid":"xxxxxxxxxxx", "snapshotName":"snapshotNameTest", "description":"this is cloud volume snapshot test" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } }

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

接口功能介绍 幂等接口，重复解绑会忽略并视为成功。 接口约束 无 URI POST /v3/desktop/unbindUser 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023101301183998 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOid":"XXXXXXXXXXXXX6925"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 切换云电脑所在VPC 接口约束 无 URI POST /v3/desktop/batch/changeVpc 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOidList 是 Array of Strings 云电脑ID列表，可设置一个或多个，最多10个 D0023092101180485 subnetOid 是 String 目标VPC子网ID snw3b8o6cb7afw4l3vd3bgb 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOidList":["XXXXXXXXXXXXX6925"],"subnetOid":"snxxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

步骤二：创建元数据导入任务 1.登陆管理控制台。 2.在管理控制台左上角单击，选择区域（请选择Kafka实例所在的区域）。 3.在管理控制台左上角单击，选择“企业中间件 > 分布式消息服务Kafka版”，进入分布式消息服务Kafka控制台页面。 4.单击集群迁移>元数据迁移>单击创建任务，进入实例详情页面。 5.输入任务名称，选择目标实例，单击上传元数据文件。 6.点击下一步，到Topic编辑页面，这里可以手动增加、删除、修改topic 7.点击下一步，到group编辑页面，这里可以手动增加、删除、修改group 8.点击创建，这样就生成了一条元数据迁移任务 步骤三：查看迁移结果 1.在左侧导航栏，单击实例列表。 2.在实例列表页面，单击目标实例名称。 3.查看资源列表。 4.在左侧导航栏，单击Topic 管理 ，在Topic 管理页面的Topic列表中查看已创建的Topic。 5.在左侧导航栏，单击消费组管理 ，在消费组管理页面的Group列表中查看已创建的Group。

本文介绍了RDSPostgreSQL提供的灵活备份方式，用于保障您的数据安全。 RDSPostgreSQL支持自动备份、手动备份、增量备份和跨域备份保障您的数据安全，方便您恢复历史数据。 备份原理及方案 RDSPostgreSQL实例支持自动、手动方式进行全量数据备份，备份类型支持全量备份、增量备份、日志备份，备份地域上支持本地域备份和跨域备份。 根据需要，在紧急情况下，您可以使用手动备份，也可以使用自动备份定期对数据进行备份，若担心自动备份周期过长，恢复数据时丢失过多数据，可以开启日志备份，当数据故障或数据损坏时，可以通过数据恢复还原数据，从而保证数据可靠性。 单机实例 采用单个数据库节点部署架构，具有高性价比。备份触发后，从实例备份数据并以压缩的形式存储到备份空间上，不会占用实例节点的磁盘空间。 高可用实例 采用一主一备、一主两备的高可用架构，主备实例每个节点的规格保持一致。备份触发后，从实例备份数据并以压缩包的形式存储在备份空间上，不会占用实例节点的磁盘空间。一主一备的高可用架构，仅能保证HA高可用，当实例数据丢失或者损坏后，无法保证数据的还原，只能依赖备份数据进行还原。若担心数据损坏或者丢失后，自动备份的周期过长，备份数据落后实例数据太多，建议您开启增量备份。

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

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