CaaS / CVPC API 开发者中心

子网段

使用说明

describeSubnets用于列出一组以上子网段的详细资讯,有以下几种方式:

1.不带任何参数:查询所有CaaS subnet,如范例1。注意:此查询方式不会回传subnet,subnetType。

2.带多个subnetBusinessServiceId或orderUuid(可混合同时带入):查询这两个参数对应之subnet(无视其他参数),如范例2~4。 注意:此查询方式不会回传description,gatewayIp,subnet,subnetType。

3.带businessTag、vpcBusinessServiceId:当subnetBusinessServiceId及orderUuid均为空时,才使用此二参数,可能的组合如下:

 (1)null + null:效果同CaaS + null,查询所有CaaS subnet(同规则1),如范例5。

 (2)null + vpcBusinessServiceId:效果同CVPC + vpcBusinessServiceId,查询指定软体资料中心下的subnet,如范例6。 注意:此查询方式不会回传zoneId。

 (3)CVPC + null:不支援此查询方式,不会回传任何资料。

 (4)CaaS + vpcBusinessServiceId:不支援此查询方式,不会回传任何资料。

Request参数

参数 说明 备注
subnetBusinessServiceId

(非必要参数)

子网段服务识别码列表
类型 : String
预设值 : 无
是否为复数型态 : 是
可支援多值
orderUuid

(非必要参数)

订单编号列表
类型 : String
预设值 : 无
是否为复数型态 : 是
可支援多值
businessTag

(非必要参数)

业务类别
类型 : String
预设值 : 无
是否为复数型态 : 否
请参考 业务类别
vpcBusinessServiceId

(非必要参数)

软体资料中心服务识别码
类型 : String
预设值 : 无
是否为复数型态 : 否

Response参数

参数 说明 备注

requestId

(非必要参数)

请求识别码
类型 : JSON value : string
是否为复数型态 : 否
系统自动产生
subnetList 子网段资讯列表
类型 : JSON value : array
是否为复数型态 : 是
SubnetEntry列表

Request范例

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

范例 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}

范例 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}

范例 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}

范例 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}

范例 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范例

{
    "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
        }
    ]
}

		

相关连结

createSubnet
deleteSubnet

错误讯息

OrderProcessFail