华为云用户手册

云数据库 GAUSSDB-查询数据库用户列表:响应参数

响应参数表2 参数说明参数参数类型描述 users Array of objects 参数解释：列表中每个元素表示一个数据库用户，详情参见表3。 total_count Integer 参数解释：总记录数。取值范围： [0, 2^31-1]，取决于实际查询大小。表3 users字段数据结构说明参数参数类型描述 name String 参数解释：用户名称。取值范围：不涉及。 attribute Object 参数解释：用户的权限属性，详情参见表 attribute字段数据结构说明。 memberof String 参数解释：用户的默认权限。取值范围：不涉及。 lock_status Boolean 参数解释：用户是否被锁。取值范围：取值为“true”或“false”。表4 attribute字段数据结构说明参数参数类型描述 rolsuper Boolean 参数解释：用户是否具有管理员权限。取值范围：取值为“true”或“false”。 rolinherit Boolean 参数解释：用户是否自动继承其所属角色的权限。取值范围：取值为“true”或“false”。 rolcreaterole Boolean 参数解释：用户是否支持创建其他子用户。取值范围：取值为“true”或“false”。 rolcreatedb Boolean 参数解释：用户是否可以创建数据库。取值范围：取值为“true”或“false”。 rolcanlogin Boolean 参数解释：用户是否可以登录数据库。取值范围：取值为“true”或“false”。 rolconnlimit Integer 参数解释：用户连接实例的最大并发连接数。-1表示没有限制。取值范围：不涉及。 rolreplication Boolean 参数解释：用户是否属于复制角色。取值范围：取值为“true”或“false”。 rolbypassrls Boolean 参数解释：用户是否绕过每个行级安全策略。取值范围：取值为“true”或“false”。 rolpassworddeadline String 参数解释：用户密码过期时间。取值范围：不涉及。

云数据库 GAUSSDB
云数据库 GAUSSDB-查询数据库用户列表:URI

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-users 表1 参数说明参数是否必选参数类型描述 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 instance_id 是 String 参数解释：实例ID。标识实例的唯一标识。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 offset 否 Integer 参数解释：分页符。从第一条数据偏移offset页数据后开始查询例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。约束限制：不涉及。取值范围： [0, 2^31-1] 默认取值：默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释：每页显示的条目数量。约束限制：不涉及。取值范围： [1, 100] 默认取值：默认为10。

云数据库 GAUSSDB
云数据库 GAUSSDB-查询数据库列表:响应示例

响应示例查询数据库列表成功。 { "databases": [ { "name": "gaussdb_test", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": " GaussDB " }, { "name": "gaussdb_test1", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" }, { "name": "gaussdb_test2", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" } ], "total_count": 3 }

云数据库 GAUSSDB
云数据库 GAUSSDB-查询数据库列表:URI

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases 表1 参数说明参数是否必选参数类型描述 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 instance_id 是 String 参数解释：实例ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 offset 否 Integer 参数解释：分页符。从第一条数据偏移offset页数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。约束限制：必须为数字，不能为负数。取值范围： [0, 2^31-1] 默认取值：默认为0（偏移0页数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释：每页显示的条目数量。约束限制：不涉及。取值范围： [1, 100] 默认取值：默认为10。

云数据库 GAUSSDB
云数据库 GAUSSDB-查询数据库列表:响应参数

响应参数表2 参数说明参数参数类型描述 databases Array of objects 参数解释：列表中每个元素表示一个数据库。详情参见表3。 total_count Integer 参数解释：总记录数。取值范围： [0, 2^31 - 1]，实际总数取决于实例个数。表3 databases字段数据结构说明参数参数类型描述 name String 参数解释：数据库名称。取值范围：不涉及。 owner String 参数解释：数据库所属用户。取值范围：不涉及。 character_set String 参数解释：数据库使用的字符集，例如UTF8。取值范围：不涉及。 collate_set String 参数解释：数据库排序集，例如en_US.UTF-8等。取值范围：不涉及。 size String 参数解释：数据库大小，单位MB。取值范围：不涉及。 datctype String 参数解释：数据库使用的字符分类，例如en_US.UTF-8等。取值范围：不涉及。 compatibility_type String 参数解释：数据库兼容的类型，如GaussDB，M。取值范围：不涉及。

云数据库 GAUSSDB
云数据库 GAUSSDB-重置数据库账号密码:请求示例

请求示例重置数据库root账号的密码。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-user/password { "name" : "root", "password" : "*******" }

云数据库 GAUSSDB
云数据库 GAUSSDB-重置数据库账号密码:URI

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

云数据库 GAUSSDB
云数据库 GAUSSDB-重置数据库账号密码:请求参数

请求参数表2 参数说明名称是否必选参数类型说明 name 是 String 数据库账号名称，不能为系统账号用户。系统用户包括“rdsAdmin”,“rdsMetric”, “rdsBackup”, “rdsRepl”。 password 是 String 数据库账号密码。取值范围：非空，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊符号~!@#%^*-_=+?,组成，长度8~32个字符，不能和数据库账号“name”或“name”的逆序相同，也不能与数据库旧密码相同。建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

云数据库 GAUSSDB
云数据库 GAUSSDB-授权数据库账号:请求示例

请求示例设置gaussdb_test数据库多个账号的权限。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-privilege { "db_name" : "gaussdb_test", "users" : [ { "name" : "rds", "readonly" : false, "schema_name" : "teste123" }, { "name" : "rds001", "readonly" : true, "schema_name" : "teste134" }, { "name" : "rds002", "readonly" : false, "schema_name" : "teste135" } ] }

云数据库 GAUSSDB
云数据库 GAUSSDB-授权数据库账号:请求消息

请求消息表2 参数说明名称是否必选参数类型说明 db_name 是 String 数据库名称。不能使用模板库，且是已存在的数据库名称。模板库包括postgres， template0 ，template1。 users 是 Array of objects 每个元素都是与数据库相关联的账号。单次请求最多支持50个元素。详情请参见表3。表3 users字段数据结构说明名称是否必选参数类型说明 name 是 String 数据库账号名称。不能使用系统用户，且账号名称必须存在。系统用户包括“rdsAdmin”,“rdsMetric”, “rdsBackup”, “rdsRepl”, “root”。 readonly 是 Boolean 数据库账号权限。 true：只读。 false：可读可写。 schema_name 是 String schema名称。不能使用public，information_schema，且schema名称必须存在。

云数据库 GAUSSDB
云数据库 GAUSSDB-授权数据库账号:URI

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

云数据库 GAUSSDB
云数据库 GAUSSDB-创建数据库SCHEMA:请求示例

请求示例在gaussdb_test数据库中创建多个SCHEMA。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/schema { "db_name" : "gaussdb_test", "schemas" : [ { "name" : "rds", "owner" : "teste123" }, { "name" : "rds001", "owner" : "teste123" } ] }

云数据库 GAUSSDB
云数据库 GAUSSDB-创建数据库SCHEMA:请求参数

请求参数表2 参数说明名称是否必选参数类型说明 db_name 是 String 数据库名称。不能使用模板库，且是已存在的数据库名称。模板库包括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 SCHEMA的属主用户。不能使用系统用户，且是已存在的数据库用户名称。系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”。

云数据库 GAUSSDB
云数据库 GAUSSDB-创建数据库SCHEMA:URI

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

云数据库 GAUSSDB
云数据库 GAUSSDB-创建数据库用户:请求参数

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

云数据库 GAUSSDB
云数据库 GAUSSDB-创建数据库用户:URI

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

云数据库 GAUSSDB
云数据库 GAUSSDB-创建数据库用户:请求示例

请求示例创建一个 GaussDB数据库用户，用户名为dbs。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-user { "name" : "dbs", "password" : "******" }

云数据库 GAUSSDB
云数据库 GAUSSDB-创建数据库:请求示例

请求示例创建一个GaussDB数据库，库名为gaussdb_test。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/database { "name" : "gaussdb_test", "owner" : "test", "template" : "template0", "character_set" : "UTF8", "lc_collate" : "en_US.UTF-8", "lc_ctype" : "en_US.UTF-8" }

云数据库 GAUSSDB 管理数据库和用户
云数据库 GAUSSDB-创建数据库:URI

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

云数据库 GAUSSDB 管理数据库和用户
云数据库 GAUSSDB-查询数据库磁盘类型:请求示例

请求示例查询分布式版数据库磁盘类型 GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/storage-type?version=3.208&ha_mode=enterprise 查询集中式版数据库磁盘类型 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/storage-type?version=3.208&ha_mode=centralization_standard

云数据库 GAUSSDB 磁盘管理
云数据库 GAUSSDB-查询数据库磁盘类型:响应示例

响应示例查询数据库磁盘类型列表成功。 { "storage_type": [ { "name": "ULTRAHIGH", "az_status": { "aaa": "normal", "bbb": "normal", "ccc": "normal" }, "support_compute_group_type": [ "normal", "armFlavors", "armFlavors2Shared", "normal2" ] }, { "name": "ESSD", "az_status": { "az2xahz": "normal", "az1xahz": "normal", "az3xahz": "normal" }, "support_compute_group_type": [ "normal", "armFlavors", "armFlavors2Shared", "normal2" ] } ] }

云数据库 GAUSSDB 磁盘管理
云数据库 GAUSSDB-查询数据库磁盘类型:URI

URI GET https://{Endpoint}/v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode} 表1 参数说明参数是否必选参数类型描述 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 version 是 String 参数解释：数据库版本号。可通过查询数据库引擎的版本查询。取值范围：不涉及。 ha_mode 否 String 参数解释：实例类型。不区分大小写。取值范围： enterprise(分布式版) centralization_standard(集中式版)

云数据库 GAUSSDB 磁盘管理
云数据库 GAUSSDB-查询错误日志下载链接:响应参数

响应参数表3 响应Body参数列表名称类型是否必选描述 total Integer 是总条数。 log_files Array of object 是日志文件列表。详情请参见表4。表4 log_files字段数据结构说明名称类型是否必选描述 file_name String 是日志文件名称。 file_link String 是日志文件下载链接。 file_size String 是日志文件大小，单位kb。 start_time String 是日志开始时间。 end_time String 是日志结束时间。 status String 是日志采集状态。

云数据库 GAUSSDB
云数据库 GAUSSDB-查询错误日志下载链接:响应示例

响应示例 { "total": 1, "log_files": [{ "status": "ENABLE", "file_name": "d289e7f024d741698fb94d73316874ffin14_collector_20220506_155941.tar.gz", "start_time": "1651820343244", "end_time": "1651823943244", "file_size": "62", "file_link": "***" }] }

云数据库 GAUSSDB
云数据库 GAUSSDB-查询错误日志下载链接:URI

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/error-log 表1 请求Path参数列表名称类型是否必选描述 project_id String 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 instance_id String 是实例ID。表2 请求Query参数列表名称类型是否必选描述 offset Integer 否索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit Integer 否查询记录数。默认为10，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。 start_time String 是开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 是结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。只能查询当前时间前30天的错误日志。

云数据库 GAUSSDB
云数据库 GAUSSDB-查询错误日志下载链接:请求示例

请求示例 GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/0317e6bbae534b8eb8f74f0eafcf1d3din01/error-log?start_time=2022-03-15T10:41:14+0800&end_time=2022-03-16T10:41:14+0800

云数据库 GAUSSDB
云数据库 GAUSSDB-查询错误日志采集开关状态:URI

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

云数据库 GAUSSDB 日志管理
云数据库 GAUSSDB-查询实例可变更规格:响应示例

响应示例查询实例可变规格成功。 { "flavors" : [ { "spec_code" : "gaussdb.opengauss.ee.m6.2xlarge.x868.ha", "vcpus" : "8", "ram" : "64", "az_status" : [ { "az2xahz" : "normal" } ] } ], "total_count" : 1 }

云数据库 GAUSSDB
云数据库 GAUSSDB-查询实例可变更规格:URI

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/available-flavors 表1 参数说明名称是否必选参数类型说明 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 instance_id 是 String 实例ID。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第2-11条数据。

云数据库 GAUSSDB
云数据库 GAUSSDB-查询引擎列表:响应参数

响应参数表2 要素说明名称参数类型说明 datastores Array of objects 数据库引擎列表。详情请参见表3。表3 dataStores字段数据结构说明参数参数类型描述 supported_versions Array of strings 部署形态支持的引擎版本列表。 instance_mode String 部署形态。取值范围： ha：集中式版。 independent：独立部署。

云数据库 GAUSSDB

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！