QingCloud 文档 – VPC 网络 - kaiyun官方网站下载手机网页

QingCloud 文档 – VPC 网络 - kaiyun官方网站下载手机网页 /network/vpc/api/vpc_api/ Recent content in VPC 网络 on QingCloud 文档 Hugo -- gohugo.io Network: CreateRouters /network/vpc/api/vpc_api/create_routers/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/create_routers/ <p>创建一个或多个 VPC 网络。 VPC 网络用于受管私有网络之间互联，并提供 DHCP 服务、端口转发、VPN 隧道服务等功能。</p> <p>该 API 只负责 VPC 网络的创建工作，如果需要通过 VPC 网络将自己名下的受管私有网络连接起来，请查看 <a href="../join_router/"><em>JoinRouter</em></a>。</p> <p>如果需要配置端口转发规则或打开VPN 隧道服务，请查看 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 和 <a href="../update_routers/"><em>UpdateRouters</em></a>。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_name</td> <td>String</td> <td>VPC 网络名称</td> <td>No</td> </tr> <tr> <td>router_type</td> <td>Integer</td> <td>VPC 网络类型: 0 - 中型，1 - 小型，2 - 大型，默认为 1</td> <td>No</td> </tr> <tr> <td>vpc_network</td> <td>String</td> <td>VPC 网络地址范围，目前支持 192.168.0.0/16 或 172.16.0.0/16 。注：此参数只在北京3区需要且是必填参数。</td> <td>No</td> </tr> <tr> <td>count</td> <td>Integer</td> <td>创建 VPC 网络的数量，默认是1</td> <td>No</td> </tr> <tr> <td>security_group</td> <td>String</td> <td>需要加载到 VPC 网络上的防火墙ID</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> <tr> <td>target_user</td> <td>String</td> <td>目标用户 ID ，可用于主账号为其子账号创建资源。</td> <td>No</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>job_id</td> <td>String</td> <td>执行任务的 Job ID</td> </tr> <tr> <td>routers</td> <td>Array</td> <td>新创建的 VPC 网络 ID 列表</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=CreateRouters &router_name=demo &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"CreateRoutersResponse", "ret_code":0, "job_id":"j-i76waodo", "routers":[ "rtr-s5nqo8mr" ] } </code></pre> Network: DescribeRouters /network/vpc/api/vpc_api/describe_routers/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/describe_routers/ <p>获取一个或多个 VPC 网络。</p> <p>可根据 VPC 网络ID，状态， VPC 网络名称作过滤条件，来获取 VPC 网络列表。如果不指定任何过滤条件，默认返回你所拥有的所有 VPC 网络。如果指定不存在的 VPC 网络ID，或非法状态值，则会返回错误信息。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>routers.n</td> <td>String</td> <td>VPC 网络ID</td> <td>No</td> </tr> <tr> <td>vxnet</td> <td>String</td> <td>私用网络ID</td> <td>No</td> </tr> <tr> <td>status.n</td> <td>String</td> <td>VPC 网络状态: pending, active, poweroffed, suspended, deleted, ceased</td> <td>No</td> </tr> <tr> <td>search_word</td> <td>String</td> <td>搜索关键词，支持 VPC 网络ID， VPC 网络名称</td> <td>No</td> </tr> <tr> <td>tags.n</td> <td>String</td> <td>按照标签ID过滤, 只返回已绑定某标签的资源</td> <td>No</td> </tr> <tr> <td>verbose</td> <td>Integer</td> <td>是否返回冗长的信息，若为1，则返回 VPC 网络相关其他资源的详细数据。</td> <td>No</td> </tr> <tr> <td>offset</td> <td>Integer</td> <td>数据偏移量，默认为0</td> <td>No</td> </tr> <tr> <td>limit</td> <td>Integer</td> <td>返回数据长度，默认为20，最大100</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_set</td> <td>Array</td> <td>JSON 格式的 VPC 网络数据列表，每项参数可见下面 <a href="#responseitemtype">ResponseItemType</a></td> </tr> <tr> <td>total_count</td> <td>Integer</td> <td>根据过滤条件得到的 VPC 网络总数</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <p><strong>ResponseItemType</strong></p> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>router_id</td> <td>String</td> <td>VPC 网络ID</td> </tr> <tr> <td>router_name</td> <td>String</td> <td>VPC 网络名称</td> </tr> <tr> <td>description</td> <td>String</td> <td>VPC 网络描述</td> </tr> <tr> <td>router_type</td> <td>Integer</td> <td>VPC 网络类型，目前有效值为 1.</td> </tr> <tr> <td>private_ip</td> <td>String</td> <td>VPC 网络内网IP</td> </tr> <tr> <td>is_applied</td> <td>Integer</td> <td>VPC 网络规则是否已更新，1为已更新，0为还未更新。</td> </tr> <tr> <td>status</td> <td>String</td> <td>VPC 网络状态，有效值为pending, active, poweroffed, suspended, deleted, ceased。<br/>pending：等待被创建<br/>active：运行状态<br/>poweroffed：关闭状态<br/>suspended：由于欠费，已被暂停使用<br/>deleted：已被删除，被删除的 VPC 网络不可以被恢复<br/>ceased：已被彻底删除</td> </tr> <tr> <td>transition_status</td> <td>String</td> <td>VPC 网络过渡状态，有效值为creating, updating, suspending, resuming，poweroffing，poweroning，deleting。<br/>creating：创建中，由 pending 状态变成 active 状态<br/>updating：更新 VPC 网络规则中<br/>suspending：欠费暂停中，由 active/poweroffed 状态变成 suspended 状态<br/>resuming：恢复中，由 suspended 状态变成 active 状态<br/>poweroffing：关闭中，由 active 状态变成 poweroffed 状态<br/>poweroning：开启中，由 poweroffed 状态变成 active 状态<br/>deleting：删除中，由 active/poweroffed/suspended 状态变成 deleted 状态</td> </tr> <tr> <td>create_time</td> <td>TimeStamp</td> <td>VPC 网络创建时间，为UTC时间，格式可参见 <a href="http://www.w3.org/TR/NOTE-datetime">ISO8601</a>.</td> </tr> <tr> <td>status_time</td> <td>TimeStamp</td> <td>VPC 网络最近一次状态变更时间，为UTC时间，格式可参见 <a href="http://www.w3.org/TR/NOTE-datetime">ISO8601</a>.</td> </tr> <tr> <td>security_group_id</td> <td>String</td> <td>VPC 网络的防火墙ID</td> </tr> <tr> <td>eip</td> <td>Dict</td> <td>VPC 网络的公网IP信息<br/>eip_id：公网IP的ID<br/>eip_name：公网IP名称<br/>eip_addr：公网IP地址</td> </tr> <tr> <td>vxnets</td> <td>Array</td> <td>VPC 网络连接的私有网络信息<br/>vxnet_id：私有网络ID<br/>nic_id：网卡ID<br/>只有在请求参数 verbose=1 时才会返回此信息。</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=DescribeRouters &routers.1=rtr-b0u6sdj6 &verbose=1 &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action": "DescribeRoutersResponse", "router_set": [ { "status": "active", "base_vxnet": "vxnet-ijduoo5", "is_applied": 1, "features": 3, "vpc_network": "192.168.0.0/16", "console_id": "qingcloud", "create_time": "2019-12-11T01:16:41Z", "alarm_status": "", "private_ip": "10.120.67.38", "resource_project_info": [ ], "owner": "usr-CT3owI01", "place_group_id": "plg-00000nfv", "security_groups": [ { "group_id": "sg-xmldyszl", "group_name": "default security group" } ], "l3vni": 10811790, "sub_code": 1, "security_group_id": "sg-xmldyszl", "source": "self", "memory": 512, "status_time": "2021-11-21T08:09:02Z", "router_id": "rtr-8vwgl9kv", "description": null, "tags": [ ], "transition_status": "", "is_default": 0, "controller": "self", "vpc_id": "vpc-r7fzo0w1", "vpc_ipv6_network": "", "eip": { "eip_name": "", "eip_addr": "139.198.181.12", "eip_id": "eip-ndy2crzh" }, "hypervisor": "lxc", "instance_id": "i-xilwvpi5", "root_user_id": "usr-CT3owI01", "dns_aliases": [ ], "mode": 0, "router_type": 1, "router_name": "测试", "cpu": 1 } ], "has_share": false, "total_count": 1, "ret_code": 0 } </code></pre> Network: ModifyRouterAttributes /network/vpc/api/vpc_api/modify_router_attributes/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/modify_router_attributes/ <p>修改一台 VPC 网络的配置。</p> <p>在修改配置之后，为了让配置生效，你可能需要执行 <a href="../update_routers/"><em>UpdateRouters</em></a> 或者 <a href="/security/firewall/api/command_list/apply_security_group/"><em>ApplySecurityGroup</em></a> 指令。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router</td> <td>String</td> <td>VPC 网络ID</td> <td>Yes</td> </tr> <tr> <td>eip</td> <td>String</td> <td>VPC 网络的公网IP，如果值为 "" ，表示将公网IP从 VPC 网络上解绑。<br/>修改这个参数之后，需要执行 <a href="../update_routers"><em>UpdateRouters</em></a> 指令才能使得修改生效。</td> <td>No</td> </tr> <tr> <td>security_group</td> <td>String</td> <td>VPC 网络的防火墙ID。<br/>修改这个参数之后，需要执行 <a href="/security/firewall/api/command_list/apply_security_group/"><em>ApplySecurityGroup</em></a> 指令才能使得修改生效。</td> <td>No</td> </tr> <tr> <td>router_name</td> <td>String</td> <td>VPC 网络的名称。</td> <td>No</td> </tr> <tr> <td>description</td> <td>String</td> <td>VPC 网络的描述。</td> <td>No</td> </tr> <tr> <td>features</td> <td>Integer</td> <td>VPC 网络功能项，目前包括 DHCP 和 DNS 。<br/>“1”: 开启 DHCP，开启时还需同时传参数 vxnet, dyn_ip_start, dyn_ip_end (私有网络连接 VPC 网络后默认即开启 DHCP)<br/>“2”: 开启私网内 DNS</td> <td>No</td> </tr> <tr> <td>vxnet</td> <td>String</td> <td>私有网络 ID。当开启、关闭 VPC 网络 DHCP 功能时，需指定私有网络。</td> <td>No</td> </tr> <tr> <td>dyn_ip_start</td> <td>String</td> <td>DHCP服务分配开始IP</td> <td>No</td> </tr> <tr> <td>dyn_ip_end</td> <td>String</td> <td>DHCP服务分配终止IP</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=ModifyRouterAttributes &router=rtr-9iy0lt3s &router_name=demo &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"ModifyRouterAttributesResponse", "ret_code":0 } </code></pre> Network: UpdateRouters /network/vpc/api/vpc_api/update_routers/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/update_routers/ <p>更新一台或多台 VPC 网络的配置信息。当配置发生变更之后，需要执行本操作使配置生效。</p> <p>可以使 VPC 网络配置发生变更的操作为 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 和 <a href="../delete_router_statics/"><em>DeleteRouterStatics</em></a> 和 <a href="../modify_router_attributes/"><em>ModifyRouterAttributes</em></a>。</p> <p>只有在处于 active 状态的 VPC 网络才能支持此操作，如果处于非活跃状态，则返回错误信息。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>routers.n</td> <td>String</td> <td>VPC 网络ID</td> <td>Yes</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>job_id</td> <td>String</td> <td>执行任务的 Job ID</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=UpdateRouters &routers.1=rtr-xt37nm9j &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"UpdateRoutersResponse", "job_id":"j-bdg2109b", "ret_code":0 } </code></pre> Network: JoinRouter /network/vpc/api/vpc_api/join_router/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/join_router/ <p>将一个受管私有网络连接到一台 VPC 网络。这样受管私有网络可以被 VPC 网络管理起来，受管私有网络里的云服务器也将获得 DHCP 自动分配地址的能力。</p> <p>只有受管私有网络才能连接到 VPC 网络，一个受管私有网络可以且仅可以连接到一台 VPC 网络。受管私有网络可以连接到状态为 active 和 poweroffed 的 VPC 网络。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>vxnet</td> <td>String</td> <td>需要连接 VPC 网络的受管私有网络ID</td> <td>Yes</td> </tr> <tr> <td>router</td> <td>String</td> <td>受管私有网络需要连接的 VPC 网络ID</td> <td>Yes</td> </tr> <tr> <td>ip_network</td> <td>String</td> <td>受管私有网络的网段，目前支持的网段为 192.168.x.0/24 和 172.16.x.0/24，需要满足 <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR格式</a><br/>注解<br/>同一个 VPC 网络下管理的受管私有网络的网段不能重复。</td> <td>Yes</td> </tr> <tr> <td>features</td> <td>Integer</td> <td>VPC 网络需要开启的功能，默认为1，目前这个值只能填1，表示开启DHCP服务。</td> <td>No</td> </tr> <tr> <td>manager_ip</td> <td>String</td> <td>VPC 网络的管理IP</td> <td>No</td> </tr> <tr> <td>dyn_ip_start</td> <td>String</td> <td>DHCP服务分配开始IP</td> <td>No</td> </tr> <tr> <td>dyn_ip_end</td> <td>String</td> <td>DHCP服务分配终止IP</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>job_id</td> <td>String</td> <td>执行任务的 Job ID</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=JoinRouter &vxnet=vxnet-rzg2llb &router=rtr-xt37nm9j &ip_network=192.168.1.0/24 &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "router_id":"rtr-xt37nm9j", "job_id":"j-lesy0k0k", "ret_code":0, "action":"JoinRouterResponse", "vxnet_id":"vxnet-rzg2llb" } </code></pre> Network: LeaveRouter /network/vpc/api/vpc_api/leave_router/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/leave_router/ <p>将一个或多个受管私有网络从一台 VPC 网络上断开。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>vxnets.n</td> <td>String</td> <td>需要从 VPC 网络上断开的受管私有网络ID</td> <td>Yes</td> </tr> <tr> <td>router</td> <td>String</td> <td>受管私有网络需要断开的 VPC 网络ID</td> <td>Yes</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>job_id</td> <td>String</td> <td>执行任务的 Job ID</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=LeaveRouter &vxnets.1=vxnet-rzg2llb &router=rtr-9iy0lt3s &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "router_id":"rtr-9iy0lt3s", "vxnets":[ "vxnet-rzg2llb" ], "job_id":"j-qqcivo9d", "ret_code":0, "action":"LeaveRouterResponse", } </code></pre> Network: DescribeRouterVxnets /network/vpc/api/vpc_api/describe_router_vxnets/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/describe_router_vxnets/ <p>获取 VPC 网络管理的私有网络列表。</p> <p>可根据 VPC 网络ID，私有网络ID，等作为过滤条件，来获取私有网络列表。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router</td> <td>String</td> <td>VPC 网络ID, “*” 表示显示所有 VPC 网络</td> <td>Yes</td> </tr> <tr> <td>vxnet</td> <td>String</td> <td>私有网络ID</td> <td>No</td> </tr> <tr> <td>verbose</td> <td>Integer</td> <td>是否返回冗长的信息，目前只支持verbose=0。</td> <td>No</td> </tr> <tr> <td>offset</td> <td>Integer</td> <td>数据偏移量，默认为0</td> <td>No</td> </tr> <tr> <td>limit</td> <td>Integer</td> <td>返回数据长度，默认为20，最大100</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_vxnet_set</td> <td>Array</td> <td>JSON 格式的私有网络列表，每项参数可见下面 <a href="#responseitemtype">ResponseItemType</a></td> </tr> <tr> <td>total_count</td> <td>Integer</td> <td>根据过滤条件得到的私有网络总数</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <p><strong>ResponseItemType</strong></p> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>router_id</td> <td>String</td> <td>VPC 网络ID</td> </tr> <tr> <td>vxnet_id</td> <td>String</td> <td>私有网络ID</td> </tr> <tr> <td>manager_ip</td> <td>String</td> <td>私有网络管理地址</td> </tr> <tr> <td>ip_network</td> <td>String</td> <td>私有网络 DHCP 地址范围</td> </tr> <tr> <td>dyn_ip_start</td> <td>String</td> <td>私有网络 DHCP 起始地址</td> </tr> <tr> <td>dyn_ip_end</td> <td>String</td> <td>私有网络 DHCP 终止地址</td> </tr> <tr> <td>features</td> <td>Integer</td> <td>私有网络开启的功能标记位<br/> “0” 表示不开启 DHCP 和内网 DNS 功能。<br/> “1” 表示只开启 DHCP 地址分配功能。<br/> “2” 表示只开启内网 DNS 功能。<br/> “3” 表示同时开启 DHCP 地址分配和内网 DNS 功能。</td> </tr> <tr> <td>create_time</td> <td>TimeStamp</td> <td>私有网络连接 VPC 网络的创建时间，为UTC时间，格式可参见 <a href="http://www.w3.org/TR/NOTE-datetime">ISO8601</a>.</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=DescribeRouterVxnets &router=rtr-b0u6sdj6 &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"DescribeRouterVxnetsResponse", "total_count":1, "router_vxnet_set":[ { "router_id":"rtr-b0u6sdj6", "manager_ip":"192.168.1.1", "ip_network":"192.168.1.0/24", "dyn_ip_end":"192.168.1.254", "vxnet_id":"vxnet-ytuyg2q", "dyn_ip_start":"192.168.1.2", "vxnet_name":"test", "create_time":"2013-08-30T09:17:40Z", "features":1 } ], "ret_code":0 } </code></pre> Network: DeleteRouters /network/vpc/api/vpc_api/delete_routers/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/delete_routers/ <p>删除一台或多台 VPC 网络。</p> <p>销毁 VPC 网络的前提，是此 VPC 网络已建立租用信息（租用信息是在创建 VPC 网络成功后，几秒钟内系统自动建立的）。所以正在创建的 VPC 网络（状态为 pending ），以及刚刚创建成功但还没有建立租用信息的 VPC 网络，是不能被销毁的。</p> <p>警告</p> <p>被删除的 VPC 网络会被立即系统回收，不具有可恢复的功能。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>routers.n</td> <td>String</td> <td>VPC 网络ID</td> <td>Yes</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>job_id</td> <td>String</td> <td>执行任务的 Job ID</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=DeleteRouters &routers.1=rtr-s5nqo8mr &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"DeleteRoutersResponse", "ret_code":0, "job_id":"j-32c66ja8", "routers":[ "rtr-s5nqo8mr" ] } </code></pre> Network: AddRouterStatics /network/vpc/api/vpc_api/add_router_statics/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/add_router_statics/ <p>增加一项或多项 VPC 网络规则，规则类型包括：端口转发、VPN 、DHCP 、隧道、过滤控制。</p> <p>注意：在增加 VPC 网络规则后，你需要执行 <a href="../update_routers/"><em>UpdateRouters</em></a> 才能使之生效。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router</td> <td>String</td> <td>需要增加规则的 VPC 网络ID</td> <td>Yes</td> </tr> <tr> <td>statics.n.router_static_name</td> <td>String</td> <td>规则名称</td> <td>No</td> </tr> <tr> <td>vxnet</td> <td>String</td> <td>vxnet id</td> <td>Yes only in VPC</td> </tr> <tr> <td>statics.n.static_type</td> <td>Integer</td> <td>第n条规则的类型。支持的规则类型有：<br/>* static_type=1：端口转发规则<br/>* static_type=2：VPN 规则<br/>* static_type=3：DHCP 选项<br/>* static_type=4：二层 GRE 隧道<br/>* static_type=5：过滤控制 (VPC不支持)<br/>* static_type=6：三层 GRE 隧道<br/>* static_type=7：三层 IPsec 隧道<br/>* static_type=8：私网DNS</td> <td>Yes</td> </tr> <tr> <td>statics.n.val1</td> <td>String</td> <td>第n条规则的 val1 值，会根据规则类型的不同，代表不同含义：<br/>* 端口转发：val1 表示源端口。<br/>* VPN：val1 表示 VPN 类型，目前支持 “openvpn” 、 “pptp” 、”l2tp”，默认值为 “openvpn”。<br/>* DHCP 选项：val1 表示 DHCP 云服务器ID。<br/>* 二层 GRE 隧道：val1 表示二层隧道的远端 IP 和密钥，如：gre|1.2.3.4|888。<br/>* 过滤控制：val1 表示『源 IP』<br/>* 三层 GRE 隧道：val1 表示远端 IP 、密钥、本地点对点IP、对端点对点IP，格式如：6.6.6.6|key|1.2.3.4|4.3.2.1。<br/>* 三层 IPsec 隧道：val1 表示远端IP（支持接受任意对端，可填 0.0.0.0）、加密算法(phase2alg&ike，可为空，默认aes)、密钥和远端设备ID（支持接受任意对端设备ID，可填 %any），格式如：1.2.3.4|passw0rd|device-id<br/>* 私网DNS：val1 表示私网域名，比如node1</td> <td>Yes</td> </tr> <tr> <td>statics.n.val2</td> <td>String</td> <td>第n条规则的 val2 值，会根据规则类型的不同，代表不同含义：<br/>* 端口转发规则：val2 表示目标 IP 。<br/>* OpenVPN 规则：val2 表示 VPN 服务端口号，默认为1194。<br/>* PPTP/L2TP VPN 规则：val2 表示用户名和密码，格式为 user:password<br/>* DHCP 选项：val2 表示 DHCP 配置内容，格式为key1=value1;key2=value2，例如：”domain-name-servers=8.8.8.8;fixed-address=192.168.1.2”。<br/>* 过滤控制：val2 表示『源端口』<br/>* 三层 GRE 隧道：val2 表示目标网络，多个网络间以 “|” 分隔。注意目标网络不能和 VPC 网络已有的私有网络重复。<br/>* 三层 IPsec 隧道：val2 表示本地网络，多个网络间以 “|” 分隔。<br/>* 私网DNS：val2 表示IP地址，格式为ip1;ip2，例如：”192.168.1.2;192.168.1.3”</td> <td>No</td> </tr> <tr> <td>statics.n.val3</td> <td>String</td> <td>第n条规则的 val3 值，会根据规则类型的不同，代表不同含义：<br/>* 端口转发规则：val3 表示目标端口号。<br/>* OpenVPN 规则：val3 表示 VPN 协议，默认为 “udp”。<br/>* PPTP VPN 规则：val3 表示最大连接数，连接数范围是 1-253。<br/>* L2TP VPN 规则：val3 表示IPsec预共享密钥(PSK, preshared secrets),可填入任意字符串。<br/>* 过滤控制：val3 表示『目标 IP』<br/>* 三层 IPsec 隧道：val3 表示目标网络，多个网络间以 “|” 分隔。</td> <td>No</td> </tr> <tr> <td>statics.n.val4</td> <td>String</td> <td>第n条规则的 val4 值，会根据规则类型的不同，代表不同含义：<br/>* 端口转发规则：val4 表示端口转发协议，默认为 “tcp” ，目前支持 “tcp” 和 “udp” 两种协议。<br/>* VPN 规则(包括 OpenVPN 、PPTP、L2TP)：val4 表示 VPN 客户端的网络地址段，目前支持10.255.x.0/24，x的范围是[0-255]，默认为自动分配。<br/>* 过滤控制：val4 表示『目标端口』<br/>* 三层 IPsec 隧道：val4 表示IPsec隧道模式，默认为”main”，支持主模式（main）和野蛮模式（aggrmode）。</td> <td>No</td> </tr> <tr> <td>statics.n.val5</td> <td>String</td> <td>第n条规则的 val5 值，会根据规则类型的不同，代表不同含义：<br/>* OpenVPN VPN 规则：val5 表示 OpenVPN 的验证方式，目前支持 1: 证书验证, 2: 用户名/密码验证, 3: 证书+用户名/密码验证，默认为 “证书验证” 方式。<br/>* L2TP VPN 规则： val5 表示L2TP服务端口号，默认是1701。<br/>* 过滤控制： val5 表示优先级</td> <td>No</td> </tr> <tr> <td>statics.n.val6</td> <td>String</td> <td>第n条规则的 val6 值，会根据规则类型的不同，代表不同含义：<br/>* 过滤控制：val6 表示『行为』，包括： “accept” 和 “drop”</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_statics</td> <td>Array</td> <td>新增加的 VPC 网络规则ID列表</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=AddRouterStatics &statics.1.static_type=1 &statics.1.val1=8080 &statics.1.val2=192.168.1.12 &statics.1.val3=8080 &statics.1.val4=tcp &statics.2.static_type=2 &statics.2.val1=openvpn &statics.2.val2=1194 &statics.2.val3=tcp &statics.2.val4=10.255.1.0/24 &statics.3.static_type=3 &statics.3.val1=i-m163jcqw &statics.3.val2=domain-name-servers=8.8.8.8 &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"AddRouterStaticsResponse", "ret_code":0, "router_statics":[ "rtrs-qihmd2vb", "rtrs-2w8msd83", "rtrs-b3epyxu5" ] } </code></pre> Network: AddRouterStaticEntries /network/vpc/api/vpc_api/add_router_static_entries/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/add_router_static_entries/ <p>增加一条 VPC 网络规则条目，比如 OpenVPN / PPTP 的账户信息或是隧道规则的网络地址。</p> <p>注意：在增加 VPC 网络规则条目后，你需要执行 <a href="../update_routers/"><em>UpdateRouters</em></a> 才能使之生效。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_static</td> <td>String</td> <td>需要增加条目的 VPC 网络规则ID</td> <td>Yes</td> </tr> <tr> <td>entries.n.val1</td> <td>String</td> <td>第n条规则的 val1 值，会根据规则类型的不同，代表不同含义：<br/>* OpenVPN / PPTP 账户信息：val1 表示账户名<br/>* 三层 GRE 隧道：val1 表示目标网络<br/>* 三层 IPsec 隧道：val1 表示本地网络 (val2 可为空)</td> <td>Yes</td> </tr> <tr> <td>entries.n.val2</td> <td>String</td> <td>第n条规则的 val2 值，会根据规则类型的不同，代表不同含义：<br/>* OpenVPN / PPTP 账户信息：val2 表示密码<br/>* 三层 IPsec 隧道：val2 表示目标网络 (val1 可为空)</td> <td>Yes</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_static_entries</td> <td>Array</td> <td>新增加的 VPC 网络规则条目ID列表</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=AddRouterStaticEntries &router_static=rtrs-hcnwdfwc &entries.1.val1=admin &entries.1.val2=passwOrd &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"AddRouterStaticEntriesResponse", "ret_code":0, "router_static_entries":[ "rse-hkzqquga" ] } </code></pre> Network: CopyRouterStatics /network/vpc/api/vpc_api/copy_router_statics/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/copy_router_statics/ <p>把源 VPC 网络的路由规则复制给目的 VPC 网络。</p> <p>如果源 VPC 网络和目的 VPC 网络都属于网络 2.0，且自身的网络地址不同，那么复制 IPsec 隧道规则时，会修改规则里的目标网络地址，以适配目的 VPC 网络。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>source_router_id</td> <td>String</td> <td>源 VPC 网络 ID</td> <td>Yes</td> </tr> <tr> <td>dest_router_id</td> <td>String</td> <td>目的 VPC 网络 ID</td> <td>Yes</td> </tr> <tr> <td>dest_zone</td> <td>String</td> <td>目的区域 ID</td> <td>Yes</td> </tr> <tr> <td>router-statics</td> <td>Array</td> <td>VPC 网络规则 ID 列表</td> <td>No</td> </tr> <tr> <td>static-type</td> <td>Array</td> <td>VPC 网络规则类型列表</td> <td>No</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=CopyRouterStatics &source_router=rtr-srcsrc11 &dest_router=rtr-destdest &dest_zone=dest </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"CopyRouterStaticsResponse", "ret_code":0 } </code></pre> Network: DescribeRouterStatics /network/vpc/api/vpc_api/describe_router_statics/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/describe_router_statics/ <p>获取 VPC 网络的规则。</p> <p>可根据 VPC 网络规则ID， VPC 网络ID，规则类型等作为过滤条件，来获取 VPC 网络规则列表。如果不指定任何过滤条件，默认返回你所拥有的所有 VPC 网络规则。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_statics.n</td> <td>String</td> <td>VPC 网络规则ID</td> <td>No</td> </tr> <tr> <td>router</td> <td>String</td> <td>VPC 网络ID</td> <td>No</td> </tr> <tr> <td>vxnet</td> <td>String</td> <td>私有网络ID</td> <td>No</td> </tr> <tr> <td>static_type</td> <td>String</td> <td>规则类型。支持的规则类型有：<br/>* 1：端口转发规则<br/>* 2：VPN 规则<br/>* 3：DHCP 选项<br/>* 4：二层 GRE 隧道<br/>* 5：过滤控制<br/>* 6：三层 GRE 隧道<br/>* 7：三层 IPsec 隧道<br/>* 8：私网DNS</td> <td>No</td> </tr> <tr> <td>verbose</td> <td>Integer</td> <td>是否返回冗长的信息，目前只支持verbose=0。</td> <td>No</td> </tr> <tr> <td>offset</td> <td>Integer</td> <td>数据偏移量，默认为0</td> <td>No</td> </tr> <tr> <td>limit</td> <td>Integer</td> <td>返回数据长度，默认为20，最大100</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_static_set</td> <td>Array</td> <td>JSON 格式的 VPC 网络规则列表</td> </tr> <tr> <td>total_count</td> <td>Integer</td> <td>根据过滤条件得到的 VPC 网络规则总数</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=DescribeRouterStatics &router=rtr-9iy0lt3s &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"DescribeRouterStaticsResponse", "total_count":2, "router_static_set":[ { "router_id":"rtr-9iy0lt3s", "vxnet_id":"", "static_type":1, "router_static_id":"rtrs-wls7otet", "create_time":"2013-08-26T12:37:56Z", "val3":"80", "val2":"192.168.1.12", "val1":"80", "val4":"tcp" }, { "router_id":"rtr-9iy0lt3s", "vxnet_id":"", "static_type":2, "router_static_id":"rtrs-y63zh53l", "create_time":"2013-08-26T12:40:06Z", "val3":"udp", "val2":"1194", "val1":"openvpn", "val4":"10.255.143.0/24" } ], "ret_code":0 } </code></pre> Network: DescribeRouterStaticEntries /network/vpc/api/vpc_api/describe_router_static_entries/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/describe_router_static_entries/ <p>获取 VPC 网络规则的条目。</p> <p>可根据 VPC 网络规则 ID 作为过滤条件，来获取 VPC 网络规则中的条目列表。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_static_entry_id</td> <td>String</td> <td>VPC 网络规则条目ID</td> <td>No</td> </tr> <tr> <td>router_static</td> <td>String</td> <td>VPC 网络规则ID</td> <td>No</td> </tr> <tr> <td>offset</td> <td>Integer</td> <td>数据偏移量，默认为0</td> <td>No</td> </tr> <tr> <td>limit</td> <td>Integer</td> <td>返回数据长度，默认为20，最大100</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_static_entry_set</td> <td>Array</td> <td>JSON 格式的 VPC 网络数据列表，每项参数可见下面 <a href="#responseitemtype">ResponseItemType</a></td> </tr> <tr> <td>total_count</td> <td>Integer</td> <td>根据过滤条件得到的 VPC 网络规则总数</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <p><strong>ResponseItemType</strong></p> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>router_id</td> <td>String</td> <td>VPC 网络ID</td> </tr> <tr> <td>router_static_entry_name</td> <td>String</td> <td>VPC 网络规则条目名称</td> </tr> <tr> <td>router_static_entry_id</td> <td>String</td> <td>VPC 网络规则条目ID</td> </tr> <tr> <td>val1</td> <td>String</td> <td>根据规则类型的不同，代表不同含义：<br/>PPTP 账户信息：val1 表示账户名<br/>三层 GRE 隧道：val1 表示目标网络<br/>三层 IPsec 隧道：val1 表示本地网络</td> </tr> <tr> <td>val2</td> <td>String</td> <td>根据规则类型的不同，代表不同含义：<br/>PPTP 账户信息：val2 表示密码<br/>三层 IPsec 隧道：val2 表示目标网络</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=DescribeRouterStaticEntries &router_static=rtrs-8e3pgr8r &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"DescribeRouterStaticEntriesResponse", "total_count":2, "router_static_entry_set":[ { "router_id":"rtr-ingyf5po", "router_static_entry_id":"rse-27qhl6ma", "router_static_id":"rtrs-8e3pgr8r", "router_static_entry_name":"", "val2":"192.168.127.0/24", "val1":"" }, { "router_id":"rtr-ingyf5po", "router_static_entry_id":"rse-t3u8dhfg", "router_static_id":"rtrs-8e3pgr8r", "router_static_entry_name":"", "val2":"", "val1":"192.168.100.0/24" }, { "router_id":"rtr-ingyf5po", "router_static_entry_id":"rse-rmz0sgbf", "router_static_id":"rtrs-8e3pgr8r", "router_static_entry_name":"", "val2":"192.168.111.0/24", "val1":"" } ], "ret_code":0 } </code></pre> Network: ModifyRouterStaticAttributes /network/vpc/api/vpc_api/modify_router_static_attributes/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/modify_router_static_attributes/ <p>修改某条 VPC 网络规则。修改规则后，需要执行 <a href="../update_routers/"><em>UpdateRouters</em></a> 来使规则生效。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_static</td> <td>String</td> <td>需要修改的 VPC 网络规则 ID</td> <td>Yes</td> </tr> <tr> <td>router_static_name</td> <td>String</td> <td>规则名称</td> <td>No</td> </tr> <tr> <td>statics.n.val1</td> <td>String</td> <td>请参考 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 对应参数说明。</td> <td>No</td> </tr> <tr> <td>statics.n.val2</td> <td>String</td> <td>请参考 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 对应参数说明。</td> <td>No</td> </tr> <tr> <td>statics.n.val3</td> <td>String</td> <td>请参考 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 对应参数说明。</td> <td>No</td> </tr> <tr> <td>statics.n.val4</td> <td>String</td> <td>请参考 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 对应参数说明。</td> <td>No</td> </tr> <tr> <td>statics.n.val5</td> <td>String</td> <td>请参考 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 对应参数说明。</td> <td>No</td> </tr> <tr> <td>statics.n.val6</td> <td>String</td> <td>请参考 <a href="../add_router_statics/"><em>AddRouterStatics</em></a> 对应参数说明。</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_static</td> <td>Array</td> <td>修改的 VPC 网络规则ID</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=ModifyRouterStaticAttributes &router_static=rtrs-c173g36a &router_static_name=new_name, &val1=8080 &val2=192.168.1.12 &val3=8080 &val4=tcp &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"ModifyRouterStaticAttributesResponse", "router_static_id":"rtrs-c173g36a", "ret_code":0 } </code></pre> Network: ModifyRouterStaticEntryAttributes /network/vpc/api/vpc_api/modify_router_static_entry_attributes/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/modify_router_static_entry_attributes/ <p>修改 VPC 网络规则中的某条条目属性。修改后，需要执行 <a href="../update_routers/"><em>UpdateRouters</em></a> 来使规则生效。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_static_entry</td> <td>String</td> <td>需要修改的 VPC 网络规则条目 ID</td> <td>Yes</td> </tr> <tr> <td>router_static_entry_name</td> <td>String</td> <td>规则条目名称</td> <td>No</td> </tr> <tr> <td>val1</td> <td>String</td> <td>规则条目的 val1 值，会根据规则类型的不同，代表不同含义：<br/>* PPTP 账户信息：val1 表示账户名<br/>* 三层 GRE 隧道：val1 表示目标网络<br/>* 三层 IPsec 隧道：val1 表示本地网络</td> <td>No</td> </tr> <tr> <td>val2</td> <td>String</td> <td>规则条目的 val2 值，会根据规则类型的不同，代表不同含义：<br/>* PPTP 账户信息：val2 表示密码<br/>* 三层 IPsec 隧道：val2 表示目标网络</td> <td>No</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>router_static_entry</td> <td>String</td> <td>修改的 VPC 网络规则条目ID</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=ModifyRouterStaticEntryAttributes &router_static_entry=rse-c173g36a &router_static_entry_name=new_name, &val1=192.168.100.0/24 &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"ModifyRouterStaticEntryAttributesResponse", "router_static_entry_id":"rse-c173g36a", "ret_code":0 } </code></pre> Network: DeleteRouterStatics /network/vpc/api/vpc_api/delete_router_statics/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/delete_router_statics/ <p>删除一条或多条 VPC 网络规则。在删除 VPC 网络规则之后，你需要执行 <a href="../update_routers/"><em>UpdateRouters</em></a> 来使规则删除生效。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_statics.n</td> <td>String</td> <td>VPC 网络规则ID</td> <td>Yes</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> <tr> <td>router_statics</td> <td>Array</td> <td>删掉的 VPC 网络规则ID列表</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=DeleteRouterStatics &router_statics.1=rtrs-wls7otet &router_statics.2=rtrs-j1tsul7v &router_statics.3=rtrs-b3epyxu5 &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"DeleteRouterStaticsResponse", "ret_code":0, "router_statics":[ "rtrs-wls7otet", "rtrs-j1tsul7v", "rtrs-b3epyxu5" ] } </code></pre> Network: DeleteRouterStaticEntries /network/vpc/api/vpc_api/delete_router_static_entries/ Mon, 01 Jan 0001 00:00:00 +0000 /network/vpc/api/vpc_api/delete_router_static_entries/ <p>删除一条或多条 VPC 网络规则条目。在删除 VPC 网络规则条目之后，你需要执行 <a href="../update_routers/"><em>UpdateRouters</em></a> 来使规则删除生效。</p> <h2 id="请求参数">请求参数</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> <th>是否必选</th> </tr> </thead> <tbody> <tr> <td>router_static_entries.n</td> <td>String</td> <td>VPC 网络规则条目ID</td> <td>Yes</td> </tr> <tr> <td>zone</td> <td>String</td> <td>区域 ID，注意要小写</td> <td>Yes</td> </tr> </tbody> </table> <p><a href="../../get_api/parameters/"><em>公共参数</em></a></p> <h2 id="返回数据">返回数据</h2> <table> <thead> <tr> <th>参数</th> <th>参数类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>action</td> <td>String</td> <td>响应动作</td> </tr> <tr> <td>ret_code</td> <td>Integer</td> <td>执行成功与否，0 表示成功，其他值则为错误代码</td> </tr> <tr> <td>router_static_entries</td> <td>Array</td> <td>删掉的 VPC 网络规则条目ID列表</td> </tr> </tbody> </table> <h2 id="示例">示例</h2> <p><strong>请求示例：</strong></p> <pre tabindex="0"><code>https://api.qingcloud.com/iaas/?action=DeleteRouterStaticEntries &router_static_entries.1=rse-wls7otet &router_static_entries.2=rse-b3epyxu5 &zone=pek3a &COMMON_PARAMS </code></pre><p><strong>返回示例：</strong></p> <pre tabindex="0"><code>{ "action":"DeleteRouterStaticEntriesResponse", "ret_code":0, "router_static_entries":[ "rse-wls7otet", "rse-b3epyxu5" ] } </code></pre>