路由表相关接口API文档

Size: px

Start display at page:

Download "路由表相关接口API文档"

寒金
5 years ago
Views:

1 私有网络路由表相关接口 API 文档

2 版权声明腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品服务的当时的整体概况, 部分产品服务的内容可能有所调整您所购买的腾讯云产品服务的种类服务标准等应由您与腾讯云之间的商业合同约定, 除非双方另有约定, 否则, 腾讯云对本文档内容不做任何明示或模式的承诺或保证第 2 页共 28 页

3 文档目录文档声明... 2 创建路由表... 4 删除路由表... 8 修改路由表查询路由表修改子网关联的路由表添加路由策略删除路由策略第 3 页共 28 页

4 创建路由表 1. 接口描述本接口 (CreateRouteTable) 用于创建路由表接口请求域名 :vpc.api.qcloud.com 创建了 VPC 后, 系统会创建一个默认路由表, 所有新建的子网都会关联到默认路由表默认情况下您可以直接使用默认路由表来管理您的路由策略当您的路由策略较多时, 您可以调用创建路由表接口创建更多路由表管理您的路由策略 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 CreateRouteTable 参数名称是否必选类型描述 vpcid 是 String 子网所属的私有网络 ID 值, 可使用 vpcid 或 unvpcid, 建议使用 unvpcid, 例如 : vp c- rqnday hs 可通过 DescribeVpcEx 接口查询 routetablename 是 String 路由表名称, 取值 :1-25 个中文英文大小写的字母数字和下划线分隔符, 同一个 VPC 下名称不可重复 routeset.n 否 array 路由表内容, 可选项 routeset.n.destinationcid是 String 目的网段, 取值不能在私有 rblock 网络网段内, 例如 : /24 第 4 页共 28 页

5 参数名称是否必选类型描述 routeset.n.nexttype 是 String 下一跳类型, 目前我们支持的类型有 :0: 公网网关 ; 1:vpn 网关 ; 3: 专线网关 ;4: 对等连接 ;7:sslv pn 网关 ;8:nat 网关 routeset.n.nexthub 是 String 下一跳地址, 这里只需要指定不同下一跳类型的网关 ID ( 推荐使用新 ID), 系统会自动匹配到下一跳地址 3. 输出参数参数名称类型描述 code Int 错误码,0: 成功, 其他值 : 失败 message String 错误信息 routetableid String 路由表 ID, 例如 :gz_rtb_4545 unroutetableid String 路由表统一 ID, 建议使用统一 ID 标识路由表, 例如 :rtb-rqndayhs routetableset.n Array 路由表内容 routetableset.n.destinationcidrbl String ock 目的网段, 取值不能在私有网络网段内, 例如 : /24 routetableset.n.nexttype String 下一跳类型, 目前我们支持的类型有 :0: 公网网关 ;1:vpn 网关 ; 3: 专线网关 ;4: 对等连接 ;7:sslvpn ;8:nat 网关 routetableset.n.nexthub String 下一跳地址, 这里只需要指定不同下一跳类型的网关 ID( 推荐使用新 ID), 系统会自动匹配到下一跳地址 4. 错误码表以下错误码表仅列出了该接口的业务逻辑错误码, 更多公共错误码详见 VPC 错误码第 5 页共 28 页

6 错误码 InvalidVpc.NotFound 描述无效的 VPC VPC 资源不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeVpcEx 接口查询 VPC InvalidRouteTableName 路由表名称不合法路由表名称取值范围 :1-60 个中文英文大小写的字母数字和下划线分隔符 InvalidRouteTableName.InUse 路由表名字已被 VPC 下其他路由表使用同一个 vpc 内路由表名称不能重复 InvalidDestinationCidr RouteTableLimitExceeded 目标网段不合法创建的路由表数量超过上限如果需要更多资源, 请联系客服申请更多 VPC 资源限制信息详见 VPC 使用限制 RouteLimitExceeded 路由表策略数超过上限如果需要更多资源, 请联系客服申请更多 VPC 资源限制信息详见 VPC 使用限制 RouteAlreadyExists 目标网段在路由表策略中已存在同一个路由表里策略中, 目标网段不能冲突 InvalidRouteNextType InvalidRouteNextHub.NotFound 无效的下一跳类型可以支持的类型详见入参说明下一跳地址不存在请核实您填写的下一跳地址资源 ID 是否正确 5. 示例输入 &< 公共请求参数 > &vpcid=vpc-amhnnao5 &routetablename=tttt111 &routeset.0.destinationcidrblock= /16 &routeset.0.nexttype=1 &routeset.0.nexthub=vpngw-dystbrkv 输出第 6 页共 28 页

7 "code": 0, "message": "", "routetableid": "gz_rtb_8755", "unroutetableid": "rtb-rqndayhs", "routetableset": [ "destinationcidrblock": " \/16", "nexttype": 1, "nexthub": "vpngw-dystbrkv" ] 第 7 页共 28 页

8 删除路由表 1. 接口描述本接口 (DeleteRouteTable) 用于删除路由表接口请求域名 :vpc.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 DeleteRouteTable 参数名称是否必选类型描述 vpcid 是 String 子网所属的私有网络 ID 值, 可使用 vpcid 或 unvpcid, 建议使用 unvpcid, 例如 : vp c- rqnday hs 可通过 DescribeVpcEx 接口查询 routetableid 是 String 系统分配的路由表 ID 值, 可使用 routetableid 或 unro utetableid, 建议使用 unr outetableid, 例如 :rtbrqnday hs 可通过 DescribeRouteTable 接口查询 3. 输出参数参数名称类型描述第 8 页共 28 页

9 参数名称类型描述 code Int 错误码,0: 成功, 其他值 : 失败 message String 错误信息 4. 错误码表以下错误码表仅列出了该接口的业务逻辑错误码, 更多公共错误码详见 VPC 错误码错误码 InvalidVpc.NotFound 描述无效的 VPC VPC 资源不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeVpcEx 接口查询 VPC InvalidRouteTableId.NotFound 无效的路由表路由表 ID 不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeRouteTable 接口查询 5. 示例输入 &< 公共请求参数 > &vpcid=vpc-amhnnao5 &routetableid=rtb-4ahe1qy2 输出 "code": 0, "message": "" 第 9 页共 28 页

10 修改路由表 1. 接口描述本接口 (ModifyRouteTableAttribute) 用于修改路由表属性接口请求域名 :vpc.api.qcloud.com 修改路由表后会用新提交的内容全量替换原有的路由表内容用户需要新增路由策略时请将原有内容一并提交 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 ModifyRouteTableAttribute 参数名称是否必选类型描述 vpcid 是 String 子网所属的私有网络 ID 值, 可使用 vpcid 或 unvpcid, 建议使用 unvpcid, 例如 : vp c- rqnday hs 可通过 DescribeVpcEx 接口查询 routetableid 是 String 系统分配的路由表 ID 值, 可使用 routetableid 或 unro utetableid, 建议使用 unr outetableid, 例如 :rtbrqnday hs 可通过 DescribeRouteTable 接口查询 routetablename 是 String 路由表名称, 取值 :1-25 第 10 页共 28 页

11 参数名称是否必选类型描述个中文英文大小写的字母数字和下划线分隔符, 同一个 VPC 下名称不可重复 routeset.n 否 array 路由表内容, 可选项 routeset.n.destinationcid是 String 目的网段, 取值不能在私有 rblock 网络网段内, 例如 : /24 routeset.n.nexttype 是 String 下一跳类型, 目前我们支持的类型有 :0: 公网网关 ; 1:vpn 网关 ; 3: 专线网关 ;4: 对等连接 ;7:sslv pn;8:nat 网关 routeset.n.nexthub 是 String 下一跳地址, 这里只需要指定不同下一跳类型的网关 ID ( 推荐使用新 ID), 系统会自动匹配到下一跳地址 3. 输出参数参数名称类型描述 code Int 错误码,0: 成功, 其他值 : 失败 message String 错误信息 4. 错误码表以下错误码表仅列出了该接口的业务逻辑错误码, 更多公共错误码详见 VPC 错误码错误码 InvalidVpc.NotFound 描述无效的 VPC VPC 资源不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeVpcEx 接口查询 VPC InvalidRouteTableId.NotFound 无效的路由表路由表 ID 不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeRouteTable 第 11 页共 28 页

12 错误码描述接口查询 InvalidRouteTableName 路由表名称不合法路由表名称取值范围 :1-60 个中文英文大小写的字母数字和下划线分隔符 InvalidRouteTableName.InUse 路由表名字已被 VPC 下其他路由表使用同一个 VPC 内路由表名称不能重复 RouteLimitExceeded 路由表策略数超过上限如果需要更多资源, 请联系客服申请更多 vpc 资源限制信息详见 VPC 使用限制 RouteAlreadyExists 目标网段在路由表策略中已存在同一个路由表里策略中, 目标网段不能冲突 InvalidRouteNextType InvalidRouteNextHub.NotFound 无效的下一跳类型可以支持的类型详见入参说明下一跳地址不存在请核实您填写的下一跳地址资源 ID 是否正确 5. 示例输入 &< 公共请求参数 > &vpcid=vpc-amhnnao5 &routetableid=rtb-8oidkjt2 &routeset.0.destinationcidrblock= /18 &routeset.0.nexttype=1 &routeset.0.nexthub=vpngw-dystbrkv &routetablename=tttt111 输出 "code": 0, "message": "" 第 12 页共 28 页

13 第 13 页共 28 页

14 查询路由表 1. 接口描述本接口 (DescribeRouteTable) 用于查询路由表接口请求域名 :vpc.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 DescribeRouteTable 参数名称是否必选类型描述 vpcid 否 String 子网所属的私有网络 ID 值, 可使用 vpcid 或 unvpcid, 建议使用 unvpcid, 例如 : vp c-0o x8fuhw 可通过 DescribeVpcEx 接口查询 routetableid 否 String 系统分配的路由表 ID 值, 可使用 routetableid 或 unro utetableid, 建议使用 unr outetableid, 例如 :rtb-0 ox8fuh w 可通过 DescribeRouteTable 接口查询 routetablename 否 String 路由表名, 支持模糊查询 offset 否 Int 初始行的偏移量, 默认为 0 limit 否 Int 每页行数, 默认为 20 第 14 页共 28 页

15 参数名称是否必选类型描述 orderfield 否 String 按某个字段排序, 目前仅支持 createtime,routetable Name 排序, 默认按 create Time 排序 orderdirection 否 String 升序 (asc) 还是降序 (de sc), 默认 :asc 3. 输出参数参数名称类型描述 code Int 错误码,0: 成功, 其他值 : 失败 message String 错误信息 totalcount Int 查询结果中路由总数量 data.n Array 返回的数组 data.n.vpcid String 系统分配的私有网络 ID, 例如 :gz_v pc_8849 data.n.unvpcid String 系统分配的新的私有网络 ID, 建议使用新 ID, 例如 :vpc-0ox8fuhw data.n.routetableid String 系统分配的路由表 ID, 例如 :gz_rtb _8849 data.n.unroutetableid String 系统分配的新的路由表 ID, 建议使用新 ID, 例如 :rtb-0ox8fuhw data.n.routetablename String 路由表名称 data.n.routetabletype Int 路由表类型,0: 默认路由表 ;1: 普通路由表默认路由表和普通路由表的区别详见路由表产品说明 data.n.routetablecreatetime String 路由表创建时间, 例如 : :50:21 data.n.subnetnum Int 关联子网的数量 data.n.routetableset.n Array 路由策略信息数组 routetableset 路由策略信息数组第 15 页共 28 页

16 参数名称类型描述 routetableset.n.destinationcidrbl string ock 目的网段, 取值不能在私有网络网段内, 例如 : /24 routetableset.n.nexttype string 下一跳类型, 目前我们支持的类型有 :0: 公网网关 ;1:vpn 网关 ; 3: 专线网关 ;4: 对等连接 ;7:sslvpn ;8:nat 网关 routetableset.n.nexthub string 下一跳地址, 这里只需要指定不同下一跳类型的网关 ID( 推荐使用新 ID), 系统会自动匹配到下一跳地址 4. 错误码表以下错误码表仅列出了该接口的业务逻辑错误码, 更多公共错误码详见 VPC 错误码错误码 InvalidVpc.NotFound 描述无效的 VPC VPC 资源不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeVpcEx 接口查询 VPC InvalidRouteTableId.NotFound 无效的路由表路由表 ID 不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeRouteTable 接口查询 5. 示例输入 &< 公共请求参数 > &vpcid=vpc-amhnnao5 &routetablename=tttt111 输出第 16 页共 28 页

17 "code": 0, "message": "", "totalcount": 114, "data": [ "vpcid": "gz_vpc_99", "unvpcid": "vpc-amhnnao5", "vpcname": "pan-vpc25", "vpccidrblock": " \/24", "routetablename": "tttt111", "routetableid": "gz_rtb_8755", "unroutetableid": "rtb-rqndayhs", "routetabletype": 0, "subnetnum": 1, "routetablecreatetime": " :50:21", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local", "destinationcidrblock": " \/16", "nexttype": 1, "nexthub": "548" ], "vpcid": "gz_vpc_266", "unvpcid": "vpc-2ari9m7h", "vpcname": "bbbtest", "vpccidrblock": " \/24", 第 17 页共 28 页

18 "routetablename": " 默认 ", "routetableid": "gz_rtb_8751", "unroutetableid": "rtb-ggovmles", "routetabletype": 1, "subnetnum": 0, "routetablecreatetime": " :33:52", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" ], "vpcid": "gz_vpc_64", "unvpcid": "vpc-kd7d06of", "vpcname": "panpan-vpc1", "vpccidrblock": " \/16", "routetablename": "tttt", "routetableid": "gz_rtb_8750", "unroutetableid": "rtb-dy09eb46", "routetabletype": 0, "subnetnum": 0, "routetablecreatetime": " :58:53", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" ], 第 18 页共 28 页

19 "vpcid": "gz_vpc_265", "unvpcid": "vpc-ktom9wg5", "vpcname": "yunapitest", "vpccidrblock": " \/24", "routetablename": " 默认 ", "routetableid": "gz_rtb_8747", "unroutetableid": "rtb-fdyy7v1o", "routetabletype": 1, "subnetnum": 1, "routetablecreatetime": " :10:49", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" ], "vpcid": "gz_vpc_260", "unvpcid": "vpc-r4wc72kt", "vpcname": "oplogtest", "vpccidrblock": " \/24", "routetablename": " 默认 ", "routetableid": "gz_rtb_8738", "unroutetableid": "rtb-cfqwtvs4", "routetabletype": 1, "subnetnum": 1, "routetablecreatetime": " :47:54", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" 第 19 页共 28 页

20 ], "vpcid": "gz_vpc_180", "unvpcid": "vpc-cor5n2a5", "vpcname": "test", "vpccidrblock": " \/24", "routetablename": "default", "routetableid": "gz_rtb_8730", "unroutetableid": "rtb-hrjfw07c", "routetabletype": 1, "subnetnum": 1, "routetablecreatetime": " :11:22", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local", "destinationcidrblock": " \/8", "nexttype": 3, "nexthub": "4245", "destinationcidrblock": " \/24", "nexttype": 3, "nexthub": "4245", "destinationcidrblock": " \/8", "nexttype": 3, "nexthub": "4245" 第 20 页共 28 页

21 ], "vpcid": "gz_vpc_248", "unvpcid": "vpc-ali73gtr", "vpcname": "pan-vpc180", "vpccidrblock": " \/24", "routetablename": " 默认 ", "routetableid": "gz_rtb_8729", "unroutetableid": "rtb-m5es14q4", "routetabletype": 1, "subnetnum": 1, "routetablecreatetime": " :25:51", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" ], "vpcid": "gz_vpc_231", "unvpcid": "vpc-erxok83l", "vpcname": "barry-uniqvpci", "vpccidrblock": " \/24", "routetablename": "apollolan121", "routetableid": "gz_rtb_8724", "unroutetableid": "rtb-5qaib2em", "routetabletype": 0, "subnetnum": 0, "routetablecreatetime": " :50:38", "routeset": [ 第 21 页共 28 页

22 "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" ], "vpcid": "gz_vpc_231", "unvpcid": "vpc-erxok83l", "vpcname": "barry-uniqvpci", "vpccidrblock": " \/24", "routetablename": " 默认 ", "routetableid": "gz_rtb_8720", "unroutetableid": "rtb-3jdtm2uk", "routetabletype": 1, "subnetnum": 1, "routetablecreatetime": " :36:00", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" ], "vpcid": "gz_vpc_174", "unvpcid": "vpc-gaep0rmx", "vpcname": "pan-vpc99", "vpccidrblock": " \/24", "routetablename": " 默认 ", "routetableid": "gz_rtb_481", "unroutetableid": "rtb-d1voj30m", 第 22 页共 28 页

23 "routetabletype": 1, "subnetnum": 1, "routetablecreatetime": " :21:19", "routeset": [ "destinationcidrblock": "Local", "nexttype": 2, "nexthub": "Local" ] ] 第 23 页共 28 页

24 修改子网关联的路由表 1. 接口描述本接口 (AssociateRouteTable) 用于修改子网关联的路由表接口请求域名 :vpc.api.qcloud.com 一个子网只能关联一个路由表 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 AssociateRouteTable 参数名称是否必选类型描述 vpcid 是 String 子网所属的私有网络 ID, 可使用 vpcid 或 unvpcid, 建议使用 unvpcid, 例如 :vp c- amhn nao5 可通过 DescribeVpcEx 接口查询 subnetid 是 String 要删除的子网 ID 值, 可使用 subnetid 或 unsubnetid, 建议使用 unsubnetid, 例如 :subnet-3x5lf5q0 可通过 DescribeSubnetEx 接口查询 routetableid 是 String 系统分配的路由表 ID, 可使用 routetableid 或 unrout etableid, 建议使用 unro utetableid, 例如 :rtb- 第 24 页共 28 页

25 参数名称是否必选类型描述 rqnday hs 可通过 DescribeRouteTable 接口查询 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 4. 错误码表以下错误码表仅列出了该接口的业务逻辑错误码, 更多公共错误码详见 VPC 错误码错误码 InvalidVpc.NotFound 描述无效的 VPC VPC 资源不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeVpcEx 接口查询 VPC InvalidSubnet.NotFound 无效的子网子网资源不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeSubnetEx 接口查询子网 InvalidRouteTableId.NotFound 无效的路由表路由表 ID 不存在, 请再次核实您输入的资源信息是否正确, 可通过 DescribeRouteTable 接口查询 5. 示例输入第 25 页共 28 页

26 &< 公共请求参数 > &vpcid=vpc-amhnnao5 &routetableid=rtb-rqndayhs &subnetid=subnet-3x5lf5q0 输出 "code": 0, "message": "" 第 26 页共 28 页

27 添加路由策略第 27 页共 28 页

28 Powered by TCPDF ( 路由表相关接口 API 文档删除路由策略第 28 页共 28 页

地域相关接口API文档

地域相关接口API文档云服务器地域相关接口 API 文档版权声明 2015-2016 腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品