API Description

<p><strong>1. CreateNetwork</strong></p> <p><strong>Interface Description</strong></p> <p>Create Network Domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get Id number by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display the name of network domain</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Type</p> </td> <td> <p>NetworkType</p> </td> <td> <p>yes</p> </td> <td> <p>Type of network domain (get type value by enum type NetworkType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ServiceProductType</p> </td> <td> <p>NetworkServiceProductType</p> </td> <td> <p>yes</p> </td> <td> <p>Product type of network service (Get Value by enum type NetworkServiceProductType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Subnets</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Subnet creates configuration parameters, in format JSON, the format is similar to: [{&quot;Display&quot;:&quot;display&quot;,&quot;NetMask&quot;:29,&quot;zoneId&quot;:&quot;Zone-southChinaA&quot;}]</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2. DeleteNetwork</strong></p> <p><strong>Interface Description</strong></p> <p>Delete Network Domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network domain ID(get ID by ListNetworks)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>3. GetNetwork</strong></p> <p><strong>Interface Description</strong></p> <p>Get information of Network Domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network domain ID(get ID by ListNetworks)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Network</p> </td> <td> <p>NetworkBean</p> </td> <td> <p>Information of Network Domain</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Subnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>List of subnet information</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4. ListAvailableIPs</strong></p> <p><strong>Interface Description</strong></p> <p>Query all available quantities</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network domain ID(get ID by ListNetworks)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>AvailableIPNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>available quantities of IP</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>5. ListNetworks</strong></p> <p><strong>Interface Description</strong></p> <p>Query Network Domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Network domain ID(get ID by ListNetworks)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Network domain name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPC Id(get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Region Id(get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Page size</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderBy</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Order by keywords(could be ordered by field value, id or name)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderType</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Type of order (Optional value: ASC/DESC,&nbsp; ASC stands for &nbsp;ascending, while DESC stands for descending)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Type</p> </td> <td> <p>NetworkType</p> </td> <td> <p>no</p> </td> <td> <p>Type of network domain(get type by enum NetworkType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>NetworkStatus</p> </td> <td> <p>no</p> </td> <td> <p>Status of network domain(get Status by enum NetworkStatus)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ServiceProductType</p> </td> <td> <p>NetworkServiceProductType</p> </td> <td> <p>no</p> </td> <td> <p>Product type of network service(Get value by enum NetworkServiceProductType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Networks</p> </td> <td> <p>List&lt;NetworkBean&gt;</p> </td> <td> <p>Information list of network domain</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>6. ModifyNetworkAttribute</strong></p> <p><strong>Interface Description</strong></p> <p>Modify the property of network domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network domain Id(Get id by ListNetworks)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Network domain Display name</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>7. SelectNetworkItem</strong></p> <p><strong>Interface Description</strong></p> <p>Select network domain by VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get id value by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ServiceProductType</p> </td> <td> <p>NetworkServiceProductType</p> </td> <td> <p>no</p> </td> <td> <p>Service type of network domain(Get type value by enum type NetworkServiceProductType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Type</p> </td> <td> <p>NetworkType</p> </td> <td> <p>no</p> </td> <td> <p>Type of network domain(Get type value by enum NetworkType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Selects</p> </td> <td> <p>List&lt;SelectItemBean&gt;</p> </td> <td> <p>Information list of options</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>8. CheckTargetVpc</strong></p> <p><strong>Interface Description</strong></p> <p>Check target VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DstRegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Target region Id(Get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstVpcName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC name of target end(Get name by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstTenantName</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Tenant name of target name(Get tenantName by GetUser)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Phone</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>The phone number of any subaccount under the tenant of the target end vpc</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>VPC Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TenantId</p> </td> <td> <p>String</p> </td> <td> <p>Tenant Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>9. CreatePeer</strong></p> <p><strong>Interface Description</strong></p> <p>Create highspeed channel</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>SrcRegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Local region Id(Get region id information by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SrcVpcId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Local VPC Id(Get id information by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SrcSubnetArray</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Name list of local subnet, separated by multiple English commas (,), for example: &ldquo;subnet 1, subnet 2, subnet 3, subnet 4&rdquo;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstTenantId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Tenant Id of target end(Get tenantUuid of tenant by GetUser)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstCheckToken</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Target end checks Token(Get checkToken by interface ListPeerSubnet)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstRegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Target region Id(Get region id information by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstVpcId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id of target end(Get id information by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Bandwidth</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Bandwidth of highspeed channel(bandwidth should be 1-20)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstSubnetArray</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Name list of local subnet, separated by multiple English commas (,), for example: &ldquo;subnet 1, subnet 2, subnet 3, subnet 4&rdquo;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name of highspeed channel(Maximum string could not exceed 100)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>10.&nbsp;DeletePeer</strong></p> <p><strong>Interface Description</strong></p> <p>Delete highspeed channel</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Id of highspeed channel(Get id by ListPeer)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>11.&nbsp;GetPeer</strong></p> <p><strong>Interface Description</strong></p> <p>Get the information of highspeed channel</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Id of highspeed channel(Get id by ListPeer)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Peer</p> </td> <td> <p>PeerBean</p> </td> <td> <p>Information of highspeed channel</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SrcSubnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>Information list of local subnet</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DstSubnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>Information list of target subnet</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>12.&nbsp;ListPeer</strong></p> <p><strong>Interface Description</strong></p> <p>Query highspeed channel</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Id of highspeed channel</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Name of highspeed channel</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPC Id of local end target end(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Region Id of local end target end(Get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PeerStatus</p> </td> <td> <p>PeerStatus</p> </td> <td> <p>no</p> </td> <td> <p>Status of highspeed channel(Get status by enum PeerStatus)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>page number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>page size</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderBy</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Keywords of order (could be ordered by id and name)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderType</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Type of order(could choose ASC or DESC,&nbsp; ASC stands for&nbsp; ascending, while DESC stands for descending)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>PeerList</p> </td> <td> <p>List&lt;PeerBean&gt;</p> </td> <td> <p>Information list of highspeed channel</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>13.&nbsp;ListPeerSubnet</strong></p> <p><strong>Interface Description</strong></p> <p>Query highspeed channel subnet</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Id of highspeed channel(Get id by ListPeer)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SmsCode</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>SMS authorized code(when the target end is not the tenant, it needs to be verified by SMS authorized code)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>Id of highspeed channel</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>AddedSubnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>Added subnet information list of highspeed channel</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NotAddSubnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>Unadded subnet information list of highspeed channel</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CheckToken</p> </td> <td> <p>String</p> </td> <td> <p>Check Token of highspeed channel(it is needed when creating highspeed channel with the tanent who is not belonging to the local end)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>14.&nbsp;ModifyPeerAttribute</strong></p> <p><strong>Interface Description</strong></p> <p>Modify the attributes of highspeed channel</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Id of highspeed channel(Get id by ListPeer)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name of highspeed channel(Maximum string could not exceed 100)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>15.&nbsp;UpdatePeerSubnet</strong></p> <p><strong>Interface Description</strong></p> <p>Update highspeed channel subnet</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Id of highspeed channel(Get id by ListPeer)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OperationType</p> </td> <td> <p>PeerSubnetOperationType</p> </td> <td> <p>yes</p> </td> <td> <p>Operation Type of highspeed channel subnet(get value by enum PeerSubnetOperationType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Subnet Id(get id by ListSubnets)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetOwnerType</p> </td> <td> <p>PeerSubnetOwnerType</p> </td> <td> <p>yes</p> </td> <td> <p>Owner type of highspeed channel subnet(get value by enum PeerSubnetOwnerType)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>16.&nbsp;CreateSubnet</strong></p> <p><strong>Interface Description</strong></p> <p>Create VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network domain Id(Get id by ListNetworks )</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Available zone Id(get id by ListZones)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetmaskLength</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Length of Subnet mask, could not be empty at the same time as the subnet mask(at present the length of mask could be 22-26)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Netmask</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Subnet mask, could not be empty at the same time as the length of subnet mask</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name of subnet(Maximum string could not exceed 100)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>17.&nbsp;DeleteSubnet</strong></p> <p><strong>Interface Description</strong></p> <p>Delete VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Subnet Id(get id by ListSubnets)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>18.&nbsp;ListSubnets</strong></p> <p><strong>Interface Description</strong></p> <p>Query subnet</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Network domain Id(Get id by ListNetworks )</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Subnet Id(get id by ListSubnets)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Subnet name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Region Id(Get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>page number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>page size</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>SubnetStatus</p> </td> <td> <p>no</p> </td> <td> <p>Subnet Status(get status by enum SubnetStatus)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Region Id(get id by ListZones)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Subnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>Information list of subnet</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>19.&nbsp;ListZoneAvailableIPs</strong></p> <p><strong>Interface Description</strong></p> <p>Quantity of available IP in Query available zone</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network domain Id(Get id by ListNetworks )</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneUuid</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Available zone Id(get id by ListZones)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>AvailableIPNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>Quantity of available IP</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>20.&nbsp;ModifySubnetAttribute</strong></p> <p><strong>Interface Description</strong></p> <p>Modify the attributes of subnet</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Subnet Id(get id by ListSubnets)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name of subnet(Maximum string could not exceed 100)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>21.&nbsp;SelectSubnetItem</strong></p> <p><strong>Interface Description</strong></p> <p>Select subnet by network domain</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network domain Id(Get id by ListNetworks )</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>ParameterName</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Selects</p> </td> <td> <p>List&lt;SelectItemBean&gt;</p> </td> <td> <p>Information list of options</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>22.&nbsp;CheckDependencyForDeleteVpc</strong></p> <p><strong>Interface Description</strong></p> <p>Check Dependency before deleting VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DependentList</p> </td> <td> <p>List&lt;DependentInfoBean&gt;</p> </td> <td> <p>List of dependent information</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>23.&nbsp;CreateVpc</strong></p> <p><strong>Interface Description</strong></p> <p>Create VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Region Id(Get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Description</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Description of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcCategory</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Type of VPC(get id by interface ListVpcCategory)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>24.&nbsp;DeleteVpc</strong></p> <p><strong>Interface Description</strong></p> <p>Delete VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>25.&nbsp;GetDependentVpcResource</strong></p> <p><strong>Interface Description</strong></p> <p>Get resource which depends on VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DependentResourceNums</p> </td> <td> <p>List&lt;DependentVpcResourceBean&gt;</p> </td> <td> <p>Information list of resource which depends on VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>26.&nbsp;GetVpc</strong></p> <p><strong>Interface Description</strong></p> <p>Get information of VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Vpc</p> </td> <td> <p>VpcBean</p> </td> <td> <p>Information of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>27.&nbsp;GetVpcSummary</strong></p> <p><strong>Interface Description</strong></p> <p>Get summary of VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Region Id(Get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpcSum</p> </td> <td> <p>Long</p> </td> <td> <p>Total count of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkSum</p> </td> <td> <p>Long</p> </td> <td> <p>Total count of network domain</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetSum</p> </td> <td> <p>Long</p> </td> <td> <p>Total count of subnet</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>28.&nbsp;ListVpcCategory</strong></p> <p><strong>Interface Description</strong></p> <p>Query types of VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpcCategorys</p> </td> <td> <p>List&lt;VpcCategoryBean&gt;</p> </td> <td> <p>Information list of types of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>29.&nbsp;ListVpcRoute</strong></p> <p><strong>Interface Description</strong></p> <p>Query the routing list of VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>VpcRouteList</p> </td> <td> <p>List&lt;VpcRouteBean&gt;</p> </td> <td> <p>Query the routing information list of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>30.&nbsp;ListVpcs</strong></p> <p><strong>Interface Description</strong></p> <p>Query VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Region Id(Get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VpcId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>page number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>page size</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>VpcStatus[]</p> </td> <td> <p>no</p> </td> <td> <p>VPC Status(get value by enum VpcStatus)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>VPC name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>GetDependencyNum</p> </td> <td> <p>boolean</p> </td> <td> <p>no</p> </td> <td> <p>Get the number of dependent resources or not (default: no)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Vpcs</p> </td> <td> <p>List&lt;VpcBean&gt;</p> </td> <td> <p>Information list of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total count</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>31.&nbsp;ModifyVpcAttribute</strong></p> <p><strong>Interface Description</strong></p> <p>Modify the attributes of VPC</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>VPC Id(Get id by ListVpcs)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name of VPC</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>32.&nbsp;SelectVpcItem</strong></p> <p><strong>Interface Description</strong></p> <p>Select VPC by VPC Status</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Region Id(Get id by ListRegions)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>VpcStatus</p> </td> <td> <p>no</p> </td> <td> <p>VPC Status(get status by enum VpcStatus)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsCreateIGW</p> </td> <td> <p>Boolean</p> </td> <td> <p>no</p> </td> <td> <p>Creat IGW or not(when creating igw, this parmeter is used to filter out vpc which is bound by igw)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Selects</p> </td> <td> <p>List&lt;SelectItemBean&gt;</p> </td> <td> <p>Information list of options</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products