该接口用于查看RDS实例的拓扑结构。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:GetDBInstanceTopology | Read |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| Code | string |
内部参数，无需关注。 |
None |
| Message | string |
内部参数，无需关注。 |
None |
| RequestId | string |
请求ID。 |
7430AB1A-6D49-5B6D-B9E5-920250076074 |
| Data | object |
拓扑结构详情。 |
|
| DBInstanceName | string |
实例ID。 |
rm-m5ezban**** |
| Connections | object [] |
实例的网络连接信息列表。 |
|
| ZoneId | string |
可用区ID。 |
cn-qingdao-c |
| DBInstanceName | string |
实例ID。 |
rm-m5ezban**** |
| ConnectionString | string |
数据库连接地址。 |
rm-m5ezban****mysql.rds.aliyuncs.com |
| NetType | string |
实例的网络连接地址类型。取值：
|
vpc |
| Nodes | object [] |
节点列表。 |
|
| DBInstanceName | string |
实例ID。 |
rm-m5ezban**** |
| ZoneId | string |
可用区ID。 |
cn-qingdao-c |
| DedicatedHostId | string |
专属集群内的主机ID。 说明 | i-bp**** |
| Role | string | 节点类型。返回值：
|
master |
| NodeId | string |
实例的唯一标识。 说明 | 349054 |
| DedicatedHostGroupId | string | 专属集群ID。 说明 | dhg-4n**** |
示例
正常返回示例
JSON格式
{
"Code": "None",
"Message": "None",
"RequestId": "7430AB1A-6D49-5B6D-B9E5-920250076074",
"Data": {
"DBInstanceName": "rm-m5ezban****",
"Connections": [
{
"ZoneId": "cn-qingdao-c",
"DBInstanceName": "rm-m5ezban****",
"ConnectionString": "rm-m5ezban****mysql.rds.aliyuncs.com",
"NetType": "vpc"
}
],
"Nodes": [
{
"DBInstanceName": "rm-m5ezban****",
"ZoneId": "cn-qingdao-c",
"DedicatedHostId": "i-bp****",
"Role": "master",
"NodeId": "349054",
"DedicatedHostGroupId": "dhg-4n****"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidAction | Specified action is not valid. | 不支持当前操作。 |
| 403 | DBInstanceStatusNotActive | The status of the current instance is not active. | 操作失败，请检查实例运行状态。 |
| 403 | DBTypeNotSupported | The database type is not supported. | 不支持数据库类型 |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败，该实例状态下不支持此操作。 |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例，请检查实例的正确性。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
||||||||||
| 2022-06-13 | 新增 OpenAPI | 看变更集 |
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：http://www.yunxiaoer.com/154051.html