参数403forbidden怎么解决

专有网络VPC开发指南开发指南API参考简介用户可以使用本文档介绍的API对VPC服务进行相关操作.
请确保在使用这些接口前,已充分了解了VPC产品说明、使用协议和收费方式.
术语表术语全称中文说明VPCVirtualPrivateCloud专有网络专有网络是用户基于阿里云创建的自定义私有网络,不同的专有网络之间彻底逻辑隔离,用户可以在自己创建的专有网络内创建和管理云产品实例,比如ECS,IntranetSLB,RDS等.
Region地域代表资源所在的地域,每个地域包含一组可用区.
ZoneAvailabilityZone可用区同一地域内,电力和网络互相独立的物理区域.
同一可用区内的ECS实例网络延时更小.
在同一地域内可用区与可用区之间内网互通,可用区之间能做到故障隔离.
VRouter路由器路由器,是VPC网络的枢纽,它可以连接VPC内的各个交换机专有网络VPC开发指南1业务限制资源规格限制说明在VPC中,对每个用户可拥有的VPC、EIP等资源的数量均有限制.
在VPC中可容纳的交换机个数、VPC中可容纳的ECS实例个数、EIP的带宽可选范围等规格方面也有限制.
在使用VPCOpenAPI时,请点此参考官网上最新的业务限制规则和资源规格限制.
在接口说明部分,凡出现对参数可选值、可用规格方面与官网上给出的资源规格限制发生矛盾时,均以官网上,同时也是连接VPC与其他网络的网关设备.
它会根据具体的路由条目的设置来转发网络流量.
VSwitch交换机交换机,是组成VPC网络的基础网络设备.
它可以连接不同的云产品实例.
在VPC网络内创建云产品实例的时候,必须指定云产品实例所在的交换机.
EIPElasticIPAddress弹性公网IP地址由一个公网IP和一份公网带宽组成.
可由用户单独购买或释放;可以与ECS实例进行灵活的绑定和解绑.
CIDRClasslessInter-DomainRouting无类别域间路由选择是互联网中一种新的寻址方式,与传统的A类、B类和C类寻址模式相比,CIDR在IP地址分配方面更为高效.
例如IP号段是125.
203.
96.
0-125.
203.
127.
255,转化cidr格式就是找相同的前十九位:125.
203.
01100000.
00000000到125.
203.
01111111.
11111111可以写成125.
203.
96.
0/19RouteTable路由表路由表,是指路由器上管理路由条目的列表.
RouteEntry路由条目路由表中的每一项成为一条路由条目,路由条目定义了通向指定目标网段的网络流量的下一跳地址,路由条目包括系统路由和自定义路由两种类型.
专有网络VPC开发指南21.
2.
3.
4.
给出的值为准.
调用方式概述调用方式对VPCAPI接口调用是通过向VPCAPI的服务端地址发送HTTPGET请求,并按照接口说明在请求中加入相应请求参数来完成的;根据请求的处理情况,系统会返回处理结果.
请求结构公共参数返回结果签名机制请求接口请求结构服务地址VPCAPI的服务接入地址为:vpc.
aliyuncs.
com通信协议支持通过HTTP或HTTPS通道进行请求通信.
为了获得更高的安全性,推荐您使用HTTPS通道发送请求.
专有网络VPC开发指南3请求方法支持HTTPGET方法发送请求,这种方式下请求参数需要包含在请求的URL中.
请求参数每个请求都需要指定要执行的操作,即Action参数(例如CreateVpc),以及每个操作都需要包含的公共请求参数和指定操作所特有的请求参数.
字符编码请求及返回结果都使用UTF-8字符集进行编码.
公共参数公共请求参数公共请求参数是指每个接口都需要使用到的请求参数.
名称类型是否必须描述FormatString否返回值的类型,支持JSON与XML.
默认为XML.
VersionString是API版本号,为日期形式:YYYY-MM-DD,本版本对应为2016-04-28.
AccessKeyIdString是阿里云颁发给用户的访问服务所用的密钥ID.
SignatureString是签名结果串,关于签名的计算方法,请参见.
SignatureMethodString是签名方式,目前支持HMAC-SHA1.
TimestampString是请求的时间戳.
日期格式按照ISO8601标准表示,并需要使用UTC时间.
格式为:YYYY-MM-DDThh:mm:ssZ例如,2014-05-26T12:00:00Z(为北京时间专有网络VPC开发指南4示例公共返回参数用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId给用户.
示例XML示例:2014年5月26日20点0分0秒).
SignatureVersionString是签名算法版本,目前版本是1.
0.
SignatureNonceString是唯一随机数,用于防止网络重放攻击.
用户在不同请求间要使用不同的随机数值ResourceOwnerAccountString否本次API请求访问到的资源拥有者账户,即登录用户名.
此参数的使用方法,详见,(只能在RAM中可对VPC资源进行授权的Action中才能使用此参数,否则访问会被拒绝)https://vpc.
aliyuncs.
com/Format=xml&Version=2016-04-28&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D&SignatureMethod=HMAC-SHA1&SignatureNonce=15215528852396&SignatureVersion=1.
0&AccessKeyId=key-test&Timestamp=2016-06-01T12:00:00Z…4C467B38-3910-447D-87BC-AC049166F216专有网络VPC开发指南5JSON示例:返回结果调用API服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回4xx或5xx的HTTP状态码代表调用失败.
调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式.
本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的.
成功结果XML示例:JSON示例:错误结果调用接口出错后,将不会返回结果数据.
调用方可根据每个接口对应的错误码以及下述2.
3.
3的公共错误码来定位错误原因.
当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码.
返回的消息体中是具体的错{"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",/*返回结果数据*/}4C467B38-3910-447D-87BC-AC049166F216{"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",/*返回结果数据*/}专有网络VPC开发指南6误代码及错误信息.
另外还包含一个全局唯一的请求ID:RequestId和一个您该次请求访问的站点ID:HostId.
在调用方找不到错误原因时,可以联系阿里云客服,并提供该HostId和RequestId,以便我们尽快帮您解决问题.
XML示例:JSON示例:公共错误码8906582E-6722-409A-A6C4-0E7863B733A5vpc.
aliyuncs.
comUnsupportedOperationThespecifiedactionisnotsupported.
{"RequestId":"8906582E-6722-409A-A6C4-0E7863B733A5","HostId":"vpc.
aliyuncs.
com","Code":"UnsupportedOperation","Message":"Thespecifiedactionisnotsupported.
"}错误代码描述Http状态码语义MissingParameterTheinputparameter"Action"thatismandatoryforprocessingthisrequestisnotsupplied400缺少Action字段MissingParameterTheinputparameter"AccessKeyId"thatismandatoryforprocessingthisrequestisnotsupplied400缺少AccessKeyId字段MissingParameterAninputparameter"Signature"thatismandatoryforprocessingtherequestisnotsupplied.
400缺少Signature字段MissingParameterTheinputparameter"TimeStamp"that400缺少Timestamp字段专有网络VPC开发指南7ismandatoryforprocessingthisrequestisnotsuppliedMissingParameterTheinputparameter"Version"thatismandatoryforprocessingthisrequestisnotsupplied400缺少Version字段InvalidParameterThespecifiedparameter"ActionorVersion"isnotvalid.
400无效的Action值(该API不存在)InvalidAccessKeyId.
NotFoundTheAccessKeyIDprovideddoesnotexistinourrecords.
400无效的AccessKeyId值(该key不存在)Forbidden.
AccessKeyDisabledTheAccessKeyisdisabled.
403该AccessKey处于禁用状态IncompleteSignatureTherequestsignaturedoesnotconformtoAliyunstandards.
400无效的Signature取值(签名结果错误)InvalidParamaterThespecifiedparameter"SignatureMethod"isnotvalid.
400无效的SignatureMethod取值InvalidParamaterThespecifiedparameter"SignatureVersion"isnotvalid.
400无效的SignatureVersion取值IllegalTimestampTheinputparameter"Timestamp"thatismandatoryforprocessingthisrequestisnotsupplied.
400无效的Timestamp取值(Timestamp与服务器时间相差超过了1个小时)SignatureNonceUsedTherequestsignaturenoncehasbeenused.
400无效的SignatureNonce(该SignatureNonce值已被使用过)InvalidParameterThespecifiedparameter"ActionorVersion"isnotvalid.
400无效的Version取值InvalidOwnerIdThespecifiedOwnerIdisnotvalid.
400无效的OwnerId取值InvalidOwnerAccountThespecifiedOwnerAccountis400无效的OwnerAccount取值专有网络VPC开发指南8notvalid.
InvalidOwnerOwnerIdandOwnerAccountcan'tbeusedatoneAPIaccess.
400同时使用了OwnerId和OwnerAccountThrottlingRequestwasdeniedduetorequestthrottling.
400因系统流控拒绝访问ThrottlingRequestwasdeniedduetorequestthrottling.
400该key的调用quota已用完InvalidActionSpecifiedactionisnotvalid.
403该key无权调用该APIUnsupportedHTTPMethodThishttpmethodisnotsupported.
403用户使用了不支持的HttpMethod(当前TOP只支持post和get)ServiceUnavailableTherequesthasfailedduetoatemporaryfailureoftheserver.
500服务不可用UnsupportedParameterTheparameter""isnotsupported.
400使用了无效的参数InternalErrorTherequestprocessinghasfailedduetosomeunknownerror,exceptionorfailure.
500其他情况MissingParameterTheinputparameterOwnerId,OwnerAccountthatismandatoryforprocessingthisrequestisnotsupplied.
403调用该接口没有指定OwnerIdForbidden.
SubUserThespecifiedactionisnotavailableforyou.
403无权调用订单类接口UnsupportedParameterTheparameter""isnotsupported.
400该参数无权使用Forbidden.
InstanceNotFoundThespecifiedInstanceisnotfound,sowecann'tgetenoughinformationtocheck404使用了RAM授权子账号进行资源访问,但是本次访问涉及到的Instance不存在专有网络VPC开发指南9permissioninRAM.
Forbidden.
DiskNotFoundThespecifiedDiskisnotfound,sowecann'tgetenoughinformationtocheckpermissioninRAM.
404使用了RAM授权子账号进行资源访问,但是本次访问涉及到的Disk不存在Forbidden.
SecurityGroupNotFoundThespecifiedSecurityGroupisnotfound,sowecann'tgetenoughinformationtocheckpermissioninRAM.
404使用了RAM授权子账号进行资源访问,但是本次访问涉及到的SecurityGroup不存在Forbidden.
SnapshotNotFoundThespecifiedSnapshotisnotfound,sowecann'tgetenoughinformationtocheckpermissioninRAM.
404使用了RAM授权子账号进行资源访问,但是本次访问涉及到的Snapshot不存在Forbidden.
ImageNotFoundThespecifiedImageisnotfound,sowecann'tgetenoughinformationtocheckpermissioninRAM.
404使用了RAM授权子账号进行资源访问,但是本次访问涉及到的Image不存在Forbidden.
RAMUsernotauthorizedtooperatethespecifiedresource,orthisAPIdoesn'tsupportRAM.
403使用了RAM授权子账号进行资源访问,但是本次操作没有被正确的授权Forbidden.
NotSupportRAMThisactiondoesnotsupportaccessedbyRAMmode.
403该接口不允许使用RAM方式进行访问InsufficientBalanceYouraccountdoesnothaveenoughbalance.
400余额不足IdempotentParameterMismatchRequestusesaclienttokeninapreviousrequestbutisnotidenticaltothatrequest.
400使用了一个已经使用过的ClientToken,但此次请求内容却又与上一次使用该Token的request不一样.
RealNameAuthenticationErrorYouraccounthasnotpassedthereal-nameauthenticationyet.
403用户未进行实名认证InvalidIdempotenceParameter.
MismatchThespecifiedparametersaredifferentfrombefore403幂等参数不匹配LastTokenProcessingThelasttokenrequestisprocessing403上一次请求还在处理中专有网络VPC开发指南10签名机制VPC服务会对每个访问的请求进行身份验证,所以无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息.
VPC通过使用AccessKeyID和AccessKeySecret进行对称加密的方法来验证请求的发送者身份.
AccessKeyID和AccessKeySecret由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中AccessKeyID用于标识访问者的身份;AccessKeySecret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密,只有阿里云和用户知道.
用户在访问时,按照下面的方法对请求进行签名处理:使用请求参数构造规范化的请求字符串(CanonicalizedQueryString)(a)参数排序.
按照参数名称的字典顺序对请求中所有的请求参数(包括"公共请求参数"和接口的自定义参数,但不能包括"公共请求参数"中提到的Signature参数本身)进行排序.
注:当使用GET方法提交请求时,这些参数就是请求URI中的参数部分(即URI中""之后由"&"连接的部分).
(b)参数编码.
对排序之后的请求参数的名称和值分别用UTF-8字符集进行URL编码.
编码的规则如下:注:该编码方式和一般采用的"application/x-www-form-urlencoded"MIME格式编码算法(比如Java标准库中的java.
net.
URLEncoder的实现)相似,但又有所不同.
实现时,可以先用标准库的方式进行编码,然后把编码后的字符串中加号(+)替换成%20、星号(*)替换成%2A、%7E替换回波浪号(~),即可得到上述规则描述的编码字符串.
这个算法可以用下面的percentEncode方法来实现:InvalidParameterThespecifiedparameterisnotvalid400参数校验失败i.
对于字符A-Z、a-z、0-9以及字符"不编码;ii.
对于其他字符编码成"%XY"的格式,其中XY是字符对应ASCII码的16进制表示.
比如英文的双引号(")对应的编码就是%22iii.
对于扩展的UTF-8字符,编码成"%XY%ZA…"的格式;iv.
需要说明的是英文空格()要被编码是%20,而不是加号(+).
privatestaticfinalStringENCODING="UTF-8";privatestaticStringpercentEncode(Stringvalue)throwsUnsupportedEncodingException{returnvalue!
=nullURLEncoder.
encode(value,ENCODING).
replace("+","%20").
replace("*","%2A").
replace("%7E"null;}专有网络VPC开发指南11(c)将编码后的参数名称和值用英文等号(=)进行连接.
(d)将等号连接得到的参数组合按步骤(a)排好的顺序依次使用&符号连接,即得到规范化请求字符串.
将上一步构造的规范化字符串按照下面的规则构造成待签名的字符串:其中HTTPMethod是提交请求用的HTTP方法,比如GET.
percentEncode("/")是按照1.
b中描述的URL编码规则对字符"/"进行编码得到的值,即"%2F".
percentEncode(CanonicalizedQueryString)是对第1步中构造的规范化请求字符串按1.
b中描述的URL编码规则编码后得到的字符串.
按照RFC2104的定义,计算待签名字符串StringToSign的HMAC值.
注意:计算签名时使用的Key就是用户持有的AccessKeySecret并加上一个"&"字符(ASCII:38),使用的哈希算法是SHA1.
按照Base64编码规则把上面的HMAC值编码成字符串,即得到签名值(Signature).
将得到的签名值作为Signature参数添加到请求参数中,即完成对请求签名的过程.
注意:得到的签名值在作为最后的请求参数值提交给VPC服务器的时候,要和其他参数一样,按照RFC3986的规则进行URL编码.
以DescribeRegions为例,假设使用的AccessKeyId是"testid",AccessKeySecret是"testsecret".
那么签名前的请求URL为:而计算得到的待签名字符串StringToSign为:StringToSign=HTTPMethod+"&"+percentEncode(percentEncode(CanonicalizedQueryString)http://vpc.
aliyuncs.
com/TimeStamp=2016-02-23T12:46:24Z&Format=XML&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&SignatureVersion=1.
0GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeRegions&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.
0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2014-05-26专有网络VPC开发指南12因为AccessKeySecret是"testsecret",所以用于计算HMAC的Key为"testsecret&",计算得到的签名值是:将签名作为Signature参数加入到URL请求中,得到最后的URL为:关于如何进行签名并提交请求的详细示例,请参见附录:如何调用接口.
借助RAM实现子账号对主账号的VPC资源访问专有网络CreateVpc描述在指定的地域创建1个VPC.
调用该接口创建VPC时,请注意:VPC只能指定1个网段,网段的范围包括10.
0.
0.
0/8、172.
16.
0.
0/12和192.
168.
0.
0/16以及它们的子网,网段的掩码为8-24位,默认为172.
16.
0.
0/12.
VPC创建后无法修改网段.
CT9X0VtwR86fNWSnsc6v8YGOjuE=http://vpc.
aliyuncs.
com/SignatureVersion=1.
0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureMethod=HMAC-SHA1&TimeStamp=2016-02-23T12%3A46%3A24Z专有网络VPC开发指南13每个VPC包含的云产品实例不能分布在不同地域,可以分布在同一地域的不同可用区内.
每个VPC包含的云产品实例数量不超过10000个.
创建VPC时,会自动创建1个虚拟路由器和1个路由表,不需要用户来创建路由器和路由表.
每个VPC支持3个用户侧网段.
如果多个用户侧网段之间存在互相包含,掩码较短的网段实际生效.
例如10.
0.
0.
0/8和10.
1.
0.
0/16中,10.
0.
0.
0/8实际生效.
请求参数名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:CreateVpcRegionIdString是VPC所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
CidrBlockString否VPC的网段.
取值:10.
0.
0.
0/8-172.
16.
0.
0/12-192.
168.
0.
0/16-以及它们包含的子网.
默认值:172.
16.
0.
0/12VpcNameString否VPC的名称,默认值为空.
长度为[2,128]个英文或中文字符,必须以大小字母或中文开头,可包含数字,下划线(_)和短横线(-)不能以"http://"或"https://"开头.
DescriptionString否VPC的描述信息,默认值为空.
长度为[2,256]个英文或中文字符,不能以"http://"或"https://"开头.
ClientTokenString否用于保证请求的幂等性.
专有网络VPC开发指南14返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
详情参见如何保证幂等性.
UserCidrString否用户侧网络的网段,如需定义多个网段请使用半角逗号(,)隔开,最多支持3个网段.
名称类型描述RequestIdString请求ID.
VpcIdString专有网络的ID.
VRouterIdString路由器的ID.
RouteTableIdString路由表的ID.
https://vpc.
aliyuncs.
com/Action=CreateVpc&RegionID=cn-beijing&461D0C42-D5D1-4009-9B6A-B3D5888A19A9vtb-25wm68mnhvrt-25bezkd03专有网络VPC开发指南15JSON格式DeleteVpc描述删除指定的VPC.
调用该接口删除VPC时,请注意:删除VPC之前,需要先释放或移走VPC内的所有资源,包括交换机,云产品实例,路由器接口,HaVip等.
只有处于Available状态的VPC可以被删除.
请求参数返回参数vpc-257gq642n{"RequestId":"461D0C42-D5D1-4009-9B6A-B3D5888A19A9","RouteTableId":"vtb-25wm68mnh","VRouterId":"vrt-25bezkd03","VpcId":"vpc-257gq642n"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DeleteVpcVpcIdString是VPC的ID.
名称类型描述RequestIdString请求ID.
专有网络VPC开发指南16错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式JSON格式DescribeVpcs描述查询VPC列表.
请求参数https://vpc.
aliyuncs.
com/Action=DeleteVpc&VpcId=vpc-25eq58pl3&606998F0-B94D-48FE-8316-ACA81BB230DA{"RequestId":"606998F0-B94D-48FE-8316-ACA81BB230DA"}名称类型是否必须描述专有网络VPC开发指南17返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
ActionString是接口名,系统规定参数.
取值:DescribeVpcsVpcIdString否VPC的ID.
最多支持提交20个VPC的ID.
多个VPC的ID之间用半角逗号(,)隔开.
RegionIdString是VPC的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
IsDefaultBoolean否是否查询指定地域下的默认VPC,取值:true(默认值):查询指定地域下的所有VPC.
-false:不查询默认VPC.
-PageNumberInteger否实例状态列表的页码,起始值为1,默认值为1.
PageSizeInteger否指定分页查询时每页的行数,最大值为50,默认值为10.
名称类型描述RequestIdString请求ID.
VpcsVpcTypeVPC的详细信息,详情参见VpcSetType.
TotalCountString列表条条目数.
PageNumberInteger当前页码.
PageSizeInteger当前分页包含多少条目.
专有网络VPC开发指南18示例请求示例返回示例XML格式JSON格式https://vpc.
aliyuncs.
com/Action=DescribeVpcs&RegionId=cn-beijing&DA1DAE87-43FA-472F-98BB-4FDBAA4A688Dvpc-257gq642ncn-beijingvrt-25bezkd03Available172.
16.
0.
0/162014-10-29T13:30:19Z{"PageNumber":1,"PageSize":10,"RequestId":"DA1DAE87-43FA-472F-98BB-4FDBAA4A688D","TotalCount":1,"Vpcs":{"Vpc":{"CidrBlock":"172.
16.
0.
0/16","CreationTime":"2014-10-29T13:30:19Z","Description":"","RegionId":"cn-beijing","Status":"Available","UserCidrs":{"UserCidr":[]专有网络VPC开发指南19ModifyVpcAttribute描述修改指定VPC的名称和描述信息.
请求参数},"VRouterId":"vrt-25bezkd03","VSwitchIds":{"VSwitchId":[]},"VpcId":"vpc-257gq642n","VpcName":""}}}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:ModifyVpcAttributeVpcIdString是VPC的ID.
VpcNameString否VPC的名称,默认值为空.
长度为[2,128]个英文或中文字符,必须以大小字母或中文开头,可包含数字,下划线(_)和短横线(-)不能以"http://"或"https://"开头.
DescriptionString否VPC的描述信息,默认值为空.
长度为[2,256]个英文或中文字符,不能以"http://"或"https://"开头.
专有网络VPC开发指南20返回参数示例请求示例返回示例XML格式JSON格式路由器DescribeVRouters名称类型描述RequestIdString请求ID.
https://vpc.
aliyuncs.
com/Action=ModifyVpcAttribute&VpcId=vpc-257gq642n&VpcName=Vpc02&5741F353-AD13-41A2-83C7-19E49BD9AE30{"RequestId":"5741F353-AD13-41A2-83C7-19E49BD9AE30"}专有网络VPC开发指南21描述查询指定地域的路由器列表.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DescribeVRoutersVRouterIdString否路由器的ID.
RegionIdString是路由器所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
PageNumberInteger否实例状态列表的页码,起始值为1,默认值为1.
PageSizeInteger否分页查询时每页的行数,最大值为50,默认为10.
名称类型描述RequestIdString请求ID.
VRoutersVRouterSetType路由器的详细信息,详情参见VRouterSetType.
TotalCountInteger列表条条目数.
PageNumberInteger当前页码.
PageSizeInteger当前分页包含的条目数.
专有网络VPC开发指南22示例请求示例返回示例XML格式JSON格式https://vpc.
aliyuncs.
com/Action=DescribeVRouters&RegionId=cn-beijing&C2C6EF61-53B7-4071-A87D-B42F1F17FA5Avpc-257gq642nvrt-25bezkd03vtb-25wm68mnh2014-10-29T13:30:19Z{"PageNumber":1,"PageSize":10,"RequestId":"C2C6EF61-53B7-4071-A87D-B42F1F17FA5A","TotalCount":1,"VRouters":{"VRouter":[{"CreationTime":"2014-10-29T13:30:19Z","Description":"","RegionId":"cn-beijing","RouteTableIds":{"RouteTableId":["vtb-25wm68mnh"]},专有网络VPC开发指南23ModifyVRouterAttribute描述修改路由器的名称和描述信息.
请求参数"VRouterId":"vrt-25bezkd03","VRouterName":"","VpcId":"vpc-257gq642n"}]}}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:ModifyVRouterAttributeVRouterIdString是路由器的ID.
VRouterNameString否路由器的名称,默认值为空.
长度为[2,128]个英文或中文字符,必须以大小字母或中文开头,可包含数字,下划线(_)和短横线(-)不能以"http://"或"https://"开头.
DescriptionString否路由器的描述信息,默认值为空.
长度为[2,256]个英文或中文字符,不能以"http://"或"https://"开头.
专有网络VPC开发指南24返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式JSON格式交换机名称类型描述RequestIdString请求ID.
https://vpc.
aliyuncs.
com/Action=ModifyVRouterAttribute&VRouterId=vrt-25bezkd03&VRouterName=VRouter&CEF72CEB-54B6-4AE8-B225-F876FF7BA984{"RequestId":"E0AAA98E-8E3C-4C11-95F3-5E2B8AD51703"}专有网络VPC开发指南25CreateVSwitch描述在指定的VPC内创建1个交换机.
调用该接口创建交换机时,请注意:同一个交换机下的云产品实例不能分布在不同可用区.
每个VPC内的交换机数量不能超过24个.
每个交换机网段的第1个和最后3个IP地址为系统保留地址.
以192.
168.
1.
0/24为例,192.
168.
1.
0、192.
168.
1.
253、192.
168.
1.
254和192.
168.
1.
255这些地址是系统保留地址.
交换机不支持组播和广播.
交换机创建成功后,网段无法修改.
交换机下的云产品实例数量不允许超过VPC剩余的可用云产品实例数量(15000减去当前云产品实例数量).
1个云产品实例只能属于1个交换机.
请求参数名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:CreateVSwitchZoneIdString是可用区的ID.
CidrBlockString是交换机的网段.
交换机网段要求如下:交换机网段的掩码长度范围为16-29位.
-交换机的网段-专有网络VPC开发指南26返回参数必须从属于所在VPC的网段.
交换机的网段与所在VPC的网段相同时,VPC只能拥有1个交换机.
交换机的网段不能与所在VPC中路由条目的目标网段相同,但可以是目标网段的子集.
-VpcIdString是交换机所属的VPC.
VSwitchNameString否交换机的名称,默认值为空.
长度为[2,128]个英文或中文字符,必须以大小字母或中文开头,可包含数字,下划线(_)和短横线(-)不能以"http://"或"https://"开头.
DescriptionString否交换机的描述信息,默认值为空.
长度为[2,256]个英文或中文字符,不能以"http://"或"https://"开头.
ClientTokenString否用于保证请求的幂等性.
由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
详情参见如何保证幂等性.
名称类型描述专有网络VPC开发指南27错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式JSON格式DeleteVSwitchRequestIdString请求ID.
VSwitchIdString交换机的ID.
https://vpc.
aliyuncs.
com/Action=CreateVSwitch&CidrBlock=172.
16.
1.
0/24&VpcId=vpc-257gq642n&ZoneId=cn-beijing-a&861E6630-AEC0-4B2D-B214-6CB5E44B7F04vsw-25naue4gz{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","VSwitchId":"vsw-25naue4gz"}专有网络VPC开发指南28描述删除指定的交换机.
调用该接口删除交换机时,请注意:只能删除处于Available状态下的交换机.
删除交换机之前,需要先释放或移走交换机下的所有云产品实例和HaVip实例.
交换机所在的VPC正在创建/删除交换机或路由条目时,无法删除交换机.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DeleteVSwitchVSwitchIdString是交换机的ID.
名称类型描述RequestIdString请求ID.
https://vpc.
aliyuncs.
com/Action=DeleteVSwitch&VSwitchId=vsw-25naue4gz&专有网络VPC开发指南29返回示例XML格式JSON格式DescribeVSwitches描述查询交换机的列表.
请求参数AF083E3D-7E29-4B77-A937-1F129802D5F3{"RequestId":"AF083E3D-7E29-4B77-A937-1F129802D5F3"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DescribeVSwitchesRegionIdString是交换机所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
VpcIdString否VPC的ID.
VSwitchIdString否交换机的ID.
最多支持提交20个交换机的ID.
多个交换机的ID之专有网络VPC开发指南30返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例间用半角逗号(,)隔开.
ZoneIdString否可用区的ID.
IsDefaultBoolean否是否查询指定地域下的默认交换机,取值:true(默认值):查询指定地域下的所有交换机.
-false:不查询默认交换机.
-PageNumberInteger否实例状态列表的页码,起始值为1,默认值为1.
PageSizeInteger否定分页查询时每页的行数,最大值为50,默认值为10.
名称类型描述RequestIdString请求ID.
VSwitchesVSwitchType交换机的详细信息,详情参见VSwitchSetType.
TotalCountInteger列表条目数.
PageNumberInteger当前页码.
PageSizeInteger当前分页包含的条目数.
https://vpc.
aliyuncs.
com/Action=DescribeVSwitches&VpcId=vpc-25eq58pl3&专有网络VPC开发指南31返回示例XML格式JSON格式9A572171-4E27-40D1-BD36-D26C9E71E29Evsw-25b7pv15tAvailable172.
16.
1.
0/24cn-beijing-a246vpc-257gq642n2014-10-29T15:21:02Z{"PageNumber":1,"PageSize":10,"RequestId":"9A572171-4E27-40D1-BD36-D26C9E71E29E","TotalCount":1,"VSwitches":{"VSwitch":[{"AvailableIpAddressCount":246,"CidrBlock":"172.
16.
1.
0/24","CreationTime":"2014-10-29T15:21:02Z","Description":"","Status":"Available","VSwitchId":"vsw-25b7pv15t","VSwitchName":"","VpcId":"vpc-257gq642n","ZoneId":"cn-beijing-a"}]}}专有网络VPC开发指南32ModifyVSwitchAttribute描述修改交换机的名称和描述信息.
请求参数返回参数示例名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:ModifyVSwitchAttributeVSwitchIdString是交换机的ID.
VSwitchNameString否交换机的名称,默认值为空.
长度为[2,128]个英文或中文字符,必须以大小字母或中文开头,可包含数字,下划线(_)和短横线(-)不能以"http://"或"https://"开头.
DescriptionString否交换机的描述信息,默认值为空.
长度为[2,256]个英文或中文字符,不能以"http://"或"https://"开头.
名称类型描述RequestIdString请求ID.
专有网络VPC开发指南33请求示例返回示例XML格式JSON格式路由表CreateRouteEntry描述在VPC路由器或边界路由器(VBR)上创建路由条目.
调用该接口创建路由条目时,请注意:同一个路由表中自定义路由条目不能超过48条.
多个路由条目可以指向同一个下一跳ID(NextHopId).
https://vpc.
aliyuncs.
com/Action=ModifyVSwitchAttribute&VSwitchId=vpc-257gq642n&C0FD0EED-F90D-4479-803D-DD62335357E5{"RequestId":"C0FD0EED-F90D-4479-803D-DD62335357E5"}专有网络VPC开发指南34同一个VPC内,最多存在5条指向HaVip的路由条目.
在VBR中创建路由条目时,VBR状态必须是Active,且对应的物理专线状态必须是Enabled.
请求参数名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:CreateRouteEntryRouteTableIdString是路由表的ID.
DestinationCidrBlockString是路由条目的目标网段,需满足以下要求:目标网段不能指向100.
64.
0.
0/10或被100.
64.
0.
0/10包含.
-同一张路由表内的不同路由条目的目标网段不能相同.
-如果提供的目标网段是一个IP地址,掩码将按照32位处理.
-NextHopTypeString否下一跳的类型,创建普通(非ECMP路由)路由条目时指定该参数.
取值:Instance:ECS实例(默认值)-Tunnel:隧道-HaVip:高可用虚拟IP-RouterInterface:路由器接口-VpnGateway:VPN网关-NextHopIdString否路由条目的下一跳实例专有网络VPC开发指南35返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
ID,创建普通(非ECMP路由)路由条目时指定该参数.
下一跳必须位于路由表所在的VPC或VBR中.
NextHopListJSONstring否路由条目的下一跳列表,创建ECMP路由条目时指定该参数.
需满足以下条件:只支持在VPC中的路由表创建ECMP路由条目.
-NextHopList中的下一跳数量为2-4个.
-NextHopList中的下一跳只能是VPC中指向VBR的路由器接口.
-详情参见NextHopListType.
ClientTokenString否用于保证请求的幂等性.
由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
详情参见如何保证幂等性.
名称类型描述RequestIdString请求ID.
专有网络VPC开发指南36示例请求示例返回示例XML格式JSON格式DeleteRouteEntry描述删除VPC路由器或边界路由器的路由表中指定的路由条目.
调用本接口删除路由条目时,请注意:只有状态为Available的路由条目可以被删除.
https://vpc.
aliyuncs.
com/Action=CreateRouteEntry&VpcId=vpc-257gq642n&RouteTableId=vrt-5citwfp6a&DestinationCidrBlock=0.
0.
0.
0/0&NextHopId=i-25skktcp4&NextHopType=Instance&12D086F6-8F31-4658-84C1-006DED011A85{"RequestId":"12D086F6-8F31-4658-84C1-006DED011A85"}专有网络VPC开发指南37路由表所在的VPC正在进行创建/删除交换机或路由条目时,无法删除路由条目.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DeleteRouteEntryRouteTableIdString是路由条目所在的路由表的ID.
DestinationCidrBlockString是路由条目的目标网段.
NextHopIdString否路由条目的下一跳实例的ID.
在删除普通(非ECMP)路由条目时,指定该参数.
NextHopListJSONstring否路由条目的下一跳列表.
在删除ECMP路由条目时,指定该参数.
详情参见NextHopListType.
名称类型描述RequestIdString请求ID.
https://vpc.
aliyuncs.
com/Action=DeleteRouteEntry&RouterTableId=vtb-25vtxl5ct&DestinationCidrBlock=192.
168.
1.
0/24&NextHopId=i-25skktcp4&专有网络VPC开发指南38返回示例XML格式JSON格式DescribeRouteTables描述查询VPC路由器和边界路由器的路由表的路由条目.
请求参数4357FA74-F9F3-46E7-8890-AA30EC4F8D4F{"RequestId":"4357FA74-F9F3-46E7-8890-AA30EC4F8D4F"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DescribeRouteTablesRouterTypeString否路由表所属的路由器类型.
取值:VRouter:VPC路由器-VBR:边界路由器-RouterIdString否路由表所属的VPC路由专有网络VPC开发指南39返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式器或边界路由器的ID.
VRouterIdString否路由表所属的VPC路由器的ID.
指定该参数将自动指定RouterType为VRouter.
RouteTableIdString否路由表的ID.
PageNumberInteger否实例状态列表的页码,起始值为1,默认值为1PageSizeInteger否指定分页查询时每页的行数,最大值为50,默认值为10名称类型描述RequestIdString请求ID.
RouteTablesJSONstring路由表的详细信息,详情参见RouteTableSetType.
TotalCountInteger列表的条目数.
PageNumberInteger当前页码.
PageSizeInteger当前分页包含的条目数.
https://vpc.
aliyuncs.
com/Action=DescribeRouteTables&VRouterId=vrt-25u5f8u2q&专有网络VPC开发指南40JSON格式913F8774-681A-4857-95D8-ACBAF044D453routetable01192.
168.
10.
1/32Customi-25skktcp4Availablevtb-25vtxl5ct192.
168.
1.
0/24vtb-25vtxl5ctAvailableSystem100.
64.
0.
0/10vtb-25vtxl5ctAvailableSystem10.
0.
0.
0/8vtb-25vtxl5ctAvailableSystemvtb-25vtxl5ctSystemvrt-25u5f8u2q2014-09-11T04:52:53Z{"PageNumber":1,"PageSize":10,"RequestId":"913F8774-681A-4857-95D8-ACBAF044D453","RouteTables":{"RouteTable":[{"CreationTime":"2014-09-11T04:52:53Z","RouteEntrys":{"RouteEntry":[{专有网络VPC开发指南41弹性公网IPAllocateEipAddress描述申请弹性公网IP(EIP),调用本接口后将在指定的地域内随机获取一个状态为Available的EIP.
"DestinationCidrBlock":"192.
168.
10.
1/32","InstanceId":"i-25skktcp4","RouteTableId":"vtb-25vtxl5ct","Status":"Available","Type":"Custom"},{"DestinationCidrBlock":"192.
168.
1.
0/24","InstanceId":"","RouteTableId":"vtb-25vtxl5ct","Status":"Available","Type":"System"},{"DestinationCidrBlock":"100.
64.
0.
0/10","InstanceId":"","RouteTableId":"vtb-25vtxl5ct","Status":"Available","Type":"System"},{"DestinationCidrBlock":"10.
0.
0.
0/8","InstanceId":"","RouteTableId":"vtb-25vtxl5ct","Status":"Available","Type":"System"}]},"RouteTableId":"vtb-25vtxl5ct","RouteTableType":"System","VRouterId":"vrt-25u5f8u2q"}]},"TotalCount":1}专有网络VPC开发指南42调用本接口申请EIP时,请注意:EIP目前只能绑定到相同地域的VPC类型的ECS实例、公网类型的SLB、NAT网关和HaVip实例.
EIP在传输层目前只支持ICMP、TCP和UDP协议,不支持IGMP和SCTP等协议.
请求参数返回参数名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:AllocateEipAddressRegionIdString是EIP的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
BandwidthString否EIP的带宽峰值,单位为Mbps,默认值为5.
InternetChargeTypeString否EIP的计费方式.
取值:PayByTraffic:按流量计费.
InstanceChargeTypeString否EIP的付费方式.
取值:PostPaid:后付费.
ClientTokenString否用于保证请求的幂等性.
由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
详情参见如何保证幂等性.
名称类型描述RequestIdString请求ID.
EipAddressString分配的EIP.
AllocationIdStringEIP的实例ID.
OrderIdString订单号,选择预付费时返回该参数.
专有网络VPC开发指南43错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式JSON格式AssociateEipAddress描述将EIP绑定到同地域的云产品实例上.
调用本接口绑定EIP时,请注意:https://vpc.
aliyuncs.
com/Action=AllocateEipAddress&RegionId=cn-beijing&eip-25877c70x123.
56.
0.
206B6B9F518-60F8-4D81-9242-1207B356754D{"AllocationId":"eip-25877c70x","EipAddress":"123.
56.
0.
206","RequestId":"B6B9F518-60F8-4D81-9242-1207B356754D"}专有网络VPC开发指南44--EIP目前只支持绑定到专有网络类型的ECS实例、NAT网关、公网类型的负载均衡实例或HAVIP实例上.
只有Available状态的EIP才能够进行绑定操作.
EIP绑定成功后立刻生效,不需要重启ECS实例.
每个EIP同时只能绑定一个云产品实例.
每个ECS实例、负载均衡实例和HAVIP实例同时只能绑定一个EIP.
每个NAT网关可以同时绑定多个EIP.
如果NAT网关已绑定了带宽包,则无法直接绑定EIP.
请提交工单进行处理.
只有处于运行中和已停止状态的ECS实例可以绑定EIP.
只有处于Available或者InUse状态的HAVIP可以绑定EIP.
因为安全原因被锁定的EIP无法进行绑定和解绑操作.
请求参数名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:AssociateEipAddressAllocationIdString是EIP的实例ID.
InstanceTypeString否云产品实例的类型.
取值:EcsInstance(默认值):ECS实例-SlbInstance:负载均衡实例-Nat:NAT网关-HAVIP:HAVI-专有网络VPC开发指南45返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式JSON格式P实例InstanceIdString是云产品的实例ID.
名称类型描述RequestIdString请求ID.
https://vpc.
aliyuncs.
com/Action=AssociateEipAddress&AllocationId=eip-25877c70x&InstanceId=i-25skktcp4&C0FD0EED-F90D-4479-803D-DD62335357E5{"RequestId":"C0FD0EED-F90D-4479-803D-DD62335357E5"}专有网络VPC开发指南46UnassociateEipAddress描述解除EIP与云产品实例的绑定关系.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:UnassociateEipAddressAllocationIdString是EIP的实例ID.
InstanceTypeString否云产品实例的类型.
取值:EcsInstance(默认值):ECS实例-SlbInstance:负载均衡实例-Nat:NAT网关-HaVip:HaVip实例-InstanceIdString是云产品的实例ID.
名称类型描述RequestIdString请求ID.
专有网络VPC开发指南47示例请求示例返回示例XML格式JSON格式DescribeEipAddresses描述查询指定地域的EIP列表.
请求参数https://vpc.
aliyuncs.
com/Action=UnassociateEipAddress&AllocationId=eip-2578g5v5a&InstanceId=i-25skktcp4&220F3179-5238-47F0-A0CA-1272AA2BC41F{"RequestId":"220F3179-5238-47F0-A0CA-1272AA2BC41F"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DescribeEipAddresses专有网络VPC开发指南48返回参数RegionIdString是EIP所在的地域.
StatusString否EIP的状态,取值:Associating:绑定中-Unassociating:解绑中-InUse:已分配-Available:可用-EipAddressString否EIP的IP地址.
AllocationIdString否EIP的实例ID.
AssociatedInstanceTypeString否云产品实例的类型,取值:EcsInstance(默认值):ECS实例-SlbInstance:负载均衡实例-Nat:NAT网关-HAVIP:HAVIP实例-AssociatedInstanceIdString否云产品的实例ID,指定该参数时,必须同时指定参数AssociatedInstanceType.
PageNumberInteger否实例状态列表的页码,起始值为1,默认值为1PageSizeInteger否指定分页查询时每页的行数,最大值为50,默认值为10名称类型描述RequestIdString请求ID.
EipAddressesEipAddressSetTypeEIP的详细信息,详情参见EipAddressSetType.
TotalCountInteger列表的条目数.
PageNumberInteger当前页码.
PageSizeInteger当前分页包含的条目数.
专有网络VPC开发指南49错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例JSON格式https://vpc.
aliyuncs.
com/Action=DescribeEipAddresses&RegionId=cn-hangzhou-1&{"PageNumber":1,"EipAddresses":{"EipAddress":[{"ChargeType":"PostPaid","AllocationTime":"2018-01-15T11:17:30Z","ResourceGroupId":"rg-acfmxazb4ph6aiy","InstanceId":"","Descritpion":"","IpAddress":"59.
110.
xx.
xx","AllocationId":"eip-2ze88m67qx5zxxxxx","InternetChargeType":"PayByTraffic","InstanceType":"","Name":"","Status":"Available","BandwidthPackageId":"","InstanceRegionId":"","BandwidthPackageType":"","RegionId":"cn-beijing","OperationLocks":{"LockReason":[]},"ExpiredTime":"","AvailableRegions":{"AvailableRegion":["cn-beijing"]},"Bandwidth":"1"}专有网络VPC开发指南50ModifyEipAddressAttribute描述修改指定EIP的名称、描述信息和带宽峰值.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
]},"TotalCount":1,"PageSize":10,"RequestId":"7EEF2D6B-D207-4197-AE37-01279C888757"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:ModifyEipAddressAttributeAllocationIdString是EIP的实例ID.
BandwidthString否EIP的带宽峰值,单位为Mbps.
NameString否EIP的名称.
DescriptionString否EIP的描述信息.
名称类型描述RequestIdString请求ID.
专有网络VPC开发指南51示例请求示例返回示例XML格式JSON格式ReleaseEipAddress描述释放指定的EIP.
请求参数https://vpc.
aliyuncs.
com/Action=ModifyEipAddressAttribute&AllocationId=eip-25877c70x&Bandwidth=1&2C63EA73-A1E7-4C46-B8BC-E7C2E543E5E8{"RequestId":"2C63EA73-A1E7-4C46-B8BC-E7C2E543E5E8"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:ReleaseEipAddress专有网络VPC开发指南52返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例XML格式JSON格式DescribePublicIpAddressAllocationIdString是EIP的实例ID.
名称类型描述RequestIdString请求ID.
https://vpc.
aliyuncs.
com/Action=ReleaseEipAddress&AllocationId=eip-25877c70x&748C38F6-9A3D-482E-83FB-DB6C39C68AEA{"RequestId":"748C38F6-9A3D-482E-83FB-DB6C39C68AEA"}专有网络VPC开发指南53注意:本API目前仅供白名单中的阿里云合作伙伴调用.
调用本API前请联系您的阿里云销售经理或商业经理来将您的帐户加入到白名单中.
相关SDK将在数周后发布.
关于如何调用API,请参见请求结构.
概述查询指定地域的公网IP地址段.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
名称类型是否必需描述ActionString是接口名,系统规定参数.
取值:DescribePublicIpAddressRegionIdString是指定查询的地域.
详情参见地域与可用区.
PageNumberInteger否公网IP地址列表的页码,起始值为1,默认值:1PageSizeInteger否分页查询时设置的每页行数,默认值:100名称类型描述PublicIpAddressString指定地域的公网IP地址范围.
TotalCountString列表条目数.
PageNumberInteger当前页码.
PageSizeInteger当前分页包含多少条目.
专有网络VPC开发指南54示例请求示例返回示例API授权当调用本API时,请确认您已为API授权.
授权可以通过调用API或RAM控制台添加以下策略来实现为API授权.
详情参见授权策略管理.
https://vpc.
aliyuncs.
com/Action=DescribePublicIpAddress&RegionId=cn-beijing&{"RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710","Code":200,"Success":"true/false","PublicIpAddress":["110.
11.
1.
0/24"],"RegionId":"cn-beijing","PageNumber":1,"PageSize":100,"TotalCount":1000}{"Version":"1","Statement":[{"Action":["vpc:DescribePublicIpAddress*",],"Resource":"*","Effect":"Allow"}]}专有网络VPC开发指南55--物理专线CreatePhysicalConnection描述申请物理专线接入.
申请完成后,物理专线的状态为Initial,请联系运营商进行施工.
在您调用本接口申请物理专线时,请注意:申请物理专线时,处于enabled状态之外的物理专线不得超过5条.
若账户下存在欠费状态的物理专线,则不能申请更多的物理专线.
请求参数名称类型是否必须描述ActionString是接口名,系统规定参数专有网络VPC开发指南56.
取值:CreatePhysicalConnectionRegionIdString是物理专线所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
AccessPointIdString是物理专线的接入点ID,所选择的接入点必须存在且处于可接入的状态.
CircuitCodeString否运营商的为物理专线提供的电路编码.
LineOperatorString是提供接入物理线路的运营商,取值:CT:中国电信-CU:中国联通-CM:中国移动-CO:中国其他-Equinix:Equinix-Other:境外其他-PeerLocationString是本地数据中心的地理位置.
长度为[2,256]个英文或中文字符,不能以"http://"或"https://"开头.
BandwidthString否物理专线接入带宽,单位为Mbps,默认值为100,取值范围为[2,10240]PortTypeString否物理专线接入端口类型,取值:100Base-T:百兆电口-1000Base-T(默认值):千兆电口-1000Base--专有网络VPC开发指南57返回参数LX:千兆单模光口(10千米)10GBase-T:万兆电口-10GBase-LR:万兆单模光口(10千米)-RedundantPhysicalConnectionIdString否冗余物理专线的ID,该专线的状态必须为Allocated、Confirmed或Enabled.
NameString否物理专线的名称.
长度为[2,128]个英文或中文字符,必须以大小字母或中文开头,可包含数字,下划线(_)和短横线(-),不能以"http://"或"https://"开头.
DescriptionString否物理专线的描述信息.
长度为[2,256]个英文或中文字符,不能以"http://"或"https://"开头.
ClientTokenString否用于保证请求的幂等性.
由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
详情参见如何保证幂等性.
名称类型描述RequestIdString请求ID.
PhysicalConnectionIdString物理专线的ID.
专有网络VPC开发指南58错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例JSON格式CancelPhysicalConnection描述在物理专线开通前取消物理专线接入,取消后物理专线进入Canceled状态.
您只能取消处于Initial、Approved、Allocated和Confirmed状态(未开通状态)的物理专线.
请求参数http://vpc.
aliyuncs.
com/Action=CreatePhysicalConnection&RegionId=cn-beijing&AccessPointId=ap-cn-beijing-ft-A&LineOperator=CT&PeerLocation=北京市XX街XX号&{"PhysicalConnectionId":"pc-"RequestId":"8A6A5EC5-6F6C-4906-9689-56ACE58A13E0"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值专有网络VPC开发指南59返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例JSON格式:CancelPhysicalConnectionRegionIdString是物理专线所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
PhysicalConnectionIdString是物理专线的ID.
名称类型描述RequestIdString请求ID.
http://vpc.
aliyuncs.
com/Action=CancelPhysicalConnection&PhysicalConnectionId=pc-2zeoaxkq3xxxxx&RegionId=cn-beijing&{"RequestId":"BE36E95A-F83E-4127-A29E-F2F35D4C999A"}专有网络VPC开发指南60DescribePhysicalConnections描述查询指定区域内物理专线的列表.
目前支持通过参数PhysicalConnectionId、AccessPointId、Type、LineOperator、Spec、Status和Name对查询结果进行过滤.
每个参数可以提供多个值,多个值之间是"or"关系,即只要与其中一个值符合则视为符合参数的过滤条件.
各个参数之间为"and"逻辑关系,即符合所有参数的过滤条件,才会进入最终查询结果中.
请求参数返回参数名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DescribePhysicalConnectionsRegionIdString是物理专线所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
Filter.
n.
KeyString否第n个参数的名称,取值范围为[1,5]Filter.
n.
Value.
mString否第n个参数的第m个值,m的取值范围为[1,5]PageNumberInteger否实例状态列表的页码,起始值为1,默认值为1PageSizeInteger否指定分页查询时每页的行数,最大值为50,默认值为10名称类型描述RequestIdString请求ID.
专有网络VPC开发指南61错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例JSON格式PhysicalConnectionSetJSONstring物理专线的详细信息,详情参见PhysicalConnectionSetType.
TotalCountInteger列表的条目数.
PageNumberInteger当前页面.
PageSizeInteger当前分页包含的条目数.
http://vpc.
aliyuncs.
com/Action=DescribePhysicalConnections&RegionId=cn-beijing&{"PageNumber":1,"TotalCount":1,"PageSize":10,"RequestId":"7C07B0AF-4FC0-4BB2-9667-F75812824BCD","PhysicalConnectionSet":{"PhysicalConnectionType":[{"Type":"VPC","PhysicalConnectionId":"pc-2zeoaxkq3jot5p71qcnuy","PeerLocation":"北京市-XX区--XXX路","CreationTime":"2017-12-13T02:28:42Z","Name":"TEST","Status":"Enabled","AdLocation":"北京市--XX-XXX机房XX机柜XXU","EnabledTime":"2017-12-18T04:01:30Z","BusinessStatus":"Normal","LineOperator":"CT","PortNumber":"1/1/4","AccessPointId":"ap-cn-beijing-dx-A","PortType":"100Base-T","Bandwidth":2专有网络VPC开发指南62ModifyPhysicalConnectionAttribute描述修改物理专线的属性.
调用本接口修改物理专线的属性时,请注意:只有处于Initial或Rejected状态的物理专线可以修改Spec和RedundantPhysicalConnectionId.
无法修改处于Canceled、Allocating、AllocationFailed和Terminated状态的物理专线.
处于Rejected状态的物理专线被修改后会进入Initial状态.
请求参数}]}}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:ModifyPhysicalConnectionAttributeRegionIdString是物理专线所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
PhysicalConnectionIdString是物理专线的ID.
LineOperatorString否提供接入物理线路的运营商,取值:CT:中国电信-CU:中国联通-专有网络VPC开发指南63CM:中国移动-CO:中国其他-Equinix:Equinix-Other:境外其他-bandwidthString否物理专线的接入带宽,单位为Mbps,取值范围为:[2,10240]PeerLocationString否本地数据中心的的地理位置.
PortTypeString否物理专线的接入端口类型,取值:100Base-T:百兆电口-1000Base-T:千兆电口-1000Base-LX:千兆单模光口(10千米)-10GBase-T:万兆电口-10GBase-LR:万兆单模光口(10千米)-RedundantPhysicalConnectionIdString否冗余物理专线的ID.
CircuitCodeString否运营商为物理专线提供的电路编码.
NameString否物理专线的名称,默认值为空.
长度为[2,128]个英文或中文字符,必须以大小字母或中文开头,可包含数字,下划线(_)和短横线(-)不能以"http://"或"https://"开头.
DescriptionString否物理专线的描述信息,默认值为空.
长度为[2,256]个英文或中文字符,不能以"http://"或专有网络VPC开发指南64返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例JSON格式TerminatePhysicalConnection"https://"开头.
ClientTokenString否用于保证请求的幂等性.
由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
具体参见附录:如何保证幂等性.
名称类型描述RequestIdString请求ID.
http://vpc.
aliyuncs.
com/Action=ModifyPhysicalConnectionAttribute&PhysicalConnectionId=pc-2zeoaxkq3xxxxx&RegionId=cn-beijing&Name=test3&{"RequestId":"8591E598-8519-48A9-9E08-72551537C199"}专有网络VPC开发指南65描述在物理专线开通后终止物理专线接入.
调用本接口后物理专线进入Terminating状态,处理完成后进入Terminated状态.
调用本接口终止物理专线时,请注意:只能终止处于Enabled状态的物理专线.
终止物理专线之前,必须删除与其关联的VBR.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:TerminatePhysicalConnectionRegionIdString是物理专线所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
PhysicalConnectionIdString是物理专线的ID.
名称类型描述RequestIdString请求ID.
专有网络VPC开发指南66示例请求示例返回示例JSON格式EnablePhysicalConnection描述开通处于Confirmed状态的物理专线,开通完成后物理专线进入Enabled状态.
请求参数http://vpc.
aliyuncs.
com/Action=TerminatePhysicalConnection&PhysicalConnectionId=pc-2zeoaxkq3xxxxx&RegionId=cn-beijing&{"RequestId":"513E0A50-4F2D-4CBE-BF35-40559DF65D79"}名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:EnablePhysicalConnectionRegionIdString是物理专线所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
专有网络VPC开发指南67返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例返回示例JSON格式PhysicalConnectionIdString是物理专线的ID.
ClientTokenString是用于保证请求的幂等性.
由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
详情参见如何保证幂等性.
名称类型描述RequestIdString请求ID.
http://vpc.
aliyuncs.
com/Action=EnablePhysicalConnection&PhysicalConnectionId=pc-2zeoaxkq3xxxxx&RegionId=cn-beijing&ClientToken=3fGlrDSu8CLXlg8f&{"RequestId":"12D57AA8-03E8-4926-A00E-77A54DD75247"}专有网络VPC开发指南68DeletePhysicalConnection描述删除物理专线.
只能删除处于Rejected,Canceled,AllocationFailed和Terminated状态的物理专线.
请求参数返回参数错误码关于本接口的错误码的详细解释,请参见VPCAPI错误中心.
示例请求示例名称类型是否必须描述ActionString是接口名,系统规定参数.
取值:DeletePhysicalConnectionRegionIdString是物理专线所在的地域.
您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID.
PhysicalConnectionIdString是物理专线的ID.
名称类型描述RequestIdString请求ID.
专有网络VPC开发指南69-------返回示例JSON格式路由器接口新建路由器接口描述创建一个路由器接口(RouterInterface).
该API仅用于生成一个RouterInterface,并未触发连接动作.
若要真的实现路由器接口的互联,需要使用后面的"发起路由器接口连接"操作.
路由器接口之间的"互连",表示两个路由器通过一根虚拟的"链路"连接起来.
若要在链路上正确的实现消息的传递,还需要在两边的路由器上正确地配置路由表,以及在实际通信的对象上正确的配置访问控制规则;任意两个路由器之间,最多只能存在一对互连的RouterInterface.
一个路由器上可以最多创建5个路由器接口.
一个用户名下最多可以同时拥有5个路由器接口.
若用户名下有RI处于欠费状态,则不允许新建更多的路由器接口.
OppositeRouterType、OppositeRouterId、OppositeInterfaceId、OppositeInterfaceOwnerId四个参数,用于两个路由器接口互连时进行校验.
在发起连接时必须事先填好.
所以,您可以选择在创建时就填好,或者创建出路由器接口之后调用ModifyRouterInterfaceAttribute来修改.
对于创建本端或对端是VBR上的RouterInterface时:http://vpc.
aliyuncs.
com/Action=DeletePhysicalConnection&PhysicalConnectionId=pc-2zeoaxkq3xxxxx&RegionId=cn-beijing&{"RequestId":"88FD7826-6186-4C4C-9733-3892E02496EC"}专有网络VPC开发指南70---qqqq-增加AccessPointId和OppositeAccessPointId参数,描述和限制见以下参数表新增HealthCheckSourceIp和HealthCheckTargetIp参数,描述和限制见以下参数表VBR只能是发起端,此时对端(接收端)只能是VRouter,具体的限制如下:如果RouterType(本端)是VBR,Role必须是InitiatingSide,而且OppositeRouterType只能是VRouter并且不能修改对端是VBR的RouterInterface只能是接收端,在创建时必须指定对端的RouterType(VBR)和AccessPointId,而且创建后不能修改这两个属性,具体的限制如下:OppositeRouterType不允许从其他值(VRouter或空)改为VBR,或从VBR改为其他值(VRouter或空)OppositeRouterType是VBR时Role(本端)必须是AcceptingSide,而且OppositeAccessPointId是必填并且不可改在VBR上创建RouterInterface要求VBR必须当时必须处于Active状态请求参数名称类型是否必须描述ActionString是操作接口名,系统规定参数,取值:CreateRouterInterfaceRegionIdString是实例所在的地域RouterTypeString是所属的路由器类型.
可选值:VRouter,VBRAccessPointIdString否所属的接入点ID.
在RouterType是VBR时必填,而且创建后不允许修改.
在RouterType是VRouter时不能填.
RouterIdString是所属的路由器Id,在RouterType是VBR时RouterId所指定的VBR必须在AccessPointId所指定的接入点内.
RoleString是连接中扮演的角色,即,是连接发起端还是连接接受端.
可选值:InitiatingSide|AcceptingSide;SpecString是规格,详见阿里云文档-网络产品-高速通道-地域、规格与价格OppositeRegionIdString是要连接的对端所在的Region.
专有网络VPC开发指南71OppositeAccessPointIdString否对端所属的接入点ID.
在OppositeRouterType是VBR时必填,而且创建后不允许修改.
在OppositeRouterType是VRouter时不能填.
在OppositeRouterType是VBR时OppositeRouterId所指定的VBR必须在OppositeAccessPointId所指定的接入点内.
在创建/修改RouterInterface时不会做对端OppositeRouterId,OppositeAccessPointId等的校验,在进行连接操作时会出错.
OppositeRouterTypeString否要连接的对端路由器接口所属的路由器类型.
可选值:VRouter,VBR;缺省为VRouter类型.
OppositeRouterIdString否要连接的对端的路由器的ID.
在OppositeRouterType是VBR时OppositeRouterId所指定的VBR必须在OppositeAccessPointId所指定的接入点内.
在创建/修改RouterInterface时不会做对端OppositeRouterId,OppositeAccessPointId等的校验,在进行连接操作时会出错.
OppositeInterfaceIdString否要连接的对端RouterInterface的IdOppositeInterfaceOwnerIdString否连接对端路由器接口的持有者账号ID.
您可以登录阿里云官网以后,在控制台-用户中心-账号管理中看到您的账号ID.
NameString否实例的显示名称,[2,128]英文或中文字符,必须以大小字母或中文开头,可包含数字,".
","_"或"-".
专有网络VPC开发指南72实例名称会显示在控制台.
如果没有指定该参数,默认值为实例的InstanceId不能以http://和https://开头.
DescriptionString否自定义描述[[2,256]个字符,实例描述会显示在控制台.
不填则为空,默认为空.
不能以http://和https://开头HealthCheckSourceIpString否专线容灾和ECMP场景下用来做专线HealthCheck的Packet的SourceIP.
只对本端是VRouter而且对端是VBR的RouterInterface有效.
必须是本端VRouter所在的VPC内的一个未被使用的IP.
HealthCheckSourceIp与HealthCheckTargetIp必须同时指定或同时不指定.
HealthCheckTargetIpString否专线容灾和ECMP场景下用来做专线HealthCheck的Packet的TargetIP.
只对本端是VRouter而且对端是VBR的RouterInterface有效.
通常可以用专线用户端CPE的IP(也就是对端RI所在的VBR上的PeerGatewayIp),用户也可以指定专线用户端的其他可以用来做HealthCheckTarget的IP.
HealthCheckSourceIp与HealthCheckTargetIp必须同时指定或同时不指定.
ClientTokenString否用于保证请求的幂等性.
由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符.
具体参见附录:如何保证幂等性.
专有网络VPC开发指南73返回参数错误码名称类型描述RouterInterfaceIdString路由器接口的实例ID,由系统生成,全局唯一.
是操作路由器接口实例的唯一标识错误代码描述Http状态码语义InvalidRegionId.
NotFoundTheRegionIdprovideddoesnotexistinourrecords.
404指定的RegionId不存在InvalidOppositeRegionId.
NotFoundTheOppositeRegionIdprovideddoesnotexistinourrecords.
404用户填写的OppositeRegionId是一个不存在的regionIdInvalidRegionPair.
NotReachableThespecifiedOppositeRegionisnotreachablebyExpressConnectfromthatregionspecifiedby'RegionId'400用户指定的两个region是无法通过高速通道产品进行连接的.
InvalidRole.
ValueNotSupportedThespecifiedRoleisnotvalid.
400指定的Role不合法InvalidSpec.
ValudNotSupportedThespecifiedSpecisnotsupported.
400指定的Spec不支持InvalidRouterType.
ValueNotSupportedThespecifiedRouterTypeisnotvalid400指定的RouterType不合法InvalidRouterId.
NotFoundThespecifiedRouterIddoesnotexistinourrecored.
404指定的RouterId不存在InvalidOppositeRouterType.
ValueNotSupportedThespecifiedOppositeRouterTypeisnotvalid.
400指定的OppositeRouterType不合法ParameterMismatch.
Role-SpecThespecifiedSpecandRolemismatch.
400指定的Spec和Role不匹配ParameterMismatch.
RegionId-OppositeRegionId-SpecThespecifiedSpecisnotsupportedbetweenthespecifiedRegionIdandOppositeRegionId.
400该规格在这两个Region之间不支持.
专有网络VPC开发指南74查询路由器接口列表InvalidName.
MalformedThespecified'Name'isnotvalid.
400指定的Name不合法InvalidDescription.
MalformedThespecifid'Description'isnotvalid.
400指定的Description不合法Forbidden.
BillsOutstandingYoucannotcreatemoreRouterInterfacebecauseyouhavebillsoutstanding.
400有未结清的账单,因而拒绝创建更多的后付费资源;QuotaExceed.
RouterInterfaceLivingRouterInterfacequotaexceeded.
400已有路由器接口数量超过配额LimitationExceed.
InterfaceNumberOnRouterTotalnumberofRouterInterfacesonaRouterexceeded.
400单个路由器上存在的路由器接口数量超过配额Forbidden.
NotInRouterInterfaceCreateWhitelistNotinrouterinterfacecreatewhitelist.
500帐号不在创建路由器接的白名单中RI_CREATE_ONE_LIMIT_BY_SYNCCreaterionlyonelimitbysync.
500InvalidAccessPoint.
ValueNotAllowedThenon-vbrrouterinterfacecannothaveaccesspointconfigured.
500非VBR路由器接口不能指定接入点信息InvalidAccessPoint.
ValueNotAllowedThenon-vbroppositerouterinterfacecannothaveoppositeaccesspointconfigured.
500非VBR对端路由器接口不能指定接入点信息InvalidParam.
NotFoundParametermustnotbenull,uid,bid,regionNo,remoteRegionNoorrouterId400'uid','bid','regionNo','remoteRegionNo'或者'routerId'不能为空InvalidAccessPoint.
NotMatchTheaccessPointidisnotmatched400接入点Id不匹配InvalidAccessPoint.
NotExistTheaccessPointnotexit400接入点Id不存在专有网络VPC开发指南75qqqqqqqqqq描述查看路由器接口列表.
可通过各种Filter对结果进行过滤.
目前支持的Filter包括:RouterInterfaceIdRouterIdRouterTypeRouterInterfaceOwnerIdOppositeInterfaceIdOppositeRouterTypeOppositeRouterIdOppositeInterfaceOwnerIdStatusName一个Filter的多个值之间是"or"关系(只要与其中一个值吻合则视为符合该Filter的过滤条件);各个Filter之间为"and"逻辑关系(符合所有Filter的过滤条件,才会进入最终查询结果中).
请求参数名称类型是否必须描述Actionstring是系统规定参数,取值:DescribeRouterInterfacesRegionIdstring是实例所在的地域Filter.
n.
Keystring否第n个过滤器的类型.
N从1开始,不大于5;Filter.
n.
Value.
mstring否第n个过滤器的第m个值.
M从1开始,不大于5PageNumberint否查询结果的页码;不指定时,默认为1;取值范围:正整数;若PageNumber大于实际结果的最大页码,则返回最后一页的内容.
PageSizeint否查询结果的分页大小.
取值范围为[1,100],默认为10专有网络VPC开发指南76---返回参数错误码发起路由器接口连接描述发起开放路由器接口互联请求,将一个发起端RouterInterface与其对端RouterInterface进行连接.
关于功能的说明:只允许对Role为InitiatingSide的RouterInterface进行该操作;对于一个Role为AcceptingSide的RouterInterface来说,只能将连接对端信息设置好后,等待对方发起连接操作.

只有当对端RouterInterface也将连接对端设置为该RouterInterface,发起连接操作才能成功完成.
这是一个异步操作,API调用返回成功,意味着连接搭建工作已经开始,RouterInterface的Status进入Connecting状态(AcceptingSide的RouterInterface进入AcceptingConnect状态);当RouterInterface进入Active状态时,连接才真正搭建起来.