华为云用户手册

响应参数 表3 响应参数 参数 参数类型 描述 job_ids Array of strings 任务ID。 succeeded_num Integer 下发成功的实例数量。 failed_num Integer 下发失败的实例数量。 failed_instance_ids Array of strings 下发失败的实例ID列表。 error_messages Array of strings 下发失败错误信息列表。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 是 Array of strings 批量实例ID。 upgrade_type 是 String 实例升级类型。包括就地升级，灰度升级、热补丁升级三种。区分大小写。 取值范围： grey：灰度升级。 inplace：就地升级。 hotfix：热补丁升级。 upgrade_action 否 String 实例升级操作，就地升级无需传值。灰度升级包括升级自动提交，升级待观察，提交升级，升级回退四种。区分大小写。 upgrade：升级。 upgradeAutoCommit：升级自动提交。 commit：提交。 rollback：回滚。 target_version 否 String 批量实例升级目标版本，非必填。 如果未传值，灰度升级和就地升级默认升级到当前实例的优选三位版本，如果是大版本升级，灰度升级和就地升级必填此参数。热补丁升级无需传该值，默认升级实例所有可升级热补丁。

请求示例 批量实例就地升级 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade { "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ], "upgrade_type" : "inplace" , "target_version" : "8.100.0" } 批量实例灰度升级并采用升级待观察方式升级传参。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade { "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ], "upgrade_type" : "grey", "upgrade_action" : "upgrade", "target_version" : "8.100.0" } 批量实例灰度升级并采用回滚方式升级传参。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade { "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ], "upgrade_type" : "grey", "upgrade_action" : "rollback", "target_version" : "8.100.0" } 批量实例灰度升级并采用升级自动提交方式升级传参。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade { "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ], "upgrade_type" : "grey", "upgrade_action" : "upgradeAutoCommit", "target_version" : "8.100.0" } 批量实例热补丁升级并采用升级自动提交方式升级传参。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade { "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ], "upgrade_type" : "hotfix", "upgrade_action" : "upgradeAutoCommit" }

功能介绍 GaussDB 批量实例版本升级。包括灰度升级，就地升级、热补丁升级三种升级方式。 批量实例可升级版本大于当前所有实例的最小引擎版本，且选择的所有实例，其升级方式和操作方式要保持一致。若批量实例升级方式是灰度升级，默认升级所有AZ和分片。 就地升级：就地升级需要停止业务进行，会一次性升级集群中所有节点。就地升级需要暂停业务30分钟来升级。 灰度升级： 每个主DN或者CN组件升级就有一次10秒业务中断。升级过程均是先管理面，再数据面，由备到主的升级方式。 升级自动提交：所有节点进程一起升级，在升级过程中有大概10秒的业务中断，不阻塞其他业务操作。 升级待观察：升级待观察，将数据库升级过程细分为升级，提交两个阶段。 升级阶段可以根据部署方式细分为按分片或者按AZ的滚动升级。 分布式实例：根据分片数滚动升级。批量实例升级方式下，默认升级所有分片。 集中式实例：根据AZ数进行滚动升级。批量实例升级方式下，默认升级所有分片。 提交阶段可以对升级完成后的实例进行业务测试，根据需要可以选择提交升级或者升级回退。 提交升级：在升级完成进入提交阶段时，业务测试正常后提交升级，完成本次升级流程。 升级回退：在升级完成进入提交阶段时，可以根据需要回退本次升级，回退到升级前的版本。 热补丁升级： 升级自动提交：热补丁自动升级并提交，中间无业务中断，仅修复产品BUG。 升级回退：热补丁回退，无业务中断时间。

请求示例 查询批量实例可升级的版本和升级类型。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade/candidate-versions { "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ] }

响应参数 表3 响应参数 参数 参数类型 描述 upgrade_type_list Array of 表4 objects 升级类型信息列表。 数组长度：0 - 1000 target_version String 若实例处于升级待观察中，返回升级的目标版本，否则返回为空。 最小长度：0 最大长度：1000 upgrade_candidate_versions Array of strings 可以升级的版本，包括大小版本。 最小长度：0 最大长度：1000 数组长度：0 - 1000 hotfix_upgrade_infos Array of 表6 objects 可以升级的热补丁信息。 数组长度：0 - 1000 hotfix_rollback_infos Array of 表6 objects 可以回滚的热补丁信息。 表4 upgrade_type_list 参数 参数类型 描述 upgrade_type String 升级类型。 取值范围： grey：灰度升级。 inplace：就地升级。 hotfix：热补丁升级。 enable Boolean 升级类型是否可用。 true：可用。 false：不可用。 upgrade_action_list Array of 表5 objects 升级操作列表。 数组长度：0 - 1000 is_parallel_upgrade Boolean 是否正在进行AZ内并行升级。 true：当前实例处于灰度升级的升级待观察升级方式中，已选择了AZ内并行升级方式，后续无法更改。 false：当前实例处于升级流程中，未选择AZ内并行升级的方式，后续无法更改。 null:当前实例尚未处于升级流程中。 表5 upgrade_action_list 参数 参数类型 描述 upgrade_action String 升级操作。 取值范围： upgrade：升级。 upgradeAutoCommit：升级自动提交。 commit：提交。 rollback：回滚。 enable Boolean 升级类型是否可用。 true：可用。 false：不可用。 表6 hotfix_upgrade_infos 参数 参数类型 描述 version String 热补丁版本。 common_patch String 补丁类型。 取值范围： common：通用补丁。 certain：定制补丁。 backup_sensitive Boolean 是否和备份相关。 取值范围： true：和备份相关。 false：和备份不相关。 descripition String 补丁的描述信息。

响应示例 查询批量实例可升级的版本和升级类型。 { "upgrade_type_list": [ { "upgrade_type": "grey", "upgrade_action_list": [ { "upgrade_action": "commit", "enable": false }, { "upgrade_action": "rollback", "enable": false }, { "upgrade_action": "upgrade", "enable": true }, { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null }, { "upgrade_type": "inplace", "upgrade_action_list": [ { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null }, { "upgrade_type": "hotfix", "upgrade_action_list": [ { "upgrade_action": "upgradeAutoCommit", "enable": false }, { "upgrade_action": "rollback", "enable": false } ], "enable": false, "is_parallel_upgrade": null } ], "upgrade_candidate_versions": [ "V2.0-8.100.0" ], "target_version": null, "hotfix_upgrade_infos": [], "hotfix_rollback_infos": [] }

URI POST https://{Endpoint}/v3.1/{project_id}/instances/db-upgrade/candidate-versions 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

响应示例 实例列表： { "instances" : [ { "id" : "b331ed66cc3249f78bc20737308c01f4in14", "status" : "ACTIVE", "name" : "gauss-9e88", "port" : 8000, "type" : "enterprise", "ha" : { "consistency" : "strong", "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "V2.0-2.7", "complete_version" : "V2.0-2.7.2", "target_version" : "V2.0-3.208.0", "complete_kernel_version" : "V500R002C10SPC610" }, "created" : "2021-01-15 01:46:40 UTC", "updated" : "2021-01-15 02:05:03 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 120 }, "nodes" : [ { "id" : "02ebf757aaf94074855f49cc6e0e4712no14", "name" : "gauss-9e88_gaussdbv5cn_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5001:" }, { "id" : "0a87b8ecbfeb46aba1409cfc0f0d5c34no14", "name" : "gauss-9e88_gaussdbv5cn_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5002:" }, { "id" : "2d9fec1ab3834936b074d63acf48b1f2no14", "name" : "gauss-9e88_gaussdbv5dn3_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60073" }, { "id" : "48bb08a2d635435891ac0caa1c0bf2e3no14", "name" : "gauss-9e88_gaussdbv5dn1_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60011" }, { "id" : "5df830f652204827ada32f8bc28b107eno14", "name" : "gauss-9e88_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "8a97a246cee841b38c5b47290d4c9c38no14", "name" : "gauss-9e88_gaussdbv5cn_1", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5003:" }, { "id" : "8c1a3f8eecca4d9e9974a868bb6dd942no14", "name" : "gauss-9e88_gaussdbv5dn2_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6004:60042" }, { "id" : "9bd0c80b8a684cc9bd7d99dd5adffb07no14", "name" : "gauss-9e88_gaussdbv5dn3_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6005:60073" }, { "id" : "9e2a3cd541e249d4af5aa57c5d3a7f39no14", "name" : "gauss-9e88_gaussdbv5dn1_2", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6006:60011" }, { "id" : "b046d28989ec4ae5a1a9ab20fe65f248no14", "name" : "gauss-9e88_gaussdbv5dn2_2", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6007:60042" }, { "id" : "b614cc12fd3742dbb230245f88a7bf00no14", "name" : "gauss-9e88_gaussdbv5dn3_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6008:60073" }, { "id" : "caba8e88c3c84ae58202f1f589490611no14", "name" : "gauss-9e88_gaussdbv5dn2_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6009:60042" } ], "private_ips" : [ "192.168.28.81 / 192.168.27.52 / 192.168.16.253" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "prePaid" }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "disk_encryption_id" : "24ae42b5-4009-4ea2-b66a-0b211e424dab", "enterprise_project_id" : "6e76681b-a2f5-4c5f-97c5-ba4fd3c0dfb2", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "0.9890", "mysql_compatibility" : { "port" : 3306 } }, { "id" : "226b4afcfcc84c86bf1b9cb345d3b00fin14", "status" : "ACTIVE", "name" : "UTS-gauss-ad53-2C3D", "port" : 8000, "type" : "enterprise", "ha" : { "consistency" : "strong", "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "V2.0-2.7", "complete_version" : "V2.0-2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "V2.0-3.208.0", "hotfix_version_infos" : [ { "version" : "V2.0-2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "V2.0-2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2021-01-08 09:18:27 UTC", "updated" : "2021-01-14 13:25:03 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 120 }, "nodes" : [ { "id" : "07538a1def584cee99e2a5685eeab36ano14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6009:60072" }, { "id" : "21f41baba1e2454f82331b7cb5aeabe5no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6008:60042" }, { "id" : "2909771a3b3e4e3998f9388e77d22391no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6007:60011" }, { "id" : "2bd9a90a5da242a6b0743a7f597f6106no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6006:60042" }, { "id" : "77092f1dadb74d3ea13d28269cdd3590no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6005:60072" }, { "id" : "a46bfaa6d5a24355a60fce7432b964cano14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6004:60072" }, { "id" : "aa5277736f3844e2a7adeb9de529e2b1no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60042" }, { "id" : "b1d798e4ea7344dfa95032984bc6cfd7no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5cn_1", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5002:" }, { "id" : "b9a46540186f4c0781eabaa2a79594cbno14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "d283813030364060ab64371d50294977no14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60042" }, { "id" : "eb7bce29b2284cd290405eaddc1b1a1eno14", "name" : "UTS-gauss-ad53-2C3D_gaussdbv5cn_0", "role" : "master", "status" : "FAILED", "availability_zone" : "az2xahz", "component_names" : "cn_5001:" } ], "private_ips" : [ "192.168.30.44 / 192.168.29.231" ], "public_ips" : [ "10.154.217.248" ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "prePaid" }, "backup_strategy" : { "start_time" : "18:00-19:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "enterprise_project_id" : "0", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "1.0000", "mysql_compatibility" : { "port" : 3306 } }, { "id" : "706c65c3dd7d497ab16f5b3a113690abin14", "status" : "ACTIVE", "name" : "UTS-gauss-7362", "port" : 8000, "type" : "enterprise", "ha" : { "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "3.208.0", "hotfix_version_infos" : [ { "version" : "2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2020-12-23 03:21:41 UTC", "updated" : "2021-01-15 02:32:13 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 80 }, "nodes" : [ { "id" : "25b7f16ee4084b7884d52f1bdfab4e68no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60011" }, { "id" : "ad6f02f31744422fa8ce487e81c9e7afno14", "name" : "UTS-gauss-7362_gaussdbv5cn_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_5001:" }, { "id" : "b30c56582bf44a548e3bb5b5af6c4773no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "f79ea0600cba42b2888bd9bd67e52a79no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60011" } ], "private_ips" : [ "192.168.26.70" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "postPaid" }, "backup_strategy" : { "start_time" : "16:00-17:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "enterprise_project_id" : "0", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "0.9940", "mysql_compatibility" : { "port" : 3306 } }, { "id" : "4ad42d079a3948d88c28d6236211b21ein14", "status" : "ACTIVE", "name" : "UTS-gauss-4336", "port" : 8000, "type" : "enterprise", "ha" : { "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "3.208.0", "hotfix_version_infos" : [ { "version" : "2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2020-12-03 14:28:53 UTC", "updated" : "2021-01-14 13:20:10 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 40 }, "nodes" : [ { "id" : "254dbda6f03643519ad64b39481bd11cno14", "name" : "UTS-gauss-4336_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "dn_6001:60011" }, { "id" : "6ad76d4db26443c2a93b280739a31558no14", "name" : "UTS-gauss-4336_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "dn_6002:60011" }, { "id" : "9fdebf821bdf444a8689b19c0ff588ceno14", "name" : "UTS-gauss-4336_gaussdbv5cn_0", "role" : "master", "status" : "FAILED", "availability_zone" : "az1xahz", "component_names" : "cn_5001:" }, { "id" : "dd64bdbc02a542d88823b1582f772d25no14", "name" : "UTS-gauss-4336_gaussdbv5cn_1", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "cn_5002:" }, { "id" : "de3c41461045466faf6c2b96eb709540no14", "name" : "UTS-gauss-4336_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az1xahz", "component_names" : "dn_6001:60011" } ], "private_ips" : [ "192.168.30.93 / 192.168.29.232" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "postPaid" }, "backup_strategy" : { "start_time" : "18:00-19:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "enterprise_project_id" : "0", "instance_mode" : "basic", "time_zone" : "UTC+08:00", "disk_usage" : "1.0000", "mysql_compatibility" : { "port" : 3306 } } ], "total_count" : 4 } 实例详情 { "instances" : [ { "id" : "706c65c3dd7d497ab16f5b3a113690abin14", "status" : "ACTIVE", "name" : "UTS-gauss-7362", "port" : 8000, "type" : "enterprise", "ha" : { "replication_mode" : "sync" }, "region" : "cn-xianhz-1", "datastore" : { "type" : "GaussDB", "version" : "2.7", "complete_version" : "2.7.2", "complete_kernel_version" : "V500R002C10SPC610", "target_version" : "3.208.0", "hotfix_version_infos" : [ { "version" : "2.7.2.1", "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" }, { "version" : "2.7.2.2", "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" } ] }, "created" : "2020-12-23 03:21:41 UTC", "updated" : "2021-01-15 02:32:13 UTC", "volume" : { "type" : "ULTRAHIGH", "size" : 80 }, "nodes" : [ { "id" : "25b7f16ee4084b7884d52f1bdfab4e68no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_2", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6003:60011" }, { "id" : "ad6f02f31744422fa8ce487e81c9e7afno14", "name" : "UTS-gauss-7362_gaussdbv5cn_0", "role" : "master", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "cn_6004:" }, { "id" : "b30c56582bf44a548e3bb5b5af6c4773no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_1", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6002:60011" }, { "id" : "f79ea0600cba42b2888bd9bd67e52a79no14", "name" : "UTS-gauss-7362_gaussdbv5dn1_0", "role" : "slave", "status" : "ACTIVE", "availability_zone" : "az2xahz", "component_names" : "dn_6001:60011" } ], "private_ips" : [ "192.168.26.70" ], "public_ips" : [ ], "db_user_name" : "root", "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info" : { "vcpu" : 2, "mem" : 16 }, "switch_strategy" : "Reliability", "charge_info" : { "charge_mode" : "postPaid" }, "backup_strategy" : { "start_time" : "16:00-17:00", "keep_days" : 7 }, "maintenance_window" : "18:00-22:00", "disk_encryption_id" : "", "enterprise_project_id" : "0", "instance_mode" : "enterprise", "time_zone" : "UTC+08:00", "disk_usage" : "0.9670" } ], "total_count" : 1 }

请求示例 根据指定条件查询实例列表。 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in14&name=hy&type=Enterprise&datastore_type=GaussDB&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 查询所有实例列表。 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.3/97b026aa9cc4417888c14c84a1ad9860/instances

响应参数 表3 响应参数 参数 参数类型 描述 instances Array of 表4 objects 实例信息。 total_count Integer 总记录数。 表4 instances 参数 参数类型 描述 id String 实例ID。 name String 创建的实例名称。 status String 实例状态。 取值： 值为“BUILD”，表示实例正在创建。 值为“BUILD_FAILED”，表示实例创建失败。 值为“ACTIVE”，表示实例正常。 值为“FAILED”，表示实例异常。 值为“FROZEN”，表示实例冻结。 值为“MODIFYING”，表示实例正在扩容磁盘或者变更规格。 值为“EXPANDING”，表示实例正在添加只读节点或扩容CN或DN。 值为“REBOOTING”，表示实例正在重启。 值为“REDUCING”, 表示实例正在删除只读节点。 值为“UPGRADING”，表示实例正在升级。 值为“RESTORING”，表示实例正在恢复。 值为“SWITCHOVER”，表示实例正在主备切换。 值为“MIGRATING”，表示实例正在迁移。 值为“BACKING UP”，表示实例正在进行备份。 值为“UPGRADE TO BE OBSERVED”，表示实例正在进行升级待观察。 值为“MODIFYING DATABASE PORT”，表示实例正在修改数据库端口。 值为“STORAGE FULL”，表示实例磁盘空间满。 值为”REPAIRING”，表示实例正在修复。 值为“SHUTDOWN”，表示实例已停止。 private_ips Array of strings 实例内网IP地址列表。分布式CN所在的弹性云服务器创建成功后该值存在，集中式版DN所在的弹性云服务器创建成功后该值存在，其他情况下为空字符串。 public_ips Array of strings 实例外网IP地址列表。绑定弹性公网IP后，该值不为空。 port Integer 数据库端口号。 GaussDB数据库 端口设置范围为1024~39998（其中2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,20049,20050,21731,21732被系统占用不可设置）。当不传该参数时，默认端口8000。 type String 实例类型，区分大小写。 Enterprise：分布式实例（企业版）。 centralization_standard：集中式版实例。 Combined：分布式实例（混合部署）。 ha 表5 object 获取分布式/集中式版实例时返回。 replica_num Integer 实例副本数。 region String 实例所在区域。 datastore 表6 object 数据库信息。 created String 创建时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。 其中timezone是指时区。 说明：创建时该值为实例下发创建的时间，创建完成后，该值为创建完成时间。例如：2024-07-02 08:32:07 UTC。 updated String 更新时间，格式与“created”字段对应格式完全相同。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 flavor_ref String 规格码。参考查询数据库规格中“spec_code”字段获取。 flavor_info 表8 object 规格信息。 volume 表9 object Volume信息。 switch_strategy String 数据库切换策略。 如果创建实例时没有选择切换策略，则该字段不显示。 取值为“Reliability”或“Availability”，分别对应于可靠性优先和可用性优先。 若创建时没有选择切换策略，则不予显示。 backup_strategy 表10 object 备份策略。 maintenance_window String 可维护时间窗，为UTC时间。 nodes Array of 表11 objects 实例节点信息列表。 disk_encryption_id String 磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。 enterprise_project_id String 企业项目标签ID。非企业项目账号的实例，企业项目默认0。 instance_mode String 实例类型。 basic：基础版。 enterprise：企业版。 disk_encryption_id String 磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。 charge_info 表12 object 计费类型信息，支持按需和包周期。 time_zone String 时区。 tags Array of 表13 objects 标签列表，没有标签不返回该参数。 disk_usage String 实例磁盘的可使用率，值范围[0-1]，值保留四位小数。 mysql_compatibility 表14 mysql_compatibility object 实例M兼容配置。 表5 ha 参数 参数类型 描述 consistency String 数据库一致性类型，仅支持分布式实例。 取值范围： strong：强一致性。 eventual：最终一致性。 replication_mode String 备机同步参数，非空，支持“sync”，表示同步模式。 表6 datastore 参数 参数类型 描述 type String 数据库引擎。 version String 数据库大版本。 complete_version String 数据库小版本。 target_version String 数据库正在升级的目标版本。 complete_kernel_version String 数据库内核版本。 hotfix_version_infos Array of 表7 objects 热补丁信息列表。 表7 hotfix_version_infos 参数 参数类型 描述 version String 热补丁版本。 upgrade_finished_time String 热补丁升级完成时间列表。 热补丁升级完成时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。 其中timezone是指时区。 表8 flavor_info 参数 参数类型 描述 vcpu Integer CPU核数。 mem Integer 内存大小。 表9 volume 参数 参数类型 描述 type String 磁盘类型。 仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。 size Integer 磁盘大小。 表10 backup_strategy 参数 参数类型 描述 start_time String 备份时间段。自动备份将在该时间段内触发。 当前时间指UTC时间。 keep_days Integer 已生成的备份文件可以保存的天数。 取值范围：1～732。 表11 nodes 参数 参数类型 描述 id String 节点ID。 name String 节点名称。 role String 节点类型。 master：主节点。 slave：备节点。 secondary：日志节点。 readreplica：只读节点。 status String 节点状态。 值为“BUILD_FAILED”，表示节点创建失败。 availability_zone String 可用区。 private_ip String 节点内网IP。分布式实例类型下该参数仅针对CN节点有效，集中式版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功后参数值存在。 public_ip String 绑定的外网IP。分布式实例类型下该参数仅针对CN节点有效，集中式版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功并绑定弹性公网IP后参数值存在。 component_names String 节点上组件信息（例组件ID:分布式ID），多个组件信息用;隔开。 表12 charge_info 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 表13 tags 参数 参数类型 描述 key String 标签键。 value String 标签值。 表14 mysql_compatibility 参数 参数类型 描述 port String M兼容端口。

URI GET https://{Endpoint}/v3.3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 实例ID。 “*”为系统保留字符，如果ID是以“*”起始，表示按照*后面的值模糊匹配，否则，按照ID精确匹配查询。不能只传入“*”。 name 否 String 实例名称。 “*”为系统保留字符，如果name是以“*”起始，表示按照*后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 type 否 String 按照实例类型查询，取值区分大小写。 取值范围： Enterprise（区分大小写），对应分布式实例（独立部署）。 Centralization_standard（区分大小写），对应集中式版实例。 datastore_type 否 String 数据库类型，支持“GaussDB”，区分大小写。 vpc_id 否 String 虚拟私有云ID。 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id 否 String 子网的网络ID信息。 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100 tags 否 Array 根据实例标签键值对进行查询。 {key}表示标签键，不可以为空或重复。最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}表示标签值，可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。 如果value为空，则表示any_value（查询任意value）。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含10组。 charge_mode 否 String 计费模式。 取值范围： postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。

响应参数 表4 响应Body参数 参数 参数类型 描述 node_limit_sql_model_list Array of objects 限流SQL模板信息，详细内容请参见表5。 limit Integer 查询记录数。 offset Integer 索引位置。 total_count Integer 总数。 表5 ListNodeLimitSqlModelResponseResult 参数 参数类型 描述 sql_id String 限流任务的sql_id。 sql_model String 限流任务SQL模板。

请求示例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/list-node-limit-sql-model?node_id=46d996fdda594f58b17fe509061e0893no14&offset=0

响应示例 { "node_limit_sql_model_list" : [ { "sql_id" : "3519660378", "sql_model" : "select * from table where id= ?" } ], "total_count" : 1, "limit" : 10, "offset" : 1 }

请求示例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task-list?offset=1&limit=10&limit_type=SQL_ID&task_name=test

响应参数 表4 响应Body参数 参数 参数类型 描述 limit_task_list Array of objects 限流任务列表，详情请参见表5。 limit Integer 查询记录数。 offset Integer 索引位置。 total_count Integer 总数。 表5 ListLimitTaskResponseResult 参数 参数类型 描述 task_id String 限流任务ID。 task_scope String 任务限流范围。 limit_type String 任务限流类型。 limit_type_value String 任务限流类型值。 task_name String 限流任务名。 databases String 实例的数据库列表，每个数据库以英文逗号形式分隔。 sql_model String SQL模板，仅当任务类型为SQL_ID时，返回该值。 key_words String 关键词，仅当任务类型为SQL_TYPE时，返回该值。 status String 限流任务状态，当前支持：CREATING，UPDATING，DELETING，WAIT_EXECUTE，EXECUTING，TIME_OVER，DELETED，CREATE_FAILED，UPDATE_FAILED，DELETE_FAILED，EXCEPTION，NODE_SHUT_DOWN。 instance_id String 实例ID。 rule_name String 规则名。 parallel_size Integer 并发数。 start_time String 限流任务开始时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。 end_time String 限流任务结束时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。 cpu_utilization Integer CPU利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。 memory_utilization Integer 内存利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。 created String 创建时间为本地时间，格式为yyyy-mm-ddThh:mm:ssZ，当前时间指UTC时间。 updated String 更新时间为本地时间，格式为yyyy-mm-ddThh:mm:ssZ，当前时间指UTC时间。 creator String 创建者。 modifier String 更新者。 node_infos Array of objects CN节点信息列表，详情请参见表6。 表6 ShowLimitTaskNodeOption 参数 参数类型 描述 node_id String 节点ID。 sql_id String 该节点执行的SQL语句ID。

响应示例 { "limit_task_list" : [ { "task_id" : "59b6a1a278844ac48119d86512e0000", "task_scope" : "SQL", "limit_type" : "SQL_ID", "limit_type_value" : 2348983611, "sql_model" : "select * from table where id = {id}", "status" : "creating", "key_words" : null, "instance_id" : "39b6a1a278844ac48119d86512e0000bin06", "parallel_size" : 100, "rule_name" : "dsa48119d86512e0000bin066a1a27", "databases" : "test1", "task_name" : "test1", "start_time" : "2023-12-30T02:00:00Z", "end_time" : "2023-12-30T02:00:00Z", "created" : "2023-12-28T01:55:08Z,", "updated" : "2023-12-28T01:55:08Z,", "creator" : "test,", "modifier" : "null,", "cpu_utilization" : null, "memory_utilization" : null, "node_infos" : [ { "node_id" : "cf521ccca2d74c9e89569a9828b6adcbno14", "sql_id" : 2348983611 } ] } ], "total_count" : 1, "limit" : 10, "offset" : 1 }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task-list 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 task_scope 否 String 限流任务范围，目前支持SQL和SESSION。 limit_type 否 String 限流类型，支持SQL_ID、SQL_TYPE、SESSION_ACTIVE_MAX_COUNT类型。 limit_type_value 否 String 限流类型值，支持模糊匹配。 task_name 否 String 限流任务名，支持模糊匹配。 sql_model 否 String SQL模板，支持模糊匹配。 rule_name 否 String 规则名。 start_time 否 String 限流任务开始时间,格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。 end_time 否 String 限流任务结束时间,格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 取值范围：0~10000 limit 否 Integer 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。

URI DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task/{task_id} 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 task_id 是 限流任务ID。 instance_id 是 实例ID。

请求示例 创建限流范围是SQL级别，限流类型是SQL_ID的限流任务。 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task { "task_scope" : "SQL", "start_time" : "2023-06-06T01:47:20+0800", "end_time" : "2023-06-07T01:47:20+0800", "limit_type" : "SQL_ID", "limit_type_value" : "39b6a1a", "task_name" : "test1", "sql_model" : "select * from a where b = ?", "parallel_size" : 100, "node_infos" : [ { "node_id" : "46d996fdda594f58b17fe509061e0893no14", "sql_id" : "39b6a1a" } ] } 创建限流范围是SQL级别，限流类型是SQL_TYPE的限流任务。 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task { "task_scope" : "SQL", "start_time" : "2023-06-06T01:47:20+0800", "end_time" : "2023-06-07T01:47:20+0800", "limit_type" : "SQL_TYPE", "limit_type_value" : "select", "task_name" : "test1", "key_words" : "table1,id", "parallel_size" : 100, "databases" : "test1" } 创建限流范围是SESSION级别，限流类型是SESSION_ACTIVE_MAX_COUNT的限流任务。 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task { "task_name" : "test", "task_scope" : "SESSION", "limit_type" : "SESSION_ACTIVE_MAX_COUNT", "limit_type_value" : "CPU_OR_MEMORY", "cpu_utilization" : 80, "memory_utilization" : 80, "parallel_size" : 100 }

响应示例 { "task_id" : "59b6a1a278844ac48119d86512e0000", "task_scope" : "SQL", "task_name" : "test1", "limit_type" : "SQL_TYPE", "limit_type_value" : "select", "instance_id" : "cb651ac71c5a447685ef981e44a0422fin14", "key_words" : "test", "databases" : "test1", "status" : "creating", "parallel_size" : 100, "rule_name" : "dsa48119d86512e0000bin066a1a27", "start_time" : "2023-12-30T02:00:00Z", "end_time" : "2023-12-30T02:00:00Z", "created" : "2023-12-30T02:00:00Z", "updated" : "2023-12-30T02:00:00Z", "creator" : "dbs_rds_guangzhou_l00417929_01", "job_id" : "d8819ac11297598d06e591b5786aab86" }

响应参数 表5 响应Body参数 参数 参数类型 描述 task_id String 限流任务ID。 task_scope String 任务限流范围。 limit_type String 任务限流类型。 limit_type_value String 任务限流类型值。 databases String 实例的数据库列表，每个数据库以英文逗号形式隔开。 task_name String 限流任务名。 sql_model String SQL模板，仅当任务类型为SQL_ID时，返回该值。 key_words String 关键词，仅当任务类型为SQL_TYPE时，返回该值。 status String 限流任务状态，当前支持：CREATING，UPDATING，DELETING，WAIT_EXECUTE，EXCUTING，TIME_OVER，DELETED，CREATE_FAILED，UPDATE_FAILED，DELETE_FAILED，EXCEPTION，NODE_SHUT_DOWN。 instance_id String 实例ID。 rule_name String 规则名。 parallel_size Integer 并发数。 cpu_utilization Integer CPU利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。 memory_utilization Integer 内存利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。 start_time String 限流任务开始时间，格式为yyyy-mm-ddThh:mm:ssZ。当“task_scope”为SQL时会返回该参数。 end_time String 限流任务结束时间，格式为yyyy-mm-ddThh:mm:ssZ。当“task_scope”为SQL时会返回该参数。 created String 创建时间，格式为yyyy-mm-ddThh:mm:ss+0000。 updated String 更新时间，格式为yyyy-mm-ddThh:mm:ss+0000。 creator String 创建者。 modifier String 更新者。 node_infos Array of 表6 objects CN节点信息列表，如果类型为SQLID，返回该值且与请求参数相同。 job_id String 工作流ID。 表6 CreateLimitTaskNodeResult 参数 参数类型 描述 node_id String 节点ID。 sql_id String 该节点执行的SQL语句ID。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 语言。 缺省值：en-us 枚举值： zh-cn en-us 表3 请求Body参数 参数 是否必选 参数类型 描述 task_scope 是 String 限流任务范围，目前支持SQL，SESSION两种级别范围。 start_time 否 String 任务开始时间，当“task_scope”为SQL时必传。 取值范围：大于等于当前时间（UTC时间）的前两分钟。 格式必须为yyyy-mm-ddThh:mm:ss+0000。 end_time 否 String 任务结束时间，当“task_scope”为SQL时必传。 取值范围：大于任务开始时间。 格式必须为yyyy-mm-ddThh:mm:ss+0000。 limit_type 是 String 限流类型。 当“task_scope”为SQL时，可选SQL_ID、SQL_TYPE类型。 当“task_scope”为SESSION时，可选SESSION_ACTIVE_MAX_COUNT类型。 limit_type_value 是 String 限流类型值。 当“limit_type”为SQL_ID类型时，该值为选中模板的sql_id。 当“limit_type”为SQL_TYPE类型时，值为SQL类型，目前支持select，update，insert，delete，merge。 当“limit_type”为SESSION_ACTIVE_MAX_COUNT类型时，只支持CPU_OR_MEMORY一种值。 key_words 否 String 关键词，当“limit_type”为SQL_TYPE时，必传。 多个关键词以逗号隔开，数量范围为[2，100]个，每个关键词长度范围[2，64]位，关键词不允许包含 " 或 \ 或 {} 或 null值以及非首尾的空格符。 task_name 是 String 限流任务名称，只能为英文字母大小写，下划线，数字和$符，最大长度为100个字符。 sql_model 否 String SQL模板。如果“limit_type”为SQLID，必传。 parallel_size 是 Integer 并发数，大于等于零的整数，取值范围[0, 2147483647]。 cpu_utilization 否 Integer CPU利用率阈值，整数，取值范围[0,100）。 如果“limit_type”为SESSION_ACTIVE_MAX_COUNT，则“cpu_utilization”必选。 不支持和内存利用率阈值同时为0，如果选择只限制CPU、内存中的其中一个，则另一个必须传值0。 memory_utilization 否 Integer 内存利用率阈值，整数，取值范围[0,100）。 如果“limit_type”为SESSION_ACTIVE_MAX_COUNT，则“memory_utilization”必选。 不支持和CPU利用率阈值同时为0，如果选择只限制CPU、内存中的其中一个，则另一个必须传值0。 databases 否 String 实例的数据库列表，每个数据库以英文逗号形式隔。 如果“limit_type”为SQL_TYPE，则“databases”必选。 node_infos 否 Array of objects CN节点信息列表，详情参见表4。 如果“limit_type”为SQL_ID，则“node_infos”必选。 表4 CreateLimitTaskNodeOption 参数 是否必选 参数类型 描述 node_id 是 String 节点ID。 sql_id 是 String 该节点执行的SQL语句ID，如果“limit_type”为SQL_ID，必须与“limit_type_value”值一致。

功能介绍 GaussDB实例版本升级。包括就地升级，灰度升级，热补丁升级三种升级方式。 就地升级 就地升级需要停止业务进行，会一次性升级集群中所有节点。就地升级需要暂停业务30分钟来升级。 灰度升级 每个主DN或者CN组件升级就有一次10秒业务中断。升级过程均是先管理面，再数据面，由备到主的升级方式。灰度升级支持升级自动提交和升级待观察两种操作方式。 升级自动提交：所有节点进程一起升级，在升级过程中有大概10秒的业务中断，不阻塞其他业务操作。 升级待观察：升级待观察，将数据库升级过程细分为升级，提交两个阶段。 升级阶段可以根据部署方式细分为按分片或者按AZ的滚动升级。 分布式实例：根据分片数滚动升级。 集中式实例：根据AZ数进行滚动升级。 提交阶段可以对升级完成后的实例进行业务测试，根据需要可以选择提交升级或者升级回退。 提交升级：在升级完成进入提交阶段时，业务测试正常后提交升级，完成本次升级流程。 升级回退：在升级完成进入提交阶段时，可以根据需要回退本次升级，回退到升级前的版本。 热补丁升级 升级自动提交：热补丁自动升级并提交，中间无业务中断。 升级回退：热补丁回退，无业务中断时间。 调用接口前，您需要了解API 认证鉴权。 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

请求示例 就地升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "inplace", "target_version": "xxx" } 热补丁升级 实例热补丁升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "hotfix", "target_version" : "xxxx,xxxx,xxxx", "upgrade_action" : "upgradeAutoCommit" } 实例热补丁升级回退。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type": "hotfix", "target_version": "xxxx,xxxx,xxxx", "upgrade_action": "rollback" } 灰度升级 实例灰度升级并采用升级自动提交升级方式升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "upgradeAutoCommit" } 实例灰度升级并采用升级待观察方式升级。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "upgrade", "upgrade_shard_num" : 1, } 实例灰度升级并采用升级待观察方式升级，当实例处于升级待观察状态中，可进行升级回退，会回退全部已升级的分片，实例恢复正常后回退成功。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "rollback" } 实例灰度升级并采用升级待观察方式升级，当实例处于升级待观察状态中，且全部分片都升级完成后，可进行升级提交。实例恢复正常后升级完成。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "target_version": "xxx", "upgrade_action" : "commit" } 集中式版实例灰度升级并采用升级待观察方式升级传参。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade { "upgrade_type" : "grey", "upgrade_action" : "upgrade", "target_version": "xxx", "upgrade_az" : "az1,az2" }

URI PUT https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-upgrade 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID，严格匹配UUID规则。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 upgrade_type 是 String 实例升级类型，区分大小写。包括就地升级，灰度升级，热补丁升级三种，三种升级方式的异同，详见接口描述。 inplace：就地升级。 grey：灰度升级。 hotfix：热补丁升级。 upgrade_action 否 String 实例升级操作，区分大小写。 实例升级类型是就地升级时非必选。 灰度升级包括升级自动提交、升级待观察、提交升级和升级回退四种。 热补丁升级包括升级自动提交，升级回退两种。 upgradeAutoCommit：升级自动提交 。 upgrade：升级待观察。 commit：提交升级。 rollback：升级回退。 target_version 否 String 实例升级目标版本。 热补丁升级场景下支持传入多个热补丁版本。 upgrade_shard_num 否 Integer 分布式实例灰度升级分片数。分布式实例灰度升级，升级待观察必填。该值不能大于实例未升级分片总数。 upgrade_az 否 String 灰度升级，升级待观察AZ值，升级待观察时必填。可以支持多AZ一起升级，AZ之间以英文逗号分隔。不能填入不属于该实例的AZ值。

URI GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-upgrade/candidate-versions 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID，严格匹配UUID规则。