全部产品
Search

搜索本产品

    云数据库 Tair（兼容 Redis®）：DescribeDBInstanceNetInfo - 查看实例的网络信息

    文档中心

    云数据库 Tair（兼容 Redis®）：DescribeDBInstanceNetInfo - 查看实例的网络信息

    更新时间：Nov 08, 2024

    查看云数据库 Tair（兼容 Redis）实例的网络信息。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    kvstore:DescribeDBInstanceNetInfoget
    • DBInstance
      acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    实例 ID。

    		r-bp1zxszhcgatnx****

    返回参数

    名称类型描述示例值
    object
    InstanceNetworkTypestring

    网络类型，返回值：

    • CLASSIC：经典网络。
    • VPC：专有网络。
    		CLASSIC
    RequestIdstring

    请求 ID。

    		FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B
    NetInfoItemsarray<object>

    实例的网络信息列表。

    InstanceNetInfoobject

    实例的网络信息列表。

    DirectConnectioninteger

    是否为直连地址，返回值：

    • 0：非直连地址。
    • 1：直连地址。
    		0
    VSwitchIdstring

    虚拟交换机的 ID。

    		vsw-bp1e7clcw529l773d****
    DBInstanceNetTypestring

    该网络信息所属的网络类型：

    • 0：公网。
    • 1：经典网络。
    • 2：专有网络。
    		1
    Upgradeablestring

    经典网络连接地址的过期时间，即剩余有效时间，单位为秒。

    说明 0 表示不会过期。
    		0
    ExpiredTimestring

    实例经典网络地址的有效时间，单位：秒。

    		5183778
    ConnectionStringstring

    实例的连接地址。

    		r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
    IPTypestring

    IP 地址的网络类型，返回值：

    • Public：公网。
    • Inner：经典网络。
    • Private：VPC 网络。
    		Inner
    VPCInstanceIdstring

    实例 ID。

    		r-bp1ky7j6qc7umk****
    Portstring

    实例的服务端口。

    		6379
    VPCIdstring

    实例所属的专有网络（VPC）的 ID。

    		vpc-bp1nme44gek34slfc****
    IPAddressstring

    IP 地址。

    		172.16.49.***
    IsSlaveProxyinteger

    表示该地址为备可用区的连接地址，取值为 1，表示备可用区。

    说明 该地址仅在开通多可用区读写分离架构后返回。
    		1

    示例

    正常返回示例

    JSON格式

    {
  "InstanceNetworkType": "CLASSIC",
  "RequestId": "FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B",
  "NetInfoItems": {
    "InstanceNetInfo": [
      {
        "DirectConnection": 0,
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "DBInstanceNetType": "1",
        "Upgradeable": "0",
        "ExpiredTime": "5183778",
        "ConnectionString": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "IPType": "Inner",
        "VPCInstanceId": "r-bp1ky7j6qc7umk****",
        "Port": "6379",
        "VPCId": "vpc-bp1nme44gek34slfc****",
        "IPAddress": "172.16.49.***",
        "IsSlaveProxy": 1
      }
    ]
  }
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-12-27OpenAPI 返回结构发生变更查看变更详情
    2022-07-27OpenAPI 错误码发生变更查看变更详情