该接口用于查询RDS实例的高可用模式和数据复制方式。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeDBInstanceHAConfig | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | rm-uf6wjk5**** |
返回参数
示例
正常返回示例
JSON
格式
{
"DBInstanceId": "rm-uf6wjk5****",
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"HAMode": "RPO",
"SyncMode": "Sync",
"HostInstanceInfos": {
"NodeInfo": [
{
"LogSyncTime": "2018-05-05T15:15:00Z",
"NodeType": "Master",
"ZoneId": "cn-hangzhou-b",
"SyncStatus": "NotAvailable",
"DataSyncTime": "2018-05-05T15:15:00Z",
"NodeId": "3397027",
"RegionId": "cn-hangzhou"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidConfigName | The ConfigName is not valid. | ConfigName无效。 |
400 | IncorrectEngineVersion | Current DB instance engine version does not support this operation. | 操作失败,当前数据库实例引擎版本不支持此操作。 |
400 | InvalidParameters.Format | Specified parameter is not valid | 操作失败,指定的参数格式不合法。 |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
403 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | 操作失败,当前数据库实例引擎和类型不支持。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2022-06-23 | OpenAPI 描述信息更新 | 看变更集 | ||
|