华为云用户手册

云数据库 GaussDB-修改指定实例的参数:请求示例

请求示例修改实例的参数failed_login_attempts的值为4。不需要重启。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations{ "values": { "failed_login_attempts": "4" }} 修改实例的参数track_activity_query_size的值为2048，修改参数max_replication_slots的值为25。需要重启。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations{ "values": { "track_activity_query_size": "2048", "max_replication_slots": "25" }}

云数据库 GaussDB
云数据库 GaussDB-重置参数组:URI

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

云数据库 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}/enterprise-projects/quotas 表1 参数说明参数是否必选参数类型描述 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。

云数据库 GaussDB
云数据库 GaussDB-修改企业项目配额:请求示例

请求示例修改企业项目配额，实例的配额设置为1000个，CPU配额100000核数，内存配额200000GB，存储空间配额1000000GB。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/enterprise-projects/quotas{ "eps_quotas": [ { "enterprise_projects_id": "0", "instance_quota": 1000, "vcpus_quota": 100000, "ram_quota": 200000, "volume_quota": 1000000 } ]}

云数据库 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-修改企业项目配额:请求参数

请求参数表2 参数说明名称是否必选参数类型说明 eps_quotas 是 Array of objects 需要修改的企业配额列表。表3。表3 EpsQuotasOption参数说明名称是否必选参数类型说明 enterprise_projects_id 是 String 企业项目ID。 instance_quota 否 Integer 实例的配额。取值范围：实际创建的实例个数 ~ 100,000。 vcpus_quota 否 Integer CPU的配额。取值范围：实际使用的CPU核数 ~ 2,147,483,646。 ram_quota 否 Integer 内存的配额。单位GB。取值范围：实际使用的内存 ~ 2,147,483,646。 volume_quota 否 Integer 存储空间的配额。单位：GB。取值范围：实际使用的存储空间 ~ 2,147,483,646。

云数据库 GaussDB
云数据库 GaussDB-查询可应用实例列表:响应示例

响应示例查询可应用当前参数组模板的实例列表成功。 { "instances": [ { "instance_id": "1995a67680474481b3e42ac1474e32e0in14", "instance_name": "gauss-a283" }, { "instance_id": "8303819fd8744ef69f34595e9710a33din14", "instance_name": "gauss-2423-lt-master" }], "total_count": 2}

云数据库 GaussDB
云数据库 GaussDB-删除手动备份:URI

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

云数据库 GaussDB
云数据库 GaussDB-查询可应用实例列表:URI

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

云数据库 GaussDB
云数据库 GaussDB-查询数据库用户列表:响应示例

响应示例查询数据库用户列表成功。 { "users": [ { "name": "root", "attribute": { "rolsuper": false, "rolinherit": true, "rolcreaterole": true, "rolcreatedb": true, "rolcanlogin": true, "rolconnlimit": -1, "rolreplication": false, "rolbypassrls": false, "rolpassworddeadline": "" }, "memberof": "{gs_role_copy_files,gs_role_signal_backend,gs_role_tablespace,gs_role_replication,gs_role_account_lock}", "lock_status": false } ], "total_count": 1}

云数据库 GaussDB
云数据库 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-删除参数模板:URI

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

云数据库 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-查询数据库列表:响应示例

响应示例查询数据库列表成功。 { "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-查询数据库列表:响应参数

响应参数表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-删除任务记录:URI

URI DELETE https://{Endpoint}/v3/{project_id}/jobs/{job_id} 表1 参数说明参数是否必选参数类型描述 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 job_id 是 String 任务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-查询预定义标签:URI

URI GET https://{Endpoint}/v3/{project_id}/predefined-tags 表1 请求参数名称类型 IN 是否必选描述 project_id string path 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。

云数据库 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-创建数据库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-查询任务列表:响应示例

响应示例查询任务列表成功。 { "tasks" : [ { "instance_info" : { "instance_id" : "ce2dce50f365430abe161bab79495a6ein14", "instance_name" : "gauss-6568-zzh", "instance_status" : "creating" }, "job_id" : "03bc055a-135c-4245-8bd8-b0bc6d3350b3", "name" : "CreateGaussDBV5Instance", "status" : "Failed", "process" : "", "created_at": "2022-08-05T08:15:07+0800", "ended_at": "2022-08-09T03:06:52+0800", "fail_reason" : "500000" }, { "instance_info" : { "instance_id" : "20ba433bd7ee40da9cf35064f04f9e4cin14", "instance_name" : "gauss-7875-lt-m", "instance_status" : "deleted" }, "job_id" : "2cc16e0b-75ab-4a28-9453-16517e990bba", "name" : "DeleteGaussDBV5Instance", "status" : "Completed", "process" : "", "created_at": "2022-08-06T09:15:07+0800", "ended_at": "2022-08-10T03:06:52+0800", "fail_reason" : null } ], "total_count" : 2 }

云数据库 GaussDB
云数据库 GaussDB-查询任务列表:请求示例

请求示例查询任务状态为“运行中”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&name=CreateGaussDBV5Instance&offset=1&limit=10 查询任务状态为“完成”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Completed&name=CreateGaussDBV5Instance&offset=1&limit=10 查询任务状态为“失败”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Failed&name=CreateGaussDBV5Instance&offset=1&limit=10

云数据库 GaussDB
云数据库 GaussDB-查询任务列表:URI

URI GET https://{Endpoint}/v3/{project_id}/tasks 表1 参数说明名称是否必选参数类型说明 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 status 否 String 任务状态。 Running：运行中 Completed：完成 Failed：失败 name 否 String 任务名称。 CreateGaussDBV5Instance：创建实例。 BackupSnapshotGaussDBV5InInstance：手动创建备份。 CloneGaussDBV5NewInstance：恢复到新实例。 RestoreGaussDBV5InInstance：恢复到当前实例。 RestoreGaussDBV5InInstanceToExistedInst：恢复到已有实例 DeleteGaussDBV5Instance：删除实例。 EnlargeGaussDBV5Volume：磁盘扩容。 ResizeGaussDBV5Flavor：规格变更。 GaussDBV5ExpandClusterCN：协调节点扩容。 GaussDBV5ExpandClusterDN：分片扩容。 start_time 否 String 开始时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time 否 String 结束时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

云数据库 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-查询任务列表:响应参数

响应参数表2 要素说明名称参数类型说明 tasks Array of objects 任务列表。详情请参见表3 tasks字段数据结构说明。 total_count Integer 任务数量。表3 tasks字段数据结构说明名称参数类型说明 instance_info Object 任务绑定的实例信息。详情请参见表4 instance_info字段数据结构说明。 job_id String 任务ID。 name String 任务名称。 status String 任务状态。 process String 任务进度，单位：%。 created_at String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 ended_at String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 fail_reason String 失败原因。表4 instance_info字段数据结构说明名称参数类型说明 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。

云数据库 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 管理数据库和用户

共100000条

undefined

意见反馈

0/200

提交取消

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