华为云用户手册

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

响应参数 表2 参数说明 参数 参数类型 描述 users Array of objects 列表中每个元素表示一个数据库用户，详情参见表3。 total_count Integer 数据库用户总数。 表3 users字段数据结构说明 参数 参数类型 描述 name String 用户名称。 attributes Object 用户的权限属性，详情参见表4。 memberof String 用户的默认权限。 表4 attributes字段数据结构说明 参数 参数类型 描述 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”。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-users 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 offset 否 Integer 分页符。从第一条数据偏移offset页数据后开始查询，默认为0（偏移0页数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。 limit 否 Integer 每页显示的条目数量,取值范围[1, 100]，默认10。

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

请求示例 设置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" } ] }

请求示例 切换多个DN分片的主备。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/switch-shard { "shards": [ { "node_id": "0bc478b4d132494a8f7b804da521b4b2no14", "component_id": "dn_6001" }, { "node_id": "53dee94c50574d36a0060db0a6b644f6no14", "component_id": "dn_6004" } ] }

请求参数 表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通过查询实例的组件列表获取。

响应参数 表2 参数说明 参数 参数类型 描述 total_count Integer 总记录数。 instances Array of objects 回收站所有的实例信息，具体参数请参考表3。 表3 instances字段数据结构说明 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 ha_mode String 部署形态。 枚举值： Ha：主备版。 Independent：独立部署。 engine_name String 引擎名称。 engine_version String 引擎版本号。 pay_model String 计费模式。 0：按需计费。 1：包年包月。 created_at String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 deleted_at String 删除时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 volume_type String 磁盘类型。 枚举值： high：高IO。 ultrahigh：超高IO。 essd：急速型SSD。 volume_size String 磁盘大小。 data_vip String 数据vip。 enterprise_project_id String 企业项目ID，"0"代表默认的企业项目。 enterprise_project_name String 企业项目名称。 backup_level String 备份级别。 recycle_backup_id String 备份ID。（指删除实例时产生备份信息中的备份ID）。 recycle_status String 回收站备份状态。 枚举值： Running：运行中。 Active：有效。 mode String 实例类型。 枚举值： basic：基础版。 standard：标准版。 enterprise：企业版。

URI GET https://{Endpoint}/v3/{project_id}/recycle-instances 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_name 否 String 实例名称。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为50，不能为负数，最小值为1，最大值为50。例如该参数设定为10，则查询结果最多只显示10条记录。

响应示例 { "total_count" : 2, "instances" : [ { "id" : "21f20e55999947a9938ad0453b757e72in14", "name" : "gaussdbv5_CCv20_bms_default_1_20220827012852", "ha_mode" : "Ha", "engine_name" : "gaussdbv5", "engine_version" : "2.3.0", "pay_model" : 0, "created_at" : "2022-08-09T09:26:44.000+08:00", "deleted_at" : "2022-08-09T09:26:44.000+08:00", "volume_type" : "localssd", "volume_size" : "", "data_vip" : "25.213.0.41 / 25.213.0.188 / 25.213.0.101 / 25.213.0.82", "enterprise_project_id" : 0, "enterprise_project_name" : null, "backup_level" : null, "recycle_backup_id" : "00b755ed678e41d18c74b28e2ad41bdcbr14", "recycle_status" : "Active", "mode" : "enterprise" }, { "id" : "a9df5b52b32e4571b1b6425a78a32956in14", "name" : "ecs-lxy-backup-3", "ha_mode" : "Ha", "engine_name" : "gaussdbv5", "engine_version" : "2.3.0", "pay_model" : 0, "created_at" : "2022-08-09T09:26:44.000+08:00", "deleted_at" : "2022-08-09T09:26:44.000+08:00", "volume_type" : "ultrahigh", "volume_size" : "", "data_vip" : "173.202.10.246 / 173.202.10.205 / 173.202.10.175", "enterprise_project_id" : 0, "enterprise_project_name" : null, "backup_level" : null, "recycle_backup_id" : "ef393704ef0045d1b6226b6f2cdc48a7br14", "recycle_status" : "Active", "mode" : "enterprise" } ] }

请求示例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations { "values": { "xxx": "10", "yyy": "OFF" } }

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

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

请求示例 创建一个 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" }

响应示例 获取参数模板列表成功。 { "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 } ] }

响应参数 表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，表示为用户自定义参数模板。

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

请求示例 设置GaussDB实例备份策略，备份文件保存时长7天，备份时间段为19:00-20:00。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy { "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 } }

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略信息。 详情参见表3。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 备份文件可以保存的天数。 取值范围：1-36500天。 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~ 1024 最小值：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以下的实例)

请求参数 表2 请求参数 名称 是否必选 参数类型 说明 expand_cluster 是 Object 请参见表3 表3 expand_cluster字段数据结构说明 名称 是否必选 参数类型 说明 shard 是 Object 请参见表4 isAutoPay 否 int 包周期用户需要填写该字段。 0：表示不自动支付扩容订单费用 1：表示自动支付扩容订单费用 不填写则保持默认。默认值：0 表4 count字段数据结构说明 名称 是否必选 参数类型 说明 count 是 Integer 新增的DN分片扩容数大小

请求示例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action { "expand_cluster": { "shard":{ "count":1 }, "isAutoPay":0 } }

响应示例 非包租期用户响应消息样例： { "job_id": "2b414788a6004883a02390e2eb0ea227" } 包租期用户响应消息样例： { "payInfo": { "payModel": null, "orderId": " CS 2105061116HNTVI", "period": null, "periodType": 5, "isAutoRenew": 0, "isAutoPay": 1 }, "job_id": null }

GaussDB授权分类 表1 实例管理 API功能 授权项 授权范围 对应API接口 创建数据库实例 gaussdb:instance:create gaussdb:param:list 支持： IAM 项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances 扩容数据库实例的磁盘空间 gaussdb:instance:modifySpec 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/action 删除数据库实例 gaussdb:instance:delete 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/instances/{instance_id} 查询数据库实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances 重置数据库密码 gaussdb:instance:modifyPasswd 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/password 修改实例名称 gaussdb:instance:rename 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/name 重启数据库实例 gaussdb:instance:restart 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/restart 分片节点主备切换 gaussdb:instance:switchShard 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/switch-shard 查询实例的组件列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/components 规格变更 gaussdb:instance:modifySpec 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instance/{instance_id}/flavor 查询实例主备平衡状态 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/balance 查询解决方案模板配置 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/deployment-form 查询已绑定的EIP列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/public-ips?offset={offset}&limit={limit} 弱密码校验 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/weak-password-verification 绑定/解绑弹性公网IP gaussdb:instance:bindPublicIp 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip 查询实例SSL证书下载地址 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/ssl-cert/download-link 查询租户的实例配额 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/project-quotas?type={type} 表2 参数配置 API功能 授权项 授权范围 对应API接口 获取参数模板列表 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations?offset={offset}&limit={limit} 获取指定实例的参数 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/configurations 修改指定实例的参数 gaussdb:param:modify 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/configurations 创建参数模板 gaussdb:param:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations 删除参数模板 gaussdb:param:delete 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/configurations/{config_id} 查询参数模板详情 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id} 复制参数模板 gaussdb:param:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations/{config_id}/copy 重置参数组 gaussdb:param:modify 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations/{config_id}/reset 比较两个参数组模板之间的差异 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations/comparison 查询可应用实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id}/applicable-instances 校验参数组名称是否存在 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/name-validation?name={name} 应用参数模板 gaussdb:param:apply 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/configurations/{config_id}/apply 查询参数模板的应用记录 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id}/applied-histories 查询参数模板的修改历史 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id}/histories 表3 备份管理 API功能 授权项 授权范围 对应API接口 设置自动备份策略 gaussdb:instance:modifyBackupPolicy 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/backups/policy 查询自动备份策略 gaussdb:backup:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/backups/policy 查询备份列表 gaussdb:backup:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{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} 创建手动备份 gaussdb:backup:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/backups 删除手动备份 gaussdb:backup:delete 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/backups/{backup_id} 查询可恢复时间段 gaussdb:backup:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/restore-time?date={date} 恢复到新实例 gaussdb:instance:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances 查询可用于备份恢复的实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/restorable-instances 根据时间点或者备份文件查询原实例信息 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instance-snapshot?instance_id={instance_id}&backup_id={backup_id}&restore_time={restore_time} 表4 引擎版本和规格 API功能 授权项 授权范围 对应API接口 查询数据库引擎的版本 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/datastore/versions 查询数据库规格 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code} 查询引擎列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/datastores 查询实例可变更规格 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/available-flavors 表5 管理数据库和用户 API功能 授权项 授权范围 对应API接口 创建数据库 gaussdb:instance:createDatabase 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/database 创建数据库用户 gaussdb:instance:createDatabaseUser 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/db-user 创建数据库SCHEMA gaussdb:instance:createDatabaseSchema 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/schema 授权数据库账号 gaussdb:instance:grantDatabasePrivilege 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/db-privilege 重置数据库账号密码 gaussdb:instance:modifyDatabasePasswd 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/db-user/password 查询数据库列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/databases 查询数据库用户列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/db-users 查询数据库SCHEMA列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/schemas 表6 标签管理 API功能 授权项 授权范围 对应API接口 查询实例标签 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/tags 查询项目标签 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/tags 查询预定义标签 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/predefined-tags 添加实例标签 gaussdb:instance:dealTag 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/tags 表7 磁盘管理 API功能 授权项 授权范围 对应API接口 查询实例存储空间使用信息 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/volume-usage 查询数据库磁盘类型 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode} 表8 配额管理 API功能 授权项 授权范围 对应API接口 修改企业项目配额 gaussdb:quota:modify 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/enterprise-projects/quotas 查询企业项目配额组 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/enterprise-projects/quotas 表9 任务管理 API功能 授权项 授权范围 对应API接口 获取任务信息 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/jobs?id={id} 查询任务列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/tasks 删除任务记录 gaussdb:instance:deleteTaskRecord 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/jobs/{job_id} 表10 回收站 API功能 授权项 授权范围 对应API接口 设置回收站策略 gaussdb:instance:setRecyclePolicy 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/recycle-policy 查看回收站策略 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/recycle-policy 查询回收站所有引擎实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/recycle-instances 父主题： 权限策略和授权项

响应参数 表2 参数说明 名称 参数类型 说明 public_ips Array of objects 查询实例已绑定EIP列表。 详情请参见表3。 total_count Integer 总记录数。 表3 public_ips字段数据结构说明 名称 参数类型 说明 public_ip_id String 弹性公网ID。 public_ip_type String 弹性公网类型。 port_id String 端口ID。 public_ip_address String 弹性公网IP。 private_ip_address String 内网地址。 bandwidth_id String 带宽ID。 bandwidth_name String 带宽名称。 bandwidth_share_type String 带宽共享类型。 bandwidth_size Integer 带宽大小。 applied_at String 修改时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+08:00。

响应示例 查询实例已绑定的弹性公网IP列表成功。 { "public_ips" : [ { "public_ip_id" : "78458261-5175-4254-8242-5959115d379a", "public_ip_type" : "5_g-vm", "port_id" : "a8d606bf-7e20-463d-afed-b7fc2909aa7d", "public_ip_address" : "100.95.156.144", "private_ip_address" : "192.168.0.133", "applied_at" : "2022-08-09T03:06:52+0800", "bandwidth_id" : "7ae23d75-3150-4957-94ae-9352b15f140e", "bandwidth_name" : "Bandwidth_2021-12-08-16-39-27", "bandwidth_size" : 5, "bandwidth_share_type" : "PER" } ], "total_count" : 1 }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/public-ips?offset={offset}&limit={limit} 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id String 是 实例ID。 offset Integer 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit Integer 否 查询记录数。默认为50，不能为负数，最小值为1，最大值为50。

响应示例 获取任务信息成功。 { "job" : { "id" : "5cbb8a90-2253-4cff-8a13-49aa8f31dfb5", "name" : "CreateGaussDBV5Instance", "status" : "Completed", "created" : "2021-07-12T09:22:04+0800", "ended" : "2021-07-12T10:10:13+0800", "progress" : "", "instance" : { "id" : "b34f8c791f2643578510c093aa2351a8in14", "name" : "gauss-c1a3" }, "fail_reason" : null } }

响应参数 表2 参数说明 名称 参数类型 描述 job Object 任务信息，请参见表job字段数据结构说明。 表3 job字段数据结构说明 名称 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务执行状态。 取值： 值为“Running”，表示任务正在执行。 值为“Completed”，表示任务执行成功。 值为“Failed”，表示任务执行失败。 created String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 ended String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 progress String 任务执行进度。 说明： 执行中状态才返回执行进度，例如“60%”，表示任务执行进度为60%，否则返回“”。 instance Object 执行任务的实例信息。 请参见表4。 fail_reason String 任务执行失败时的错误信息。 表4 instance字段数据结构说明 名称 参数类型 描述 id String 实例ID。 name String 实例名称。

请求参数 表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

请求示例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,3,4,5", "differential_period": "30" } }