文档平台 API 中心 私有网络 私有网络 API 2017 私有网络相关接口 查询私有网络和基础网络云主机互通

查询私有网络和基础网络云主机互通

最近更新时间:2018-08-24 10:01:05

1. 接口描述

本接口(DescribeVpcClassicLink)用于查询私有网络和基础网络云服务器互通。
接口请求域名:vpc.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为DescribeVpcClassicLink。

参数名称 是否必选 类型 描述
vpcId String 系统分配的私有网络ID,支持升级前的vpcId,也支持升级后的unVpcId,例如:vpc-dgd5454。
classicLinkId String vpc与基础网络云服务器互通ID,例如:vcx-opgnzgo9。
lanIp String 云服务器内网IP。
offset Int 初始行的偏移量,默认为0。
limit Int 每页行数,默认为20,最大支持50。
orderField String 按某个字段排序,默认不排序。支持字段:createTime。
orderDirection String 升序(asc)或降序(desc),默认:desc。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
totalCount Int 返回的互通总数量。
data.n Array 返回信息详情。
data.n.lanIp String 腾讯云服务器内网ip地址。
data.n.unVpcId String 系统分配的vpc统一ID,由vpcId升级而来,为了兼容这两种ID系统都支持,推荐使用统一ID,示例:vpc-2ari9m7h。
data.n.vpcId String 系统分配的私有网络ID,例如:gz_vpc_15。
data.n.classicLinkId String 系统分配的互通ID,例如:vcx-opgnzgo9。
data.n.createTime String 创建时间,例如:2016-01-21 14:59:37。
data.n.instanceId String 腾讯云服务器统一ID,例如:ins-xxd51df。
data.n.instanceName String 腾讯云服务器名称。

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见VPC错误码

错误码 描述
InvalidLanIp.NotFound 云服务器不存在,请核实您填写的lanIp是否正确,查询VPC下云服务器详见查看云服务器实例列表
InvalidVpc.NotFound 无效的VPC。VPC资源不存在,请再次核实您输入的资源信息是否正确。

5. 示例

输入


  https://vpc.api.qcloud.com/v2/index.php?Action=DescribeVpcClassicLink
    &<公共请求参数>
    &vpcId=vpc-2ari9m7h
    &classicLinkId=vcx-df454d

输出


{
    "code": 0,
    "message": "",
        "totalCount":"1",
        "data":[
        {
            "lanIp":"10.232.18.145",
            "uniqVpcId":"vpc-8e0ypm3z",
            "vpcId":"gz_vpc_245",
            "classicLinkId":"vcx-opgnzgo9",
            "createTime":"2016-01-21 14:59:37",
            "instanceId":"ins-d1o128ru",
            "instanceName":"未命名"
        }
    ]
}