{ "name": "postgres", "display_name": "云数据库 PostgreSQL", "description": "介绍如何使用API对云数据库PostgreSQL进行操作，包括实例管理、创建数据库账号等。", "domain": "database", "api_version": "2017-03-12", "endpoint": "postgres.tencentcloudapi.com", "actions": [ { "name": "AddDBInstanceToReadOnlyGroup", "description": "本接口（AddDBInstanceToReadOnlyGroup）用于添加只读实例到只读组", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "pgro-9epegwdp" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取", "example": "pgrogrp-efacxt00" } ], "required": [ "DBInstanceId", "ReadOnlyGroupId" ] }, { "name": "CloneDBInstance", "description": "用于克隆实例，支持指定备份集、指定时间点进行克隆。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "克隆的源实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-ascg1724" }, { "name": "SpecCode", "type": "string", "required": true, "description": "售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。", "example": "pg.it.2xlarge16" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘容量大小，设置步长限制为10。单位：GB。", "example": "10" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长，单位：月。 - 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36 - 后付费：只支持1", "example": "1" }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "续费标记。仅当计费模式为预付费时生效。 枚举值： - 0：手动续费 - 1：自动续费 默认值：0", "example": "1" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询；也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ，从接口返回中的unVpcId字段获取。", "example": "vpc-2ot3acw1" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的unSubnetId字段获取。", "example": "subnet-ppv9iw34" }, { "name": "Name", "type": "string", "required": false, "description": "新购的实例名称，仅支持长度小于60的中文/英文/数字/\"_\"/\"-\"，不指定实例名称则默认显示\"源实例名-Copy\"。", "example": "ins-name-clone-1" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例计费类型，目前支持： - PREPAID：预付费，即包年包月 - POSTPAID_BY_HOUR：后付费，即按量计费 默认值：PREPAID", "example": "PREPAID" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用[DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808)的返回值中的SecurityGroupId字段来获取。若不指定该参数，则绑定默认安全组。", "example": "[\"sg-95hf6965\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。默认值为0，表示所属默认项目。", "example": "0" }, { "name": "TagList", "type": "array", "required": false, "description": "实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "prod" } ] }, { "name": "DBNodeSet", "type": "array", "required": false, "description": "实例节点部署信息，必须填写主备节点可用区。支持多可用区部署时需要指定每个节点的部署可用区信息。 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。", "example": "无", "item_type": "object", "children": [ { "name": "Role", "type": "string", "required": true, "description": "节点类型，值可以为： Primary，代表主节点； Standby，代表备节点。", "example": "Primary, Standby" }, { "name": "Zone", "type": "string", "required": true, "description": "节点所在可用区，例如 ap-guangzhou-1。", "example": "ap-guangzhou-1" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "专属集群ID", "example": "cluster-d8htgb6k" } ] }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券： - 0：否 - 1：是 默认值：0", "example": "0" }, { "name": "VoucherIds", "type": "string", "required": false, "description": "代金券ID列表。", "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]" }, { "name": "ActivityId", "type": "integer", "required": false, "description": "活动ID。", "example": "2364" }, { "name": "BackupSetId", "type": "string", "required": false, "description": "基础备份集ID。参数BackupSetId、RecoveryTargetTime两者必须填写一项，且不能同时填写。", "example": "f6yecd1a-087c-5c66-cdas-95c835d7ec24" }, { "name": "RecoveryTargetTime", "type": "string", "required": false, "description": "恢复时间点。参数BackupSetId、RecoveryTargetTime两者必须填写一项，且不能同时填写。", "example": "2021/12/25 1:27:35" }, { "name": "SyncMode", "type": "string", "required": false, "description": "主从同步方式，支持： Semi-sync：半同步 Async：异步 主实例默认值：Semi-sync 只读实例默认值：Async", "example": "Async" }, { "name": "DeletionProtection", "type": "boolean", "required": false, "description": "实例是否开启删除保护: true-开启删除保护；false-关闭删除保护。", "example": "true" } ], "required": [ "DBInstanceId", "SpecCode", "Storage", "Period", "AutoRenewFlag", "VpcId", "SubnetId" ] }, { "name": "CloseAccountCAM", "description": "本接口用于关闭数据库账户的CAM验证服务。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID", "example": "postgres-4sfuv15b" }, { "name": "UserName", "type": "string", "required": true, "description": "需要关闭CAM服务的账号名称", "example": "readonly_user" }, { "name": "Password", "type": "string", "required": true, "description": "关闭CAM后，登录该账号所需要的新密码", "example": "1359Qwe!" }, { "name": "PasswordEncrypt", "type": "boolean", "required": false, "description": "密码是否加密", "example": "false" } ], "required": [ "DBInstanceId", "UserName", "Password" ] }, { "name": "CloseDBExtranetAccess", "description": "本接口（CloseDBExtranetAccess）用于关闭实例公网地址。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。形如postgres-6r233v55", "example": "postgres-apzvwncr" }, { "name": "IsIpv6", "type": "integer", "required": false, "description": "是否关闭Ipv6外网，1：是，0：否。默认值：0。", "example": "0" } ], "required": [ "DBInstanceId" ] }, { "name": "CreateAccount", "description": "此接口用于创建数据账号，返回的Oid为账号唯一标识。与数据库系统表pg_roles中记录的oid一致。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-4sfuv15b" }, { "name": "UserName", "type": "string", "required": true, "description": "创建的账号名称。由字母（a-z, A-Z）、数字（0-9）、下划线（_）组成，以字母或（_）开头，最多63个字符。不能使用系统保留关键字，不能为postgres，且不能由pg_或tencentdb_开头", "example": "readonly_user" }, { "name": "Type", "type": "string", "required": true, "description": "账号类型。当前支持normal、tencentDBSuper两个输入。normal指代普通用户，tencentDBSuper为拥有pg_tencentdb_superuser角色的账号。", "example": "normal" }, { "name": "Password", "type": "string", "required": false, "description": "账号对应的密码。密码规则如下： 长度8 ~ 32位，推荐使用12位以上的密码 不能以\" / \"开头 必须包含以下四项: 小写字母 a ~ z 大写字母 A ～ Z 数字 0 ～ 9 特殊字符 ()`~!@#$%^\u0026*-+=_|{}[]:,.?/", "example": "1357Qwe!" }, { "name": "Remark", "type": "string", "required": false, "description": "账号备注。只允许英文字母、数字、下划线、中划线，以及全体汉字，限60个字符", "example": "test Remark" }, { "name": "OpenCam", "type": "boolean", "required": false, "description": "账号是否开启CAM验证", "example": "false" } ], "required": [ "DBInstanceId", "UserName", "Type" ] }, { "name": "CreateBackupPlan", "description": "此接口用于创建备份策略。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-herclkx7" }, { "name": "PlanName", "type": "string", "required": true, "description": "备份计划名称。", "example": "panl1" }, { "name": "BackupPeriodType", "type": "string", "required": true, "description": "创建的备份计划类型，当前仅支持month创建。", "example": "month" }, { "name": "BackupPeriod", "type": "array", "required": true, "description": "备份的日期，示例是每个月的2号开启备份。", "example": "['2']", "item_type": "string" }, { "name": "MinBackupStartTime", "type": "string", "required": false, "description": "备份开始时间，不传跟随默认备份计划。", "example": "01:00:00\t" }, { "name": "MaxBackupStartTime", "type": "string", "required": false, "description": "备份结束时间，不传跟随默认计划。", "example": "02:00:00\t" }, { "name": "BaseBackupRetentionPeriod", "type": "integer", "required": false, "description": "数据备份保留时长，单位：天。取值范围为：[0,30000) BackupPeriodType为week时默认是7,为month时默认为31。", "example": "30" } ], "required": [ "DBInstanceId", "PlanName", "BackupPeriodType", "BackupPeriod" ] }, { "name": "CreateBaseBackup", "description": "本接口（CreateBaseBackup）用于创建实例的数据备份。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxxxxxxx" } ], "required": [ "DBInstanceId" ] }, { "name": "CreateDBInstanceNetworkAccess", "description": "本接口（CreateDBInstanceNetworkAccess）用于创建实例网络。单个实例允许创建的网络配置最多为2套，最少为1套。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如：postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络统一 ID。", "example": "vpc-gaestjaf" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网ID。", "example": "subnet-4s9dejli" }, { "name": "IsAssignVip", "type": "boolean", "required": true, "description": "是否指定分配vip true-指定分配 false-自动分配。", "example": "true" }, { "name": "Vip", "type": "string", "required": false, "description": "目标VIP地址。当不指定该参数，且IsAssignVip为true时，默认自动分配Vip。", "example": "10.*.*.*" } ], "required": [ "DBInstanceId", "VpcId", "SubnetId", "IsAssignVip" ] }, { "name": "CreateDatabase", "description": "此接口用于创建数据库，需指定数据库名及所有者。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "创建的数据库名。 名称规范：由字母（a-z, A-Z）、数字（0-9）、下划线（_）组成，以字母或（_）开头，最多63个字符。不能使用系统保留关键字，不能为postgres。", "example": "mydatabase" }, { "name": "DatabaseOwner", "type": "string", "required": true, "description": "数据库的所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取", "example": "data_team" }, { "name": "Encoding", "type": "string", "required": false, "description": "数据库的字符编码。 支持的常用字符集包括：UTF8、LATIN1、LATIN2、WIN1250、WIN1251、WIN1252、KOI8R、EUC_JP、EUC_KR 默认值：UTF8", "example": "UTF8" }, { "name": "Collate", "type": "string", "required": false, "description": "数据库的排序规则", "example": "C" }, { "name": "Ctype", "type": "string", "required": false, "description": "数据库的字符分类", "example": "C" } ], "required": [ "DBInstanceId", "DatabaseName", "DatabaseOwner" ] }, { "name": "CreateInstances", "description": "本接口 (CreateInstances) 用于创建一个或者多个PostgreSQL实例，通过此接口创建的实例无需进行初始化，可直接使用。 实例创建成功后将自动开机启动，实例状态变为“运行中”。 预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属主可用区， 如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息；可用区信息可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。", "example": "ap-guangzhou-6" }, { "name": "SpecCode", "type": "string", "required": true, "description": "售卖规格码。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。", "example": "pg.it.2xlarge16" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘容量大小，单位：GB。该参数的设置步长为10。", "example": "60" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长，单位：月。预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36后付费：只支持1", "example": "12" }, { "name": "Charset", "type": "string", "required": true, "description": "实例字符集，目前只支持： UTF8 LATIN1", "example": "UTF8" }, { "name": "AdminName", "type": "string", "required": true, "description": "实例根账号用户名，具体规范如下：用户名需要1-16个字符，只能由字母、数字或下划线组成不能为postgres不能由数字和pg_开头所有规则均不区分大小写", "example": "pgadmin1" }, { "name": "AdminPassword", "type": "string", "required": true, "description": "实例根账号用户名对应的密码，长度8 ~ 32位，推荐使用12位以上的密码;不能以\u0026quot; / \u0026quot;开头;必须包含以下四项，字符种类:小写字母： [a ~ z]大写字母：[A ～ Z]数字：0 - 9特殊字符：()`~!@#$%^\u0026amp;*-+=_|{}[]:;'\u0026lt;\u0026gt;,.?/", "example": "A8b!C2d#E4f\u0026" }, { "name": "DBMajorVersion", "type": "string", "required": false, "description": "PostgreSQL大版本号（该参数当前必传），版本信息可从DescribeDBVersions获取。目前支持10，11，12，13，14，15这几个大版本，详情见内核版本概述。输入该参数时，会基于此大版本号创建对应的最新小版本的最新内核版本号实例。", "example": "12" }, { "name": "DBVersion", "type": "string", "required": false, "description": "PostgreSQL社区大版本+小版本号。一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新小版本号。", "example": "12.7" }, { "name": "DBKernelVersion", "type": "string", "required": false, "description": "PostgreSQL内核版本号。一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新内核版本号。", "example": "v12.7_r1.8" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例计费类型，目前支持：PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：后付费，即按量计费默认值：PREPAID", "example": "POSTPAID_BY_HOUR" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，形如vpc-xxxxxxxx（该参数当前必传）。有效的VpcId可通过登录控制台查询；也可以调用接口 DescribeVpcEx ，从接口返回中的unVpcId字段获取。", "example": "vpc-8e0ypm3z" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络子网ID，形如subnet-xxxxxxxx（该参数当前必传）。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的unSubnetId字段获取。", "example": "subnet-bthucmmy" }, { "name": "DBNodeSet", "type": "array", "required": false, "description": "实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。可用区信息可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。", "example": "无", "item_type": "object", "children": [ { "name": "Role", "type": "string", "required": true, "description": "节点类型，值可以为： Primary，代表主节点； Standby，代表备节点。", "example": "Primary, Standby" }, { "name": "Zone", "type": "string", "required": true, "description": "节点所在可用区，例如 ap-guangzhou-1。", "example": "ap-guangzhou-1" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "专属集群ID", "example": "cluster-d8htgb6k" } ] }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "续费标记：0：手动续费1：自动续费默认值：0", "example": "0" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券：0：否1：是默认值：0", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。默认取之为0，表示归属默认项目。", "example": "0" }, { "name": "ActivityId", "type": "integer", "required": false, "description": "活动ID。", "example": "14542" }, { "name": "Name", "type": "string", "required": false, "description": "实例名称，仅支持长度小于60的中文/英文/数字/\u0026quot;_\u0026quot;/\u0026quot;-\u0026quot;，不指定实例名称则默认显示\u0026quot;未命名\u0026quot;。", "example": "pg-instance-1" }, { "name": "TagList", "type": "array", "required": false, "description": "实例需要绑定的Tag信息，默认为空；可以通过调用 DescribeTags 返回值中的 Tags 字段来获取。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "prod" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组，该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。", "example": "[ \"sg-g09vl0p7\" ]", "item_type": "string" }, { "name": "NeedSupportTDE", "type": "integer", "required": false, "description": "是否需要支持数据透明加密：0：否1：是默认值：0参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)", "example": "1" }, { "name": "KMSKeyId", "type": "string", "required": false, "description": "自定义密钥的KeyId，若选择自定义密匙加密，则需要传入自定义密匙的KeyId，KeyId是CMK的唯一标识。KeyId创建获取相关参考开启透明数据加密", "example": "7f370325-bb06-11ec-b54a-525400bb1222" }, { "name": "KMSRegion", "type": "string", "required": false, "description": "使用KMS服务的地域，KMSRegion为空默认使用本地域的KMS，本地域不支持的情况下需自选其他KMS支持的地域。KMSRegion相关介绍参考开启透明数据加密", "example": "ap-guangzhou" }, { "name": "KMSClusterId", "type": "string", "required": false, "description": "指定KMS服务的集群，KMSClusterId为空使用默认集群的KMS，若选择指定KMS集群，则需要传入KMSClusterId。 KMSClusterId相关介绍参考开启透明数据加密", "example": "cls-hsm-xxxxxxx" }, { "name": "DBEngine", "type": "string", "required": false, "description": "数据库引擎，支持：postgresql：云数据库PostgreSQLmssql_compatible：MSSQL兼容-云数据库PostgreSQL默认值：postgresql", "example": "postgresql" }, { "name": "DBEngineConfig", "type": "string", "required": false, "description": "数据库引擎的配置信息，配置格式如下：{\u0026quot;$key1\u0026quot;:\u0026quot;$value1\u0026quot;, \u0026quot;$key2\u0026quot;:\u0026quot;$value2\u0026quot;}各引擎支持如下：mssql_compatible引擎：migrationMode：数据库模式，可选参数，可取值：single-db（单数据库模式），multi-db（多数据库模式）。默认为single-db。defaultLocale：排序区域规则，可选参数，在初始化后不可修改，默认为en_US，可选值如下：\"af_ZA\", \"sq_AL\", \"ar_DZ\", \"ar_BH\", \"ar_EG\", \"ar_...", "example": "{\"migrationMode\":\"single-db\",\"DefaultLocale\":\"zh_CN\",\"serverCollationName\":\"sql_latin1_general_cp1250_ci_as\"}" }, { "name": "SyncMode", "type": "string", "required": false, "description": "主从同步方式，支持： Semi-sync：半同步Async：异步主实例默认值：Semi-sync只读实例默认值：Async", "example": "Async" }, { "name": "NeedSupportIpv6", "type": "integer", "required": false, "description": "是否需要支持Ipv6：0：否1：是默认值：0", "example": "0" }, { "name": "DeletionProtection", "type": "boolean", "required": false, "description": "实例是否开启删除保护: true-开启删除保护；false-关闭删除保护。", "example": "true" } ], "required": [ "Zone", "SpecCode", "Storage", "InstanceCount", "Period", "Charset", "AdminName", "AdminPassword" ] }, { "name": "CreateParameterTemplate", "description": "本接口 (CreateParameterTemplate) 用于创建参数模板。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称，长度为1～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@", "example": "test_template" }, { "name": "DBMajorVersion", "type": "string", "required": true, "description": "数据库大版本号，例如：11，12，13。可通过[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取", "example": "13" }, { "name": "DBEngine", "type": "string", "required": true, "description": "数据库引擎，例如：postgresql，mssql_compatible", "example": "postgresql" }, { "name": "TemplateDescription", "type": "string", "required": false, "description": "参数模板描述，长度为0～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@", "example": "my_custom_template" } ], "required": [ "TemplateName", "DBMajorVersion", "DBEngine" ] }, { "name": "CreateReadOnlyDBInstance", "description": "本接口(CreateReadOnlyDBInstance)用于创建只读实例", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属主可用区， 如：ap-guangzhou-3；可用区信息可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "MasterDBInstanceId", "type": "string", "required": true, "description": "只读实例的主实例ID。可通过DescribeDBInstances接口获取", "example": "postgres-efacxt00" }, { "name": "SpecCode", "type": "string", "required": true, "description": "售卖规格码。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。", "example": "pg.it.large8" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例硬盘容量大小，单位：GB。该参数的设置步长为10。", "example": "100" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "购买实例数量，取值范围：[1-6]。购买支持最大数量6个。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长，单位：月。预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36后付费：只支持1", "example": "1" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，形如vpc-xxxxxxxx（该参数当前必传）。有效的VpcId可通过登录控制台查询；也可以调用接口 DescribeVpcEx ，从接口返回中的unVpcId字段获取。", "example": "vpc-e3t30r8t" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络子网ID，形如subnet-xxxxxxxx（该参数当前必传）。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的unSubnetId字段获取。", "example": "subnet-jd9cvu0o" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例计费类型，目前支持：PREPAID：预付费，即包年包月。POSTPAID_BY_HOUR：后付费，即按量计费。默认值：PREPAID。如果主实例为后付费，只读实例必须也为后付费。", "example": "PREPAID" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券：0：否1：是默认值：0", "example": "1" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[ \"100\" ]", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "续费标记：0：手动续费1：自动续费默认值：0", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。默认值为0，表示归属默认项目。", "example": "1457" }, { "name": "ActivityId", "type": "integer", "required": false, "description": "优惠活动ID", "example": "1364" }, { "name": "ReadOnlyGroupId", "type": "string", "required": false, "description": "只读组ID。", "example": "pgrogrp-efacxt00" }, { "name": "TagList", "type": "object", "required": false, "description": "实例需要绑定的Tag信息，默认为空；可以通过调用 DescribeTags 返回值中的 Tags 字段来获取。", "example": "无", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "prod" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组，该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。", "example": "[\"sg-95hf696p\"]", "item_type": "string" }, { "name": "NeedSupportIpv6", "type": "integer", "required": false, "description": "是否需要支持Ipv6：0：否1：是默认值：0", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "实例名。仅支持长度小于60的中文/英文/数字/\u0026quot;_\u0026quot;/\u0026quot;-\u0026quot;", "example": "Name" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "专属集群ID", "example": "dedicatedCluster-gz" }, { "name": "DeletionProtection", "type": "boolean", "required": false, "description": "实例是否开启删除保护: true-开启删除保护；false-关闭删除保护。", "example": "true" } ], "required": [ "Zone", "MasterDBInstanceId", "SpecCode", "Storage", "InstanceCount", "Period" ] }, { "name": "CreateReadOnlyGroup", "description": "本接口（CreateReadOnlyGroup）用于创建只读组", "status": "online", "parameters": [ { "name": "MasterDBInstanceId", "type": "string", "required": true, "description": "主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-4xf28bd3" }, { "name": "Name", "type": "string", "required": true, "description": "只读组名称。仅支持长度小于60的中文/英文/数字/\"_\"/\"-\"。", "example": "Name" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。默认值为0，表示归属于默认项目。", "example": "1" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID。注：默认使用基础网络，当前不支持基础网络，故该参数必填。", "example": "vpc-f3bpuq3v" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID。注：默认使用基础网络，当前不支持基础网络，故该参数必填。", "example": "subnet-97b73i1q" }, { "name": "ReplayLagEliminate", "type": "integer", "required": false, "description": "延迟时间大小开关：0关、1开。该参数必填。", "example": "1" }, { "name": "ReplayLatencyEliminate", "type": "integer", "required": false, "description": "延迟空间大小开关： 0关、1开。该参数的填写需要与ReplayLagEliminate一致。", "example": "1" }, { "name": "MaxReplayLag", "type": "integer", "required": false, "description": "延迟时间大小阈值，取值为正整数，单位s。当ReplayLagEliminate为1时，该参数必填；当ReplayLagEliminate为0时，该参数需填0。", "example": "1" }, { "name": "MaxReplayLatency", "type": "integer", "required": false, "description": "延迟空间大小阈值，取值为正整数，单位MB。当ReplayLatencyEliminate为1时，该参数必填；当ReplayLatencyEliminate为0时，该参数需填0。", "example": "1" }, { "name": "MinDelayEliminateReserve", "type": "integer", "required": false, "description": "延迟剔除最小保留实例数。取值范围[0,100]。当ReplayLatencyEliminate为1时，该参数必填；当ReplayLagEliminate为0时，该参数无效。", "example": "1" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组id", "example": "[\"sg-9wcpd7sb\"]", "item_type": "string" } ], "required": [ "MasterDBInstanceId", "Name" ] }, { "name": "CreateReadOnlyGroupNetworkAccess", "description": "本接口（CreateReadOnlyGroupNetworkAccess）用于创建RO组的网络。创建网络的数量最多为2个。", "status": "online", "parameters": [ { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "RO组ID，形如：pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取", "example": "pgrogrp-4t9c6g7k" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络统一 ID。", "example": "vpc-gaestjaf" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网ID。", "example": "subnet-4s9dejli" }, { "name": "IsAssignVip", "type": "boolean", "required": true, "description": "是否指定分配vip true-指定分配 false-自动分配。", "example": "true" }, { "name": "Vip", "type": "string", "required": false, "description": "目标VIP地址。当不指定该参数，且IsAssignVip为true时，默认自动分配Vip。", "example": "10.*.*.*" } ], "required": [ "ReadOnlyGroupId", "VpcId", "SubnetId", "IsAssignVip" ] }, { "name": "DeleteAccount", "description": "此接口用于删除数据库账号，需要同时输入Oid与UserName，避免误删。注：该接口可重入，如果账号已经不存在，调用此接口进行删除时不会报错。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-4sfuv15b\t" }, { "name": "UserName", "type": "string", "required": true, "description": "删除的账号名称。 可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取", "example": "readonly_user" } ], "required": [ "DBInstanceId", "UserName" ] }, { "name": "DeleteBackupPlan", "description": "删除备份策略", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-herclkx7\t" }, { "name": "PlanId", "type": "string", "required": true, "description": "备份计划的ID。可通过[DescribeBackupPlans](https://cloud.tencent.com/document/api/409/68069)接口获取", "example": "0ee6843a-475b-5514-bd29-c432b75bb036" } ], "required": [ "DBInstanceId", "PlanId" ] }, { "name": "DeleteBaseBackup", "description": "本接口（DeleteBaseBackup）用于删除实例指定数据备份。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-apzvwncr" }, { "name": "BaseBackupId", "type": "string", "required": true, "description": "数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。7天内自动备份集不允许删除。", "example": "4c144959-aca8-5266-bb96-7fb7aa2ca409" } ], "required": [ "DBInstanceId", "BaseBackupId" ] }, { "name": "DeleteDBInstanceNetworkAccess", "description": "可对实例进行网络的删除操作（实例内至少保留一个网络）。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如：postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络统一 ID，若是基础网络则传\"0\"。", "example": "vpc-gaestjaf" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网ID，若是基础网络则传\"0\"。", "example": "subnet-4s9dejli" }, { "name": "Vip", "type": "string", "required": true, "description": "目标VIP地址。", "example": "10.*.*.*" } ], "required": [ "DBInstanceId", "VpcId", "SubnetId", "Vip" ] }, { "name": "DeleteLogBackup", "description": "本接口（DeleteLogBackup）用于删除实例指定日志备份。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-apzvwncr" }, { "name": "LogBackupId", "type": "string", "required": true, "description": "日志备份ID。可通过[DescribeLogBackups](https://cloud.tencent.com/document/api/409/89021)接口获取。注：7天内自动备份集不允许删除。", "example": "4c144959-aca8-5266-bb96-7fb7aa2ca409" } ], "required": [ "DBInstanceId", "LogBackupId" ] }, { "name": "DeleteParameterTemplate", "description": "本接口（DeleteParameterTemplate）主要用于删除某个参数模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "参数模板ID，用于唯一确认待操作的参数模板。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取", "example": "423984bb-97fe-5693-a74f-63cc8dfb6c5d" } ], "required": [ "TemplateId" ] }, { "name": "DeleteReadOnlyGroup", "description": "本接口(DeleteReadOnlyGroup)用于删除指定的只读组", "status": "online", "parameters": [ { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "待删除只读组ID", "example": "pgrogrp-efacxt00" } ], "required": [ "ReadOnlyGroupId" ] }, { "name": "DeleteReadOnlyGroupNetworkAccess", "description": "可对RO组进行网络的删除操作（网络数量至少保留1个）。", "status": "online", "parameters": [ { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "RO组ID，形如：pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取", "example": "pgrogrp-4t9c6g7k" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络统一 ID，若是基础网络则传\"0\"。", "example": "vpc-gaestjaf" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网ID，若是基础网络则传\"0\"。", "example": "subnet-4s9dejli" }, { "name": "Vip", "type": "string", "required": true, "description": "目标VIP地址。", "example": "10.*.*.*" } ], "required": [ "ReadOnlyGroupId", "VpcId", "SubnetId", "Vip" ] }, { "name": "DescribeAccountPrivileges", "description": "查询数据库账号对某数据库对象拥有的权限列表。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-4sfuv15b\t" }, { "name": "UserName", "type": "string", "required": true, "description": "查询此账号对某数据库对象所拥有的权限信息。账号名可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取", "example": "app_user" }, { "name": "DatabaseObjectSet", "type": "array", "required": true, "description": "要查询的数据库对象信息", "example": "[{\"ObjectType\":\"table\",\"ObjectName\":\"users\",\"DatabaseName\":\"user_database\",\"SchemaName\":\"user_schema\"}]", "item_type": "object", "children": [ { "name": "ObjectType", "type": "string", "required": true, "description": "支持使用的数据库对象类型有：account,database,schema,sequence,procedure,type,function,table,view,matview,column。", "example": "database" }, { "name": "ObjectName", "type": "string", "required": true, "description": "所描述的数据库对象名称", "example": "test_database\t" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "所要描述的数据库对象，所属的数据库名称。当描述对象类型不为database时，此参数必选。", "example": "test_database" }, { "name": "SchemaName", "type": "string", "required": false, "description": "所要描述的数据库对象，所属的模式名称。当描述对象不为database、schema时，此参数必选。", "example": "test_schema" }, { "name": "TableName", "type": "string", "required": false, "description": "所要描述的数据库对象，所属的表名称。当描述的对象类型为column时，此参数必填。", "example": "test_table" } ] } ], "required": [ "DBInstanceId", "UserName", "DatabaseObjectSet" ] }, { "name": "DescribeAccounts", "description": "本接口（DescribeAccounts）用于查询实例的数据库账号列表。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-apzvwncr" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页最大返回数目，默认20，取值范围为1-100", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "返回数据按照创建时间或者用户名排序。取值支持createTime、name、updateTime。createTime-按照创建时间排序；name-按照用户名排序; updateTime-按照更新时间排序。 默认值：createTime", "example": "createTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "返回结果是升序还是降序。取值只能为desc或者asc。desc-降序；asc-升序 默认值：desc", "example": "desc" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeAvailableRecoveryTime", "description": "本接口（DescribeAvailableRecoveryTime）用于查询实例可恢复的时间范围。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-abcd1234" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeBackupDownloadRestriction", "description": "本接口（DescribeBackupDownloadRestriction）用于查询备份文件下载限制。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBackupDownloadURL", "description": "本接口 (DescribeBackupDownloadURL) 用于查询指定备份集的下载地址，可包括全量备份集、增量日志备份集。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxxxxxxx" }, { "name": "BackupType", "type": "string", "required": true, "description": "备份类型，目前支持：LogBackup，BaseBackup。", "example": "LogBackup" }, { "name": "BackupId", "type": "string", "required": true, "description": "备份的唯一ID。", "example": "f6adc02a-432e-536f-a5f3-3dbf40ecd683" }, { "name": "URLExpireTime", "type": "integer", "required": false, "description": "链接的有效时间，取值为[0,36]，默认为12小时。", "example": "12" }, { "name": "BackupDownloadRestriction", "type": "object", "required": false, "description": "备份下载限制", "example": "{ \"RestrictionType\": \"NONE\", \"VpcRestrictionEffect\": \"ALLOW\", \"VpcIdSet\": [ \"vpc-15ld6dhr\" ], \"IpRestrictionEffect\": \"ALLOW\", \"IpSet\": [ \"10.10.10.220\" ] }", "children": [ { "name": "RestrictionType", "type": "string", "required": false, "description": "备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE 时，vpc或ip信息至少填写一项", "example": "NONE" }, { "name": "VpcRestrictionEffect", "type": "string", "required": false, "description": "vpc限制效力，ALLOW 允许；DENY 拒绝。", "example": "ALLOW" }, { "name": "VpcIdSet", "type": "array", "required": false, "description": "允许或拒绝下载备份文件的vpcId列表。", "example": "[ \"vpc-15ld6dhr\" ]", "item_type": "string" }, { "name": "IpRestrictionEffect", "type": "string", "required": false, "description": "ip限制效力，ALLOW 允许；DENY 拒绝。", "example": "ALLOW" }, { "name": "IpSet", "type": "array", "required": false, "description": "允许或拒绝下载备份文件的ip列表。", "example": "[ \"10.10.10.220\" ]", "item_type": "string" } ] } ], "required": [ "DBInstanceId", "BackupType", "BackupId" ] }, { "name": "DescribeBackupOverview", "description": "本接口（DescribeBackupOverview）用于查询用户的备份概览信息。返回用户当前备份个数、备份占用容量、免费容量、收费容量等信息（容量单位为字节）。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBackupPlans", "description": "本接口 (DescribeBackupPlans) 用于实例所有的备份计划查询", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxxxxxxx" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeBackupSummaries", "description": "本接口(DescribeBackupSummaries)用于查询实例备份的统计信息，返回以实例为维度的备份个数、占用容量等信息（容量单位为字节）。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为1-100，默认为返回10条。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-instance-id：按照实例ID过滤，类型为string。 db-instance-name：按照实例名过滤，支持模糊匹配，类型为string。 db-instance-ip：按照实例私有网络IP地址过滤，类型为string。", "example": "[ { \"Values\": [ \"postgres-2uepfuz1\" ], \"Name\": \"db-instance-id\" } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，支持TotalBackupSize - 备份总大小、LogBackupSize - 备份日志的大小、ManualBaseBackupSize - 手动备份数据大小、AutoBaseBackupSize - 自动备份数据大小。当不传入该参数时，默认不进行排序。", "example": "TotalBackupSize" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，包括升序：asc，降序：desc。默认值：asc。", "example": "asc" } ], "required": [] }, { "name": "DescribeBaseBackups", "description": "本接口（DescribeBaseBackups）用于查询数据备份列表。", "status": "online", "parameters": [ { "name": "MinFinishTime", "type": "string", "required": false, "description": "备份的最小结束时间，形如2018-01-01 00:00:00。默认为7天前。", "example": "2018-06-10 17:06:38" }, { "name": "MaxFinishTime", "type": "string", "required": false, "description": "备份的最大结束时间，形如2018-01-01 00:00:00。默认为当前时间。", "example": "2018-06-10 17:06:38" }, { "name": "Filters", "type": "array", "required": false, "description": "按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-instance-id：按照实例ID过滤，类型为string。 db-instance-name：按照实例名过滤，支持模糊匹配，类型为string。 db-instance-ip：按照实例私有网络IP地址过滤，类型为string。 base-backup-id：按照备份集ID过滤，类型为string。 db-instance-status：按实例状态过滤，类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/167...", "example": "[ { \"Values\": [ \"postgres-jdlmoll9\" ], \"Name\": \"db-instance-id\" } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为1-100，默认为返回10条。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，支持StartTime,FinishTime,Size。默认值：StartTime。", "example": "StartTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，包括升序：asc，降序：desc。默认值：desc。", "example": "asc" } ], "required": [] }, { "name": "DescribeClasses", "description": "本接口（DescribeClasses）用于查询实例售卖规格。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区名称。可以通过接口DescribeZones获取。", "example": "ap-guangzhou-1" }, { "name": "DBEngine", "type": "string", "required": true, "description": "数据库引擎，支持：1、postgresql（云数据库PostgreSQL）；2、mssql_compatible（MSSQL兼容-云数据库PostgreSQL）；", "example": "postgresql" }, { "name": "DBMajorVersion", "type": "string", "required": true, "description": "数据库主版本号。例如12，13，可以通过接口DescribeDBVersions获取。", "example": "12" } ], "required": [ "Zone", "DBEngine", "DBMajorVersion" ] }, { "name": "DescribeCloneDBInstanceSpec", "description": "本接口（DescribeCloneDBInstanceSpec）用于查询克隆实例可选择的最小规格，包括SpecCode和磁盘。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-abcd1234" }, { "name": "BackupSetId", "type": "string", "required": false, "description": "基础备份集ID，可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置，则以此参数为准。", "example": "f22057d2-46c0-5808-ab8a-d0c3385afabc" }, { "name": "RecoveryTargetTime", "type": "string", "required": false, "description": "恢复目标时间，此入参和BackupSetId必须选择一个传入。时区以东八区（UTC+8）为准。", "example": "2022-01-01 12:00:00" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeDBBackups", "description": "本接口（DescribeDBBackups）用于查询实例备份列表。**本接口属于早期接口，已停止功能迭代，推荐使用接口**[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)**替代**。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-4wdeb0zv。", "example": "postgres-6fego161" }, { "name": "Type", "type": "integer", "required": true, "description": "备份方式（1-全量）。目前只支持全量，取值为1。", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，形如2018-06-10 17:06:38，起始时间不得小于7天以前", "example": "2018-06-10 17:06:38" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，形如2018-06-10 17:06:38", "example": "2018-06-11 17:06:38" }, { "name": "Limit", "type": "integer", "required": false, "description": "备份列表分页返回，每页返回数量，默认为 20，最小为1，最大值为 100。（当该参数不传或者传0时按默认值处理）", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回结果中的第几页，从第0页开始。默认为0。", "example": "0" } ], "required": [ "DBInstanceId", "Type", "StartTime", "EndTime" ] }, { "name": "DescribeDBErrlogs", "description": "本接口（DescribeDBErrlogs）用于查询错误日志。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-apzvwncr" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，形如2018-01-01 00:00:00。日志保留时间默认为7天，起始时间不能超出保留时间范围。", "example": "2018-06-10 17:06:38" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，形如2018-01-01 00:00:00。", "example": "2018-06-11 17:06:38" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名字。", "example": "webapp-use" }, { "name": "SearchKeys", "type": "array", "required": false, "description": "搜索关键字。", "example": "ERROR", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为1-100。默认值为50。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。默认值为0。", "example": "0" } ], "required": [ "DBInstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeDBInstanceAttribute", "description": "本接口 (DescribeDBInstanceAttribute) 用于查询某个实例的详情信息。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxxxxxxx" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeDBInstanceHAConfig", "description": "本接口（DescribeDBInstanceHAConfig）用于查询实例HA配置信息。其中HA配置信息包括： 允许备节点切换为主节点的条件配置 半同步实例使用同步复制或异步复制的条件配置", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-aser1j2o" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeDBInstanceParameters", "description": "本接口（DescribeDBInstanceAttribute）用于查询实例的参数信息。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxx" }, { "name": "ParamName", "type": "string", "required": false, "description": "查询指定参数详情。ParamName为空或不传，默认返回全部参数列表", "example": "wal_level" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeDBInstanceSSLConfig", "description": "本接口用于查询实例SSL状态", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeDBInstanceSecurityGroups", "description": "本接口（DescribeDBInstanceSecurityGroups）用于查询实例安全组。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": false, "description": "实例ID，可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个；如果都传，忽略ReadOnlyGroupId。", "example": "postgres-apzvwncr" }, { "name": "ReadOnlyGroupId", "type": "string", "required": false, "description": "只读组ID，可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个；如果要查询只读组关联的安全组，只传ReadOnlyGroupId。", "example": "pgrogrp-nqwpkjbu" } ], "required": [] }, { "name": "DescribeDBInstances", "description": "本接口 (DescribeDBInstances) 用于查询一个或多个实例的详细信息。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-instance-id：按照实例ID过滤，类型为string db-instance-name：按照实例名过滤，支持模糊匹配，类型为string db-project-id：按照项目ID过滤，类型为integer db-pay-mode：按照实例付费模式过滤，prepaid - 预付费；postpaid - 后付费。类型为string db-tag-key：按照标签键过滤，类型为string db-private-ip： 按照实例私有网络IP过滤，类型为s...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为0-100，传入0时，取默认配置。默认为返回10条。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序指标，如实例名、创建时间等，支持DBInstanceId,CreateTime,Name,EndTime。默认值：CreateTime。", "example": "CreateTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，包括升序：asc、降序：desc。默认值：asc。", "example": "desc" } ], "required": [] }, { "name": "DescribeDBVersions", "description": "本接口（DescribeDBVersions）用于查询支持的数据库版本。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDBXlogs", "description": "本接口（DescribeDBXlogs）用于获取实例Xlog列表。 **本接口属于早期接口，已停止功能迭代，推荐使用接口**[DescribeLogBackups](https://cloud.tencent.com/document/api/409/89021)**替代**。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-4wdeb0zv。", "example": "postgres-apzvwncr" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间，形如2018-06-10 17:06:38，起始时间不得小于7天以前", "example": "2018-06-10 17:06:38" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，形如2018-06-10 17:06:38", "example": "2018-06-11 17:06:38" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，表示返回第几页的条目。从第0页开始计数。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，表示每页有多少条目。取值为1-100。", "example": "100" } ], "required": [ "DBInstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeDatabaseObjects", "description": "本接口用于查询数据库对象列表。例如查询test数据库下的模式列表。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-4sfuv15b\t" }, { "name": "ObjectType", "type": "string", "required": true, "description": "查询的对象类型。支持查询的数据对象有：database,schema,sequence,procedure,type,function,table,view,matview,column。", "example": "table" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次显示数量，默认20。可选范围为[0,100]。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "查询对象所属的数据库。当查询对象类型不为database时，此参数必填。", "example": "test_database" }, { "name": "SchemaName", "type": "string", "required": false, "description": "查询对象所属的模式。当查询对象类型不为database、schema时，此参数必填。", "example": "test_schema" }, { "name": "TableName", "type": "string", "required": false, "description": "查询对象所属的表。当查询对象类型为column时，此参数必填。", "example": "test_table" } ], "required": [ "DBInstanceId", "ObjectType" ] }, { "name": "DescribeDatabases", "description": "接口（DescribeDatabases）用来查询实例的数据库列表。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "Filters", "type": "array", "required": false, "description": "按照一个或者多个过滤条件进行查询，目前支持的过滤条件有：database-name：按照数据库名称过滤，类型为string。此处使用模糊匹配搜索符合条件的数据库。", "example": "[{\"Name\":\"database-name\",\"Values\":[\"postgres\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次显示数量。建议最大取值100。 默认值：20", "example": "20" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeDedicatedClusters", "description": "查询专属集群", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： dedicated-cluster-id: 按照专属集群ID筛选，类型为string", "example": "[{\"Values\": [\"dedicatedCluster-gz\" ], \"Name\": \"dedicated-cluster-id\" } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeDefaultParameters", "description": "本接口（DescribeDefaultParameters）主要用于查询某个数据库版本和引擎支持的所有参数。", "status": "online", "parameters": [ { "name": "DBMajorVersion", "type": "string", "required": true, "description": "数据库版本，大版本号，例如11，12，13。可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取", "example": "13" }, { "name": "DBEngine", "type": "string", "required": true, "description": "数据库引擎，例如：postgresql,mssql_compatible", "example": "postgresql" } ], "required": [ "DBMajorVersion", "DBEngine" ] }, { "name": "DescribeEncryptionKeys", "description": "本接口 （DescribeEncryptionKeys） 用于查询实例的密钥信息列表。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxxxxxxx" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeLogBackups", "description": "本接口（DescribeLogBackups）用于查询日志备份列表。", "status": "online", "parameters": [ { "name": "MinFinishTime", "type": "string", "required": false, "description": "备份的最小结束时间，形如2018-01-01 00:00:00。默认为7天前。", "example": "2018-06-10 17:06:38" }, { "name": "MaxFinishTime", "type": "string", "required": false, "description": "备份的最大结束时间，形如2018-01-01 00:00:00。默认为当前时间。", "example": "2018-06-10 17:06:38" }, { "name": "Filters", "type": "array", "required": false, "description": "按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-instance-id：按照实例ID过滤，类型为string。 db-instance-name：按照实例名过滤，支持模糊匹配，类型为string。 db-instance-ip：按照实例私有网络IP地址过滤，类型为string。 db-instance-status：按实例状态过滤，类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778#DBInstance)结构的DBInstanceStatus字段。", "example": "[ { \"Values\": [ \"postgres-xxxxxxxx\" ], \"Name\": \"db-instance-id\" } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为1-100，默认为返回10条。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，支持StartTime,FinishTime,Size。默认值：StartTime", "example": "StartTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，包括升序：asc，降序：desc。默认值：desc。", "example": "asc" } ], "required": [] }, { "name": "DescribeMaintainTimeWindow", "description": "本接口 (DescribeMaintainTimeWindow) 用于查询实例的维护时间窗口", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-rwwbeuyx" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeOrders", "description": "本接口（DescribeOrders）用于查询订单信息。", "status": "online", "parameters": [ { "name": "DealNames", "type": "array", "required": true, "description": "订单名集合", "example": "[\"20180615110033\"]", "item_type": "string" } ], "required": [ "DealNames" ] }, { "name": "DescribeParameterTemplateAttributes", "description": "本接口（DescribeParameterTemplateAttributes）用于查询某个参数模板的具体内容，包括基本信息和参数信息。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "参数模板ID。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取", "example": "423984bb-97fe-5693-a74f-63cc8dfb6c5d" } ], "required": [ "TemplateId" ] }, { "name": "DescribeParameterTemplates", "description": "本接口 (DescribeParameterTemplates) 用于查询参数模板列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，目前支持的过滤条件有：TemplateName, TemplateId，DBMajorVersion，DBEngine。TemplateName不支持模糊匹配。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，[0，100]，默认 20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序指标，枚举值，支持：CreateTime，TemplateName，DBMajorVersion。如果不指定该参数，默认将按照参数模板的编号倒序排列，也就是说最新添加的参数模板会排在最前面。", "example": "CreateTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，枚举值，支持：asc（升序） ，desc（降序）。默认值为asc。当未指定OrderBy时，该参数失效，此时排序方式为OrderBy参数描述中给出的默认排序方式。", "example": "desc" } ], "required": [] }, { "name": "DescribeParamsEvent", "description": "本接口（DescribeParamsEvent）用于查询参数修改事件。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "”postgres-xxx\"" } ], "required": [ "DBInstanceId" ] }, { "name": "DescribeProductConfig", "description": "本接口（DescribeProductConfig）用于查询售卖规格配置。**本接口属于早期接口，已停止功能迭代，推荐使用新接口**[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)**替代**。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": false, "description": "可用区名称", "example": "ap-guangzhou-7" }, { "name": "DBEngine", "type": "string", "required": false, "description": "数据库引擎，支持：1、postgresql（云数据库PostgreSQL）；2、mssql_compatible（MSSQL兼容-云数据库PostgreSQL）；如不指定默认使用postgresql。", "example": "postgresql" } ], "required": [] }, { "name": "DescribeReadOnlyGroups", "description": "本接口（DescribeReadOnlyGroups）用于查询只读组列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-master-instance-id：按照主实例过滤，类型为string。 read-only-group-id：按照只读组ID过滤，类型为string。 注：该参数的过滤条件中，db-master-instance-id为必须指定项。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤键的名称。", "example": "TemplateName" }, { "name": "Values", "type": "array", "required": false, "description": "一个或者多个过滤值。", "example": "[\"my_custom_template\"]", "item_type": "string" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "查询每一页的条数，默认为10，最大值99。", "example": "1" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "查询的页码，默认为1", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "查询排序依据，目前支持:ROGroupId,CreateTime,Name。默认值CreateTime", "example": "ROGroupId" }, { "name": "OrderByType", "type": "string", "required": false, "description": "查询排序依据类型，目前支持:desc,asc。默认值asc。", "example": "desc" } ], "required": [] }, { "name": "DescribeRegions", "description": "本接口 (DescribeRegions) 用于查询售卖地域信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSlowQueryAnalysis", "description": "此接口（DescribeSlowQueryAnalysis）用于统计指定时间范围内的所有慢查询，根据SQL语句抽象参数后，进行聚合分析，并返回同类SQL列表。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxx" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，形如2018-01-01 00:00:00。日志保留时间默认为7天，起始时间不能超出保留时间范围。", "example": "2020-02-01 01:02:03" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，形如2018-01-01 00:00:00。", "example": "2020-02-01 01:02:03" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名字。", "example": "postgres" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值范围[CallNum,CostTime,AvgCostTime]。默认值为CallNum。", "example": "CallNum" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，包括升序：asc 降序：desc。默认值为desc。", "example": "desc" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为1-100。默认值为50。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。默认值为0。", "example": "0" } ], "required": [ "DBInstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeSlowQueryList", "description": "此接口（DescribeSlowQueryList）用于查询指定时间范围内的所有慢查询。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xx" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间，形如2018-01-01 00:00:00。日志保留时间默认为7天，起始时间不能超出保留时间范围。", "example": "2020-01-01 02:03:04" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间，形如2018-01-01 00:00:00。", "example": "2020-01-01 02:03:04" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名字。", "example": "postgres" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，包括升序：asc 降序：desc。默认值为desc。", "example": "desc" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值范围[SessionStartTime,Duration]。默认值为SessionStartTime。", "example": "SessionStartTime" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为1-100。默认值为50。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。默认值为0。", "example": "0" } ], "required": [ "DBInstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeTasks", "description": "本接口（DescribeTasks）用于查询任务列表，展示异步任务的执行进度。 注：本接口中展示的步骤为总结性步骤，可能伴随着版本迭代进行调整，不建议作为关键逻辑使用", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": false, "description": "按照任务ID进行查询。其余云API中返回的FlowId和TaskId等价。", "example": "120069" }, { "name": "DBInstanceId", "type": "string", "required": false, "description": "按照数据库实例ID进行查询。", "example": "postgres-q6fj84vb" }, { "name": "MinStartTime", "type": "string", "required": false, "description": "任务的最早开始时间，形如2024-08-23 00:00:00,默认只展示180天内的数据。", "example": "2024-09-23 00:00:00" }, { "name": "MaxStartTime", "type": "string", "required": false, "description": "任务的最晚开始时间，形如2024-08-23 00:00:00，默认为当前时间。", "example": "2024-09-30 00:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量，取值范围为1-100，默认为返回20条。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始。", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，支持StartTime,EndTime，默认为StartTime。", "example": "StartTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，包括升序：asc，降序：desc，默认为desc。", "example": "asc" } ], "required": [] }, { "name": "DescribeZones", "description": "本接口 (DescribeZones) 用于查询支持的可用区信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DestroyDBInstance", "description": "本接口 (DestroyDBInstance) 用于彻底销毁指定DBInstanceId对应的实例，销毁后实例数据将彻底删除，无法找回，调用前请仔细确认要操作的实例。只能销毁隔离中的实例。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "待下线实例ID", "example": "postgres-19nmz2xb" } ], "required": [ "DBInstanceId" ] }, { "name": "DisIsolateDBInstances", "description": "本接口（DisIsolateDBInstances）用于解隔离实例", "status": "online", "parameters": [ { "name": "DBInstanceIdSet", "type": "array", "required": true, "description": "实例ID列表。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时解隔离多个实例。", "example": "[\"postgres-xxxxxxx\"]", "item_type": "string" }, { "name": "Period", "type": "integer", "required": false, "description": "购买时长，单位：月。 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36 后付费：该参数不生效", "example": "1" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否使用代金券： true：使用 false：不使用 默认值：false", "example": "true" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券id列表。", "example": "[\"a\"]", "item_type": "string" } ], "required": [ "DBInstanceIdSet" ] }, { "name": "InquiryPriceCreateDBInstances", "description": "本接口 (InquiryPriceCreateDBInstances) 用于查询购买实例的价格信息。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区名称。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。", "example": "ap-guangzhou-2" }, { "name": "SpecCode", "type": "string", "required": true, "description": "规格ID。该参数可以通过调用DescribeClasses接口的返回值中的SpecCode字段来获取。", "example": "cdb.pg.z1.2g" }, { "name": "Storage", "type": "integer", "required": true, "description": "存储容量大小，单位：GB。该参数的设置步长为10。", "example": "100" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "实例数量。目前最大数量不超过100，如需一次性创建更多实例，请联系客服支持。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长，单位：月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值。", "example": "1" }, { "name": "Pid", "type": "integer", "required": false, "description": "【弃字段，不再生效】，计费ID。该参数可以通过调用DescribeProductConfig接口的返回值中的Pid字段来获取。", "example": "11004" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例计费类型。目前支持：PREPAID（预付费，即包年包月）和 POSTPAID（按量计费）。默认值：PREPAID", "example": "PREPAID" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型，默认primary，支持如下：primary（双机高可用（一主一从））readonly（只读实例）", "example": "primary" }, { "name": "DBEngine", "type": "string", "required": false, "description": "DB引擎，默认postgresql，支持如下：postgresql（云数据库PostgreSQL）mssql_compatible（MSSQL兼容-云数据库PostgreSQL）", "example": "postgresql" } ], "required": [ "Zone", "SpecCode", "Storage", "InstanceCount", "Period" ] }, { "name": "InquiryPriceRenewDBInstance", "description": "本接口（InquiryPriceRenewDBInstance）用于查询续费实例的价格。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)获取。 （此接口仅支持预付费实例的查询）", "example": "postgres-6fego161" }, { "name": "Period", "type": "integer", "required": true, "description": "续费周期，按月计算", "example": "12" } ], "required": [ "DBInstanceId", "Period" ] }, { "name": "InquiryPriceUpgradeDBInstance", "description": "本接口（InquiryPriceUpgradeDBInstance）用于查询升级实例的价格。只支持按量计费实例。", "status": "online", "parameters": [ { "name": "Storage", "type": "integer", "required": true, "description": "实例的磁盘大小，单位GB", "example": "500" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例的内存大小，单位GB", "example": "4" }, { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6fego161" }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例的Cpu大小，单位Core。 不传入此参数时，默认根据Memory确定的售卖规格所对应的Cpu进行设置。如Memory为2，支持的售卖规格有1核2GiB，则不传入Cpu时，Cpu默认为1。", "example": "2" } ], "required": [ "Storage", "Memory", "DBInstanceId" ] }, { "name": "IsolateDBInstances", "description": "本接口（IsolateDBInstances）用于隔离实例。", "status": "online", "parameters": [ { "name": "DBInstanceIdSet", "type": "array", "required": true, "description": "实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。注意：不推荐同时隔离多个实例。建议每次操作仅传入单个实例ID。", "example": "[\"postgres-xxxxxxxx\"]", "item_type": "string" } ], "required": [ "DBInstanceIdSet" ] }, { "name": "LockAccount", "description": "此接口用于锁定数据库账号，锁定后账号当前连接会断开，并且无法建立新连接。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "postgres-4sfuv15b\t" }, { "name": "UserName", "type": "string", "required": true, "description": "账号名称。", "example": "db_user" } ], "required": [ "DBInstanceId", "UserName" ] }, { "name": "ModifyAccountPrivileges", "description": "修改某账号对某数据库对象的权限、修改账号类型。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-4sfuv15b\t" }, { "name": "UserName", "type": "string", "required": true, "description": "修改此账号对某数据库对象的权限。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取", "example": "readonly_user" }, { "name": "ModifyPrivilegeSet", "type": "array", "required": true, "description": "修改的权限信息，支持批量修改，一次最高修改50条。", "example": "无", "item_type": "object", "children": [ { "name": "DatabasePrivilege", "type": "object", "required": false, "description": "要修改的数据库对象及权限列表", "example": "\"Object\":{\"ObjectType\":\"table\",\"ObjectName\":\"test_table\",\"DatabaseName\":\"test_database\",\"SchemaName\":\"test_schema\"},\"Privileges\":[\"SELECT\"]", "children": [ { "name": "Object", "type": "object", "required": false, "description": "数据库对象，当ObjectType为database时，DatabaseName/SchemaName/TableName可为空；当ObjectType为schema时，SchemaName/TableName可为空；当ObjectType为column时，TableName不可为空，其余情况均可为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"ObjectType\":\"table\",\"ObjectName\":\"test_table\",\"DatabaseName\":\"test_database\",\"SchemaName\":\"test_schema\"}", "children": [ { "name": "ObjectType", "type": "string", "required": true, "description": "支持使用的数据库对象类型有：account,database,schema,sequence,procedure,type,function,table,view,matview,column。", "example": "database" }, { "name": "ObjectName", "type": "string", "required": true, "description": "所描述的数据库对象名称", "example": "test_database\t" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "所要描述的数据库对象，所属的数据库名称。当描述对象类型不为database时，此参数必选。", "example": "test_database" }, { "name": "SchemaName", "type": "string", "required": false, "description": "所要描述的数据库对象，所属的模式名称。当描述对象不为database、schema时，此参数必选。", "example": "test_schema" }, { "name": "TableName", "type": "string", "required": false, "description": "所要描述的数据库对象，所属的表名称。当描述的对象类型为column时，此参数必填。", "example": "test_table" } ] }, { "name": "PrivilegeSet", "type": "array", "required": false, "description": "指定账号对数据库对象拥有的权限列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"SELECT\"]", "item_type": "string" } ] }, { "name": "ModifyType", "type": "string", "required": false, "description": "修改的方式，当前仅支持grantObject、revokeObject、alterRole。grantObject代表授权、revokeObject代表收回权、alterRole代表修改账号类型。", "example": "grantObject" }, { "name": "IsCascade", "type": "boolean", "required": false, "description": "当ModifyType为revokeObject才需要此参数，参数为true时，撤销权限会级联撤销。默认为false。", "example": "false" } ] } ], "required": [ "DBInstanceId", "UserName", "ModifyPrivilegeSet" ] }, { "name": "ModifyAccountRemark", "description": "本接口（ModifyAccountRemark）用于修改账号备注。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-4wdeb0zv", "example": "postgres-6bwgamo3" }, { "name": "UserName", "type": "string", "required": true, "description": "实例用户名", "example": "bob_admin" }, { "name": "Remark", "type": "string", "required": true, "description": "用户UserName对应的新备注", "example": "bob have admin permissions" } ], "required": [ "DBInstanceId", "UserName", "Remark" ] }, { "name": "ModifyBackupDownloadRestriction", "description": "本接口（ModifyBackupDownloadRestriction）用于修改备份文件下载限制。", "status": "online", "parameters": [ { "name": "RestrictionType", "type": "string", "required": true, "description": "备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE时，Vpc限制和Ip限制需要至少填写一项。", "example": "NONE" }, { "name": "VpcRestrictionEffect", "type": "string", "required": false, "description": "vpc限制效力，ALLOW 允许；DENY 拒绝。", "example": "ALLOW" }, { "name": "VpcIdSet", "type": "array", "required": false, "description": "允许或拒绝下载备份文件的vpcId列表。 **注意：**该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[ \"vpc-15ld6dhr\" ]", "item_type": "string" }, { "name": "IpRestrictionEffect", "type": "string", "required": false, "description": "ip限制效力，ALLOW 允许；DENY 拒绝。", "example": "ALLOW" }, { "name": "IpSet", "type": "array", "required": false, "description": "允许或拒绝下载备份文件的ip列表。 **注意：**该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[ \"10.*.*.*\" ]", "item_type": "string" } ], "required": [ "RestrictionType" ] }, { "name": "ModifyBackupPlan", "description": "本接口 (ModifyBackupPlan) 用于实例备份计划的修改，默认是在每天的凌晨开始全量备份，备份保留时长是7天。可以根据此接口指定时间进行实例的备份。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxxxxxxx" }, { "name": "MinBackupStartTime", "type": "string", "required": false, "description": "实例最早开始备份时间", "example": "01:00:00" }, { "name": "MaxBackupStartTime", "type": "string", "required": false, "description": "实例最晚开始备份时间", "example": "02:00:00" }, { "name": "BaseBackupRetentionPeriod", "type": "integer", "required": false, "description": "实例备份保留时长，取值范围为7-1830，单位是天", "example": "7" }, { "name": "BackupPeriod", "type": "array", "required": false, "description": "实例备份周期，若是星期维度，格式为小写星期英文单词，且至少设置两天备份；若是按月维度，格式为数字字符，如[\"1\",\"2\"]。", "example": "[\"monday\", \"tuesday\", \"wednesday\"]", "item_type": "string" }, { "name": "LogBackupRetentionPeriod", "type": "integer", "required": false, "description": "实例日志备份保留时长，取值范围为7-1830，单位是天", "example": "7" }, { "name": "PlanId", "type": "string", "required": false, "description": "备份计划ID，用于指明要修改哪个备份计划，不传则是修改默认备份计划。", "example": "0ee6843a-475b-5514-bd29-c432b75bb036" }, { "name": "PlanName", "type": "string", "required": false, "description": "要修改的备份计划名称。", "example": "plan2" } ], "required": [ "DBInstanceId" ] }, { "name": "ModifyBaseBackupExpireTime", "description": "本接口（ModifyBaseBackupExpireTime）用于修改实例指定数据备份的过期时间。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-xxxxxxxx" }, { "name": "BaseBackupId", "type": "string", "required": true, "description": "数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取", "example": "f6adc02a-432e-536f-a5f3-3dbf40ecd683" }, { "name": "NewExpireTime", "type": "string", "required": true, "description": "新过期时间。", "example": "2006-01-02 15:04:05" } ], "required": [ "DBInstanceId", "BaseBackupId", "NewExpireTime" ] }, { "name": "ModifyDBInstanceChargeType", "description": "支持实例的计费类型转换（目前仅支持按量计费转包年包月）", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-apzvwncr\t" }, { "name": "InstanceChargeType", "type": "string", "required": true, "description": "实例计费类型，目前支持： PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：后付费，即按量计费 默认值：PREPAID", "example": "POSTPAID_BY_HOUR" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长，单位：月。 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36 后付费：只支持1", "example": "1" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "续费标记： 0：手动续费 1：自动续费 默认值：0", "example": "1" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券： 0：否 1：是 默认值：0", "example": "0" } ], "required": [ "DBInstanceId", "InstanceChargeType", "Period" ] }, { "name": "ModifyDBInstanceDeletionProtection", "description": "本接口（DeletionProtection）用于开启或关闭实例销毁保护", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "DeletionProtection", "type": "boolean", "required": true, "description": "开启或关闭实例删除保护。true - 开启 ；false - 关闭。", "example": "true" } ], "required": [ "DBInstanceId", "DeletionProtection" ] }, { "name": "ModifyDBInstanceDeployment", "description": "本接口（ModifyDBInstanceDeployment）用于修改节点可用区部署方式，仅支持主实例。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "DBNodeSet", "type": "array", "required": true, "description": "实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。", "example": "无", "item_type": "object", "children": [ { "name": "Role", "type": "string", "required": true, "description": "节点类型，值可以为： Primary，代表主节点； Standby，代表备节点。", "example": "Primary, Standby" }, { "name": "Zone", "type": "string", "required": true, "description": "节点所在可用区，例如 ap-guangzhou-1。", "example": "ap-guangzhou-1" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "专属集群ID", "example": "cluster-d8htgb6k" } ] }, { "name": "SwitchTag", "type": "integer", "required": true, "description": "指定实例配置完成变更后的切换时间。 0：立即切换 1：指定时间切换 2：维护时间窗口内切换", "example": "1" }, { "name": "SwitchStartTime", "type": "string", "required": false, "description": "切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。", "example": "12:00:00" }, { "name": "SwitchEndTime", "type": "string", "required": false, "description": "切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。", "example": "12:30:00" } ], "required": [ "DBInstanceId", "DBNodeSet", "SwitchTag" ] }, { "name": "ModifyDBInstanceHAConfig", "description": "本接口（ModifyDBInstanceHAConfig）用于修改实例HA配置信息。其中HA配置信息包括： 允许备节点切换为主节点的条件配置 半同步实例使用同步复制或异步复制的条件配置", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-aser1j2o" }, { "name": "SyncMode", "type": "string", "required": true, "description": "主从同步方式： Semi-sync：半同步 Async：异步", "example": "Async" }, { "name": "MaxStandbyLatency", "type": "integer", "required": true, "description": "高可用备机最大延迟数据量。备节点延迟数据量小于等于该值，且备节点延迟时间小于等于MaxStandbyLag时，可以切换为主节点。 单位：byte 参数范围：[1073741824, 322122547200]", "example": "2073741824" }, { "name": "MaxStandbyLag", "type": "integer", "required": true, "description": "高可用备机最大延迟时间。备节点延迟时间小于等于该值，且备节点延迟数据量小于等于MaxStandbyLatency时，可以切换为主节点。 单位：s 参数范围：[5, 10]", "example": "10" }, { "name": "MaxSyncStandbyLatency", "type": "integer", "required": false, "description": "同步备机最大延迟数据量。备机延迟数据量小于等于该值，且该备机延迟时间小于等于MaxSyncStandbyLag时，则该备机采用同步复制；否则，采用异步复制。 该参数值针对SyncMode设置为Semi-sync的实例有效。 半同步实例禁止退化为异步复制时，不设置MaxSyncStandbyLatency、MaxSyncStandbyLag。 半同步实例允许退化异步复制时，PostgreSQL 9版本的实例须设置MaxSyncStandbyLatency且不设置MaxSyncStandbyLag，...", "example": "1000000" }, { "name": "MaxSyncStandbyLag", "type": "integer", "required": false, "description": "同步备机最大延迟时间。备机延迟时间小于等于该值，且该备机延迟数据量小于等于MaxSyncStandbyLatency时，则该备机采用同步复制；否则，采用异步复制。 该参数值针对SyncMode设置为Semi-sync的实例有效。 半同步实例禁止退化为异步复制时，不设置MaxSyncStandbyLatency、MaxSyncStandbyLag。 半同步实例允许退化异步复制时，PostgreSQL 9版本的实例须设置MaxSyncStandbyLatency且不设置MaxSyncStandbyLag\ufffd\ufffd...", "example": "5" } ], "required": [ "DBInstanceId", "SyncMode", "MaxStandbyLatency", "MaxStandbyLag" ] }, { "name": "ModifyDBInstanceName", "description": "本接口（ModifyDBInstanceName）用于修改postgresql实例名字。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6fego161" }, { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称，仅支持长度小于60的中文/英文/数字/\"_\"/\"-\"。", "example": "testModifyInstanceName" } ], "required": [ "DBInstanceId", "InstanceName" ] }, { "name": "ModifyDBInstanceParameters", "description": "本接口 (ModifyDBInstanceParameters) 用于修改实例参数。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-q12ghoq1" }, { "name": "ParamList", "type": "array", "required": true, "description": "待修改参数及期望值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "参数名", "example": "wal_level" }, { "name": "ExpectedValue", "type": "string", "required": true, "description": "修改参数值。入参均以字符串形式传递，例如：小数”0.1“、整数”1000“、枚举”replica“", "example": "replica" } ] } ], "required": [ "DBInstanceId", "ParamList" ] }, { "name": "ModifyDBInstanceReadOnlyGroup", "description": "本接口（ModifyDBInstanceReadOnlyGroup）用于修改实例所属的只读组", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "pgro-kwk4tq23" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "当前实例所在只读组ID", "example": "pgrogrp-fyzsd35e" }, { "name": "NewReadOnlyGroupId", "type": "string", "required": true, "description": "实例修改的目标只读组ID", "example": "pgrogrp-mnwtmp20" } ], "required": [ "DBInstanceId", "ReadOnlyGroupId", "NewReadOnlyGroupId" ] }, { "name": "ModifyDBInstanceSSLConfig", "description": "本接口用于修改实例SSL配置，功能包含开启、关闭、修改SSL证书保护的连接地址。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "SSLEnabled", "type": "boolean", "required": true, "description": "开启或关闭SSL。true - 开启 ；false - 关闭。", "example": "true" }, { "name": "ConnectAddress", "type": "string", "required": false, "description": "SSL证书保护的唯一连接地址，若为主实例，可设置为内外网IP地址；若为只读实例，可设置为实例IP或只读组IP。在开启SSL或修改SSL保护的连接地址时，该参数为必传项；在关闭SSL时，该参数将被忽略。", "example": "10.0.0.4" } ], "required": [ "DBInstanceId", "SSLEnabled" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口（ModifyDBInstanceSecurityGroups）用于修改实例安全组。", "status": "online", "parameters": [ { "name": "SecurityGroupIdSet", "type": "array", "required": true, "description": "实例或只读组要绑定的安全组列表。 安全组信息可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来查询。 **注意：**该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[\"sg-91jbmkp1\"]", "item_type": "string" }, { "name": "DBInstanceId", "type": "string", "required": false, "description": "实例ID，可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个；如果都传，忽略ReadOnlyGroupId。", "example": "postgres-apzvwncr" }, { "name": "ReadOnlyGroupId", "type": "string", "required": false, "description": "只读组ID，可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个；如果要修改只读组关联的安全组，只传ReadOnlyGroupId", "example": "pgrogrp-nqwpkjbu" } ], "required": [ "SecurityGroupIdSet" ] }, { "name": "ModifyDBInstanceSpec", "description": "本接口（ModifyDBInstanceSpec）用于修改实例规格，包括内存、磁盘、Cpu。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如：postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "Memory", "type": "integer", "required": true, "description": "修改后的实例内存大小，单位GiB。", "example": "16" }, { "name": "Storage", "type": "integer", "required": true, "description": "修改后的实例磁盘大小，单位GiB。该参数的设置步长为10。", "example": "1000" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券： 0：否 1：是 默认值：0", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]", "item_type": "string" }, { "name": "ActivityId", "type": "integer", "required": false, "description": "活动ID。", "example": "0" }, { "name": "SwitchTag", "type": "integer", "required": false, "description": "指定实例配置完成变更后的切换时间。 0：立即切换 1：指定时间切换 2：维护时间窗口内切换 默认值：0", "example": "1" }, { "name": "SwitchStartTime", "type": "string", "required": false, "description": "切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。", "example": "12:00:00" }, { "name": "SwitchEndTime", "type": "string", "required": false, "description": "切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。", "example": "12:30:00" }, { "name": "Cpu", "type": "integer", "required": false, "description": "修改后的实例CPU大小，单位Core。不填写该参数时，默认根据Memory确定Cpu大小。如Memory为2，支持的规格有1核2GiB，则不传入Cpu时，Cpu默认为1。", "example": "4" } ], "required": [ "DBInstanceId", "Memory", "Storage" ] }, { "name": "ModifyDBInstancesProject", "description": "本接口（ModifyDBInstancesProject）用于修改实例所属项目。", "status": "online", "parameters": [ { "name": "DBInstanceIdSet", "type": "array", "required": true, "description": "实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时操作多个实例。", "example": "[\"postgres-6bwgamo3\",\"postgres-lnp6j6172\"]", "item_type": "string" }, { "name": "ProjectId", "type": "string", "required": true, "description": "所属新项目的ID。可通过[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)获取", "example": "10467" } ], "required": [ "DBInstanceIdSet", "ProjectId" ] }, { "name": "ModifyDatabaseOwner", "description": "修改数据库所有者", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-mnhbbw99" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库名称。可通过[DescribeDatabases](https://cloud.tencent.com/document/api/409/43353)接口获取", "example": "alice_database" }, { "name": "DatabaseOwner", "type": "string", "required": true, "description": "数据库新所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取", "example": "alice" } ], "required": [ "DBInstanceId", "DatabaseName", "DatabaseOwner" ] }, { "name": "ModifyMaintainTimeWindow", "description": "本接口 (ModifyMaintainTimeWindow) 用于实例维护时间窗口的修改。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-c4wtbx1f" }, { "name": "MaintainStartTime", "type": "string", "required": false, "description": "维护开始时间。时区为东八区（UTC+8）", "example": "22:00" }, { "name": "MaintainDuration", "type": "integer", "required": false, "description": "维护持续时间。单位：小时。取值范围：[1,4]", "example": "1" }, { "name": "MaintainWeekDays", "type": "array", "required": false, "description": "维护周期", "example": "[\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\"]", "item_type": "string" } ], "required": [ "DBInstanceId" ] }, { "name": "ModifyParameterTemplate", "description": "本接口（ModifyParameterTemplate）主要用于修改参数模板名称，描述等配置，也可用于管理参数模板中的参数列表。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "参数模板ID，用于唯一确认参数模板，不可修改。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取", "example": "497857b4-4676-5583-8359-b697fe5968d9" }, { "name": "TemplateName", "type": "string", "required": false, "description": "参数模板名称，长度为1～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@ 注：若该字段为空 ，则保持原参数模板名称", "example": "test_template" }, { "name": "TemplateDescription", "type": "string", "required": false, "description": "参数模板描述，长度为0～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@ 注：若不传入该参数，则保持原参数模板描述", "example": "ThisTemplateIsUsedForTestingEnvironment" }, { "name": "ModifyParamEntrySet", "type": "array", "required": false, "description": "需要修改或添加的参数集合，注：同一参数不能同时出现在修改添加集合和删除集合中", "example": "[ { \"Name\": \"max_wal_senders\", \"ExpectedValue\": \"360\" }, { \"Name\": \"max_logical_replication_workers\", \"ExpectedValue\": \"360\" } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "参数名", "example": "wal_level" }, { "name": "ExpectedValue", "type": "string", "required": true, "description": "修改参数值。入参均以字符串形式传递，例如：小数”0.1“、整数”1000“、枚举”replica“", "example": "replica" } ] }, { "name": "DeleteParamSet", "type": "array", "required": false, "description": "需要从模板中删除的参数集合，注：同一参数不能同时出现在修改添加集合和删除集合中", "example": "[\"wal_level\"]", "item_type": "string" } ], "required": [ "TemplateId" ] }, { "name": "ModifyReadOnlyDBInstanceWeight", "description": "本接口（ModifyReadOnlyDBInstanceWeight）用于修改只读实例权重", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "pgro-xxxx" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取", "example": "pgrogp-xxx" }, { "name": "Weight", "type": "integer", "required": true, "description": "只读实例在只读组中的流量权重(1-50)", "example": "10" } ], "required": [ "DBInstanceId", "ReadOnlyGroupId", "Weight" ] }, { "name": "ModifyReadOnlyGroupConfig", "description": "本接口(ModifyReadOnlyGroupConfig)用于更新只读组配置信息", "status": "online", "parameters": [ { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID。", "example": "pgrogrp-7bqtch8z" }, { "name": "ReadOnlyGroupName", "type": "string", "required": false, "description": "只读组名称。仅支持长度小于60的中文/英文/数字/\"_\"/\"-\"", "example": "ReadOnlyGroupName" }, { "name": "ReplayLagEliminate", "type": "integer", "required": false, "description": "延迟时间配置开关：0关、1开", "example": "1" }, { "name": "ReplayLatencyEliminate", "type": "integer", "required": false, "description": "延迟日志大小配置开关：0关、1开", "example": "1" }, { "name": "MaxReplayLatency", "type": "integer", "required": false, "description": "延迟日志大小阈值，单位MB。当开启延迟日志大小配置，应输入正整数", "example": "1" }, { "name": "MaxReplayLag", "type": "integer", "required": false, "description": "延迟时间大小阈值，单位s。当开启延迟时间配置时，应输入正整数。", "example": "1" }, { "name": "Rebalance", "type": "integer", "required": false, "description": "自动负载均衡开关：0关、1开", "example": "1" }, { "name": "MinDelayEliminateReserve", "type": "integer", "required": false, "description": "延迟剔除最小保留实例数。取值范围[0,100]", "example": "1" } ], "required": [ "ReadOnlyGroupId" ] }, { "name": "ModifySwitchTimePeriod", "description": "当升级完成后，对处于等待切换状态下的实例，强制实例立即切换。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "处于等待切换状态中的实例ID。可通过DescribeDBInstances接口获取", "example": "postgres-19nmz2xb" }, { "name": "SwitchTag", "type": "integer", "required": true, "description": "入参取值为 0 ，代表立即切换。", "example": "0" } ], "required": [ "DBInstanceId", "SwitchTag" ] }, { "name": "OpenAccountCAM", "description": "本接口用于开启数据库账户的CAM验证服务。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "数据库实例ID", "example": "postgres-4sfuv15b" }, { "name": "UserName", "type": "string", "required": true, "description": "需要开启CAM服务的账号名称", "example": "readonly_user" } ], "required": [ "DBInstanceId", "UserName" ] }, { "name": "OpenDBExtranetAccess", "description": "本接口（OpenDBExtranetAccess）用于开通实例公网地址。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。", "example": "postgres-apzvwncr" }, { "name": "IsIpv6", "type": "integer", "required": false, "description": "是否开通Ipv6外网，1：是，0：否 默认值：0", "example": "0" } ], "required": [ "DBInstanceId" ] }, { "name": "RebalanceReadOnlyGroup", "description": "本接口(RebalanceReadOnlyGroup)用于重新均衡 RO 组内实例的负载。注意，RO 组内 RO 实例会有一次数据库连接瞬断，请确保应用程序能重连数据库，谨慎操作。", "status": "online", "parameters": [ { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取", "example": "pgrogrp-e0tfm161" } ], "required": [ "ReadOnlyGroupId" ] }, { "name": "RefreshAccountPassword", "description": "本接口用于对开启CAM验证的账户执行手动刷新密码。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID", "example": "postgres-4sfuv15b" }, { "name": "UserName", "type": "string", "required": true, "description": "账号名称", "example": "readonly_user" } ], "required": [ "DBInstanceId", "UserName" ] }, { "name": "RemoveDBInstanceFromReadOnlyGroup", "description": "本接口（RemoveDBInstanceFromReadOnlyGroup）用户将只读实例从只读组中移除", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "pgro-c4wtbx1f" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取", "example": "pgrogrp-7ikfr75q" } ], "required": [ "DBInstanceId", "ReadOnlyGroupId" ] }, { "name": "RenewInstance", "description": "本接口（RenewInstance）用于续费实例。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费（包年包月）实例。", "example": "postgres-apzvwncr" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长，单位：月。 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36", "example": "1" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券： 0：否 1：是 默认值：0", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券", "example": "100010010100101", "item_type": "string" } ], "required": [ "DBInstanceId", "Period" ] }, { "name": "ResetAccountPassword", "description": "本接口（ResetAccountPassword）用于重置实例的账户密码。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-4wdeb0zv。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-lnp6j6172" }, { "name": "UserName", "type": "string", "required": true, "description": "实例账户名。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取", "example": "test_account" }, { "name": "Password", "type": "string", "required": true, "description": "UserName账户对应的新密码。 密码设置规则如下： - 长度8~ 32位，推荐使用12位以上的密码 - 不能以\" / \"开头 - 必须包含以下四项: 1. 小写字母a ~ z 2. 大写字母 A ～ Z 3. 数字 0 ～ 9 4. 特殊字符 ()`~!@#$%^\u0026*-+=_|{}[]:,.?/", "example": "1357Qwer()" } ], "required": [ "DBInstanceId", "UserName", "Password" ] }, { "name": "RestartDBInstance", "description": "本接口（RestartDBInstance）用于重启实例。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID，形如postgres-6r233v55。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-apzvwncr" } ], "required": [ "DBInstanceId" ] }, { "name": "RestoreDBInstanceObjects", "description": "根据备份集或恢复目标时间，在原实例上恢复数据库相关对象，例如数据库、表。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-6bwgamo3" }, { "name": "RestoreObjects", "type": "array", "required": true, "description": "需要恢复的对象列表。假设需要恢复的对象名为user，则恢复后的名称为user_bak_${LinuxTime}。${LinuxTime}无法指定，由系统根据任务发起的linux时间设定。", "example": "[\"user\"]", "item_type": "string" }, { "name": "BackupSetId", "type": "string", "required": false, "description": "恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取", "example": "db468966-a8d8-5831-8596-763a7833e380" }, { "name": "RestoreTargetTime", "type": "string", "required": false, "description": "恢复目标时间，北京时间。BackupSetId与RestoreTargetTime有且只能传一个。", "example": "2024-04-30 00:20:27" } ], "required": [ "DBInstanceId", "RestoreObjects" ] }, { "name": "SetAutoRenewFlag", "description": "本接口（SetAutoRenewFlag）用于设置自动续费。", "status": "online", "parameters": [ { "name": "DBInstanceIdSet", "type": "array", "required": true, "description": "实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费（包年包月）的实例。支持同时操作多个实例。", "example": "[\"postgres-6fego161\"]", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "续费标记。0-正常续费；1-自动续费；2-到期不续费", "example": "1" } ], "required": [ "DBInstanceIdSet", "AutoRenewFlag" ] }, { "name": "SwitchDBInstancePrimary", "description": "本接口（SwitchDBInstancePrimary）用于切换实例主备关系。 通过主动发起切换，可以验证业务能否正确处理实例主备切换的场景 通过使用强制切换，可以在备节点延迟不满足切换条件时，强制发起主从切换 只有主实例可以执行该操作", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-aser1j2o" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制切换。强制切换时只要备节点可访问，无论主备延迟多大都会发起切换。只有SwitchTag为0时，才可使用立即切换。 默认：false", "example": "true" }, { "name": "SwitchTag", "type": "integer", "required": false, "description": "指定实例配置完成变更后的切换时间。 0：立即切换 1：指定时间切换 2：维护时间窗口内切换 默认值：0", "example": "1" }, { "name": "SwitchStartTime", "type": "string", "required": false, "description": "切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。", "example": "01:00:00" }, { "name": "SwitchEndTime", "type": "string", "required": false, "description": "切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。SwitchStartTime和SwitchEndTime时间窗口不能小于30分钟。", "example": "01:30:00" } ], "required": [ "DBInstanceId" ] }, { "name": "UnlockAccount", "description": "解除数据库账号的锁定，解锁后账号可以登录数据库。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "postgres-4sfuv15b\t" }, { "name": "UserName", "type": "string", "required": true, "description": "账号名称。", "example": "bob_admin" } ], "required": [ "DBInstanceId", "UserName" ] }, { "name": "UpgradeDBInstanceKernelVersion", "description": "本接口（UpgradeDBInstanceKernelVersion）用于升级实例的内核版本号。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-aser1j2o" }, { "name": "TargetDBKernelVersion", "type": "string", "required": true, "description": "升级的目标内核版本号。可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)的返回字段AvailableUpgradeTarget获取。", "example": "v12.4_r1.5" }, { "name": "SwitchTag", "type": "integer", "required": false, "description": "指定实例升级内核版本号完成后的切换时间。可选值: 0：立即切换 1：指定时间切换 2：维护时间窗口内切换 默认值：0", "example": "1" }, { "name": "SwitchStartTime", "type": "string", "required": false, "description": "切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。", "example": "01:00:00" }, { "name": "SwitchEndTime", "type": "string", "required": false, "description": "切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。SwitchStartTime和SwitchEndTime时间窗口不能小于30分钟。", "example": "01:30:00" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否对本次升级实例内核版本号操作执行预检查。 true：执行预检查操作，不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。 false：发送正常请求（默认值），通过检查后直接升级内核版本号。 默认值：false", "example": "true" } ], "required": [ "DBInstanceId", "TargetDBKernelVersion" ] }, { "name": "UpgradeDBInstanceMajorVersion", "description": "本接口（UpgradeDBInstanceMajorVersion）用于升级实例内核大版本，例如从PostgreSQL 12升级到PostgreSQL 15。", "status": "online", "parameters": [ { "name": "DBInstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取", "example": "postgres-klj12ina" }, { "name": "TargetDBKernelVersion", "type": "string", "required": true, "description": "目标内核版本号，可以通过API [DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取可以升级的目标内核版本号。", "example": "v15.1_r1.6" }, { "name": "UpgradeCheck", "type": "boolean", "required": false, "description": "是否为校验模式，若UpgradeCheck为True，表示仅进行内核版本兼容性检查，不会进行实质性的升级操作，对原实例无影响。检查结果可以通过升级日志查看。", "example": "false" }, { "name": "BackupBeforeUpgrade", "type": "boolean", "required": false, "description": "升级前备份选项。True，表示升级前需要创建全量备份，False，表示升级前不需要创建全量备份。当实例已有备份集可以恢复到升级前的状态时，可选择False，否则需要指定为True。UpgradeCheck为True时，此参数无效。", "example": "true" }, { "name": "StatisticsRefreshOption", "type": "integer", "required": false, "description": "统计信息收集选项，对主例运行 ANALYZE 以在升级后更新系统统计信息。可选值包括， 0：不需要收集统计信息； 1：实例恢复写之前收集统计信息； 3：实例恢复写之后收集统计信息。 UpgradeCheck为True时，此参数无效。", "example": "0" }, { "name": "ExtensionUpgradeOption", "type": "integer", "required": false, "description": "插件升级选项，pg_upgrade不会升级任何插件，需要在升级完成后在创建过插件的库上执行\"ALTER EXTENSION UPDATE\"。发起升级实例大版本时可以指定在实例恢复写前/后是否需要升级任务自动升级插件版本。可选值包括： 0：不需要自动升级插件； 1：恢复写之前升级插件； 2：恢复写之后升级插件。 UpgradeCheck为True时，此参数无效。", "example": "0" }, { "name": "UpgradeTimeOption", "type": "integer", "required": false, "description": "升级时间选项，升级过程中会有一段时间实例只读，并会有一次秒级闪断，发起升级时需要选择这段影响的时间窗。可选值包括： 0：自动执行，不需要指定时间窗； 1：指定本次升级任务的时间窗，通过参数UpgradeTimeBegin和UpgradeTimeEnd设置； 2：在实例运维时间窗内执行。 UpgradeCheck为True时，此参数无效。", "example": "1" }, { "name": "UpgradeTimeBegin", "type": "string", "required": false, "description": "升级时间窗开始时间，时间格式：HH:MM:SS，例如：01:00:00。当UpgradeTimeOption为1时，该参数有效。 UpgradeCheck为True时，此参数无效。", "example": "01:00:00" }, { "name": "UpgradeTimeEnd", "type": "string", "required": false, "description": "升级时间窗截止时间，时间格式：HH:MM:SS，例如：02:00:00。当UpgradeTimeOption为1时，该参数有效。 UpgradeCheck为True时，此参数无效。", "example": "02:00:00" } ], "required": [ "DBInstanceId", "TargetDBKernelVersion" ] } ] }