华为云用户手册

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/extend-volume 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

云数据库 GeminiDB授权项说明 表1 实例管理 权限 对应API接口 授权项(Action) IAM 项目(Project) 企业项目(Enterprise Project) 创建数据库实例 POST /v3/{project_id}/instances nosql:instance:create √ √ 删除数据库实例 DELETE /v3/{project_id}/instances/{instance_id} nosql:instance:delete √ √ 查询数据库实例列表 GET /v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} nosql:instance:list √ √ 扩容实例存储容量 POST /v3/{project_id}/instances/{instance_id}/extend-volume nosql:instance:modifyStorageSize √ √ 扩容集群实例的节点数量 POST /v3/{project_id}/instances/{instance_id}/enlarge-node nosql:instance:extendNode √ √ 缩容集群实例的节点数量 POST /v3/{project_id}/instances/{instance_id}/reduce-node nosql:instance:reduceNode √ √ 变更实例规格 PUT /v3/{project_id}/instances/{instance_id}/resize nosql:instance:modifySpecification √ √ 修改实例管理员密码 PUT /v3/{project_id}/instances/{instance_id}/password nosql:instance:modifyPasswd √ √ 修改实例名称 PUT /v3/{project_id}/instances/{instance_id}/name nosql:instance:rename √ √ 变更实例安全组 PUT /v3/{project_id}/instances/{instance_id}/security-group nosql:instance:modifySecurityGroup √ √ 数据库补丁升级 POST /v3/{project_id}/instances/{instance_id}/db-upgrade nosql:instance:upgradeDatabaseVersion √ √ 批量数据库补丁升级 /v3/{projectId}/instances/db-upgrade nosql:instance:batchUpgradeDatabaseVersion √ √ 创建冷数据存储 POST /v3/{project_id}/instances/{instance_id}/cold-volume nosql:instance:modifyStorageSize √ √ 扩容冷数据存储 PUT /v3/{project_id}/instances/{instance_id}/cold-volume nosql:instance:modifyStorageSize √ √ 绑定/解绑弹性公网IP POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip nosql:instance:bindPublicIp √ √ 切换SSL开关 POST /v3/{project_id}/instances/{instance_id}/ssl-option nosql:instance:switchSSL √ √ 重启数据库实例 POST /v3/{project_id}/instances/{instance_id}/restart nosql:instance:restart √ √ 设置磁盘自动扩容策略 PUT /v3/{project_id}/instances/disk-auto-expansion nosql:instance:modifyStorageSize √ √ 修改高危命令 PUT /v3/{projectId}/instances/{instanceId}/high-risk-commands nosql:instances:modifyHighRiskCommands √ √ 设置实例可维护时间段 PUT /v3/{project_id}/instances/{instance_id}/maintenance-window nosql:instance:modifyMaintenanceWindow √ √ 获取GeminiDB Redis的免密配置 Get /v3/{project_id}/instances/{instance_id}/passwordless-config nosql:instance:getPasswordlessConfig √ √ 支持修改GeminiDB Redis的免密配置 PUT /v3/{project_id}/instances/{instance_id}/passwordless-config nosql:instance:setPasswordlessConfig √ √ 更新委托权限策略 x nosql:instance:updateAgency √ √ 查询委托权限详情 x nosql:instance:listAgency √ √ 查询内存加速映射列表和详情 GET /v3/{project_id}/dbcache/mappings nosql:instance:listDBCacheMappings √ √ 创建内存加速规则 POST /v3/{project_id}/dbcache/rule nosql:instance:listDBCacheRules √ √ 删除内存加速映射 DELETE /v3/{project_id}/dbcache/mapping nosql:instance:deleteDBCacheMapping √ √ 创建内存加速映射 POST /v3/{project_id}/dbcache/mapping nosql:instance:createDBCacheMapping √ √ 修改内存加速规则 PUT /v3/{project_id}/dbcache/rule nosql:instance:updateDBCacheRule √ √ 查询内存加速规则列表和详情 GET /v3/{project_id}/dbcache/rules nosql:instance:listDBCacheRules √ √ 删除内存加速规则 DELETE /v3/{project_id}/dbcache/rule nosql:instance:deleteDBCacheRule √ √ 开启/关闭实例数据导出 PUT /v3/{project_id}/instances/{instance_id}/data-dump nosql:instance:operateDataDump √ √ 开启/关闭秒级监控 PUT /v3/{project_id}/instances/{instance_id}/monitoring-by-seconds/switch nosql:instance:secondLevelMonitoring √ √ 查询秒级监控配置 GET /v3/{project_id}/instances/{instance_id}/monitoring-by-seconds/switch nosql:instance:secondLevelMonitoring √ √ 查询Redis实例的热key GET /v3/{project_id}/instances/{instance_id}/hot-keys nosql:instance:getHotKeys √ √ Redis主备切换 PUT /v3/{project_id}/instance/{instance_id}/switchover nosql:instance:switchover √ √ 查询Redis禁用命令 GET /v3/{project_id}/redis/instances/{instance_id}/disabled-commands nosql:instance:queryRedisDisabledCommands √ √ 设置Redis禁用命令 POST /v3/{project_id}/redis/instances/{instance_id}/disabled-commands nosql:instance:setRedisDisabledCommands √ √ 删除Redis禁用命令 DELETE /v3/{project_id}/redis/instances/{instance_id}/disabled-commands nosql:instance:setRedisDisabledCommands √ √ 表2 连接管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 获取实例的会话 GET /v3/{project_id}/instances/{instance_id}/sessions nosql:session:list √ √ 关闭实例所有节点会话 DELETE /v3/{project_id}/instances/{instance_id}/sessions nosql:session:delete √ √ 表3 备份与恢复 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询自动备份策略 GET /v3.1/{project_id}/instances/{instance_id}/backups/policy nosql:backup:list √ √ 设置自动备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/policy nosql:instance:modifyBackupPolicy √ √ 查询可恢复的实例列表 GET /v3/{project_id}/backups/{backup_id}/restorable-instances nosql:instance:list √ √ 查询实例可恢复的时间段 GET /v3/{project_id}/instances/{instance_id}/backups/restorable-time-periods nosql:backup:list √ √ 创建手动备份 POST /v3/{project_id}/instances/{instance_id}/backups nosql:backup:create √ √ 删除手动备份 DELETE /v3/{project_id}/backups/{backup_id} nosql:backup:delete √ √ 恢复到已有实例 POST /v3/{project_id}/instances/{instance_id}/recovery nosql:backup:refreshInstanceFromBacku √ √ 恢复当前Redis实例到指定时间点 PUT /v3/{project_id}/redis/instances/{instance_id}/pitr nosql:instance:redisPitrRestore √ √ 设置Redis恢复到指定时间点策略 PUT /v3/{project_id}/redis/instances/{instance_id}/pitr/policy nosql:instance:setRedisPitrPolicy √ √ 查询Redis恢复到指定时间点策略 GET /v3/{project_id}/redis/instances/{instance_id}/pitr/policy nosql:instance:showRedisPitrPolicy √ √ 查询Redis可恢复时间点 GET /v3/{project_id}/redis/instances/{instance_id}/pitr/restorable-time-periods nosql:instance:queryRedisPitrRestoreTime √ √ 查询Redis实例指定时间点恢复所占用的存储空间 GET /v3/{project_id}/redis/instances/{instance_id}/pitr nosql:instance:showRedisPitrInfo √ √ 停止备份 PUT /v3/{project_id}/backups/{backup_id} nosql:backup:stop √ √ 批量删除手动备份 DELETE /v3/{project_id}/instances/backups nosql:backup:delete √ √ 表4 参数模板管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 获取参数模板列表 GET /v3/{project_id}/configurations nosql:param:list √ √ 创建参数模板 POST /v3/{project_id}/configurations nosql:param:create √ √ 修改参数模板的参数 PUT /v3/{project_id}/configurations/{config_id} nosql:param:modify √ √ 应用参数模板 PUT /v3.1/{project_id}/configurations/{config_id}/apply nosql:instance:modifyParameter √ √ 修改指定实例的参数 PUT /v3.1/{project_id}/instances/{instance_id}/configurations nosql:instance:modifyParameter √ √ 获取指定实例的参数 GET /v3/{project_id}/instances/{instance_id}/configurations nosql:param:list √ √ 获取指定参数模板的参数 GET /v3/{project_id}/configurations/{config_id} nosql:param:list √ √ 删除参数模板 DELETE /v3/{project_id}/configurations/{config_id} nosql:param:delete √ √ 查询参数模板可应用的实例列表 GET /v3/{project_id}/configurations/{config_id}/applicable-instances nosql:instance:list √ √ 查询实例参数的修改历史 GET /v3/{project_id}/instances/{instance_id}/configuration-histories nosql:param:list √ √ 查询参数模板应用历史 GET /v3/{project_id}/configurations/{config_id}/applied-histories nosql:param:list √ √ 表5 标签管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询资源实例 POST /v3/{project_id}/instances/resource_instances/action nosql:instance:list nosql:tag:list √ √ 批量添加或删除资源标签 POST /v3/{project_id}/instances/{instance_id}/tags/action nosql:instance:tag √ √ 查询资源标签 GET /v3/{project_id}/instances/{instance_id}/tags nosql:instance:list nosql:tag:list √ √ 表6 日志管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询数据库慢日志 GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} nosql:instance:list √ √ 表7 配额管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询配额 GET /v3/{project_id}/quotas nosql:instance:list √ √ 表8 容灾管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询实例可搭建双活关系的Region GET /v3/{project_id}/instances/{instance_id}/disaster-recovery/regions nosql:instance:list √ √ 设置实例容灾切换的故障节点比例 PUT /v3/{project_id}/instances/disaster-recovery/settings nosql:dr:setDisasterRecoverySettings √ √ 查询实例容灾切换的故障节点比例 GET /v3/{project_id}/instances/disaster-recovery/settings nosql:dr:listDisasterRecoverySettings √ √ 表9 任务管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询实例可维护时间段 GET /v3/{project_id}/instances/{instance_id}/ops-window nosql:instance:maintenanceWindow √ √ 取消定时任务 DELETE /v3/{project_id}/scheduled-jobs/{job_id} nosql:instance:cancleScheduleJob √ √ 查询定时任务列表 GET /v3/{projectId}/scheduled-jobs nosql:task:list √ √ “√”表示支持，“x”表示暂不支持。 父主题： 权限策略和授权项

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

URI DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

具体步骤 Token认证，具体操作请参考认证鉴权。 发送“POST https://{Endpoint}/v3/{project_id}/instances”。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： 样例中参数“region”和“availability_zone”的值为示例值。 关于创建实例接口的详细说明，请参见创建实例。 { "name": "test-cassandra-01",//实例名称 "datastore": { "type": "cassandra",//数据库类型 "version": "3.11", //数据库版本 "storage_engine": "rocksDB"//存储引擎 }, "region": "aaa",//区 域名 称 "availability_zone": "bbb", //可用区名称 "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",//虚拟私有云ID "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",//子网ID "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",//安全组ID "password": "xxxx",//管理员密码 "mode": "Cluster", //实例类型 "flavor": [ { "num": 3,//节点数量 "size": 500,//磁盘大小 "storage": "ULTRAHIGH", //磁盘类型 "spec_code": "geminidb.cassandra.4xlarge.4" //资源规格编码 } ], "backup_strategy": { "start_time": "08:00-09:00",//备份时间段 "keep_days": "8"//备份文件的保留天数 }, "enterprise_project_id": "0"//企业项目ID } 请求成功后，返回如下信息： { "id": "39b6a1a278844ac48119d86512e0000bin06", "name": "test-cassandra-01", "datastore": { "type": "cassandra", "version": "3.11", "storage_engine": "rocksDB" }, "created": "2019-10-28 14:10:54", "status": "creating", "region": "aaa", "availability_zone": "bbb", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "mode": "Cluster", "flavor": [ { "num": 3, "size": 500, "storage": "ULTRAHIGH", "spec_code": "geminidb.cassandra.4xlarge.4" } ], "backup_strategy": { "start_time": "08:00-09:00", "keep_days": "8" }, "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f", "enterprise_project_id": "0" } 若请求失败，会返回错误码及对应的错误信息说明，详细错误码信息请参见错误码。

认证鉴权 云数据库 GeminiDB支持通过Token认证的方式进行认证鉴权。 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示： { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "password", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。 父主题： 如何调用API

API概览 云数据库 GeminiDB所提供的接口为扩展接口。通过使用云数据库 GeminiDB接口，您可以使用云数据库 GeminiDB的部分功能，具体如下表所示。 表1 接口说明 类型 描述 查询API版本 查询API版本列表 查询API版本信息 查询数据库版本信息 查询指定实例类型的数据库版本信息。 查询所有实例规格信息 查询指定条件下的所有实例规格信息。 实例管理 包括创建实例、删除实例、查询实例列表、扩容实例存储容量、扩容集群实例的节点数量、缩容集群实例的节点数量、变更实例规格、修改实例管理员密码、修改实例名称和变更实例安全组接口。 备份和恢复 包括查询自动备份策略、设置自动备份策略接口。 参数管理 包括获取参数模板列表、创建参数模板、修改参数模板的参数、应用参数模板、修改指定实例的参数、获取指定实例的参数、获取指定参数模板的参数、删除参数模板接口。 账号管理 包括创建数据库账号、修改数据库账号权限、修改数据库账号密码、删除数据库账号、获取数据库账号列表和详情、获取实例数据库列表。 标签管理 包括查询资源实例、批量添加或删除资源标签、查询资源标签接口。 日志管理 包括查询数据库慢日志接口。 配额管理 包括查询配额 容灾管理 包括校验实例是否可以与指定实例建立/解除容灾关系、搭建实例与特定实例的容灾关系、解除实例与指定实例的容灾关系。

基本概念 账号 用户的账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用其进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

URI GET https://{Endpoint}/v3/{project_id}/redis/instances/{instance_id}/pitr/restorable-time-periods 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 查询可恢复时间点的开始时间，为“yyyy-mm-ddThh:mm:ssZ”字符串格式，T指某个时间的开始，Z指时区偏移量。 end_time 是 String 查询可恢复时间点的结束时间，为“yyyy-mm-ddThh:mm:ssZ”字符串格式，T指某个时间的开始，Z指时区偏移量。 offset 否 Integer 偏移量，表示查询该偏移量后面的记录，默认值为0。 limit 否 Integer 查询返回记录的数量上限值，取值范围为1~100，默认值为300。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 restore_time Array of strings Redis可恢复时间点列表。 “yyyy-mm-ddThh:mm:ssZ”字符串格式，T指某个时间的开始，Z指时区偏移量。 total_count Integer Redis实例可恢复时间点总数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=100

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 enabled Boolean 标识Redis实例是否开启指定时间点恢复。 “true”，表示实例开启Redis指定时间点恢复功能。 “false”，表示实例不启用Redis指定时间点恢复功能。 interval Integer 数据备份的时间间隔，仅在开启时返回。 keep_days Integer 指定已生成的备份文件可以保存的天数，仅在开启时返回。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/policy { "enabled" : true, "interval" : 20, "keep_days" : 7 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 enabled 是 Boolean 标识Redis实例是否开启指定时间点恢复。 “true”表示实例开启Redis指定时间点恢复功能。 “false”表示实例不启用Redis指定时间点恢复功能。 interval 否 Integer 数据备份的时间间隔。默认值：20分钟，取值范围：5～120，单位：分钟。 例如，当interval为20分钟时，可恢复时间点的间隔为20分钟。其interval越小，对性能影响越大，存储空间膨胀越明显。 keep_days 否 Integer 指定已生成的备份文件可以保存的天数。默认值：1 天，取值范围：1～7，单位：天。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 restore_time 是 String 恢复的指定时间点, 格式为“yyyy-mm-ddThh:mm:ssZ”字符串格式，T指某个时间的开始，Z指时区偏移量。 获取方法请参见表4中“restore_time”字段下参数的值。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 database_name 是 String 数据库名。 offset 否 Integer 索引位置偏移量。 索引位置偏移量，表示从指定project ID下最新的专属资源创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。 取值大于或等于0。 不传该参数时，查询偏移量默认为0，表示从最新的创建时间对应的专属资源开始查询。 limit 否 Integer 查询专属资源个数上限值。 取值范围：1~100。不传该参数时，默认查询前100条实例信息。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置偏移量。 索引位置偏移量，表示从指定project ID下最新的专属资源创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。 取值大于或等于0。 不传该参数时，查询偏移量默认为0，表示从最新的创建时间对应的专属资源开始查询。 limit 否 Integer 查询专属资源个数上限值。 取值范围：1~100。不传该参数时，默认查询前100条实例信息。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/disaster-recovery/deconstruction 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups 创建手动备份 { "name" : "创建手动备份", "description" : "创建手动备份", }

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-upgrade 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quotas ShowResourcesListResponseBody object 参数解释： 配额信息。 表5 ShowResourcesListResponseBody 参数 参数类型 描述 resources Array of ShowResourcesDetailResponseBody objects 参数解释： 资源列表对象。 表6 ShowResourcesDetailResponseBody 参数 参数类型 描述 type String 参数解释： 配额资源类型。 约束限制： 当前配额类型仅支持实例类型（instance）。 取值范围： 不涉及。 quota Integer 参数解释： 当前配额值。 取值为0时，表示不限制当前配额值。 取值范围： 不涉及。 used Integer 参数解释： 已使用的资源数。 取值范围： 不涉及。

URI GET https://{Endpoint}/v3/{project_id}/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 datastore_type 否 String 参数解释： 数据库类型。 约束限制： 不涉及。 取值范围： 取值为“cassandra”，表示查询GeminiDB Cassandra数据库实例配额。 取值为“mongodb”，表示GeminiDB Mongo查询数据库实例配额。 取值为“influxdb”，表示查询GeminiDB Influx数据库实例配额。 取值为“redis”，表示查询GeminiDB Redis数据库实例配额。 默认取值： 如果不传该参数，表示查询所有数据库实例配额。 mode 否 String 参数解释： 实例类型。 约束限制： 不涉及。 取值范围： 取值为“Cluster”，表示GeminiDB Redis Proxy集群，GeminiDB Cassandra、GeminiDB Influx经典部署模式集群实例类型。 取值为“CloudNativeCluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。 取值为“RedisCluster”，表示GeminiDB Redis Cluster经典部署模式集群实例类型。 取值为“Replication”，表示GeminiDB Redis经典部署模式主备实例类型。 取值为“InfluxdbSingle”，表示GeminiDB Influx经典部署模式单节点实例类型。 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。 默认取值： 如果不传datastore_type参数，自动忽略该参数设置，传入datastore_type时，该参数必填。 product_type 否 String 参数解释： 产品类型。 约束限制： 不涉及。 取值范围： Capacity 容量型 Standard 标准型 当查询GeminiDB redis云原生部署模式集群类型配额必传此参数。 默认取值： 不涉及。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 version ApiVersionResponse object API版本详细信息列表。 表3 ApiVersionResponse 参数 参数类型 描述 id String API版本号。 links Array of Links objects 对应API的链接信息。 说明： v3版本该字段为[]。 status String 版本状态。 version String API版本的子版本信息。 min_version String API版本的最小版本号。 updated String 版本更新时间。 格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始，Z指UTC时间。 表4 Links 参数 参数类型 描述 href String 对应该API的URL，该字段为""。 rel String 值为“self”，表示URL为本地链接。

响应示例 状态码： 200 Success { "histories" : [ { "parameter_name" : "mongos.connPoolMaxShardedConnsPerHost", "old_value" : "600", "new_value" : "500", "update_result" : "FAILED", "applied" : true, "updated_at" : "2022-09-20T11:17:04+0000", "applied_at" : "2022-09-20T11:17:04+0000" } ] }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configuration-histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 约束限制： 取值必须为数字，不能为负数。 取值范围： 非负整数。 默认取值： 0 limit 否 Integer 参数解释： 查询个数上限值。 约束限制： 不涉及。 取值范围： 1~100。 默认取值： 100。不传该参数时，默认查询前100条信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 histories Array of ConfigurationHistoryRsp objects 参数解释： 实例参数的修改历史列表。 表5 ConfigurationHistoryRsp 参数 参数类型 描述 parameter_name String 参数解释： 参数名称。 取值范围： 不涉及。 old_value String 参数解释： 参数旧值。 取值范围： 不涉及。 new_value String 参数解释： 参数新值。 取值范围： 不涉及。 update_result String 参数解释： 更新结果。 取值范围： SUC CES S：成功。 FAILED：失败。 applied Boolean 参数解释： 是否生效。 取值范围： true:已生效。 false:未生效。 updated_at String 参数解释： 更新时间。 取值范围： 格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 applied_at String 参数解释： 生效时间。 取值范围： 格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

响应示例 状态码： 200 Success { "histories" : [ { "instance_id" : "a2d0cf32db3e4f2aa3a684240e10b457in06", "instance_name" : "test", "applied_at" : "2022-09-20T11:17:04+0000", "apply_result" : "SUCCESS", "failure_reason": "" } ] }

URI GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 config_id 是 String 参数模板id。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 取值必须为数字，不能为负数。 limit 否 Integer 查询个数上限值。 取值范围: 1~100。 不传该参数时，默认查询前100条信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 histories Array of ApplyHistoryRsp objects 参数模板应用历史列表。 表5 ApplyHistoryRsp 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称 applied_at String 生效时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 apply_result String SUCCESS：应用成功。 APPLYING：应用中。 FAILED：应用失败。 failure_reason String 失败原因。