子网

更新时间：2024-01-10

获取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进行配置，具体配置方法如下：

static final String ENDPOINT = ""
static final String AK = "";
static final String SK = "";

SubnetClientConfiguration config = new SubnetClientConfiguration();
config.setCredentials(new DefaultBceCredentials(AK, SK));
config.setEndpoint(ENDPOINT);
SubnetClient subnetClient = new SubnetClient(config);

创建子网

函数声明

public CreateSubnetResponse createSubnet(String name, String vpcId, String cidr, String zoneName) {
}
public CreateSubnetResponse createSubnet(CreateSubnetRequest request)
    throws BceClientException {
}

注意：
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数，但需要创建request实例

参数含义

请参考OpenAPI文档创建Subnet请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "subnetId":"sbn-p09p0ihp7498"
}

操作失败

操作失败返回异常列表参考Subnet异常列表

代码示例

具体代码示例参考：ExampleCreateSubnet.java

列举子网

函数声明

public ListSubnetsResponse listSubnets() {
}
public ListSubnetsResponse listSubnets(ListSubnetsRequest request) {  
}

注意：
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数，但需要创建request实例

参数含义

请参考OpenAPI文档列举Subnet请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "subnets":[
        {
            "name":"系统预定义子网",
            "subnetId":"sbn-qz55vemw0n40",
            "zoneName":"cn-bj-a",
            "cidr":"192.168.0.0/20",
            "ipv6Cidr":"",
            "vpcId":"vpc-hdq0mqg68si0",
            "subnetType":"BCC",
            "description":"",
            "createdTime":"2020-03-11T04:01:11Z"
        }
      ]
}

操作失败

操作失败返回异常列表参考Subnet异常列表

代码示例

具体代码示例参考：ExampleListSubnet.java

查询子网

函数声明

 public GetSubnetDetailResponse getSubnetDetail(String subnetId) {
 }

参数含义

请参考OpenAPI文档查询Subnet请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "subnet": {
            "name":"系统预定义子网",
            "subnetId":"sbn-qz55vemw0n40",
            "zoneName":"cn-bj-a",
            "cidr":"192.168.0.0/20",
            "ipv6Cidr":"",
            "vpcId":"vpc-hdq0mqg68si0",
            "subnetType":"BCC",
            "description":"",
            "createdTime":"2020-03-11T04:01:11Z"
        }
}

操作失败

操作失败返回异常列表参考Subnet异常列表

代码示例

具体代码示例参考：ExampleGetSubnet.java

更新子网

函数声明

public void modifySubnetAttributes(String subnetId, String name) {
}
public void modifySubnetAttributes(ModifySubnetAttributesRequest modifySubnetAttributesRequest) {
}

注意：
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数，但需要创建request实例

参数含义

请参考OpenAPI文档更新Subnet请求参数

返回值

操作成功

无返回值

操作失败

操作失败返回异常列表参考Subnet异常列表

代码示例

具体代码示例参考：ExampleUpdateSubnet.java

删除子网

函数声明

public void deleteSubnet(String subnetId) {
}
public void deleteSubnet(DeleteSubnetRequest deleteSubnetRequest) {
}

注意：
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数，但需要创建request实例

参数含义

请参考OpenAPI文档删除Subnet请求参数

返回值

操作成功

无返回值

操作失败

操作失败返回异常列表参考Subnet异常列表

代码示例

具体代码示例参考：ExampleDeleteSubnet.java

创建预留网段

函数声明

public CreateIpReservedResponse createIpReserved(CreateIpReservedReq createIpReservedReq) {
}

参数含义

请参考OpenAPI文档创建预留网段请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "ipReserveId":"ipr-vjh3nqvptqkk"
}

操作失败

操作失败返回异常列表参考预留网段异常列表

代码示例

具体代码示例参考：ExampleCreateIpReserve.java

删除预留网段

函数声明

public void deleteIpReserve(String ipReserveId) {
}
public void deleteIpReserve(DeleteIpReserveRequest deleteIpReserveRequest) {
}

注意：
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数，但需要创建request实例

参数含义

请参考OpenAPI文档删除预留网段请求参数

返回值

操作成功

无返回值

操作失败

操作失败返回异常列表参考预留网段异常列表

代码示例

具体代码示例参考：ExampleDeleteIpReserve.java

查询预留网段列表

函数声明

public ListIpReserveResponse listIpReserve() {
}
public ListIpReserveResponse listIpReserve(ListIpReserveRequest request) {
}

注意：
第一个接口只支持少量常用参数
第二个接口则可以支持较多参数，但需要创建request实例

参数含义

请参考OpenAPI文档查询预留网段请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "ipReserves":[
        {
            "ipReserveId":"ipr-vjh3nqvptqkk",
            "subnetId":"sbn-6ha6gp1vczuv",
            "ipCidr":"192.168.0.0/30",
            "ipVersion":"4",
            "description":"aaa",
            "createdTime":"2023-12-08T06:40:20Z",
            "updatedTime":"2023-12-08T06:40:20Z"
        }
    ]
}

操作失败

操作失败返回异常列表参考预留网段异常列表

代码示例

具体代码示例参考：ExampleListIpReserve.java

附录

公共返回信息metadata格式

 {
      "bceRequestId":"f5f0821d-45fe-439b-bbf4-fc48b639f84a",
      "contentLength":28,
      "contentType":"application/json;charset=UTF-8",
      "date":1701917695000,
      "server":"openresty/1.15.8.1"
 }

VPC

普通安全组

私有网络 VPC

私有网络 VPC

子网

获取Endpoint

获取AK/SK

新建SubnetClient

创建子网

列举子网

查询子网

更新子网

删除子网

创建预留网段

删除预留网段

查询预留网段列表

附录