查询实例 Endpoint 信息。
接口说明
背景信息
您已经创建了RDS MySQL集群版实例。
仅支持RDS MySQL集群版实例。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDBInstanceEndpoints | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 该参数用于保证请求的幂等性，防止重复提交请求。参数值由客户端生成，保证在不同请求间唯一。 该参数值由ASCII字符组成，最长不超过64个字符，不能包含非ASCII字符。 | ETnLKlblzczshOTUbOC**** |
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances查询。 | rm-u**** |
| DBInstanceEndpointId | string | 否 | 实例的Endpoint ID。 未传该参数表示返回所有Endpoint信息。 | ep-****-ro |
返回参数
示例
正常返回示例
JSON格式
{
"Data": {
"DBInstanceName": "rm-u****",
"IpVersion": "ipv4",
"DBInstanceEndpoints": {
"DBInstanceEndpoint": [
{
"EndpointId": "ep-****",
"EndpointType": "Readonly",
"EndpointDescription": "for readonly business",
"NodeItems": {
"NodeItem": [
{
"NodeId": "rn-****13p6tum4289h",
"DBInstanceId": "rm-u****",
"Weight": 50
}
]
},
"AddressItems": {
"AddressItem": [
{
"VpcId": "vpc-bp17xdic25d****",
"VSwitchId": "vsw-bp12u14ecz****",
"IpType": "Private",
"Port": "3306",
"ConnectionString": "rm****.mysql.rds.aliyuncs.com",
"IpAddress": "10.71.XX.XX"
}
]
}
}
]
}
},
"RequestId": "777C4593-8053-427B-****105593277CAB"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | APICallingFailed | Meta db calling failed. | API调用异常。 |
| 400 | InvalidSourceCategory | specified source category is invalid. | 指定的源类别无效。 |
| 400 | InvalidDBInstanceConnType.Format | Specified DB instance conn type is not valid. | 操作失败，当前数据库实例的连接类型不支持此操作。 |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | 子账号权限不足，请先获取授权。 |
| 400 | InvalidEngineVersion.NotSupport | The specified parameter "EngineVersion" is not valid. | 无效的引擎版本参数。请重新设置：MySQL：5.5/5.6/5.7；SQLServer：2008r2/2012；PostgreSQL：9.4；PPAS：9.3。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 实例状态非运行中 |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败，实例处于锁定状态。 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-05-09 | OpenAPI 错误码发生变更 | |||||||||
|