开发者社区 问答 正文

API参考 - API参考 -   网络管理 - DescribeDBInstanceNetInfo






描述

该接口用于查看指定实例的所有连接信息。

请求参数

[tr=rgb(51, 205, 229)][td]名称 类型是否必须描述ActionString是系统规定参数,取值为DescribeDBInstanceNetInfo。DBInstanceIdString是单个实例名。ConnectionStringTypeString否查询连接串类型:
  • Normal:查询普通连接
  • ReadWriteSplitting:查询读写分离连接
  • 不传则返回所有连接:


返回参数

[tr=rgb(51, 205, 229)][td]名称 类型描述<公共返回参数>详见公共参数。DBInstanceNetInfosList<DBInstanceNetInfo>实例的连接信息。InstanceNetworkTypeString
  • Classic:经典网络。
  • VPC:VPC网络


DBInstanceNetInfo

[tr=rgb(51, 205, 229)][td]名称 类型描述ConnectionStringStringDNS连接串。IPAddressStringIP地址。IPTypeString
  • 经典网络类型的实例IPType为:Inner、Public;
  • VPC类型的实例IPType为:Private、Public。
PortString端口信息。VPCIdStringVPC ID。VSwitchIdStringVSwitch ID,多个值用英文逗号“,”隔开。ConnectionStringTypeString连接串类型:
  • Normal:普通连接地址
  • ReadWriteSplitting:读写分离地址
MaxDelayTimeString最大延迟时长阈值,读写分离链路时返回该参数。超过该时长的只读不分配流量,单位是秒。DistributionTypeString读请求分配策略,仅在读写分离链路返回该参数:
  • Standard:指按规格自动分配权重
  • Custom:指自定义分配权重
DBInstanceWeightsList实例权重信息,只有读写分离链路返回该参数。

DBInstanceWeight

[tr=rgb(51, 205, 229)][td]名称 类型描述DBInstanceIdString实例ID。DBInstanceTypeString实例类型:
  • Master:主实例
  • Readonly:只读实例
WeightString实例当前权重。[tr=rgb(239, 251, 255)][td]Availability String实例可用状态:
  • Unavailable:不可用
  • Available:可用

展开
收起
梨好橙 2018-09-14 00:48:11 1516 分享 版权
阿里云 AI 助理回答

要查询指定阿里云RDS实例的所有连接信息,您需要调用DescribeDBInstanceNetInfo接口。以下是该操作的详细说明和参数要求:

请求参数

  • Action: 必填,系统规定参数,固定取值为DescribeDBInstanceNetInfo
  • DBInstanceId: 必填,指定单个RDS实例的ID。
  • ConnectionStringType: 可选,查询连接串类型:
    • Normal:查询普通连接地址。
    • ReadWriteSplitting:查询读写分离连接地址。 不传此参数则返回所有类型的连接信息。

返回参数

基础返回信息

  • DBInstanceNetInfos: 实例的连接信息列表。
  • InstanceNetworkType: 实例网络类型,可为:
    • Classic:经典网络。
    • VPC:VPC网络。

DBInstanceNetInfo详情

  • ConnectionString: DNS连接字符串。
  • IPAddress: IP地址。
  • IPType: IP类型,根据网络类型不同分为:
    • 经典网络:Inner, Public
    • VPC网络:Private, Public
  • Port: 端口信息。
  • VPCId: VPC ID。
  • VSwitchId: VSwitch ID,多值时以英文逗号分隔。
  • ConnectionStringType: 连接串类型,可为:
    • Normal:普通连接地址。
    • ReadWriteSplitting:读写分离地址。
  • MaxDelayTime: 仅在读写分离链路时返回,表示最大延迟时长阈值,超过该时长的只读实例不分配流量,单位为秒。
  • DistributionType: 仅在读写分离链路返回,表示读请求分配策略:
    • Standard:按规格自动分配权重。
    • Custom:自定义分配权重。
  • DBInstanceWeightsList: 实例权重信息列表,仅在读写分离链路返回。
    • DBInstanceId: 实例ID。
    • DBInstanceType: 实例类型,如Master(主实例)、Readonly(只读实例)。
    • Weight: 实例当前权重。
    • Availability: 实例可用状态,如Unavailable(不可用)、Available(可用)。

通过上述参数配置与返回信息,您可以全面了解指定RDS实例的连接详情,包括但不限于连接地址、IP类型、端口以及特定于读写分离配置的高级属性。

请确保在调用接口前已获取到正确的DBInstanceId,并根据实际需求选择是否指定ConnectionStringType来过滤连接信息类型。


注:角标引用的知识库资料为[1]至[5],代表提供的参考资料编号。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答