接口功能介绍 调用此接口可查询信息配置的基本信息和告警对象。 接口约束 参见请求参数说明。 URI GET /v4/monitor/querynoticetemplatevariable 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 group 是 String 本参数表示分组名称。取值范围： basic：基本信息。 entity：告警对象。 根据以上范围取值。 basic dimension 是 String 告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs 请求参数 请求头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 参数 参数类型 说明 示例 下级对象 name String lable名称 basic.idc description String lable描述 资源池名称

接口功能介绍 查看iplistener详情 接口约束 无 URI GET /v4/iplistener/show 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 ipListenerID 是 String 监听器 ID listenerxxx 请求参数 请求头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 参数 参数类型 说明 示例 下级对象 gwElbID String 网关负载均衡 ID gwlbxxx name String 名字 test 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

6、请求代码示例 json Curl X POST " H "ContentType: application/json" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "appkey:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:aiglobal.ctapi.ctyun.cn" data '{"data":["AAAAAAAAA...."]}' 7、返回值说明 请求成功返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Int 返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表。 0 message 是 String 如果statusCode 为 0，返回 success；如果statusCode 非 0，则返回对应的可读错误信息。 success returnObj 是 Dict 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 porn 是 List 审核场景 / porn[] 表porn 参数 是否必填 参数类型 说明 示例 下级对象 label 是 Int 分类标签值 0 / classname 是 String 分类标签描述 违规 / confidence 是 Float 该段文本违规的置信度 0.98 / 请求失败返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Int 错误码，放置API对应的错误码 4010 message 是 Str 返回对应的错误信息 error details 是 Str 返回对应的错误描述 文件大小不符合要求 error 是 String 返回对应的错误码 AIOP4101

接口功能介绍 查询应用接入点列表 接口约束 无 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

本节主要介绍功能特性 堆栈管理 堆栈是应用程序、云服务资源的集合。堆栈将应用、云服务作为一个整体来进行创建、升级、删除等。 在AOS中，通过创建堆栈可以把应用程序一键式部署到天翼云上，并有序的管理所依赖的云服务资源。 模板管理 AOS模板是一个YAML或JSON格式的文本描述文件，用于描述您想要的云对象（云对象包括应用、资源、服务等所有云上的对象）。AOS服务根据描述文件帮助您完成各种云对象的创建。 任何一种自动化的过程，都需要一种描述语言来控制其执行流程。 例如，shell脚本（文本文件）描述如何自动执行command命令，AOS模板也一样，用来描述各种云对象的创建、销毁等流程。以Shell脚本为例，其执行逻辑如下： Shell脚本特点大致为： •脚本是一个文本文件。 •若脚本写的好，可以重复执行。 AOS模板也是一样的逻辑，AOS服务就是模板的解释器，根据模板要求，执行对应动作。您可以把AOS看作是云上自动化标准。 一个良好定义输入、编排和输出的模板就会更加的通用。使用这个模板，就可以方便的进行传递和分享。

接口功能介绍 查询黑白名单接口 接口约束 传参规范 URI GET /vfw/v2blackwhitepolicyquery 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 addressDirection 否 String 地址方向 dst blackWhiteType 是 String 黑白类型 BLACK firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 ip 否 String ip地址 127.0.0.1/20 ipProto 否 String ip协议 v4 page 否 Integer 页码 1 ruleId 否 Long 规则id 1099 ruleIds 否 String 规则ids [1099] ruleName 否 String 规则名称 1099 size 否 Integer 条数 10 addressGroup 否 String 地址簿名称 dst 请求参数 请求头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 结果集 BlackWhitePolicyEntity 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 表 BlackWhitePolicyEntity 参数 参数类型 说明 示例 下级对象 ruleId Long 规则id 1099 ruleName String 规则名称 1099 ipProto String ip协议 v4 blackWhiteType String 黑白类型 BLACK addressDirection String 地址方向 dst ip String ip地址 127.0.0.1/20 mask Integer 掩码 32 blackWhiteDesc String 黑白名单描述 status Integer 规则开关 10 ipBeginNum String ip的开始数字形式 127.0.0.1/20 ipEndNum String ip的结束数字形式 127.0.0.1/20 privateIps String 私网ips 192.168.1.1/24 ipGroupId Integer ip地址组 11 ipGroupName String ip地址组 562b89493b1a40e1b97ea05e50dd8170

接口功能介绍 查询对等连接列表 接口约束 传参规范 URI GET /vfw/v2assertvpcPeerquery 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 endRow Long 当前页面最后一个元素在数据库中的行号 hasNextPage Boolean 是否有下一页 hasPreviousPage Boolean 是否有前一页 isFirstPage Boolean 是否为首页 isLastPage Boolean 是否为末页 list Array of Objects 资产列表 VpcPeerView navigateFirstPage Integer 导航条上的第一页 1 navigateLastPage Integer 导航条上的最后一页 1 navigatePages Integer 导航页码数 1 navigatepageNums Array of Integers 所有导航页号 1 nextPage Integer 下一页 1 pageNum Integer 当前页的页码 1 pageSize Integer 每页的数量 1 pages Integer 总页数 1 prePage Integer 前一页 1 size Integer 当前页的数量 1 startRow Long 当前页面第一个元素在数据库中的行号 total Long 总记录数 表 VpcPeerView 参数 参数类型 说明 示例 下级对象 id Long id vpcPeerId String 对等连接id name String 对等连接名称 vpcId String 本端vpc id requestVpcName String 本端vpc名称 requestVpcCidr String 本端vpc的网段 acceptVpcId String 对端vpc的id acceptVpcName String 对端vpc的名称 acceptVpcCidr String 对端vpc的网段 acceptEmail String 对端vpc账户的邮箱 userType String 类型: current(同租户);other(不同租户) status String 状态: agree(同意建立)/pending(待同意建立) protectStatus Boolean 防护状态false;true syncStatus String 同步状态 add, delete, unchanged firewallId String 防火墙id firewallEdition String 防火墙版本号 endpoint Object 终端节点 GwlbeInfoVo 表 GwlbeInfoVo 参数 参数类型 说明 示例 下级对象 endpointName String 终端节点名称 endpointId String 终端节点id vpcName String Vpc名称 subnetName String 子网名称 description String 描述

本章节介绍故障演练服务中应用配置管理功能。 概述 应用 是故障演练服务 中一组资源的逻辑聚合，是进行演练管理的核心对象。 创建应用 1. 登录应用高可用服务控制台。 2. 在左侧导航栏中，选择 故障演练 > 应用列表 ，进入应用列表页面。 3. 单击页面中的创建应用按钮。 4. 根据页面提示，填写应用名称 和描述 ，并选择其所属的环境。 5. 填写完毕后，单击确定按钮完成创建。 6. 返回应用列表，可以看到新创建的应用对象。 修改应用 1. 进入应用列表页面。 2. 在应用列表 中找到需要修改的应用对象，单击其操作列的 更多 > 编辑。 3. 在弹出的对话框中，根据需要修改应用名称 或描述 ，然后单击确定按钮完成修改。 4. 返回应用列表，可以看到应用信息已更新。 删除应用 1. 进入应用列表页面。 2. 在应用列表 中找到需要删除的应用对象，单击其操作列的 更多 > 删除。 3. 在弹出的确认对话框中，按提示完成删除操作。 4. 返回应用列表，确认该应用对象已被成功移除。 注意 若该应用下有正在执行的演练任务，则无法直接删除，必须先结束所有相关演练，才能执行删除操作。 若该应用被其他应用的演练任务关联，也无法直接删除，需要先解除关联演练任务对本应用的引用，然后再进行删除操作。

此小节介绍数据库安全如何配置隐私数据保护规则。 当需要对输入的SQL语句的敏感信息进行脱敏时，您可以通过开启隐私数据脱敏功能，以及配置隐私数据脱敏规则，防止数据库用户敏感信息泄露。 前提条件 已成功购买数据库安全审计实例，且实例的状态为“运行中”。 已成功添加数据库并开启审计功能。 已成功添加并安装Agent。 操作步骤 1. 登录管理控制台。 2. 单击右上角的 ，选择区域。 3. 选择“安全 > 数据库安全服务”，进入数据库安全审计“总览”界面。 4. 在左侧导航树中，选择“审计规则”，进入审计规则界面。 5. 在“选择实例”下拉列表框中，选择需要配置隐私数据保护规则的实例。 6. 选择“隐私数据保护”页签。 7. 开启或关闭“存储结果集”和“隐私数据脱敏”。 存储结果集 建议关闭 。关闭后，数据库安全审计分析平台将不会存储用户SQL语句的结果集。 说明 如果用于PCI DSS/PCI 3DS CSS认证，禁止开启。 隐私数据脱敏 建议开启 。开启后，您可以通过配置隐私数据脱敏规则，防止数据库敏感信息泄露。 8. 单击“添加自定义规则”，在弹出“添加自定义规则”对话框中设置数据脱敏规则，如下图所示，相关参数说明如下表所示。 参数名称 说明 取值样例 规则名称 自定义规则的名称。 test 正则表达式 输入需要配置的正则表达式。 替换值 输入正则表达式脱敏后的替换值。

本文以“通过SSH远程安装Agent”为例介绍如何安装Agent，更多安装Agent的方法请参Agent管理。 通过SSH远程安装Agent 您可以通过SSH协议将Agent自动安装到需要审计的服务器上，目前仅支持Linux系统。 在界面上输入需要审计的服务器IP、SSH端口、root用户名、密码，天翼云数据库审计通过scp协议将agent安装包传输到宿主机上并自动安装。 1. 在菜单栏选择“系统管理 > Agent管理”进入“Agent管理”页面，选择“Agent安装”页签。 2. 单击“开始安装”进入通过SSH远程安装Agent页面，编辑审计服务器IP，并添加安装Agent的服务器，单击“安装”。 填写参数说明请参见下表： 参数 参数说明 审计服务器IP 默认为当前的审计服务器IP，用户可以根据需要修改。 安装Agent的服务器 输入需要安装Agent的服务器IP及该服务器root账户的密码，默认端口为22，用户可以根据实际情况修改。 支持表单格式和文本格式输入。 支持IPv4和IPv6。 最多填写20个。 说明 单击“安装状态”可进入“安装状态”查看页面，可进行以下操作： 单击“卸载”可远程卸载已经成功安装了的Agent。 单击“重新安装”可对未成功安装Agent的服务器重新安装。 将光标悬停至“安装失败”后的图标，查看安装失败原因。 若您的业务部署在一类节点的资源池上，审计服务器IP需改为数据库审计所在的VPC组的公网IP。（一类节点可参考[支持的区域](/document/10446453/10489850

本文介绍并行文件服务HPFS产品的欠费说明提醒。 您可在费用中心总览或费用中心资金管理余额明细查看欠费金额。按需计费是先使用后付费的模式，即会根据使用资源的时间从用户的帐户余额中扣费，因此会出现欠费的情况。欠费后，账户下的按需资源将进入保留期，您将不能正常访问及使用按需计费的并行文件系统（资源冻结），但对于您存储在并行文件系统中的数据予以保留。 注意 账户欠费状态下，您需要在结清欠费账单后确认账户余额大于等于 100 元人民币，否则将无法创建和删除文件系统。 您可以在费用中心总览自行设置可用额度预警，当余额低于预警阈值时，系统将发送短信提醒。账户欠费将影响资源正常访问，请及时充值避免造成业务损失。 数据保留 欠费后存储资源将暂时被冻结，无法进行读写操作。资源保留期15天，若没有及时续费资源及数据将被销毁，无法找回。 并行文件服务资源保留期为15天。 若您在保留期内充值，充值后系统会自动扣减欠费金额，恢复使用。 若保留期到期您仍未充值，存储在文件系统中的数据将被删除、文件系统资源将被释放。 欠费提醒 用户可自定义账户提醒余额，当账户金额小于用户自定义余额时，用户会收到一次账户金额低于设定值的提醒。当用户欠费时，系统会向用户发送一次欠费提醒，并在欠费的第2天、第4天、第6天各发送一次欠费提醒。欠费提醒会以邮件和短信方式告知用户，请及时关注您的短信及邮件。

本文主要介绍云搜索服务的应用场景。 日志检索分析 云搜索服务可以采集分析各类以文件形式存储的日志，包括不限于服务器、容器日志等。结合消息队列Kafka、Logstash对日志数据进行采集清洗，进入Elasticsearch或OpenSearch中存储检索分析，并通过Kibana或Dashboards进行可视化呈现。 高稳定：通过读写限流、查询熔断、集群监控等方式保障。 性能优化：通过支持压缩算法、内核增强节省存储空间，增强读写速率、降低响应延迟。 易用性：支持多种统计分析方法、划分维度，丰富的可视化查询，可对接BI实现拖拽式报表。 站内搜索 面对海量数据，提供分布式的信息检索工具，可根据网站内容进行关键字检索，也可搭建商品检索或推荐系统。 实时检索：支持模糊搜索，数据来源多样且持续写入，站内资料或商品信息更新数秒内即可被检索。 分类统计：检索同时可以将符合条件的结果进行排序或分类统计。 多场景适配：可用于网站、移动端应用搜索、企业内部应用等多种需要快速检索的场景。 数据分析 提供开箱即用的可视化、高聚合分析能力，便捷高效地对海量数据实时分析。更好地适配实时多维分析在线查询服务场景，满足高实时性，高查询QPS，低查询延迟的数据分析要求。 快速响应：支持海量的、数据源多样、字段不固定的数据高并发处理，毫秒级响应。 复杂查询：支持大批量模糊关键字搜索及一些聚合的复杂查询。 向量检索：基于向量特征相似度匹配，支持图文搜索、地理位置搜索。

接口功能介绍 更改接入点的资源权限 接口约束 无 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

接口功能介绍 创建租户身份凭证aksk 接口约束 无 URI POST /v1/userAkControl/createUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d policy 否 String 名称 full 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 userAk String 租户ak 02baad12e63c471c85400df031e18520 userSk String 租户sk 11111111111111111111111111111111 userId String 租户id 562b89493b1a40e1b97ea05e50dd8170 policy String 权限 full applicationId String 接入点id b2160c2c9c704ca9b8080d186c97280d requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d

接口功能介绍 创建租户身份凭证aksk 接口约束 无 URI POST /v1/userAkControl/createUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d policy 否 String 名称 full 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 userAk String 租户ak 02baad12e63c471c85400df031e18520 userSk String 租户sk 11111111111111111111111111111111 userId String 租户id 562b89493b1a40e1b97ea05e50dd8170 policy String 权限 full applicationId String 接入点id b2160c2c9c704ca9b8080d186c97280d requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d

接口功能介绍 获取接入点的接口权限详情 接口约束 无 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/create 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 是 String IPSCE 服务名称 111ipsec regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 ipAddress 是 String IPAddress 111.0.0.1 vpnGatewayID 否 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 GET /v4/monitor/querydevicetypes 请求参数 Query参数 无。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 devices Array of Objects 设备类型列表 device 表device 参数 参数类型 说明 示例 下级对象 device String 设备类型 vm description String 描述 云主机 请求示例 GET /v4/monitor/querydevicetypes 响应示例 json { "statusCode": 800, "returnObj": { "devices": [ {"device": "vm", "description": "云主机"}, {"device": "disk", "description": "云硬盘"}, {"device": "baremetal", "description": "物理机"}, {"device": "eip","description": "弹性ip/ipv6"} ] }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

接口功能介绍 删除给定的监控视图。 监控视图属于一个监控面板，一个监控面板可以包含多个监控视图。 接口约束 regionID（资源池）、templateID（监控面板）、viewID（监控视图）存在。 URI POST /v4/monitor/deletemonitorview 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID viewID String 是 9a8892ba486c11eda9b7005056897257 监控视图ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否删除成功 true

字段 说明 apiVersion API版本，固定值“autoscaling.cce.io/v2alpha1”。 kind API类型，固定值“CronHorizontalPodAutoscaler”。 metadata.name CronHPA策略名称。 metadata.namespace CronHPA策略所在的命名空间。 spec.scaleTargetRef 指定CronHPA的扩缩容对象，可配置以下字段： apiVersion：CronHPA扩缩容对象的API版本。 kind：CronHPA扩缩容对象的API类型。 name：CronHPA扩缩容对象的名称。CronHPA支持HPA策略或Deployment。 spec.rules CronHPA策略规则，可添加多个规则。每个规则可配置以下字段： ruleName：CronHPA规则名称，该名称需唯一。 schedule：指定任务运行时间与周期，参数格式与CronTab类似，请参见

本节介绍了如何创建数据库账号。 操作场景 开通实例后，通过控制台创建数据库账号。 操作步骤 1. 登录天翼云官网。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在【实例管理】的实例列表中选择目标实例，点击实例名称进入实例管理详情页。 6. 选择账号管理页签。 7. 点击创建账号按钮。 8. 在弹出框中，填写账号、密码、备注说明、选择账号类型和密码有效期，点击确定提交。 参数 说明 账号 由字母、数字或下划线组成。 不能以pg开头。 不能使用SQL关键字。 长度为2~63个字符。 账号类型 支持数据库账号：高权限账号和普通账号。 密码 长度为8~32个字符。 由大写字母、小写字母、数字和特殊字符中的任意三种或以上组成。 特殊字符支持为!@ $%^&()+。 有效期 支持有效期为长期有效和短期有效。 备注说明 填写备注信息，最大支持1000个字符。 注意 不同资源池因IaaS资源能力等原因，加载版本有所差异，详见

本文介绍了重启RDSPostgreSQL实例操作。 通常出于维护目的，您可能需要重启数据库实例。例如当实例出现连接数满或者其他性能问题时，您可以通过控制台页面手动对数据库实例进行重启操作。 约束限制 如果数据库实例处于“异常”状态，可能会重启失败。 重启数据库实例会重新启动数据库引擎服务。重启数据库实例将导致短暂中断，在此期间，数据库实例状态将显示为“重启中”。 重启过程中，实例将不可用。重启后实例会自动释放内存中的缓存，请在业务低峰期进行重启，避免对高峰期业务造成影响。 如果是主备实例，对应的备实例也会被同步重启，业务也会有中断。 操作步骤 1. 登录天翼云门户。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在“实例管理”页面，选择指定的实例，单击“更多”>“重启”。如果是主备实例，对应的备实例也会被同步重启，业务也会有中断。 6. 在“重启”弹框，单击“确定”重启实例。 7. 实例重启完成后，实例状态为正常运行中。

本节介绍云手机（政企版）的创建虚拟私有云操作说明。 操作场景 云手机如果需要上网，需配置虚拟私有云（VPC）、子网及上网带宽。VPC可在开通云手机服务时同步创建，也可单独管理。 创建虚拟私有云 1.进入“云手机”控制台； 2.单击“网络管理”，选择“虚拟私有云”，进入虚拟私有云管理页面； 3.点击“创建虚拟私有云”按钮； 4.配置虚拟私有云的“网段”、“名称”、“子网名称”、“子网网络地址”等信息； 5.确认配置信息后，点击“立即创建”，即完成云手机虚拟私有云及子网的创建。 创建IPv6云手机 当虚拟私有云开启了IPv6的功能后，创建云手机在网络模块配置时，选择开启IPv6功能的子网后，云手机则同样可以选择是否开启IPv6，具体操作如下。 操作步骤 1.在创建虚拟私有云时，子网 IPv6网段选择“开启IPv6”； 2.创建云手机时，网络模块选择绑定开启IPv6的业务子网，然后选择“开启IPv6”； 3.云手机其他信息完成配置后，点击“开通云手机”，即完成IPv6的云手机创建。

接口功能介绍 设置带宽VPC 接口约束 无 URI POST /v3/bandwidth/setVpc 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 bandwidthOid 是 String 带宽ID bwsya8ts02mjfxfxf2i000t vpcOid 是 String VPC ID vpchlhmzjrk74jg85kg3trh6 subnetOidList 是 Array of Strings 子网ID列表，长度至少为1 snepz4b7l2fdeirbgetbdlg 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"bandwidthOid":"bwfoo","vpcOid":"vpcxxx","subnetOidList":["snxx"]}

接口功能介绍 编辑池化桌面池策略 接口约束 无 URI POST /v3/commonDesktopPool/editPolicy 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 池化桌面池ID dpucod37vk0gca50kur44j4 keepDuration 否 Integer 用户断开连接后，云电脑的保留时长（单位：分钟），至少是3 33 afterReleaseAction 否 String 云电脑释放后操作（rebuild还原;stop关机） null rebuildAfterStopOrReboot 否 String 关机/重启后还原系统（on开启;off关闭） null 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无

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

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

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

接口功能介绍 修改云电脑归属部门 接口约束 无 URI POST /v3/desktop/batch/modifyOrg 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOidList 是 Array of Strings 云电脑ID列表，可设置一个或多个，最多10个 D0023092001180339 orgOid 是 String 部门ID org4eq48g7mes4dvuh011j2o includeUser 否 Boolean 是否包括云电脑关联用户，默认为否 includeUser 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOidList":["XXXXXXXXXXXXX6925"],"orgOid":"orghgh29f93c2anwk0332hxn","includeUser":null}

监控看板 监控看板：视图详情 接口功能介绍 查看监控看板详细信息，包括视图信息，不包含监控数据信息。 接口约束 参见请求参数说明。 URI GET /v4/monitor/monitorboard/describeview 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b viewID 是 String 监控视图ID 0bf803e8504911ed8fb7005056897257 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 viewID String 监控视图ID 0a84e6da9fabfcd115526ab6a0b7ac88 name String 监控视图名称 name service String 云监控服务 ecs dimension String 云监控维度 ecs viewType String 视图类型。取值范围:timeSeries：折线图。gauge：仪表盘。barChart：柱状图。table：表格。pieChart：饼状图。根据以上范围取值。 timeSeries orderIndex Integer 排序次序，相同则按照updateTime降序。 0 itemNameList Array of Strings 监控指标，指标项最多支持20个 ['cpuutil'] compares Array of Strings 同比环比比较时间配置，格式为“数字+单位”，单位为空时默认为秒。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 ['1d'] resources Array of Objects 监控资源实例 ,监控资源实例最多支持20个 resource gaugePattern Object 仪表盘配置，仅当viewType为gaugePattern时有效 gaugePattern createTime Integer 创建时间，时间戳，精确到秒 1667459789 updateTime Integer 最近更新时间, 时间戳，精确到秒 1667459789 表 resource 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源 obj 表 obj 参数 参数类型 说明 示例 下级对象 key String 资源键 uuid value String 资源键对应的值 xxxx 表 gaugePattern 参数 参数类型 说明 示例 下级对象 minVal Integer 仪表盘最小值 0 maxVal Integer 仪表盘最大值 100 threshold Array of Integers 仪表盘中间分段取值 [30,80]

archivetimeout (integer) archivecommand仅在已完成的 WAL 段上调用。因此，如果你的服务器只产生很少的 WAL 流量（或产生流量的周期很长），那么在事务完成和它被安全地记录到归档存储之间将有一个很长的延迟。为了限制未归档数据存在的时间，你可以设置archivetimeout来强制服务器来周期性地切换到一个新的 WAL 段文件。当这个参数被设置为大于零时，只要从上次段文件切换后过了参数所设置的那么多秒并且已经有过任何数据库活动，包括一个单一检查点（如果没有数据库活动则跳过检查点），服务器将切换到一个新的段文件。注意，由于强制切换而提早关闭的被归档文件仍然与完整的归档文件长度相同。因此，使用非常短的archivetimeout是不明智的 — 它将占用巨大的归档存储。一分钟左右的archivetimeout设置通常比较合理。如果你希望数据能被更快地从主服务器上复制下来，你应该考虑使用流复制而不是归档。这个参数只能在postgresql.conf文件中或在服务器命令行上设置。