1. CreateNetwork
接口描述
创建网络域
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
VpcId |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
DisplayName |
String |
否 |
网络域显示名称(最大字符长度不超过100) |
|
Type |
NetworkType |
是 |
网络域类型(通过枚举类NetworkType获取type值) |
|
ServiceProductType |
NetworkServiceProductType |
是 |
网络服务产品类型(通过枚举类NetworkServiceProductType获取值) |
|
Subnets |
String |
否 |
子网创建配置参数,JSON格式 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
2. DeleteNetwork
接口描述
删除网络域
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
网络域Id(通过ListNetworks获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
3. GetNetwork
接口描述
获取网络域信息
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
网络域Id(通过ListNetworks获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Network |
NetworkBean |
网络域信息 |
|
Subnets |
List<SubnetBean> |
子网信息列表 |
|
4. ListAvailableIPs
接口描述
查询指定网络域下所有可用IP数量
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
NetworkId |
String |
是 |
网络域Id(通过ListNetworks获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AvailableIPNumber |
Integer |
可用IP数量 |
|
5. ListNetworks
接口描述
查询网络域
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
否 |
网络域Id(通过ListNetworks获取id值) |
|
Name |
String |
否 |
网络域名称 |
|
VpcId |
String |
否 |
VPC Id(通过ListVpcs获取id值) |
|
RegionId |
String |
否 |
地域Id(通过ListRegions获取id值) |
|
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
Type |
NetworkType |
否 |
网络域类型(通过枚举类NetworkType获取type值) |
|
Status |
NetworkStatus |
否 |
网络域状态(通过枚举类NetworkStatus获取status值) |
|
ServiceProductType |
NetworkServiceProductType |
否 |
网络域服务产品类型(通过枚举类NetworkServiceProductType获取值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Networks |
List<NetworkBean> |
网络域信息列表 |
|
TotalCount |
Long |
总数 |
|
6. ListRegionNetworkType
接口描述
查询地域下支持的网络域类型
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RegionId |
String |
否 |
地域UUID |
|
ServiceProductType |
NetworkServiceProductType |
否 |
网络域服务产品类型(通过枚举类NetworkServiceProductType获取值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
NetworkTypes |
List<String> |
网络域类型信息 |
|
7. ModifyNetworkAttribute
接口描述
修改网络域属性
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
网络域Id(通过ListNetworks获取id值) |
|
DisplayName |
String |
否 |
网络域显示名称 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
8. SelectNetworkItem
接口描述
根据VPC选择网络域
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
VpcId |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
ServiceProductType |
NetworkServiceProductType |
否 |
网络域服务类型(通过枚举类NetworkServiceProductType获取值) |
|
Type |
NetworkType |
否 |
网络域类型(通过枚举类NetworkType获取type值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Selects |
List<SelectItemBean> |
选项信息列表 |
|
9. CheckTargetVpc
接口描述
校验对端VPC
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
DstRegionId |
String |
是 |
对端地域Id(通过ListRegions获取id值) |
|
DstVpcName |
String |
是 |
对端VPC名称(通过ListVpcs获取name值) |
|
DstTenantName |
String |
是 |
对端租户名称(通过GetUser获取tenantName值) |
|
Phone |
String |
是 |
对端vpc所属租户下的任一子账户手机号(手机号码前加区号), |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
VpcId |
String |
VPC Id |
|
TenantId |
String |
租户Id |
|
10. CreatePeer
接口描述
创建高速通道
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
SrcRegionId |
String |
是 |
本端地域Id(通过ListRegions获取地域id信息) |
|
SrcVpcId |
String |
是 |
本端VPC Id(通过ListVpcs获取id信息) |
|
SrcSubnetArray |
String |
是 |
本端子网Id列表,多个子网间用英文逗号(,)分隔,举例:"子网1,子网2,子网3,子网4" |
|
DstTenantId |
String |
否 |
对端租户Id(通过GetUser获取租户tenantUuid) |
|
DstCheckToken |
String |
否 |
对端校验Token(通过接口ListPeerSubnet获取checkToken值) |
|
DstRegionId |
String |
是 |
对端地域Id(通过ListRegions获取地域id信息) |
|
DstVpcId |
String |
是 |
对端VPC Id(通过ListVpcs获取id信息) |
|
DstSubnetArray |
String |
是 |
对端子网Id列表,多个子网间用英文逗号(,)分隔,举例:"子网1,子网2,子网3,子网4" |
|
DisplayName |
String |
否 |
高速通道显示名称(最大字符长度不超过100) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
11. DeletePeer
接口描述
删除高速通道
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
高速通道Id(通过ListPeer获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
12. GetPeer
接口描述
获取高速通道信息
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
高速通道Id(通过ListPeer获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Peer |
PeerBean |
高度通道信息 |
|
SrcSubnets |
List<SubnetBean> |
本端子网信息列表 |
|
DstSubnets |
List<SubnetBean> |
对端子网信息列表 |
|
13. ListPeer
接口描述
查询高速通道
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
否 |
高速通道id |
|
Name |
String |
否 |
高速通道名称 |
|
VpcId |
String |
否 |
本端或对端VPC Id(通过ListVpcs获取id值) |
|
RegionId |
String |
否 |
本端或对端Region Id(通过ListRegions获取id值) |
|
PeerStatus |
PeerStatus |
否 |
高速通道状态(通过枚举类PeerStatus获取status值) |
|
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
PeerList |
List<PeerBean> |
高速通道信息列表 |
|
TotalCount |
Long |
总数 |
|
14. ListPeerSubnet
接口描述
查询高速通道子网
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
否 |
高速通道Id(通过ListPeer获取id值) |
|
VpcId |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
SmsCode |
String |
否 |
短信授权码(对端子网非本租户时,需要验证,通过手机接收授权码) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Id |
String |
高速通道id |
|
AddedSubnets |
List<SubnetBean> |
已添加高速通道的子网信息列表 |
|
NotAddSubnets |
List<SubnetBean> |
未添加到高速通道的子网信息列表 |
|
CheckToken |
String |
高速通道校验Token(与非本端租户建立高速通道时需要) |
|
15. ModifyPeerAttribute
接口描述
修改高速通道属性
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
高速通道Id(通过ListPeer获取id值) |
|
DisplayName |
String |
否 |
高速通道显示名称(最大字符长度不超过100) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
16. UpdatePeerSubnet
接口描述
更新高速通道子网
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
高速通道Id(通过ListPeer获取id值) |
|
OperationType |
PeerSubnetOperationType |
是 |
高速通道子网操作类型(通过枚举类PeerSubnetOperationType获取值) |
|
SubnetId |
String |
是 |
子网Id(通过ListSubnets获取id值) |
|
SubnetOwnerType |
PeerSubnetOwnerType |
是 |
高速通道子网属主类型(通过枚举类PeerSubnetOwnerType获取值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
17. AddInstanceToSecurityGroup
接口描述
将云主机/网卡添加到安全组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
InstanceId |
String |
否 |
云主机Id,只有与该安全组处于同一网络域下的主机才能加入安全组中 |
|
SecurityGroupId |
String |
是 |
安全组Id |
|
InstanceIds |
String[] |
否 |
云主机Id列表,只有与该安全组处于同一网络域下的主机才能加入安全组中 |
|
NicIds |
String[] |
否 |
网卡Id列表,只有与该安全组处于同一网络域下的网卡才能加入安全组中 |
|
NicId |
String |
否 |
网卡Id,只有与该安全组处于同一网络域下的网卡才能加入安全组中 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
18. AddResourceToSecurityGroup
接口描述
将资源添加到安全组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
ResourceIds |
String[] |
否 |
资源UUID列表,只有与该安全组处于同一网络域下的资源才能加入安全组中 |
|
SecurityGroupId |
String |
是 |
安全组Id |
|
ResourceType |
String |
否 |
资源类型:VIP,ELB |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
19. AddSecurityGroupRule
接口描述
给安全组添加安全组规则
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
SecurityGroupId |
String |
是 |
添加安全组规则的安全组Id |
|
Direction |
DirectionType |
是 |
规则方向,比如: |
|
Cidr |
String |
是 |
授权的ip地址 |
|
Port |
String |
否 |
端口 |
|
Protocol |
ProtocolType |
否 |
协议类型,比如:ALL,TCP,UDP,ICMP |
|
IcmpCode |
String |
否 |
ICMP协议的code |
|
IcmpType |
String |
否 |
ICMP类型 |
|
Description |
String |
否 |
描述 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
SecurityGroupRule |
SecurityGroupRuleBean |
安全组规则信息 |
|
20. CheckDependencyForDeleteSG
接口描述
删除安全组前检查依赖资源
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
安全组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
DependentList |
List<DependentInfoBean> |
资源依赖信息列表 |
|
21. CreateSecurityGroup
接口描述
创建安全组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
NetworkId |
String |
是 |
创建安全组所属的网络域Id |
|
DisplayName |
String |
否 |
安全组在门户的显示名称 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
SecurityGroup |
SecurityGroupBean |
安全组详细信息 |
|
22. DeleteSecurityGroup
接口描述
根据安全组id的删除安全组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
安全组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
23. ListSecurityGroupResources
接口描述
查询安全组绑定的资源接口
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认1。 |
|
PageSize |
Integer |
否 |
分页大小,默认1000。 |
|
ResourceType |
String |
是 |
资源类型 |
|
SecurityGroupId |
String |
是 |
安全组id |
|
Name |
String |
否 |
资源名称(模糊查询) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Resources |
List<ResourceBean> |
实例 |
|
TotalCount |
Long |
安全组信息列表的总数 |
|
24. ListSecurityGroupRules
接口描述
查询安全组规则
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
否 |
安全组规则Id |
|
SecurityGroupId |
String |
否 |
安全组Id |
|
Direction |
DirectionType |
否 |
安全组规则方向,比如: |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
SecurityGroupRules |
List<SecurityGroupRuleBean> |
安全组规则信息列表 |
|
25. ListSecurityGroups
接口描述
查询安全组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
否 |
安全组Id |
|
Name |
String |
否 |
安全组名称 |
|
DisplayName |
String |
否 |
安全组在门户的显示名 |
|
RegionId |
String |
否 |
安全组所属的地域Id。 |
|
InstanceId |
String |
否 |
云主机实例Id。 |
|
VpcId |
String |
否 |
VPC Id |
|
VpcName |
String |
否 |
VPC名称 |
|
NetworkName |
String |
否 |
网络域名称 |
|
NetworkId |
String |
否 |
网络域Id |
|
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
NicId |
String |
否 |
网卡Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
SecurityGroups |
List<SecurityGroupBean> |
安全组信息列表 |
|
TotalCount |
Long |
安全组信息列表的总数 |
|
26. ListVpcSecurityGroupInstances
接口描述
查询安全组绑定的实例接口
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认1。 |
|
PageSize |
Integer |
否 |
分页大小,默认1000。 |
|
InstanceType |
String |
否 |
实例类型:Ecs,Caas普通云主机;Dedicated:专属云主机;Nic:网卡 |
|
SecurityGroupId |
String |
否 |
安全组id |
|
Name |
String |
否 |
实例名称 |
|
Status |
InstanceStatus |
否 |
实例状态 |
|
NicStatus |
NicStatus |
否 |
网卡状态 |
|
PrivateIpAddress |
String |
否 |
私有ip地址 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Instances |
List<InstanceBean> |
实例数量 |
|
TotalCount |
Long |
安全组信息列表的总数 |
|
27. ModifySecurityGroupAttribute
接口描述
根据安全组id修改安全组属性
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
需要修改的安全组Id |
|
DisplayName |
String |
否 |
安全组在门户上的显示名 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
28. ModifySecurityGroupRule
接口描述
修改安全组规则
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Description |
String |
否 |
描述 |
|
Id |
String |
是 |
安全组规则id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
29. RemoveInstanceFromSecurityGroup
接口描述
将云主机移出安全组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
InstanceId |
String |
否 |
移除的云主机Id |
|
SecurityGroupId |
String |
是 |
安全组Id |
|
InstanceIds |
String[] |
否 |
移除的云主机Id列表 |
|
NicIds |
String[] |
否 |
移除的网卡Id列表 |
|
NicId |
String |
否 |
移除的网卡Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
30. RemoveResourceFromSecurityGroup
接口描述
将资源移出安全组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
ResourceIds |
String[] |
否 |
移除的资源UUIds |
|
ResourceType |
String |
否 |
移除的资源类型 |
|
SecurityGroupId |
String |
是 |
安全组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
31. RemoveSecurityGroupRule
接口描述
根据安全组规则id删除安全组规则
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
将要被删除的安全组规则Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
32. CreateSubnet
接口描述
创建子网
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
NetworkId |
String |
是 |
网络域Id(通过ListNetworks获取id值 ) |
|
ZoneId |
String |
是 |
可用区Id(通过ListZones获取id值) |
|
NetmaskLength |
Integer |
否 |
子网掩码长度,不可与子网掩码同时为空(通过接口DescribeNetmaskRange获取掩码长度范围) |
|
Netmask |
String |
否 |
子网掩码,不可与子网掩码长度同时为空 |
|
DisplayName |
String |
否 |
子网显示名(最大字符长度不超过100) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
33. DeleteSubnet
接口描述
删除子网
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
子网Id(通过ListSubnets获取id值 ) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
34. DescribeNetmaskRange
接口描述
获取子网掩码长度范围
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
MinNetmaskLength |
Integer |
最小子网掩码长度 |
|
MaxNetmaskLength |
Integer |
最大子网掩码长度 |
|
35. DescribeSubnetItems
接口描述
根据vpcId获取网络域下的子网信息及子网下的可用ip数
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
VpcId |
String |
是 |
VPC Id |
|
ServiceProductType |
NetworkServiceProductType |
否 |
网络域服务类型 |
|
Type |
NetworkType |
否 |
网络域类型 |
|
ZoneUuid |
String |
是 |
可用区Id(通过ListZones获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
NetworkItemBeans |
List<NetworkItemBean> |
网络域Item项 |
|
36. ListAvailableAddrs
接口描述
查询子网下可用ip地址
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
Id |
String |
是 |
子网Id(通过ListSubnets获取id值 ) |
|
Ip |
String |
否 |
ip地址 支持模糊查询 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
TotalCount |
Long |
总数 |
|
AvailableAddrs |
List<String> |
子网信息列表 |
|
37. ListSubnets
接口描述
查询子网
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
NetworkId |
String |
否 |
网络域Id(通过ListNetworks获取id值 ) |
|
Id |
String |
否 |
子网Id(通过ListSubnets获取id值 ) |
|
Name |
String |
否 |
子网名称 |
|
RegionId |
String |
否 |
地域Id(通过ListRegions获取id值) |
|
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
Status |
SubnetStatus |
否 |
子网状态(通过枚举类SubnetStatus获取status值) |
|
VpcId |
String |
否 |
VPC Id(通过ListVpcs获取id值) |
|
ZoneId |
String |
否 |
地域Id(通过ListZones获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
TotalCount |
Long |
总数 |
|
Subnets |
List<SubnetBean> |
子网信息列表 |
|
38. ListZoneAvailableIPs
接口描述
查询可用区可用IP数
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
NetworkId |
String |
是 |
网络域Id(通过ListNetworks获取id值 ) |
|
ZoneUuid |
String |
是 |
可用区Id(通过ListZones获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AvailableIPNumber |
Integer |
可用Ip数 |
|
39. ListZoneAvailableIPsBySubnet
接口描述
根据子网ID查询可用IP数
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
SubnetId |
String |
是 |
子网Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AvailableIPNumber |
Integer |
可用Ip数 |
|
40. ModifySubnetAttribute
接口描述
修改子网属性
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
子网Id(通过ListSubnets获取id值 ) |
|
DisplayName |
String |
否 |
子网显示名称(最大字符长度不超过100) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
41. SelectSubnetItem
接口描述
根据网络域选择子网
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
NetworkId |
String |
是 |
网络域Id(通过ListNetworks获取id值 ) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Selects |
List<SelectItemBean> |
选项信息列表 |
|
42. BindVip
接口描述
绑定VIP
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
InstanceUuidList |
String[] |
是 |
绑定的实例列表 |
|
VipUuid |
String |
是 |
Vip的UUID |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
43. CreateVip
接口描述
创建VIP
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
SubnetId |
String |
是 |
子网的UUID |
|
DisplayName |
String |
否 |
显示名称(最大长度为20) |
|
AutoConfig |
Boolean |
否 |
是否手动配置 |
|
Ip |
String |
否 |
IP |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
44. DeleteVip
接口描述
删除VIP
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
VipUuid |
String |
是 |
VIP的UUID |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
45. ListInstanceForVip
接口描述
查询VIP绑定的实例
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
SubnetId |
String |
否 |
子网UUID |
|
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
Name |
String |
否 |
实例名称 |
|
VipUuid |
String |
否 |
VIP的UUID |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
InstanceBeanList |
List<InstanceBean> |
绑定实例信息列表 |
|
TotalCount |
Integer |
总数 |
|
46. ListVip
接口描述
查询VIP
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
SubnetId |
String |
否 |
子网UUID |
|
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
Name |
String |
否 |
名称 |
|
NetworkId |
String |
否 |
网络域的UUID |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Vips |
List<VipBean> |
VIP信息列表 |
|
TotalCount |
Long |
总数 |
|
47. ModifyVip
接口描述
修改VIP
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
DisplayName |
String |
否 |
显示名称(最大长度为20) |
|
VipUuid |
String |
是 |
VIP的UUID |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
48. UnBindVip
接口描述
解绑VIP
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
InstanceUuidList |
String[] |
是 |
实例UUID集合 |
|
VipUuid |
String |
是 |
VIP的UUID |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
49. CheckDependencyForDeleteVpc
接口描述
删除VPC前检查依赖
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
DependentList |
List<DependentInfoBean> |
依赖信息列表 |
|
50. CreateVpc
接口描述
创建VPC
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RegionId |
String |
是 |
地域Id(通过ListRegions获取id值) |
|
DisplayName |
String |
否 |
VPC显示名称(最大字符长度不超过100) |
|
Description |
String |
否 |
VPC描述信息(最大字符长度不超过255) |
|
VpcCategory |
String |
是 |
VPC类型(通过接口ListVpcCategory获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
51. DeleteVpc
接口描述
删除VPC
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
52. GetDependentVpcResource
接口描述
获取依赖VPC的资源
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
DependentResourceNums |
List<DependentVpcResourceBean> |
依赖VPC的资源信息列表 |
|
53. GetVpc
接口描述
获取VPC信息
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Vpc |
VpcBean |
VPC信息 |
|
54. GetVpcSummary
接口描述
获取VPC概览信息
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RegionId |
String |
是 |
地域Id(通过ListRegions获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
VpcSum |
Long |
VPC总数 |
|
NetworkSum |
Long |
网络域总数 |
|
SubnetSum |
Long |
子网总数 |
|
55. ListVpcCategory
接口描述
查询VPC类型
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
VpcCategorys |
List<VpcCategoryBean> |
VPC类型信息列表 |
|
56. ListVpcRoute
接口描述
查询VPC路由列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
VpcId |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
VpcRouteList |
List<VpcRouteBean> |
VPC路由信息列表 |
|
57. ListVpcs
接口描述
查询VPC
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RegionId |
String |
是 |
地域Id(通过ListRegions获取id值) |
|
VpcId |
String |
否 |
VPC Id(通过ListVpcs获取id值) |
|
PageNumber |
Integer |
否 |
分页页码 |
|
PageSize |
Integer |
否 |
分页大小 |
|
Status |
VpcStatus[] |
否 |
VPC状态(通过枚举类VpcStatus获取值) |
|
Name |
String |
否 |
VPC名称 |
|
GetDependencyNum |
boolean |
否 |
是否获取依赖资源数(默认为false) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Vpcs |
List<VpcBean> |
VPC信息列表 |
|
TotalCount |
Long |
总数 |
|
58. ModifyVpcAttribute
接口描述
修改VPC属性
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
VPC Id(通过ListVpcs获取id值) |
|
DisplayName |
String |
否 |
VPC显示名称(最大字符长度不超过100) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
59. SelectVpcItem
接口描述
根据VPC状态查询VPC
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RegionId |
String |
是 |
地域Id(通过ListRegions获取id值) |
|
Status |
VpcStatus |
否 |
VPC状态(通过枚举类VpcStatus获取status值) |
|
IsCreateIGW |
Boolean |
否 |
是否创建IGW(当创建igw时,通过该参数过滤掉已经被igw绑定的vpc) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Selects |
List<SelectItemBean> |
选项信息列表 |
|