华为云用户手册

如何在含有多张人脸的图片中实现多 人脸识别 当前 人脸识别服务 中，如果传入的图片中包含多个人脸，则只能选取最大的一个人脸进行识别。但是我们可以使用如下方法，实现一张图片中多张人脸的识别（比对/搜索）： 调用人脸检测接口，可以得到多张人脸在图片中的像素位置。 通过获取到的人脸位置信息，从原图中将人脸图片截出，可以参考多人脸识别Demo。 再调用人脸识别接口，实现多人脸的比对/搜索。 父主题： 产品咨询类

如何获取图片的base64编码 本节以Python为例，介绍如何将本地图片，转换为base64编码。您也可以使用在线的图片转base64工具。 使用时，需要将代码的d:\demo.jpg替换为实际图片路径。 import base64with open("d:\demo.jpg", "rb") as image_file: encoded_string = base64.b64encode(image_file.read()).decode()print(encoded_string) 父主题： API使用类

有哪些途径可以使用人脸识别的API 共有三种方式可以基于已构建好的请求消息发起请求。 cURL cURL是一个命令行工具，用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端，可以发送HTTP请求给服务端，并接收响应消息。cURL适用于接口调试。 编码 通过编码调用接口，组装请求消息，并发送处理请求消息。 REST客户端 Mozilla、Google都为REST提供了图形化的浏览器插件，发送处理请求消息。Postman建议使用7.24.0版本。 父主题： API使用类

如何获取正确的终端节点（Endpoint） 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同。 人脸识别服务的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。 表1 人脸识别服务终端节点 区域名称 区域 终端节点（Endpoint） 协议类型 部署的服务 华北-北京四 cn-north-4 face.cn-north-4.myhuaweicloud.com HTTPS 人脸识别API 华东-上海一 cn-east-3 face.cn-east-3.myhuaweicloud.com HTTPS 人脸识别API 华南-广州 cn-south-1 face.cn-south-1.myhuaweicloud.com HTTPS 人脸识别API 父主题： API使用类

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/histories URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/histories 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 config_id 是 String 参数模板ID。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 histories Array of objects 参数模板信息，具体参数请参考表3。 total_count Integer 总记录数。 表3 histories字段数据结构说明 参数 参数类型 描述 parameter_name String 参数名称。 old_value String 修改前参数值。 new_value String 修改后参数值。 update_result String 修改状态 (SUC CES S | FAILED)。 updated_at String 修改时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 正常响应样例 { "histories" : [ { "parameter_name" : "audit_system_object", "old_value" : "12295", "new_value" : "12298", "update_result" : "SUCCESS", "updated_at" : "2022-08-09T03:06:52+0800" } ], "total_count" : 1 }

URI URI格式 GET https://{Endpoint}/v3.1/{project_id}/configurations?offset={offset}&limit={limit} URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/configurations?offset=1&limit=3 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 configurations Array of objects 参数模板信息，具体参数请参考表3。 count Integer 总记录数。 表3 configurations字段数据结构说明 参数 参数类型 描述 id String 参数组ID。 name String 参数组名称。 description String 参数组描述。 datastore_version String 引擎版本。 datastore_name String 引擎名称。 ha_mode String 实例类型。 created String 创建时间，格式为"yyyy-MM-dd HH:mm:ss"。 updated String 更新时间，格式为"yyyy-MM-dd HH:mm:ss"。 user_defined Boolean 是否是用户自定义参数模板： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。 正常响应样例 { "count": 3, "configurations": [ { "id": "b000d7c91f1749da87315700793a11d4pr14", "name": "Default- GaussDB -EE-1.0-Dist-Combined (4 replicas)", "description": "Default parameter template for GaussDB-Enterprise Edition-1.0-Distributed-combined (4 replicas)", "created": "2022-03-23 07:20:11", "updated": "2022-03-23 07:20:11", "datastore_version": "1.0", "datastore_name": "GaussDB", "ha_mode": "combined", "user_defined": false }, { "id": "8d99f260ea1b4493a1b349e7abce5c09pr14", "name": "Default-Finance-Edition-GaussDB-1.3-Combined", "description": "Default parameter template for Finance Edition GaussDB 1.3-Combined", "created": "2022-03-23 07:20:11", "updated": "2022-03-23 07:20:11", "datastore_version": "1.1", "datastore_name": "GaussDB", "ha_mode": "combined", "user_defined": false }, { "id": "0f44b65521a8414d8b8811df810d94ccpr14", "name": "Default-Finance-Disaster-GaussDB-1.3-Combined", "description": "Default parameter template for Finance Disaster GaussDB 1.3-Combined", "created": "2022-03-23 07:20:11", "updated": "2022-03-23 07:20:11", "datastore_version": "1.2", "datastore_name": "GaussDB", "ha_mode": "combined", "user_defined": false }]}

URI URI格式 GET https://{Endpoint}/v3.1/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time} URI样例 查询所有备份列表 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups 根据指定条件查询实例列表 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=88be33e4c5a64ceba42b42da89310111in14&backup_id=88be1234c5a64ceba42b42da89310111br14&backup_type=auto&begin_time=2022-05-09T16:15:50+0800&end_time=2022-05-09T16:20:45+0800&limit=1&offset=1 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 否 String 实例ID。 backup_id 否 String 备份ID，严格匹配UUID规则。 backup_type 否 String 备份类型，取值范围： auto：实例级自动全量备份 manual：实例级手动全量备份 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 最小值：0 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 最小值：1 最大值：100 begin_time 否 String 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。与end_time必须同时使用。 end_time 否 String 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。与begin_time必须同时使用。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 backups Array of objects 备份信息。 详情请参见表3。 total_count Long 备份文件的总数。 表3 backups字段数据结构说明 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 description String 备份文件描述信息。 begin_time String 备份开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 status String 备份状态 枚举值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 size Double 备份大小(单位：MB)。 type String 备份类型 取值： auto：实例级自动全量备份。 manual：实例级手动全量备份。 datastore Object 数据库信息。 详情请参见表4 instance_id String 实例ID。 表4 datastore字段数据结构说明 参数 参数类型 描述 type String 数据库引擎，不区分大小写，取值如下： GaussDB。 version String 数据库版本。不填时，默认为当前最新版本。 数据库支持版本可根据查询数据库引擎的版本接口获取。 正常响应样例 { "backups": [ { "id": "a696cd25e4fc453aa503650225cece8bbr14", "name": "GaussDB-hly-ha-20220509080110906", "description": null, "status": "FAILED", "size": 0.0, "type": "auto", "datastore": { "type": "GaussDB", "version": "1.4" }, "begin_time": "2022-05-09T16:01:10+0800", "end_time": "2022-05-09T16:04:31+0800", "instance_id": "164abc6d35114095bb849d007b19db3bin14" }, { "id": "5651c62a7f12461c98020dd3abfe24ccbr14", "name": "GaussDB-hly-master-20220509022658257", "description": null, "status": "FAILED", "size": 0.0, "type": "auto", "datastore": { "type": "GaussDB", "version": "1.4" }, "begin_time": "2022-05-09T10:26:58+0800", "end_time": "2022-05-09T10:30:17+0800", "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14" }], "total_count": 167} 异常响应 请参见异常请求结果。

状态码 状态码如表1所示： 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 200 OK 请求成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

请求示例 创建一个 GaussDB数据库 ，库名为gaussdb_test。 { "name" : "gaussdb_test", "owner" : "test", "template" : "template0", "character_set" : "UTF8", "lc_collate" : "en_US.UTF-8", "lc_ctype" : "en_US.UTF-8" }

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

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 histories Array of objects 应用记录列表，具体参数请参考表3。 total_count Integer 总记录数。 表3 histories字段数据结构说明 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 apply_result String 应用状态 (SUCCESS | FAILED)。 applied_at String 应用时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 error_code String 失败原因错误码，如DBS.280005。 正常响应样例 { "total_count": 2, "histories": [ { "instance_id": "1995a67680474481b3e42ac1474e32e0in14", "instance_name": "gauss-a283", "apply_result" : "SUCCESS", "applied_at" : "2022-08-09T03:06:52+0800", "error_code" : null }, { "instance_id": "8303819fd8744ef69f34595e9710a33din14", "instance_name": "gauss-2423-lt-master", "apply_result" : "FAILED", "applied_at" : "2022-08-09T03:06:52+0800", "error_code" : "DBS.280005" }]}

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 datastores Array of objects 数据库引擎列表。 详情请参见表3。 表3 dataStores字段数据结构说明 参数 参数类型 描述 supported_versions Array of strings 部署形态支持的引擎版本列表。 instance_mode String 部署形态。 枚举值： ha：主备版 independent：独立部署 正常响应样例 {"datastores": [{"instance_mode": "ha","supported_versions": ["2.0","2.3","2.6","2.9"]}]}

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/applied-histories 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 config_id 是 String 参数模板ID。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

请求示例 在gaussdb_test数据库中创建多个SCHEMA。 { "db_name" : "gaussdb_test", "schemas" : [ { "name" : "rds", "owner" : "teste123" }, { "name" : "rds001", "owner" : "teste123" } ] }

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

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 数据库名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，且不能和模板库重名。 模板库包括postgres， template0 ，template1。 schemas 是 Array of objects 每个元素都是与数据库相关联的schema信息。单次请求最多支持20个元素。详情请参见表3 表3 schemas字段数据结构说明 名称 是否必选 参数类型 说明 name 是 String schema名称。 schema名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，且不能和模板库和已存在的schema重名。模板库包括postgres， template0 ，template1。 已存在的schema包括public，information_schema。 owner 是 String 数据库属主用户。 数据库属主名称在1到63个字符之间，不能以“pg”和数字开头，不能和系统用户名称相同。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”。

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

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库用户名称。 数据库用户名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，不能和系统用户名称相同。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”, “root”。 password 是 String 数据库用户密码。 取值范围：非空，密码长度在8到32个字符之间，至少包含大写字母、小写字母、数字、特殊字符~!@#%^*-_=+?,三种字符的组合，不能和数据库帐号“name”或“name”的逆序相同。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 is_login_only 否 boolean 数据库账户是否只支持登录。 取值范围： false或者不填：创建的数据库账号包含登录数据库、创建数据库、创建用户权限。 true：创建的数据库用户只包含登录数据库权限。

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

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/name-validation?name={name} URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/configurations/name-validation?name=paramTemplate-a9f3 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 name 是 String 参数模板名称。 取值范围：长度1到64位之间，区分大小写字母，可包含字母、数字、中划线、下划线或句点，不能包含其他特殊字符。

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

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 id String 参数模板ID。 name String 参数模板名称。 description String 参数模板描述。 engine_version String 引擎版本。 instance_mode String 部署形态。 枚举值： ha：主备版 independent：独立部署 created_at String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated_at String 修改时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 configuration_parameters Array of objects 参数详情，具体请参考 表configuration_parameters字段数据结构说明。 表3 configuration_parameters字段数据结构说明 参数 参数类型 描述 name String 特定参数名称。 value String 特定参数值。 need_restart Boolean 参数是否需要重启。 - 取值为"true"，需要重启。 - 取值为"false"，不需要重启。 readonly Boolean 该参数是否只读。 true：只读 false：可编辑 value_range String 参数取值范围。 data_type String 参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。 description String 参数描述。 正常响应样例 { "id": "3ca44134a16d4bbab8eb701e025b19f7pr14", "name": "GaussDB_2b87a799-515", "description": "ParamGroup for instance.", "engine_version": "2.3", "instance_mode": "ha", "created_at": "2022-08-05T08:15:07+0800", "updated_at": "2022-08-09T03:06:52+0800", "configuration_parameters": [ { "name": "audit_system_object", "value": "12294", "need_restart": false, "readonly": false, "value_range": "1-65536", "data_type": "integer", "description": "该参数决定是否对GaussDB Kernel数据库对象的CREATE、DROP、ALTER操作进行审计。GaussDB Kernel数据库对象包括DATABASE、USER、schema、TABLE等。通过修改该配置参数的值，可以只审计需要的数据库对象的操作，在主备强制选主场景建议audit_system_object取最大值，所有DDL对象全部审计，不当修改该参数会导致丢失DDL审计日志，请在客服人员指导下进行修改。" } ]}

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 instances Array of objects 参数模板信息，具体参数请参考表3。 total_count Integer 总记录数。 表3 instances字段数据结构说明 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 正常响应样例 { "total_count": 2, "instances": [ { "instance_id": "1995a67680474481b3e42ac1474e32e0in14", "instance_name": "gauss-a283" }, { "instance_id": "8303819fd8744ef69f34595e9710a33din14", "instance_name": "gauss-2423-lt-master" }]}

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/applicable-instances 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 config_id 是 String 参数模板ID。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

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

响应消息 正常响应要素说明 表3 参数说明 参数 参数类型 描述 differences Array of objects 参数组之间的差异集合。 详情请参见表 differences字段数据结构说明 表4 differences字段数据结构说明 参数 参数类型 描述 name String 参数名称。 source_value String 比较参数组的参数值。 target_value String 目标参数组的参数值。 正常响应样例 { "differences" : [ { "name" : "audit_system_object", "source_value" : "12289", "target_value" : "12295" } ]} 异常响应 请参见异常请求结果。