子网
获取Endpoint
在确认您使用SDK时配置的Endpoint时,可先阅读开发人员指南中关于VPC服务域名的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明中网络产品VPC的部分。
注意: 子网 API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性,建议通过HTTPS调用
获取AK/SK
要使用百度智能云子网,您需要拥有一个有效的 AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问服务做签名验证。 可以通过如下步骤获得并了解您的AK/SK信息:
新建SubnetClient
SubnetClient是Subnet服务的客户端,为开发者与Subnet服务进行交互提供了一系列的方法。 新建SubnetClient时,需要先使用Endpoint、AK、SK对BceClientConfigurationl类型的config实例进行配置,再使用config实例对SubnetClient进行配置,具体配置方法如下:
1static final String ENDPOINT = ""
2static final String AK = "";
3static final String SK = "";
4
5SubnetClientConfiguration config = new SubnetClientConfiguration();
6config.setCredentials(new DefaultBceCredentials(AK, SK));
7config.setEndpoint(ENDPOINT);
8SubnetClient subnetClient = new SubnetClient(config);
创建子网
函数声明
1public CreateSubnetResponse createSubnet(String name, String vpcId, String cidr, String zoneName) {
2}
3public CreateSubnetResponse createSubnet(CreateSubnetRequest request)
4 throws BceClientException {
5}
注意:
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数,但需要创建request实例
参数含义
请参考OpenAPI文档 创建Subnet请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "subnetId":"sbn-p09p0ihp7498"
4}
- 操作失败
操作失败返回异常列表参考Subnet异常列表
代码示例
具体代码示例参考:ExampleCreateSubnet.java
列举子网
函数声明
1public ListSubnetsResponse listSubnets() {
2}
3public ListSubnetsResponse listSubnets(ListSubnetsRequest request) {
4}
注意:
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数,但需要创建request实例
参数含义
请参考OpenAPI文档 列举Subnet请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "subnets":[
4 {
5 "name":"系统预定义子网",
6 "subnetId":"sbn-qz55vemw0n40",
7 "zoneName":"cn-bj-a",
8 "cidr":"192.168.0.0/20",
9 "ipv6Cidr":"",
10 "vpcId":"vpc-hdq0mqg68si0",
11 "subnetType":"BCC",
12 "description":"",
13 "createdTime":"2020-03-11T04:01:11Z"
14 }
15 ]
16}
- 操作失败
操作失败返回异常列表参考Subnet异常列表
代码示例
具体代码示例参考:ExampleListSubnet.java
查询子网
函数声明
1 public GetSubnetDetailResponse getSubnetDetail(String subnetId) {
2 }
参数含义
请参考OpenAPI文档 查询Subnet请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "subnet": {
4 "name":"系统预定义子网",
5 "subnetId":"sbn-qz55vemw0n40",
6 "zoneName":"cn-bj-a",
7 "cidr":"192.168.0.0/20",
8 "ipv6Cidr":"",
9 "vpcId":"vpc-hdq0mqg68si0",
10 "subnetType":"BCC",
11 "description":"",
12 "createdTime":"2020-03-11T04:01:11Z"
13 }
14}
- 操作失败
操作失败返回异常列表参考Subnet异常列表
代码示例
具体代码示例参考:ExampleGetSubnet.java
更新子网
函数声明
1public void modifySubnetAttributes(String subnetId, String name) {
2}
3public void modifySubnetAttributes(ModifySubnetAttributesRequest modifySubnetAttributesRequest) {
4}
注意:
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数,但需要创建request实例
参数含义
请参考OpenAPI文档 更新Subnet请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考Subnet异常列表
代码示例
具体代码示例参考:ExampleUpdateSubnet.java
删除子网
函数声明
1public void deleteSubnet(String subnetId) {
2}
3public void deleteSubnet(DeleteSubnetRequest deleteSubnetRequest) {
4}
注意:
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数,但需要创建request实例
参数含义
请参考OpenAPI文档 删除Subnet请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考Subnet异常列表
代码示例
具体代码示例参考:ExampleDeleteSubnet.java
创建预留网段
函数声明
1public CreateIpReservedResponse createIpReserved(CreateIpReservedReq createIpReservedReq) {
2}
参数含义
请参考OpenAPI文档 创建预留网段请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipReserveId":"ipr-vjh3nqvptqkk"
4}
- 操作失败
操作失败返回异常列表参考预留网段异常列表
代码示例
具体代码示例参考:ExampleCreateIpReserve.java
删除预留网段
函数声明
1public void deleteIpReserve(String ipReserveId) {
2}
3public void deleteIpReserve(DeleteIpReserveRequest deleteIpReserveRequest) {
4}
注意:
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数,但需要创建request实例
参数含义
请参考OpenAPI文档 删除预留网段请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考预留网段异常列表
代码示例
具体代码示例参考:ExampleDeleteIpReserve.java
查询预留网段列表
函数声明
1public ListIpReserveResponse listIpReserve() {
2}
3public ListIpReserveResponse listIpReserve(ListIpReserveRequest request) {
4}
注意:
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数,但需要创建request实例
参数含义
请参考OpenAPI文档 查询预留网段请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipReserves":[
4 {
5 "ipReserveId":"ipr-vjh3nqvptqkk",
6 "subnetId":"sbn-6ha6gp1vczuv",
7 "ipCidr":"192.168.0.0/30",
8 "ipVersion":"4",
9 "description":"aaa",
10 "createdTime":"2023-12-08T06:40:20Z",
11 "updatedTime":"2023-12-08T06:40:20Z"
12 }
13 ]
14}
- 操作失败
操作失败返回异常列表参考预留网段异常列表
代码示例
具体代码示例参考:ExampleListIpReserve.java
附录
公共返回信息metadata格式
1 {
2 "bceRequestId":"f5f0821d-45fe-439b-bbf4-fc48b639f84a",
3 "contentLength":28,
4 "contentType":"application/json;charset=UTF-8",
5 "date":1701917695000,
6 "server":"openresty/1.15.8.1"
7 }