华为云用户手册

  • 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 失败原因。
  • URI GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances 表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参数 参数 参数类型 描述 slow_log_list Array of SlowlogResult objects 参数解释: 具体信息。 total_record Integer 参数解释: 总记录数。 表5 SlowlogResult 参数 参数类型 描述 time String 参数解释: 执行时间。 database String 参数解释: 所属数据库。 query_sample String 参数解释: 执行语法。 type String 参数解释: 语句类型。 start_time String 参数解释: 发生时间,UTC时间。
  • 请求示例 URI样例 查询数据库慢日志: GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein06/slowlog?start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800 URI样例 根据指定条件查询数据库慢日志: GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/6ade8143870047b8999aba8f1891b48ein06/slowlog?type=SELECT&offset=1&limit=20&node_id=a7c84462483642798cf159237343135fno06&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800
  • 响应示例 状态码: 200 Success { "total_record" : 1, "slow_log_list" : [ { "time" : "513 ms", "database" : "cassandra", "query_sample" : "SELECT * FROM cassandra.sz_user LIMIT 100;", "type" : "SELECT", "start_time" : "2020-11-15T22:49:38.643000Z" } ] }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 instances Array of InstanceResult objects 实例列表。 total_count Integer 总记录数。 表7 InstanceResult 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 tags Array of InstanceTagResult objects 标签列表。如果没有标签,默认为空数组。 表8 InstanceTagResult 参数 参数类型 描述 key String 标签键。最大长度36个unicode字符,key不能为空。 字符集:0-9,A-Z,a-z,“_”,“-”,中文。 value String 标签值。最大长度43个unicode字符,可以为空字符串。 字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。
  • 请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/resource-instances/action 请求体样例 根据实例名称查询实例,索引位置偏移量为100,查询100条数据 { "offset" : 100, "limit" : 100, "action" : "filter", "matches" : [{ "key" : "instance_name", "value" : "test-single" }], "tags" : [{ "key" : "key1", "values" : [ "value1", "value2" ] }] } 查询总记录数 { "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "instance_name", "value" : "test-single" }, { "key" : "instance_id", "value" : "958693039f284d6ebfb177375711072ein06" } ] }
  • 响应示例 状态码: 200 Success { "total_count": 1, "instances" : [{ "instance_id" : "2acbf2223caf3bac3c33c6153423c3ccin06", "instance_name" : "test-single", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] }] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置偏移量,表示从第一条数据偏移offset条数据后开始查询。 “action”值为“count”时,不传该参数。 “action”值为“filter”时,取值必须为数字,不能为负数。默认取0值,表示从第一条数据开始查询。' limit 否 String 查询记录数。 “action”值为“count”时,不传该参数。 “action”值为“filter”时,取值范围:1~100。不传该参数时,默认查询前100条实例信息。 action 是 String 操作标识。 取值为“filter”,表示根据标签过滤条件查询实例。 取值为“count”,表示仅返回总记录数,禁止返回其他字段。 matches 否 Array of MatchOption objects 搜索字段。 该字段值为空,表示不按照实例名称或实例ID查询。 该字段值不为空。 tags 否 Array of TagOption objects 包含标签,最多包含20个key。 表4 MatchOption 参数 是否必选 参数类型 描述 key 是 String 取值为“instance_name”或“instance_id”,分别表示按实例名称或按实例ID匹配查询。 value 是 String 待匹配的实例名称或实例ID。 表5 TagOption 参数 是否必选 参数类型 描述 key 是 String 标签键。最大长度36个unicode字符,key不能为空或者空字符串,不能为空格,校验和使用之前先排除前后半角空格。 说明: 搜索时不对该参数做字符集校验。 values 是 Array of strings 标签值列表。最大长度43个unicode字符,不能为空格,校验和使用之前先排除前后半角空格。 如果values为空列表,则表示查询任意value。value之间为或的关系。
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全