华为云用户手册

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 keys Array of 表5 objects 查询到的热Key列表。 count Integer 总数。 表5 HotKeysInfoRsponseBody 参数 参数类型 描述 name String 热Key名。 type String 热Key类型。 command String 热Key命令。 qps Integer 热Key QPS。 db_id Integer 热key所在的DB。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 URI样例 PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/41409e5a49ee467287d738b9b6d0adcbin12/high-risk-commands 修改高危命令 { "commands" : [ { "origin_name" : "keys", "name" : "newKeys" }, { "origin_name" : "flushdb", "name" : "newFlushdb" }, { "origin_name" : "flushall", "name" : "newFlushall" }, { "origin_name" : "hgetall", "name" : "newHgetall" }, { "origin_name" : "hkeys", "name" : "newHkeys" }, { "origin_name" : "hvals", "name" : "newHvals" }, { "origin_name" : "smembers", "name" : "newSmembers" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 commands 是 Array of objects 高危命令与对应重命名命令。详情请参考表4。 表4 CommandInfo 参数 是否必选 参数类型 描述 origin_name 是 String 原高危命令，当前支持的有：keys、flushdb、flushall、hgetall、hkeys、hvals、smembers name 是 String 当前生效的命令名称，当为空时表示命令禁用，允许修改为30个字符以内数字、字母和下划线的组合 最小长度：0 最大长度：30

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 commands Array of objects 高危命令与对应重命名命令。详情请参考表4 CommandInfo。 表4 CommandInfo 参数 参数类型 描述 origin_name String 原高危命令，当前支持的有：keys、flushdb、flushall、hgetall、hkeys、hvals、smembers name String 当前生效的命令名称，当为空时表示命令禁用，允许修改为30个字符以内数字、大写字母、小写字母和下划线的组合。 最小长度：0 最大长度：30

响应示例 状态码： 200 Success { "commands" : [ { "origin_name" : "keys", "name" : "newKeys" }, { "origin_name" : "flushdb", "name" : "newFlushdb" }, { "origin_name" : "flushall", "name" : "newFlushall" }, { "origin_name" : "hgetall", "name" : "newHgetall" }, { "origin_name" : "hkeys", "name" : "newHkeys" }, { "origin_name" : "hvals", "name" : "newHvals" }, { "origin_name" : "smembers", "name" : "newSmembers" } ] }

请求示例 URI样例 DELETE https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/nodes/784b3fb7bac14bc490659950dd4f022fno12/sessions 删除"1131"和"2323"的会话 { "is_all" : false, "session_ids" : [ "1131", "2323" ] }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 is_all 是 Boolean 参数解释： 是否删除全部会话。 约束限制： 不涉及。 取值范围： true，表示全部关闭。 false，表示非全部关闭。 默认取值： 不涉及。 session_ids 否 Array of strings 参数解释： 需要删除的会话id。is_all为false的时候，session_ids为必填，不能为空。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 状态码： 200 Success { "total_connection_count" : 10, "active_connection_count" : 5, "top_source_ips" : [ { "client_ip" : "127.0.0.1", "connection_count" : 10 }, { "client_ip" : "192.10.14.1", "connection_count" : 9 } ], "top_dbs" : [ { "db" : "12", "connection_count" : 10 }, { "db" : "14", "connection_count" : 8 } ] }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_connection_count Integer 参数解释： 总客户端连接数。 取值范围： 不涉及。 active_connection_count Integer 参数解释： 活跃客户端连接数。 取值范围： 不涉及。 top_source_ips Array of objects 参数解释： 节点连接的各个客户端连接数汇总，从大到小取前十个，最多十个，展示客户端的ip地址和连接总数。详情请参考表4。 取值范围： 不涉及。 top_dbs Array of objects 参数解释： 节点各数据库连接的客户端的ip和该ip连接节点的连接数，按连接数从高到低取前十个，最多十个。详情请参考表5。 取值范围： 不涉及。 表4 SourceTopConnection 参数 参数类型 描述 client_ip String 参数解释： 客户端ip地址。 取值范围： 不涉及。 connection_count Integer 参数解释： 客户端连接数。 取值范围： 不涉及。 表5 TopDbConnection 参数 参数类型 描述 db String 参数解释： redis数据库id。 取值范围： 不涉及。 connection_count Integer 参数解释： 客户端连接数。 取值范围： 不涉及。

响应示例 状态码： 200 Success { "total_count" : 100, "sessions" : [ { "addr" : "127.0.0.1:8080", "id" : "254487", "name" : "cli", "cmd" : "get", "age" : "8888581", "idle" : "8888581", "db" : "0", "fd" : "1311", "sub" : "0", "psub" : "0", "multi" : "-1" } ] }

URI GET https://{Endpoint}/v3/{project_id}/redis/nodes/{node_id}/sessions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 node_id 是 String 参数解释： 节点ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 索引位置，偏移量。 约束限制： 不涉及。 取值范围： 大于或等于0。 默认取值： 默认为0，表示从最新创建的实例节点连接开始查询。 limit 否 Integer 参数解释： 分页查询页数。 约束限制： 最大100条。 取值范围： 1-100。 默认取值： 不传该参数时，默认每页50条实例节点连接信息。 addr_prefix 否 String 参数解释： 用户端地址前缀匹配字符串。约束限制： 完整的地址由ip和端口号组成。 取值范围： 不涉及。 默认取值： 不传则默认查询所有。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 sessions Array of objects 参数解释： 实例会话详细信息列表。详情请参考表5。 取值范围： 不涉及。 total_count Integer 参数解释： 符合查询条件的总会话数。 取值范围： 不涉及。 表5 InstanceSession 参数 参数类型 描述 addr String 参数解释： 客户端IP地址和端口。 取值范围： 不涉及。 id String 参数解释： 客户端ID。 取值范围： 不涉及。 name String 参数解释： 客户端名称（由CLIENT SETNAME命令设定）。 取值范围： 不涉及。 cmd String 参数解释： 最近一次执行的命令。 取值范围： 不涉及。 age String 参数解释： 客户端连接建立时长（单位：秒）。 取值范围： 不涉及。 idle String 参数解释： 客户端连接空闲时长（单位：秒）。 取值范围： 不涉及。 db String 参数解释： 当前访问的子库DB ID。 取值范围： 不涉及。 fd String 参数解释： socket套接字所使用的文件描述符。 取值范围： 不涉及。 sub String 参数解释： pub/sub已订阅的频道数量。 取值范围： 不涉及。 psub String 参数解释： pub/sub批量订阅的频道数量。 取值范围： 不涉及。 multi String 参数解释： 单次MULTI/EXEC事务中包含的命令数量。 取值范围： 不涉及。

接口约束 该接口支持如下数据库实例： GeminiDB Cassandra包年/包月实例和按需计费实例 GeminiDB Redis包年/包月实例和按需计费实例 GeminiDB Mongo包年/包月实例和按需计费实例 GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关，如果目标结果无法满足实例运行所需的磁盘大小，将无法缩容节点。 GeminiDB Mongo仅支持缩容只读节点。 该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 num 否 Integer 参数解释： 随机缩减的节点数量。 说明： 如果客户端采用直连节点方式，不推荐使用随机节点缩容。 约束限制： 数值类型。 取值范围： GeminiDB Cassandra实例该字段取值为1~10。 GeminiDB Redis该字段取值为1。 默认取值： 不涉及。 node_list 否 Array of strings 参数解释： 指定缩容节点的ID，且该节点必须支持节点缩容。如果该字段不传指定缩减的节点ID，将根据系统内部策略缩减指定个数的节点。 约束限制： num与node_list必须有一个字段传值。 如果node_list传值时，GeminiDB Cassandra长度必须为1~10，GeminiDB Redis长度必须为1。 如果num与node_list同时传值时，则以node_list的值为主。 如果node_list取值为空时，缩容以随机节点缩容进行；node_list字段取值不为空，缩容以指定节点ID进行。 节点缩容前，请避免直连节点，以防该节点缩容导致业务中断。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node 缩容1个实例节点 { "num" : 1, "node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ] }

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

接口约束 该接口支持如下数据库实例： GeminiDB Cassandra GeminiDB Mongo GeminiDB Influx GeminiDB Redis GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关，如果目标结果无法满足实例运行所需的磁盘大小，将无法扩容节点。 该接口既支持包周期实例，也支持按需实例。 GeminiDB Influx单节点实例不支持节点扩容。 GeminiDB Mongo仅支持扩容只读节点。 该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 num 是 Integer 参数解释： 新增加的节点数量。 约束限制： 取值为正整数。 取值范围： 不涉及。 默认取值： 不涉及。 subnet_id 否 String 参数解释： 扩容的节点所使用的子网的ID。 约束限制： 该参数只支持GeminiDB Cassandra数据库实例扩容节点时传入。 所传入的子网ID必须属于实例当前所在的VPC。 不传该参数时，系统会为当前扩容的节点选择一个IP容量较为充足的子网。 取值范围： 不涉及。 默认取值： 不涉及。 is_auto_pay 否 String 参数解释： 创建包周期实例时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 约束限制： 不涉及。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 默认取值： false

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 参数解释： 待扩容到的磁盘容量。 约束限制： 取值为整数，并且大于当前磁盘容量。 取值范围： 磁盘容量最大值的大小与所选接口类型以及规格相关。 GeminiDB Cassandra请参见数据库实例规格。 GeminiDB Mongo请参见数据库实例规格。 GeminiDB Influx请参见数据库实例规格。 GeminiDB Redis请参见数据库实例规格。 默认取值： 不涉及。 is_auto_pay 否 String 参数解释： 创建包周期实例时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 约束限制： 不涉及。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 默认取值： false。

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版本信息 查询数据库版本信息 查询指定实例类型的数据库版本信息。 查询所有实例规格信息 查询指定条件下的所有实例规格信息。 实例管理 包括创建实例、删除实例、查询实例列表、扩容实例存储容量、扩容集群实例的节点数量、缩容集群实例的节点数量、变更实例规格、修改实例管理员密码、修改实例名称和变更实例安全组接口。 备份和恢复 包括查询自动备份策略、设置自动备份策略接口。 参数管理 包括获取参数模板列表、创建参数模板、修改参数模板的参数、应用参数模板、修改指定实例的参数、获取指定实例的参数、获取指定参数模板的参数、删除参数模板接口。 账号管理 包括创建数据库账号、修改数据库账号权限、修改数据库账号密码、删除数据库账号、获取数据库账号列表和详情、获取实例数据库列表。 标签管理 包括查询资源实例、批量添加或删除资源标签、查询资源标签接口。 日志管理 包括查询数据库慢日志接口。 配额管理 包括查询配额 容灾管理 包括校验实例是否可以与指定实例建立/解除容灾关系、搭建实例与特定实例的容灾关系、解除实例与指定实例的容灾关系。