华为云用户手册

URI URI格式 POST https://{Endpoint}/v3/{project_id}/configurations/{config_id}/reset URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/reset 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 config_id String 是 参数模板ID。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 shards 是 Array 节点列表，支持对单个或者多个DN分片做主备切换。节点信息为将要升主的备DN分片对应的节点id(node_id)和组件id(component_id)。具体请参考表3。 表3 shards参数说明 名称 是否必选 参数类型 说明 node_id 是 String 将要升主的备DN的节点Id。 component_id 是 String 将要升主的备DN的组件Id。最大长度7个字符，不能为null或者空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为_）四类字符中的三类字符。组件id通过查询实例的组件列表获取。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switch-shard URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/switch-shard 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

请求示例 切换多个DN分片的主备。 {"shards":[ { "node_id":"0bc478b4d132494a8f7b804da521b4b2no14", "component_id":"dn_6001" }, { "node_id":"53dee94c50574d36a0060db0a6b644f6no14", "component_id":"dn_6004" } ]}

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略信息。 详情参见表3。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 备份文件可以保存的天数。 取值范围：1-732天。 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1，mm和MM取值必须相同，且取值必须为00。 取值示例： 21:00-22:00 period 是 String 全量备份周期配置。自动全量备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。 differential_period 是 String 差异备份间隔时间配置。每次自动差异备份的间隔时间。 取值范围：15、30、60、180、360、720、1440。单位：分钟。 取值示例：30 rate_limit 否 Integer 备份限速,默认值为0MB/s，表示不限速。控制备份是备份数据上传OBS的速度，限速用于限制上传备份对上传带宽的影响 取值范围：0 MB/s ~ 1024 MB/s 最小值：0 MB/s prefetch_block 否 Integer 控制差量备份时读取磁盘上表文件差量修改页面的预取页面个数。当差量修改页面非常集中时（如数据导入场景），可以适当调大该值；当差量修改页面非常分散时（如随机更新），可以适当调小该值。默认为64,单位个数 取值范围：1 ~ 8192 最小值：1 最大值：8192 file_split_size 否 Integer 全量、差量备份时产生的备份文件会根据该参数的值进行拆分，可设置范围为0~1024GB，设置需为4的倍数，默认4GB，0GB表示不限制大小。 取值范围：0 ~ 1024 最小值：0 最大值：1024 filesplit_size 否 Integer 全量、差量备份时产生的备份文件会根据该参数的值进行拆分，废弃，无需填写。 enable_standby_backup 否 Boolean 是否启用备机备份。(不支持单节点实例及3.100.0以下的实例)

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

请求示例 设置GaussDB实例备份策略，备份文件保存时长7天，备份时间段为"19:00-20:00"。 {"backup_policy": {"keep_days": 7,"start_time": "19:00-20:00","period": "1,2,3,4,5","differential_period": "30", "rate_limit": 75 , "prefetch_block": 64 , "file_split_size": 4 , "enable_standby_backup" : "false" }}

URI URI格式 POST https://{Endpoint}/v3.1/{project_id}/instances URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。

响应消息 正常响应要素说明 表8 要素说明 名称 参数类型 说明 instance Object 实例信息。 详情请参见表9。 job_id String 实例创建的任务id。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 表9 instance说明 名称 参数类型 说明 id String 实例id。 name String 实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围：4~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 status String 实例状态。如BUILD，表示创建中。 仅创建按需实例时会返回该参数。 datastore Object 数据库信息。 详情请参见表10。 ha Object 数据库部署形态。 详情请参见表11。 replica_num Integer 实例副本数。 port String 数据库端口信息，与请求参数相同。 backup_strategy Object 自动备份策略。 详情请参见表12。 enterprise_project_id String 项目标签。 flavor_ref String 规格码，取值范围：非空。参考数据库实例规格中GaussDB的“规格编码”列内容获取。 volume Object volume信息。 详情请参见表13。 region String 区域ID。 availability_zone String 可用区ID。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 实例所属的安全组。 charge_info Object 付费方式信息。 详情请参见表14。 表10 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎，返回值如下： GaussDB version String 数据库版本。 表11 ha字段数据结构说明 名称 参数类型 说明 mode String GaussDB分布式模式支持取值：enterprise(企业版) ，主备版取值:centralization_standard，不区分大小写。 replication_mode String 备机同步参数。 取值： GaussDB为“sync”。 说明： “sync”为同步模式。 consistency String GaussDB的预留参数：指定事务一致性类型，取值范围：strong（强一致性） | eventual(最终一致性)。 consistency_protocol String 指定副本一致性协议类型，取值范围：quorum | paxos。不填时，默认为quorum。 表12 backup_strategy字段数据结构说明 名称 参数类型 说明 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为整点。 取值示例： 08:00-09:00 23:00-00:00 如果请求体中不填写“backup_strategy”字段，则响应体中 “start_time”默认返回“02:00-03:00”。 keep_days Integer 指定已生成备份文件的可保存天数。 取值范围：1～732。如果请求体中不填写“backup_strategy”字段，则响应体中 “keep_days”默认填写为7天。 表13 volume字段数据结构说明 名称 参数类型 说明 type String 磁盘类型。 取值如下，区分大小写： ULTRAHIGH，表示SSD盘。 ESSD,表示极速云盘。 size Integer 磁盘大小。 GaussDB分布式实例创建时需指定大小：要求必须为（分片数 * 40GB）的倍数，取值范围：（分片数*40GB）~（分片数*16TB）。 表14 charge_Info字段数据结构说明 名称 参数类型 说明 charge_mode String 计费模式。 postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 period_type String 订购周期类型。month：包月。year：包年。说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。当“period_type”为“year”时，取值为1~3。 is_auto_renew Boolean 创建包周期实例时可指定,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。 true,表示自动续订。 false,表示不自动续订,默认为该方式。 is_auto_pay Boolean 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。 正常响应样例 GaussDB企业版实例：{ "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-independent", "status": "BUILD", "datastore": { "type": "GaussDB", "version": "1.4" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong", "consistency_protocol":"quorum" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "replica_num": 3, "region": "aaa", "region": "aaa", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "availability_zone": "bbb,ccc", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "charge_info": { "charge_mode": "postPaid" } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"} 异常响应 请参见异常请求结果。

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。

URI 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} URI样例 查询所有实例列表 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances 根据指定条件查询实例列表 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 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 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 String 否 根据实例标签键值对进行查询。 {key}表示标签键，最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}表示标签值，可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。如果value为空，则表示any_value（查询任意value）。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含20组。

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/password 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

URI URI格式 POST https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/action URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 expand_cluster 是 Object 请参见表2 表2 expand_cluster字段数据结构说明 名称 是否必选 参数类型 说明 shard 是 Object 请参见表3 isAutoPay 否 int 包周期用户需要填写该字段。 0：表示不自动支付扩容订单费用 1：表示自动支付扩容订单费用 不填写则保持默认。默认值：0 表3 count字段数据结构说明 名称 是否必选 参数类型 说明 count 是 Integer 新增的DN分片扩容数大小

URI URI格式 PUT https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/name URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

URI URI格式 PUT https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/configurations URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restart URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/restart 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。

URI URI格式 PUT https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/backups/policy URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略信息。 详情参见表3。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 备份文件可以保存的天数。 取值范围：1-732天。 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1，mm和MM取值必须相同，且取值必须为00。 取值示例： 21:00-22:00 period 是 String 全量备份周期配置。自动全量备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。 differential_period 是 String 差异备份间隔时间配置。每次自动差异备份的间隔时间。 取值范围：15、30、60、180、360、720、1440。单位：分钟。 取值示例：30

URI URI格式 GET https://{Endpoint}/v3/{project_id}/datastore/versions URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/datastore/versions 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/configurations 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。

响应消息示例 正常响应要素说明 { "created": "2022-04-11 10:46:59", "updated": "2022-04-11 10:46:59", "datastore_version": "2.0", "datastore_name": "GaussDB(for openGauss)", "configuration_parameters": [ { "name": "audit_system_object", "value": "12295", "type": "integer", "description": "该参数决定是否对数据库对象的CREATE、DROP、ALTER操作进行审计。", "restart_required": false, "value_range": "0-2097151" } ]}

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 datastore_version String 引擎版本。 datastore_name String 引擎名称。 created String 创建时间，格式为"yyyy-MM-dd HH:mm:ss"。 updated String 更新时间，格式为"yyyy-MM-ddHH:mm:ss"。 configuration_parameters Array of objects 参数对象，用户基于默认参数模板自定义的参数配置，具体请参考表3。 表3 configuration_parameters字段数据结构说明 参数 参数类型 描述 name String 参数名称。 value String 参数值。 restart_required Boolean 修改该参数是否需要重启实例。 value_range String 参数取值范围。 type String 参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。 枚举值： string integer boolean list float description String 参数描述。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 expand_cluster 否 Object CN横向扩容/DN分片扩容时必填。 详情请参见表3。 enlarge_volume 否 Object 扩容实例磁盘时必填。 所需扩容到的磁盘容量大小。 详情请参见表6。 is_auto_pay 否 String 包周期实例时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 枚举值： true false 表3 expand_cluster字段数据结构说明 名称 是否必选 参数类型 说明 coordinators 否 Array of Coordinators objects CN扩容时必选。需要填写表4参数。 shard 否 Shard object DN分片扩容时必选。需要填写表5参数。 表4 coordinators参数填写说明 名称 是否必选 参数类型 说明 az_code 是 string 新增CN横向扩容每个节点的可用区。如果需要扩容多个CN，请分别填写待扩容CN所在的可用区。 不同区域的可用区请参考地区和终端节点。 说明： 扩容后，实例中CN节点的数量必须小于或等于两倍的分片数量。 表5 shard参数填写说明 名称 是否必选 参数类型 说明 count 是 integer 新增DN分片的数量。 表6 enlarge_volume字段数据结构说明 名称 是否必选 参数类型 说明 size 是 Integer GaussDB磁盘大小要求（分片数*40GB）的倍数；取值范围：（分片数*40GB）~（分片数*16TB）。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/action 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 datastore_version String 引擎版本。 datastore_name String 引擎名称。 created String 创建时间，格式为"yyyy-MM-dd HH:mm:ss"。 updated String 更新时间，格式为"yyyy-MM-ddHH:mm:ss"。 configuration_parameters Array of objects 参数对象，用户基于默认参数模板自定义的参数配置，具体请参考表3。 表3 configuration_parameters字段数据结构说明 参数 参数类型 描述 name String 参数名称。 value String 参数值。 restart_required Boolean 修改该参数是否需要重启实例。 value_range String 参数取值范围。 type String 参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。 枚举值： string integer boolean list float description String 参数描述。

URI URI格式 GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/configurations URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/configurations 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。

响应消息示例 正常响应要素说明 { "created": "2022-04-11 10:46:59", "updated": "2022-04-11 10:46:59", "datastore_version": "2.0", "datastore_name": "GaussDB", "configuration_parameters": [ { "name": "audit_system_object", "value": "12295", "type": "integer", "description": "Determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include databases, users, schemas, and tables. You can change the parameter value to audit only the operations on required database objects. During a forcible primary/standby failover, set audit_system_object to the maximum value and audit all DDL objects. If the parameter value is incorrectly changed, DDL audit logs will be lost. Contact customer service personnel to change it.", "restart_required": false, "value_range": "0-2097151" } ]}