参数模版
获取Endpoint
在确认您使用SDK时配置的Endpoint时,可先阅读开发人员指南中关于VPC服务域名的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明中网络产品VPC的部分。
注意: 子网 API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性,建议通过HTTPS调用
获取AK/SK
要使用百度智能云子网,您需要拥有一个有效的 AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问服务做签名验证。 可以通过如下步骤获得并了解您的AK/SK信息:
新建IpCollectionClient
IpCollectionClient,为开发者与IpCollection服务进行交互提供了一系列的方法。 新建IpCollectionClient时,需要先使用Endpoint、AK、SK对BceClientConfigurationl类型的config实例进行配置,再使用config实例对SubnetClient进行配置,具体配置方法如下:
1static final String ENDPOINT = ""
2static final String AK = "";
3static final String SK = "";
4
5IpCollectionClientConfiguration config = new IpCollectionClientConfiguration();
6config.setCredentials(new DefaultBceCredentials(AK, SK));
7config.setEndpoint(ENDPOINT);
8IpCollectionClient ipCollectionClient = new IpCollectionClient(config);
创建IP地址组
函数声明
1public CreateIpAddressSetResponse createIpAddressSet(CreateIpAddressSetRequest request) {
2}
参数含义
请参考OpenAPI文档 创建IP地址组请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipSetId":"ips-zq8i7q57ubxd"
4}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleCreateIpAddressSet.java
IP地址组添加IP地址
函数声明
1public void addIpAddressToIpSet(AddIpAddressToIpSetRequest request) {
2}
参数含义
请参考OpenAPI文档 IP地址组添加IP地址请求参数
返回值
-
操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleAddIpAddressToIpSet.java
IP地址组删除IP地址
函数声明
1public void removeIpAddressFromIpSet(RemoveIpAddressFromIpSetRequest request) {
2}
参数含义
请参考OpenAPI文档 IP地址组删除IP地址请求参数
返回值
-
操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleRemoveIpAddressFromIpSet.java
更新IP地址组
函数声明
1public void updateIpSet(UpdateIpSetRequest request) {
2}
参数含义
请参考OpenAPI文档 更新IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleUpdateIpSet.java
删除IP地址组
函数声明
1public void deleteIpSet(DeleteIpSetRequest request) {
2}
参数含义
请参考OpenAPI文档 删除IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleDeleteIpSet.java
查询IP地址组列表
函数声明
1public QueryIpSetListResponse queryIpSetList(QueryIpSetListRequest request) {
2}
参数含义
请参考OpenAPI文档 查询IP地址组列表请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipSets": [{
4 "ipSetId": "ips-w2d4kgc3x0y1",
5 "name": "test_ipSet",
6 "description": "",
7 "ipVersion": "IPv4",
8 "ipAddressInfo": [{
9 "ipAddress": "10.101.151.17",
10 "description": "ip address description"
11 }],
12 "bindedInstanceNum": 3
13 }],
14 "marker": "ips-w2d4kgc3x0y1",
15 "isTruncated": true,
16 "nextMarker": "ips-sd57mmq4irn7",
17 "maxKeys": 1
18}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpSetList.java
查询指定的IP地址组
函数声明
1QueryIpSetDetailResponse queryIpSetDetail(QueryIpSetDetailRequest request) {
2}
参数含义
请参考OpenAPI文档 查询指定的IP地址组请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipSet": "ips-w2d4kgc3x0y1",
4 "name": "test_ipSet",
5 "description": "",
6 "ipVersion": "IPv4",
7 "ipAddressInfo": [{
8 "ipAddress": "10.101.151.17",
9 "description": "ip address description"
10 }],
11 "bindedInstances": [{
12 "instanceId": "esg-w2kmnu1peqxg",
13 "instanceType": "ESG"
14 },
15 {
16 "instanceId": "esg-7c9yzhkfn9c2",
17 "instanceType": "ESG"
18 }
19 ]
20}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpSetDetail.java
创建IP地址族
函数声明
1public CreateIpAddressGroupResponse createIpAddressGroup(CreateIpAddressGroupRequest request) {
2}
参数含义
请参考OpenAPI文档 创建IP地址族请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipGroupId":"ipg-pcpvtee8kd6b"
4}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleCreateIpAddressGroup.java
IP地址族添加IP地址组
函数声明
1public void bindIpSet(BindIpSetRequest request) {
2}
参数含义
请参考OpenAPI文档 IP地址族添加IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleBindIpSet.java
IP地址族移除IP地址组
函数声明
1public void unBindIpSet(UnBindIpSetRequest request) {
2}
参数含义
请参考OpenAPI文档 IP地址族移除IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleUnBindIpSet.java
更新IP地址族
函数声明
1public void updateIpGroup(UpdateIpGroupRequest request) {
2}
参数含义
请参考OpenAPI文档 更新IP地址族请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleUpdateIpGroup.java
删除IP地址族
函数声明
1public void deleteIpGroup(DeleteIpGroupRequest request) {
2}
参数含义
请参考OpenAPI文档 删除IP地址族请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleDeleteIpGroup.java
查询IP地址族列表
函数声明
1public QueryIpGroupListResponse queryIpGroupList(QueryIpGroupListRequest request) {
2}
参数含义
请参考OpenAPI文档 查询IP地址族列表请求参数
返回值
- 操作成功
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipGroups": [{
4 "ipGroupId": "ipg-w2d4kgc3x0y1",
5 "name": "test_ipGroup",
6 "description": "",
7 "ipVersion": "IPv4",
8 "ipSetIds": ["ips-rpight2b8866"],
9 "bindedInstanceNum": 3
10 }],
11 "marker": "ipg-w2d4kgc3x0y1",
12 "isTruncated": true,
13 "nextMarker": "ipg-sd57mmq4irn7",
14 "maxKeys": 1
15}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpGroupList.java
查询指定的IP地址族
函数声明
1public QueryIpGroupDetailResponse queryIpGroupDetail(QueryIpGroupDetailRequest request) {
2}
参数含义
请参考OpenAPI文档 查询指定的IP地址族请求参数
返回值
1{
2 "metadata":具体信息参考附录metadata部分,
3 "ipGroupId": "ipg-w2d4kgc3x0y1",
4 "name": "test_ipGroup",
5 "description": "",
6 "ipVersion": "IPv4",
7 "ipSetIds": ["ips-sd57mmq4irn7"],
8 "bindedInstances": [{
9 "instanceId": "esg-w2kmnu1peqxg",
10 "instanceType": "ESG"
11 },
12 {
13 "instanceId": "esg-7c9yzhkfn9c2",
14 "instanceType": "ESG"
15 }
16 ]
17}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpGroupDetail.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 }