CaaS / CVPC API Developer Center

Subnet

Description

describeSubnets is used to list the detailed information of multiple subnets.

1.If no parameter is specified, CaaS subnets are listed, for example 1.

2.Give subnetBusinessServiceId or orderUuid to list specific subnets, for example 2~4.

Parameters businessTag and vpcBusinessServiceId are used only when there are no parameters subnetBusinessServiceId or orderUuid.

3.To query CaaS subnets, please give businessTag (CaaS), for example 5.

4.To query CVPC subnets, please give businessTag (CVPC) and business service ID of VPC, for example 6.

Request Parameter

Parameter Description Note
subnetBusinessServiceId

(not a necessary parameter)

list of business service ID of subnet
Type : String
Default Value : No
Whether it is plural : Yes
Multiple values can be supported.
orderUuid

(not a necessary parameter)

order UUID list
Type : String
Default Value : No
Whether it is plural : Yes
Multiple values can be supported.
businessTag

(not a necessary parameter)

business tag
Type : String
Default Value : No
Whether it is plural : No
refer to Business Tag
vpcBusinessServiceId

(not a necessary parameter)

business service ID of VPC
Type : String
Default Value : No
Whether it is plural : No

Response Parameter

Parameter Description Note

requestId

(not a necessary parameter)

request ID
Type : JSON value : string
Whether it is plural : No
automatically produced by the system
subnetList subnet list
Type : JSON value : array
Whether it is plural : Yes
SubnetEntry list

Response Example

ex 1:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

ex 2:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&subnetBusinessServiceId=VQ55020001IOSQ
&subnetBusinessServiceId=VQ55020001IOSS
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

ex 3:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&orderUuid=31c2540b-e3dc-4aa2-a0f8-282270da268f
&orderUuid=9e20419a-f148-4124-829f-5670b6bb1289
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

ex 4:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&subnetBusinessServiceId=VQ55020001IOSQ
&orderUuid=9e20419a-f148-4124-829f-5670b6bb1289
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

ex 5:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&businessTag=cb168f20-c515-4e41-84cd-830dedfe7f49
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

ex 6:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&businessTag=a2931aa4-8751-4f09-8df3-bcc0d18f8b75
&vpcBusinessServiceId=VV55020001IOSE
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
		

Response Example

{
    "requestId": "xxxEXAMPLE",
    "subnetList": [
        {
            "applyDate": "2016-10-01T01:01:01Z",
            "businessTag": "a2931aa4-8751-4f09-8df3-bcc0d18f8b75",
            "description": "myDescription1",
            "endDate": null,
            "gatewayIp": "172.23.0.254",
            "name": "myName1",
            "orderUuid": "31c2540b-e3dc-4aa2-a0f8-282270da268f",
            "provisionMessage": "PROVISION_SUCCESS",
            "provisionStatus": "provisionok",
            "regionId": "region-tw-1",
            "startDate": "2016-10-01T01:01:01Z",
            "subnet": "172.23.0.0/24",
            "subnetBusinessServiceId": "VQ55020001IOSQ",
            "subnetType": "VM",
            "zoneId": null
        },
        {
            "applyDate": "2016-10-01T01:01:01Z",
            "businessTag": "a2931aa4-8751-4f09-8df3-bcc0d18f8b75",
            "description": myDescription2,
            "endDate": null,
            "gatewayIp": "192.168.88.254",
            "name": "myName2",
            "orderUuid": "9e20419a-f148-4124-829f-5670b6bb1289",
            "provisionMessage": "PROVISION_SUCCESS",
            "provisionStatus": "provisionok",
            "regionId": "region-tw-1",
            "startDate": "2016-10-01T01:01:01Z",
            "subnet": "192.168.88.0/24",
            "subnetBusinessServiceId": "VQ55020001IOSS",
            "subnetType": "VM",
            "zoneId": null
        }
    ]
}

		

Related Links

createSubnet
deleteSubnet

Error Code

OrderProcessFail