查询NAT网关绑定的子网

最近更新时间:2019-03-07 10:22:39

功能描述

DescribeBmNatBindSubnets 接口用于查询黑石 NAT 网关绑定的子网信息

接口请求域名:bmvpc.api.qcloud.com

请求

请求示例

GET https://bmvpc.api.qcloud.com/v2/index.php/?Action=DescribeBmNatBindSubnets
    &<公共请求参数>
    &natId=<NAT网关ID>

请求参数

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

参数名称 描述 类型 必选
natId NAT 网关统一 ID,例如:nat-xx454 String

响应

响应示例

{
 "code": 0,
 "message": "",
 "codeDesc": "Success",
 "data": [{
  "natId": "<NAT网关统一ID>",
  "unVpcId": "<VPC统一ID>",
  "vpcId": "<vpc网络ID>",
  "subnets.n.name": "<子网名称>",
  "subnets.n.unSubnetId": "<子网统一ID>",
  "subnets.n.subnetId": "<子网ID>",
  "subnets.n.subnetNatType": "<子网绑定的类型>",
  "subnets.n.cidrBlock": "<子网网段信息>"
 }]
}

响应参数

参数名称 描述 类型
code 错误码, 0: 成功, 其他值: 失败 Int
message 错误信息 String
data.n 查询NAT网关绑定的子网信息数组 Array

data 数据结构如下:

参数名称 描述 类型
data.n.natId NAT网关统一ID,例如:nat-xx454 String
data.n.unVpcId 私有网络统一ID,例如:vpc-xgfd55d String
data.n.vpcId 私有网络ID Int
data.n.subnets.n.name 子网名称 String
data.n.subnets.n.unSubnetId 子网统一ID String
data.n.subnets.n.subnetId 子网ID Int
data.n.subnets.n.subnetNatType 子网绑定的类型, 0表示绑定部分IP的子网,1表示绑定全部IP的子网,2表示绑定CIDR方式的子网 Int
data.n.subnets.n.cidrBlock 子网网段信息 String

错误码

错误代码 英文提示 错误描述
-3047 InvalidBmVpc.NotFound 无效的 VPC。VPC 资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeBmVpcEx 接口查询 VPC。
13014 BmVpcNat.NotFound 无效的 NAT 网关,NAT 网关资源不存在。请再次核实您输入的资源信息是否正确

实际案例

输入

GET https://bmvpc.api.qcloud.com/v2/index.php?
    Action=DescribeBmNatBindSubnets
    &SecretId=AKID1ub7R1JoyBF7nHqjk7IH8nGWaR6Yezwd
    &Nonce=4557
    &Timestamp=1507692902
    &Region=gz
    &natId=nat-axd6t16w
    &Signature=4dq8JXWTyg9n8FuVckaIhg8Pnbw%3D

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "natId": "nat-axd6t16w",
        "unVpcId": "vpc-221ibyxt",
        "vpcId": 101211,
        "subnets": [
            {
                "name": "test",
                "unSubnetId": "subnet-5n0j08b2",
                "subnetId": 858,
                "subnetNatType": 1,
                "cidrBlock": "172.16.128.0/18"
            },
            {
                "name": "nat-test-123",
                "unSubnetId": "subnet-jbrwcpe6",
                "subnetId": 857,
                "subnetNatType": 0,
                "cidrBlock": "172.16.0.0/24"
            }
        ]
    }
}