查询实例容灾切换的故障节点比例 - QueryingthePercentageofFaultyNodestoBeTakenOver

功能介绍

查询实例容灾切换的故障节点比例。

接口约束

该接口支持GeminiDB Cassandra 数据库实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:listDisasterSettings
List
-
-
nosql:dr:listDisasterRecoverySettings
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbfornosql:instance:listDisasterSettings	List	-	-	nosql:dr:listDisasterRecoverySettings	-

URI

GET /v3/{project_id}/instances/disaster-recovery/settings

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一region下的project ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
instance_id	否	String	实例ID。
offset	否	Integer	索引位置偏移量，表示从指定offset条数据后查询对应的实例信息。取值大于或等于0。不传该参数时，查询偏移量默认为0。
limit	否	Integer	查询实例个数上限值。取值范围：1~50。不传该参数时，默认查询50条实例信息。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
disaster_recovery_settings	Array of SwitchoverRatio objects	容灾切换的故障节点比例列表。
total_count	Integer	总记录数。

表5 SwitchoverRatio
参数	参数类型	描述
instance_id	String	实例ID。
switchover_ratio	Integer	容灾切换的故障节点比例，下限是50，步长是10，最大是100，默认为100。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误消息。

状态码： 500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

默认查询50个实例容灾切换的故障节点比例。

GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings

查询实例容灾切换的故障节点比例。

GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings?offset=0&limit=50&instance_id=d74162b942604190b991d1c39772a66ain06&instance_id=e74162b942604190b991d1c39772a66ain06

响应示例

状态码： 200

Success.

{ 
  "total_count" : 2, 
  "disaster_recovery_settings" : [ { 
    "instance_id" : "d74162b942604190b991d1c39772a66ain06", 
    "switchover_ratio" : 50 
  }, { 
    "instance_id" : "e74162b942604190b991d1c39772a66ain06", 
    "switchover_ratio" : 100 
  } ] 
}