华为云用户手册

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueExecuteTaskVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueExecuteTaskVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value ExecuteTaskVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ExecuteTaskVo 参数 参数类型 描述 flag Boolean 标志 uri String URI task_result_vo TaskResultVo object 实际的数据类型：单个对象，集合 或 NULL update_case_uri_list Array of strings 更新用例 test_case_result_list Array of TestResultVo objects 用例结果列表 表6 TaskResultVo 参数 参数类型 描述 uri String URI name String 测试套名称 description String 描述 owner String 责任人 creator String 创建人id updator String 更新人 task_uri String 任务uri owner_name String 责任人名称 release_dev String 发布版本号 version_uri String 分支/迭代uri creator_name String 创建人名称 create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 updator_name String 更新人名称 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 start_time String 开始时间 start_time_timestamp Long 开始时间时间戳 end_time String 结束时间 end_time_timestamp Long 开始时间时间戳 result_code Integer 执行结果Code result_name String 测试结果名称 finish_flg Integer 测试任务是否执行完成（0：未完成，1：已完成） project_uuid String 项目id 表7 TestResultVo 参数 参数类型 描述 uri String 结果URI name String 用例结果名称 author String 创建人ID rank Integer 级别 result Integer 测试结果Code round Integer 执行批次 preparation String 前置条件 description String 描述 region String 逻辑Region steps Array of ResultStepVo objects 测试步骤信息 number String 用例结果编号 author_name String 创建人名称 begin_time String 执行开始时间 begin_time_timestamp Long 执行开始时间时间戳 end_time String 执行结束时间 end_time_timestamp Long 执行结束时间时间戳 creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 last_modified String 最后修改时间 last_modified_timestamp Long 最后修改时间 last_change_time String 最后变更时间 last_change_time_timestamp Long 最后变更时间 dfx_test_result String DFX测试结果 failure_cause String 失败原因 parent_uri String 父节点URI(分支用例URI或迭代用例URI) test_case_uri String 分支用例URI test_case_name String 用例名称 task_uri String 测试任务URI result_name String 测试结果 test_result_ae String 是否自动化执行 executor_id String 执行人ID executor_name String 执行人名称 task_id String 执行机任务ID execute_id String 执行ID time_cost Integer 执行耗时 step_txt String 测试步骤 step_expect String 测试步骤期望结果 step_actual String 测试步骤实际结果 step_result String 测试步骤结果 release_dev String 版本号 creation_version_uri String 创建版本URI version_uri String 版本URI project_uuid String 项目ID report_url String 第三方过来的执行结果，返回跳转到第三方的url test_case_number String 测试用例编号 service_type String 测试类型 表8 ResultStepVo 参数 参数类型 描述 result String 结果 test_step String 测试步骤 expect_result String 预期结果 actual_result String 实际结果 result_name String 测试结果名称 表9 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

功能介绍 自然语言处理包含如下子服务。 机器翻译 （Machine Translation，简称MT），为用户提供快速准确的翻译服务，帮助用户跨语言沟通，可用于文档翻译等场景中。 优势 功能全面 提供多种常用自然语言类的算法模型及解决方案，可覆盖不同行业的各类需求。 高效准确 可快速分析大数据量的文本，深度理解文本语义，更加准确的挖掘出文本中的关键信息。 简单易用 简单易用的API接口。无需下载SDK、购买服务器，支持跨平台调用。丰富的产品种类，可一站式开通、部署。 稳定可靠 故障自动迁移，服务可用性达99.95%，保障业务连续。数据多副本，数据持久性99.99995%，保障数据不丢失。

欠费 按需购买的接口是按照API调用次数阶梯价格计费，当余额不足，无法对当前产生费用进行扣费，就会导致欠费，欠费后有保留期。您续费后可继续正常使用，请注意在保留期进行的续费，是以原到期时间作为生效时间，您应当支付从进入保留期开始到续费时的服务费用。 您账号欠费后，会导致部分操作受限，建议您尽快续费。具体受限操作如下所示： 按需方式的API接口不可调用 不可重置套餐包方式的API接口，例如“10万次基础套餐包”，在欠费后如果套餐包有剩余，可继续使用，但不可购买，也不可续期 每日或每月可重置套餐包方式的API接口，例如“每月20000次基础套餐包”，在调用超过每日或每月限额导致欠费，会进入保留期，保留期后会被冻结，无法使用该套餐包 无法开通服务

监控指标 表1 NLP支持的监控指标 指标ID 指标名称 指标含义 取值范围 单位 进制 测量对象（维度） 监控周期（原始指标） successful_calls_of_service 调用服务成功次数 统计周期内调用服务成功次数。 ≥ 0 Times/min 不涉及 接口 1分钟 failed_calls_of_service 调用服务失败次数 统计周期内调用服务失败次数。 ≥ 0 Times/min 不涉及 接口 1分钟

云监控 云监控（Cloud Eye）可以监控自然语言处理的相关指标，具体如表1所示。用户可以通过指标及时了解自然语言处理的使用情况。Cloud Eye的更多信息请参见云监控 CES 。 表1 NLP的监控指标 指标名称 指标含义 取值范围 测量对象 调用服务成功次数 该指标用于统计用户请求服务成功次数，以“次每分钟”为单位。 ≥0次每分钟 自然语言处理 调用服务失败次数 该指标用于统计用户请求服务失败次数，以“次每分钟”为单位。 ≥0次每分钟 自然语言处理 每个子服务都有调用成功次数和失败次数两个指标。

首次使用NLP 如果您是首次使用NLP的用户，建议您学习并了解如下信息： 功能介绍 通过功能介绍章节的内容，了解NLP不同功能的具体介绍，主要包括机器翻译（Machine Translation，简称MT）功能。 入门使用 NLP以开放API的方式提供给用户，您可以参考《快速入门》学习并使用NLP服务。 使用方式 如果您是一个开发工程师，熟悉代码编写，想要直接调用NLP的API或SDK使用服务，您可以参考《API参考》或《SDK参考》获取详情。 由浅入深学习 您可以参考成长地图，由浅入深学习使用NLP。

问题现象 VS Code连接开发环境时报错“Connection permission denied (publickey). Please make sure the key file is correctly selected and the file permission is correct. You can view the instance keypair information on ModelArts console.”

解决方案 排查/home/ma-user权限，建议将该目录权限设置为755或750，权限不能过于宽松，以保证用户隔离和安全。修改方法如下。 chmod 755 /home/ma-user chmod 750 /home/ma-user 排查密钥是否是和实例绑定的一致。 停止实例，进入实例详情页。 更新密钥：单击“认证”旁边的编辑按钮，然后单击“立即创建”创建并选择新密钥。 重新使用VS Code连接实例，选择新创建的密钥。

原因分析及处理方法 查看训练作业的“日志”，出现报错“MoxFileNotExistsException(resp, 'file or directory or bucket not found.')”。 原因：Moxing在进行文件复制时，未找到train_data_obs目录。 处理建议：修改train_data_obs目录为正确地址，重新启动训练作业。 另外在Moxing下载OBS对象过程中，不要删除相应OBS目录下的对象，否则Moxing在下载到被删除的对象时会下载失败。 查看训练作业的“日志”，出现报错“CUDA capability sm_80 is not compatible with the current PyTorch installation.The current PyTorch install supports CUDA capabilities sm_37 sm_50 sm_60 sm_70'”。 原因：训练作业使用的镜像CUDA版本只支持sm_37、sm_50、sm_60和sm_70的加速卡，不支持sm_80。 处理建议：使用自定义镜像创建训练作业，并安装高版本的cuda以及对应的PyTorch版本。 查看训练作业的“日志”，出现报错“ERROR:root:label_map.pbtxt cannot be found. It will take a long time to open every annotation files to generate a tmp label_map.pbtxt.”。 如果使用的是订阅的算法，建议先检查数据的标签是否有问题。 如果使用的是物体检测类算法，建议检查数据的label框是否为非矩形。 物体检测类算法仅支持矩形label框。 查看训练作业的“日志”，出现报错“RuntimeError: The server socket has failed to listen on any local network address. The server socket has failed to bind to [::]:29500 (errno: 98 - Address already in use). The server socket has failed to bind to 0.0.0.0:29500 (errno: 98 - Address already in use).”。 原因：训练作业的端口号有冲突。 处理建议：更改代码中的端口号，重启训练作业。 查看训练作业的“日志”，出现报错“WARNING: root: Retry=7, Wait=0.4, Times tamp=1697620658.6282516”。 原因：Moxing版本太低。 处理建议：联系技术支持将Moxing版本升级至2.1.6及以上版本。

处理方法 按照报错提示，需要排查以下几个问题： 检查moxing.file.copy_parallel()的第一个参数中是否有文件，否则会出现报错：No files to copy 文件存在，请执行2。 文件不存在，请忽略该报错继续执行后续操作。 检查复制的OBS的路径是否与开发环境或训练作业在同一个区域。 进入ModelArts管理控制台，查看其所在区域。然后再进入OBS管理控制台，查看您使用的OBS桶所在的区域。查看是否在同一区域。 是，请执行3。 否，请在ModelArts同一区域的OBS中新建桶和文件夹，并将所需的数据上传至此OBS桶中。 检查OBS的路径是否正确，是否写为了“obs://xxx”。可使用如下方式判断OBS路径是否存在。 mox.file.exists('obs://bucket_name/sub_dir_0/sub_dir_1') 路径存在，请执行4。 路径不存在，请更换为一个可用的OBS路径。 检查使用的资源是否为CPU，CPU的“/cache”与代码目录共用10G，可能是空间不足导致，可在代码中使用如下命令查看磁盘大小。 os.system('df -hT') 磁盘空间满足，请执行5。 磁盘空间不足，请您使用GPU资源。 如果是在Notebook使用MoXing复制数据不成功，可以在Terminal界面中使用df -hT命令查看空间大小，排查是否因空间不足导致，可在创建Notebook时使用EVS挂载。

响应示例 实例列表： { "instances": [ { "id": "b331ed66cc3249f78bc20737308c01f4in14", "status": "ACTIVE", "name": "gauss-9e88", "port": 8000, "type": "Enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "eu-de", "region": "aaa", "datastore": { "type": " GaussDB ", "version": "1.3" }, "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", "private_ip": "192.168.16.253" }, { "id": "0a87b8ecbfeb46aba1409cfc0f0d5c34no14", "name": "gauss-9e88_gaussdbv5cn_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.28.81" }, { "id": "2d9fec1ab3834936b074d63acf48b1f2no14", "name": "gauss-9e88_gaussdbv5dn3_2", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "48bb08a2d635435891ac0caa1c0bf2e3no14", "name": "gauss-9e88_gaussdbv5dn1_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "5df830f652204827ada32f8bc28b107eno14", "name": "gauss-9e88_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "8a97a246cee841b38c5b47290d4c9c38no14", "name": "gauss-9e88_gaussdbv5cn_1", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.27.52" }, { "id": "8c1a3f8eecca4d9e9974a868bb6dd942no14", "name": "gauss-9e88_gaussdbv5dn2_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "9bd0c80b8a684cc9bd7d99dd5adffb07no14", "name": "gauss-9e88_gaussdbv5dn3_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "9e2a3cd541e249d4af5aa57c5d3a7f39no14", "name": "gauss-9e88_gaussdbv5dn1_2", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "b046d28989ec4ae5a1a9ab20fe65f248no14", "name": "gauss-9e88_gaussdbv5dn2_2", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "b614cc12fd3742dbb230245f88a7bf00no14", "name": "gauss-9e88_gaussdbv5dn3_0", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "caba8e88c3c84ae58202f1f589490611no14", "name": "gauss-9e88_gaussdbv5dn2_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" } ], "private_ips": [ "192.168.16.253 / 192.168.28.81 / 192.168.27.52" ], "replica_num": 3, "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", "time_zone": "UTC+08:00", "instance_mode":"enterprise" }, { "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": "1.3" }, "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" }, { "id": "21f41baba1e2454f82331b7cb5aeabe5no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "2909771a3b3e4e3998f9388e77d22391no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "2bd9a90a5da242a6b0743a7f597f6106no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "77092f1dadb74d3ea13d28269cdd3590no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "a46bfaa6d5a24355a60fce7432b964cano14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "aa5277736f3844e2a7adeb9de529e2b1no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "b1d798e4ea7344dfa95032984bc6cfd7no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_1", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.29.231" }, { "id": "b9a46540186f4c0781eabaa2a79594cbno14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "d283813030364060ab64371d50294977no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "eb7bce29b2284cd290405eaddc1b1a1eno14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_0", "role": "master", "status": "FAILED", "availability_zone": "az2xahz", "private_ip": "192.168.30.44", "public_ip": "10.154.217.248" } ], "private_ips": [ "192.168.29.231 / 192.168.30.44" ], "public_ips": [ "10.154.217.248" ], "replica_num": 3, "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", "time_zone": "UTC+08:00", "instance_mode":"enterprise" }, { "id": "706c65c3dd7d497ab16f5b3a113690abin14", "status": "ACTIVE", "name": "UTS-gauss-7362", "port": 8000, "type": "Enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "GaussDB", "version": "1.2" }, "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" }, { "id": "ad6f02f31744422fa8ce487e81c9e7afno14", "name": "UTS-gauss-7362_gaussdbv5cn_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.26.70" }, { "id": "b30c56582bf44a548e3bb5b5af6c4773no14", "name": "UTS-gauss-7362_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "f79ea0600cba42b2888bd9bd67e52a79no14", "name": "UTS-gauss-7362_gaussdbv5dn1_0", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz" } ], "private_ips": [ "192.168.26.70" ], "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", "time_zone": "UTC+08:00", "instance_mode":"enterprise" }, { "id": "4ad42d079a3948d88c28d6236211b21ein14", "status": "ACTIVE", "name": "UTS-gauss-4336", "port": 8000, "type": "Enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "GaussDB", "version": "1.2" }, "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" }, { "id": "6ad76d4db26443c2a93b280739a31558no14", "name": "UTS-gauss-4336_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az1xahz" }, { "id": "9fdebf821bdf444a8689b19c0ff588ceno14", "name": "UTS-gauss-4336_gaussdbv5cn_0", "role": "master", "status": "FAILED", "availability_zone": "az1xahz", "private_ip": "192.168.30.93" }, { "id": "dd64bdbc02a542d88823b1582f772d25no14", "name": "UTS-gauss-4336_gaussdbv5cn_1", "role": "master", "status": "ACTIVE", "availability_zone": "az1xahz", "private_ip": "192.168.29.232" }, { "id": "de3c41461045466faf6c2b96eb709540no14", "name": "UTS-gauss-4336_gaussdbv5dn1_0", "role": "slave", "status": "ACTIVE", "availability_zone": "az1xahz" } ], "private_ips": [ "192.168.30.93 / 192.168.29.232" ], "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", "time_zone": "UTC+08:00", "instance_mode":"enterprise" } ], "total_count": 4 } 实例详情： { "instances": [ { "id": "706c65c3dd7d497ab16f5b3a113690abin14", "status": "ACTIVE", "name": "UTS-gauss-7362", "port": 8000, "type": "Enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "aaa", "datastore": { "type": "GaussDB", "version": "1.4" }, "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", "region": "bbb", }, { "id": "ad6f02f31744422fa8ce487e81c9e7afno14", "name": "UTS-gauss-7362_gaussdbv5cn_0", "role": "master", "status": "ACTIVE", "region": "bbb", "private_ip": "192.168.26.70" }, { "id": "b30c56582bf44a548e3bb5b5af6c4773no14", "name": "UTS-gauss-7362_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "region": "bbb", }, { "id": "f79ea0600cba42b2888bd9bd67e52a79no14", "name": "UTS-gauss-7362_gaussdbv5dn1_0", "role": "slave", "status": "ACTIVE", "region": "bbb", } ], "private_ips": [ "192.168.26.70" ], "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.2xlarge.8.in", "flavor_info": { "vcpu": 8, "mem": 64 }, "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", "time_zone": "UTC+08:00", "instance_mode":"enterprise" } ], "total_count": 1 }

请求示例 查询所有实例列表 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances 根据指定条件查询实例列表 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/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

URI GET https://{Endpoint}/v3/{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个字符。 默认取值： 不涉及。 id String 否 参数解释： 实例ID。实例的唯一标识，可根据实例ID查询实例列表。 “*”为系统保留字符，如果id是以“*”起始，表示按照*后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 name String 否 参数解释： 实例名称。可根据实例名称查询实例列表。 “*”为系统保留字符，如果name是以“*”起始，表示按照*后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 约束限制： 不涉及。 取值范围： 实例名称长度在4~64个字符之间，以字母开头，可以包含字母、数字、中划线或下划线，不能包含其他特殊字符。 默认取值： 不涉及。 type String 否 参数解释： 实例类型。可根据实例类型查询实例列表。 约束限制： 不涉及。 取值范围： Enterprise（区分大小写），对应分布式实例（独立部署）。 Centralization_standard（区分大小写），对应集中式版实例。 默认取值： 不涉及。 datastore_type String 否 参数解释： 数据库类型，不区分大小写。可根据数据库类型查询实例列表。 约束限制： 不涉及。 取值范围： GaussDB。 默认取值： 不涉及。 vpc_id String 否 参数解释： 虚拟私有云ID，可按照实例所在的私有云查询实例列表，获取方法如下。 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 约束限制： 不涉及。 取值范围： UUID形式。 默认取值： 不涉及。 subnet_id String 否 参数解释： 子网的网络ID信息。可按照实例所在的子网查询实例列表。 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 约束限制： 不涉及。 取值范围： UUID形式。 默认取值： 不涉及。 offset Integer 否 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit Integer 否 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为100。 tags String 否 参数解释： 根据实例标签键值对进行查询。 {key}表示标签键。 {value}表示标签值。 约束限制： 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含20组。 取值范围： {key}最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。如果value为空，则表示any_value（查询任意value）。 默认取值： 不涉及。

响应示例 实例列表： { "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" : "2.7", "complete_version" : "2.7.2", "target_version" : "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" : "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" : "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.2/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.2/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.2/{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 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 实例ID。 “*”为系统保留字符，如果iID是以“*”起始，表示按照*后面的值模糊匹配，否则，按照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：预付费，即包年/包月。

请求示例 查询所有实例列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances 根据指定条件查询实例列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/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

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

响应示例 实例列表： { "instances": [ { "id": "b331ed66cc3249f78bc20737308c01f4in14", "status": "ACTIVE", "name": "gauss-9e88", "port": 8000, "type": "Enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "eu-de", "datastore": { "type": "GaussDB", "version": "2.7", "complete_version": "2.7.2", "hotfix_versions": "2.7.2.1,2.7.2.2", "target_version": "3.208.0", "hotfix_finished_times": [ "2020-12-23 03:21:41 UTC", "2020-12-23 03:22:41 UTC" ] }, "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", "private_ip": "192.168.16.253", "component_names": "cn_5001:" }, { "id": "0a87b8ecbfeb46aba1409cfc0f0d5c34no14", "name": "gauss-9e88_gaussdbv5cn_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.28.81", "component_names": "cn_5002:" }, { "id": "2d9fec1ab3834936b074d63acf48b1f2no14", "name": "gauss-9e88_gaussdbv5dn3_2", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "48bb08a2d635435891ac0caa1c0bf2e3no14", "name": "gauss-9e88_gaussdbv5dn1_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz" }, { "id": "5df830f652204827ada32f8bc28b107eno14", "name": "gauss-9e88_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6002:60011", "availability_zone": "az2xahz" }, { "id": "8a97a246cee841b38c5b47290d4c9c38no14", "name": "gauss-9e88_gaussdbv5cn_1", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.27.52", "component_names": "cn_5003:" }, { "id": "8c1a3f8eecca4d9e9974a868bb6dd942no14", "name": "gauss-9e88_gaussdbv5dn2_0", "role": "master", "status": "ACTIVE", "component_names": "dn_6004:60042", "availability_zone": "az2xahz" }, { "id": "9bd0c80b8a684cc9bd7d99dd5adffb07no14", "name": "gauss-9e88_gaussdbv5dn3_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6005:60073", "availability_zone": "az2xahz" }, { "id": "9e2a3cd541e249d4af5aa57c5d3a7f39no14", "name": "gauss-9e88_gaussdbv5dn1_2", "role": "slave", "status": "ACTIVE", "component_names": "dn_6006:60011", "availability_zone": "az2xahz" }, { "id": "b046d28989ec4ae5a1a9ab20fe65f248no14", "name": "gauss-9e88_gaussdbv5dn2_2", "role": "slave", "status": "ACTIVE", "component_names": "dn_6007:60042", "availability_zone": "az2xahz" }, { "id": "b614cc12fd3742dbb230245f88a7bf00no14", "name": "gauss-9e88_gaussdbv5dn3_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6008:60073", "availability_zone": "az2xahz" }, { "id": "caba8e88c3c84ae58202f1f589490611no14", "name": "gauss-9e88_gaussdbv5dn2_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6009:60042", "availability_zone": "az2xahz" } ], "private_ips": [ "192.168.16.253 / 192.168.28.81 / 192.168.27.52" ], "replica_num": 3, "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": "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", "time_zone": "UTC+08:00", "instance_mode":"enterprise", "disk_usage": "0.9890", "backup_used_space": "37846" }, { "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": "2.7", "complete_version": "2.7.2", "hotfix_versions": "2.7.2.1,2.7.2.2", "target_version": "3.208.0", "hotfix_finished_times": [ "2020-12-23 03:21:41 UTC", "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" }, { "id": "21f41baba1e2454f82331b7cb5aeabe5no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2", "role": "master", "status": "ACTIVE", "component_names": "dn_6008:60042", "availability_zone": "az2xahz" }, { "id": "2909771a3b3e4e3998f9388e77d22391no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6007:60011", "availability_zone": "az2xahz" }, { "id": "2bd9a90a5da242a6b0743a7f597f6106no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2", "role": "master", "status": "ACTIVE", "component_names": "dn_6006:60042", "availability_zone": "az2xahz" }, { "id": "77092f1dadb74d3ea13d28269cdd3590no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2", "role": "master", "status": "ACTIVE", "component_names": "dn_6005:60072", "availability_zone": "az2xahz" }, { "id": "a46bfaa6d5a24355a60fce7432b964cano14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6004:60072", "availability_zone": "az2xahz" }, { "id": "aa5277736f3844e2a7adeb9de529e2b1no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6003:60042", "availability_zone": "az2xahz" }, { "id": "b1d798e4ea7344dfa95032984bc6cfd7no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_1", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.29.231", "component_names": "cn_5002:" }, { "id": "b9a46540186f4c0781eabaa2a79594cbno14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1", "role": "slave", "status": "ACTIVE", "component_names": "dn_6002:60011", "availability_zone": "az2xahz" }, { "id": "d283813030364060ab64371d50294977no14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0", "role": "slave", "status": "ACTIVE", "component_names": "dn_6001:60042", "availability_zone": "az2xahz" }, { "id": "eb7bce29b2284cd290405eaddc1b1a1eno14", "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_0", "role": "master", "status": "FAILED", "availability_zone": "az2xahz", "private_ip": "192.168.30.44", "component_names": "cn_5001:", "public_ip": "10.154.217.248" } ], "private_ips": [ "192.168.29.231 / 192.168.30.44" ], "public_ips": [ "10.154.217.248" ], "replica_num": 3, "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", "time_zone": "UTC+08:00", "instance_mode":"enterprise", "disk_usage": "1.0000", "backup_used_space": "55824" }, { "id": "7139e0eee4ac4922927f22e22114a548in14", "status": "ACTIVE", "name": "gauss-readonly", "port": 8000, "type": "centralization_standard", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "GaussDB", "version": "3.220", "complete_version": "3.220.0", "complete_kernel_version": "503.1.0.SPC1500", "target_version": "3.208.0", "hotfix_finished_times": [ "2020-12-23 03:21:41 UTC", "2020-12-23 03:22:41 UTC" ] }, "created": "2024-06-04 03:41:19 UTC", "updated": "2024-06-18 02:01:17 UTC", "volume": { "type": "ULTRAHIGH", "size": 40 }, "nodes": [ { "id": "7fd28bb9a142491a8b0f57ef3c662a2ano14", "name": "gauss-readonly_readonly_4", "role": "readreplica", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.167.105", "component_names": "dn_6005:60011", "flavor_ref": "gaussdb.opengauss.ee.c3.xlarge.x864.ha", "flavor_info": { "vcpu": "4", "mem": "16" } }, { "id": "c532d75f8ee44b4e8ef8bf291bf8ed98no14", "name": "gauss-readonly_readonly_3", "role": "readreplica", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.184.6", "component_names": "dn_6004:60011", "flavor_ref": "gaussdb.opengauss.ee.c3.xlarge.x864.ha", "flavor_info": { "vcpu": "4", "mem": "16" } }, { "id": "1624226d9281469fa2fc865299b62999no14", "name": "gauss-readonly_root_1", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.243.237", "component_names": "cm_2:,dn_6002:60011,etcd_7002:" }, { "id": "236b7fb1e28e4caba6cf90e4739ed4d8no14", "name": "gauss-readonly_root_0", "role": "master", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.232.222", "component_names": "cm_1:,dn_6001:60011,etcd_7001:" }, { "id": "bfe9bff81020427a983588f5e00c7832no14", "name": "gauss-readonly_root_2", "role": "slave", "status": "ACTIVE", "availability_zone": "az2xahz", "private_ip": "192.168.135.66", "component_names": "cm_3:,dn_6003:60011,etcd_7003:" } ], "private_ips": [ "192.168.167.105 / 192.168.184.6 / 192.168.243.237 / 192.168.232.222 / 192.168.135.66" ], "replica_num": 3, "db_user_name": "root", "vpc_id": "caacd96c-6643-4106-9fea-8cab88f556c08", "subnet_id": "be02c6ca-b3b9-423e-a472-fd043e19d7b7", "security_group_id": "6b95cf16-0555-4997-96c3-udb19ac24384", "flavor_ref": "gaussdb.opengauss.ee.c3.xlarge.x864.ha", "flavor_info": { "vcpu": 4, "mem": 16 }, "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", "time_zone": "UTC+08:00", "instance_mode": "basic", "backup_used_space": "1595991", "disk_usage": "0.6922" } ], "total_count": 3 }

响应示例 实例列表： { "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：预付费，即包年/包月。

支持的数据库类型 目前，DRS实时灾备支持的数据库类型，如下表所示。 表1 灾备方案 业务数据库 灾备数据库 相关文档 本地自建MySQL数据库 E CS 自建MySQL数据库 其他云上MySQL数据库 RDS for MySQL RDS for MySQL MySQL到MySQL单主灾备 MySQL到MySQL双主灾备 TaurusDB MySQL到TaurusDB单主灾备 DDM DDM DDM到DDM单主灾备 TaurusDB TaurusDB TaurusDB到TaurusDB单主灾备 TaurusDB到TaurusDB双主灾备

实例监控指标 数据复制服务 性能监控指标，如表1所示。 表1 数据复制服务支持的监控指标 指标ID 指标名称 指标含义 取值范围 单位 进制 测量对象 监控周期（原始指标） cpu_util CPU使用率 该指标用于统计测量对象的CPU使用率，以比率为单位。 0-100 % 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 mem_util 内存使用率 该指标用于统计测量对象的内存使用率。 0-100 % 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 network_incoming_bytes_rate 网络输入吞吐量 该指标用于统计平均每秒从测量对象的所有网络适配器输入的流量。 ≥ 0 byte/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 network_outgoing_bytes_rate 网络输出吞吐量 该指标用于统计平均每秒从测量对象的所有网络适配器输出的流量。 ≥ 0 byte/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 disk_read_bytes_rate 磁盘读吞吐量 该指标用于统计每秒从磁盘读取的字节数。 ≥ 0 byte/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 disk_write_bytes_rate 磁盘写吞吐量 该指标用于统计每秒写入磁盘的字节数。 ≥ byte/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 disk_util 磁盘利用率 该指标用于统计测量对象的磁盘利用率。 0-100 % 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 extract_bytes_rate 读源库吞吐量 该指标用于统计每秒从源库读取表数据或者WAL的字节数。 ≥ 0 byte/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 extract_rows_rate 读源库频率 该指标用于统计每秒从源库读取表数据或者WAL的行数。 ≥ 0 row/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 extract_latency 源库WAL抽取延迟 该指标用于统计当前从源库抽取WAL的延迟。 ≥ 0 ms 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_bytes_rate 写目标库吞吐量 该指标用于统计每秒向目标库写入数据的字节数。 ≥ 0 byte/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_rows_rate 写目标库频率 该指标用于统计每秒向目标库写入数据的行数。 ≥ 0 row/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_transactions_rate DML TPS 该指标用于统计每秒向目标库写入的DML事务数。 ≥ 0 transaction/s 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_ddls_number或apply_ddls_rate 说明： apply_ddls_rate在2022年12月之后替换为apply_ddls_number。 DDL TPS 该指标用于统计向目标库写入的DDL事务总数。 ≥ 0 transaction 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_latency 数据同步延迟 该指标用于统计当前数据向目标库回放延迟。 ≥ 0 ms 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_average_execute_time 事务平均执行时间 该指标用于统计当前一个事务在目标库的平均执行时间（一个事务的RT=执行时间+提交时间）。 ≥ 0 ms 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_average_commit_time 事务平均提交时间 该指标用于统计当前一个事务在目标库的平均提交时间（一个事务的RT=执行时间+提交时间）。 ≥ 0 ms 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_current_state 同步状态 该指标用于表示当前内核数据的同步状态（10：异常，1：空闲，2：执行DML，3：执行DDL），不代表任务状态。 10：异常 1：空闲 2：执行DML 3：执行DDL 不涉及 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_thread_workers 同步线程数量 该指标用于表示当前数据同步的工作线程数量。 ≥ 0 Counts 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟 apply_job_status 任务状态 该指标用于表示当前任务所处的状态(0：正常，1：异常，2：暂停)。 0：正常 1：异常 2：暂停 不涉及 不涉及 测量对象：弹性云服务器 监控实例类型：实时迁移、实时同步和实时灾备实例 1分钟

数据库账号权限要求 在使用DRS进行灾备时，连接业务数据库和灾备数据库的账号需要满足以下权限要求，才能启动实时灾备任务。不同类型的灾备任务，需要的账号权限也不同，详细可参考表2进行赋权。DRS会在“预检查”阶段对数据库账号权限进行自动检查，并给出处理建议。 表2 数据库账号权限 类型名称 所需权限 业务数据库连接账号 DDM账户至少需要具备一个权限，比如SELECT权限。 灾备数据库连接账号 DDM账户至少需要具备一个权限，比如SELECT权限。 建议创建单独用于DRS任务连接的数据库账号，避免因为数据库账号密码修改，导致的任务连接失败。 连接业务和灾备数据库的账号密码修改后，请参考修改连接信息章节修改DRS任务的连接信息，避免任务连接失败后自动重试，导致数据库账号被锁定影响使用。

使用建议 灾备初始化阶段，请不要在业务数据库执行DDL操作，否则可能导致任务异常。 灾备初始化阶段，确保灾备数据库无业务写入，保证灾备前后数据一致。 数据库灾备与环境多样性和人为操作均有密切关系，为了确保灾备的平顺，建议您在进行正式的数据库灾备之前进行一次演练，可以帮助您提前发现问题并解决问题。 基于以下原因，建议您在启动任务时选择“稍后启动”功能，选择业务低峰期开始运行灾备任务，避免灾备任务对业务造成性能影响。 在网络无瓶颈的情况下，灾备初始化阶段会对业务数据库增加约50MB/s的查询压力，以及占用2~4个CPU。 灾备无主键表时，为了确保数据一致性，会存在3s以内的单表级锁定。 正在灾备的数据被其他事务长时间锁死，可能导致读数据超时。 DRS并发读取数据库，会占用大约6-10个session连接数，需要考虑该连接数对业务的影响。 灾备初始化阶段读取表数据时，特别是大表的读取，可能会阻塞业务上对大表的独占锁操作。 更多DRS对数据库的影响，可参考DRS对源数据库和目标数据库有什么影响。 数据对比 建议您结合数据对比的“稍后启动”功能，选择业务低峰期进行数据对比，以便得到更为具有参考性的对比结果。由于同步具有轻微的时差，在数据持续操作过程中进行对比任务，可能会出现少量数据不一致对比结果，从而失去参考意义。

TEMPORARY | TEMP参数使用说明 LOCAL/VOLATILE临时表通过每个会话独立的以pg_temp开头的schema来保证只对当前会话可见，因此，不建议用户在日常操作中手动删除以pg_temp，pg_toast_temp开头的schema。 如果建表时不指定TEMPORARY/TEMP关键字，而指定表的schema为当前会话的pg_temp_开头的schema，则此表会被创建为临时表。 LOCAL临时表的所有相关元数据同普通表类似，都存储在系统表内，而VOLATILE临时表会将除schema外的相关表结构元数据直接存储在内存中。所以相对本地临时表而言，VOLATILE临时表有更多约束： 当前CN或DN重启之后，对应实例上的内存数据丢失，相关volatile临时表会失效。 VOLATILE临时表当前不支持ALTER/GRANT等修改表结构相关操作。 VOLATILE临时表和LOCAL临时表共用一种临时schema，所以在同一session中，VOLATILE临时表和LOCAL临时表不能存在同名表。 VOLATILE临时表信息不存储在系统表内，所以无法通过对系统表执行DML语句查询到VOLATILE相关元数据。 VOLATILE临时表仅支持普通的行存、列存表，不支持delta表、时序表、冷热表。 不支持基于VOLATILE临时表创建视图。 不支持创建临时表时指定tablespace(VOLATILE临时表默认tablespace均为pg_volatile)。 创建VOLATILE临时表时不支持指定约束：CHECK约束、UNIQUE约束、主键约束、触发器约束、EXCLUDE约束、PARTIAL CLUSTER约束。 GLOBAL临时表的所有相关元数据同普通表类似，都存储在系统表内。 GLOBAL临时表与LOCAL临时表不同的是，会话退出时元数据不会删除，但会话的数据会删除。不同会话的数据独立，但共享同一份GLOBAL临时表的元数据。 全局临时表的schema与普通表类似，不是以pg_temp开头的schema，但与LOCAL/VOLATILE临时表不同，所以可以与LOCAL/VOLATILE临时表同名。 全局临时表仅支持普通的行存、列存表，不支持delta表、时序表、冷热表。 不支持操作其他逻辑集群的全局临时表。

DISTRIBUTE BY参数使用说明 指定表如何在节点之间分布或者复制。 取值范围： REPLICATION：表的每一行存在所有数据节点（DN）中，即每个数据节点都有完整的表数据。 ROUNDROBIN：表的每一行被轮番地发送给各个DN，因此数据会被均匀地分布在各个DN中。（ROUNDROBIN仅8.1.2及以上版本支持） HASH (column_name ) ：对指定的列进行Hash，通过映射，把数据分布到指定DN。 当指定DISTRIBUTE BY HASH (column_name)参数时，创建主键和唯一索引必须包含“ column_name”列。 当被参照表指定DISTRIBUTE BY HASH (column_name)参数时，参照表的外键必须包含“ column_name”列。 如果TO GROUP指定为复制表节点组（8.1.2及以上版本支持），DISTRIBUTE BY必须指定为REPLICATION。如果没有指定DISTRIBUTE BY，创建的表会自动设置为复制表。 单节点集群（单机部署）由于只有单DN，因此分布规则会被忽略，也不支持针对分布规则的修改。 默认值：由GUC参数default_distribution_mode控制。 当default_distribution_mode=roundrobin时，DISTRIBUTE BY的默认值按如下规则选取： 若建表时包含主键/唯一约束，则选取HASH分布，分布列为主键/唯一约束对应的列。 若建表时不包含主键/唯一约束，则选取ROUNDROBIN分布。 当default_distribution_mode=hash时，DISTRIBUTE BY的默认值按如下规则选取： 若建表时包含主键/唯一约束，则选取HASH分布，分布列为主键/唯一约束对应的列。 若建表时不包含主键/唯一约束，但存在数据类型支持作分布列的列，则选取HASH分布，分布列为第一个数据类型支持作分布列的列。 若建表时不包含主键/唯一约束，也不存在数据类型支持作分布列的列，选取ROUNDROBIN分布。 以下数据类型支持作为分布列： INTEGER TYPES：TINYINT，SMALLINT，INT，BIGINT，NUMERIC/DECIMAL CHARACTER TYPES：CHAR，BPCHAR，VARCHAR，VARCHAR2，NVARCHAR2，TEXT DATE/TIME TYPES：DATE，TIME，TIMETZ，TIMESTAMP，TIMESTAMPTZ，INTERVAL，SMALLDATETIME 在建表时，选择分布列和分区键可对SQL查询性能产生重大影响。因此，需要根据一定策略选择合适的分布列和分区键。 选择合适的分布列 对于采用散列（Hash）方式的数据分布表，一个合适的分布列应将一个表内的数据，均匀分散存储在多个DN内，避免出现数据倾斜现象（即多个DN内数据分布不均）。请按照如下原则判定合适的分布列： 判断是否已发生数据倾斜现象。 连接数据库，执行如下语句，查看各DN内元组数目。命令中的斜体部分tablename，请填入待分析的表名。 SELECT a.count,b.node_name FROM (SELECT count(*) AS count,xc_node_id FROM tablename GROUP BY xc_node_id) a, pgxc_node b WHERE a.xc_node_id=b.node_id ORDER BY a.count DESC; 如果各DN内元组数目相差较大（如相差数倍、数十倍），则表明已发生数据倾斜现象，请按照下面原则调整分布列。 重新选择分布列，可通过ALTER TABLE语句调整分布列，选择原则如下： 分布列的列值应比较离散，以便数据能够均匀分布到各个DN。例如，考虑选择表的主键为分布列，如在人员信息表中选择身份证号码为分布列。 在满足上面原则的情况下，考虑选择查询中的连接条件为分布列，以便Join任务能够下推到DN中执行，且减少DN之间的通信数据量。 如果找不到一个合适的分布列，使数据能够均匀分布到各个DN，那么可以考虑使用REPLICATION或ROUNDROBIN的数据分布方式。由于REPLICATION的数据分布方式会在每个DN中存放完整的数据，因此在表较大且找不到合适的分布列时，推荐使用ROUNDROBIN的数据分布方式。（ROUNDROBIN分布方式8.1.2及以上版本支持） 选择合适的分区键 数据分区功能，可根据表的一列或者多列，将要插入表的记录分为若干个范围（这些范围在不同的分区里没有重叠）。然后为每个范围创建一个分区，用来存储相应的数据。 调整分区键，使每次查询结果尽可能存储在相同或者最少的分区内（称为“分区剪枝”），通过获取连续I/O大幅度提升查询性能。 实际业务中，经常将时间作为查询对象的过滤条件，因此，可考虑选择时间列为分区键，键值范围可根据总数据量、一次查询数据量调整。