参数模版
获取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进行配置,具体配置方法如下:
static final String ENDPOINT = ""
static final String AK = "";
static final String SK = "";
IpCollectionClientConfiguration config = new IpCollectionClientConfiguration();
config.setCredentials(new DefaultBceCredentials(AK, SK));
config.setEndpoint(ENDPOINT);
IpCollectionClient ipCollectionClient = new IpCollectionClient(config);
创建IP地址组
函数声明
public CreateIpAddressSetResponse createIpAddressSet(CreateIpAddressSetRequest request) {
}
参数含义
请参考OpenAPI文档 创建IP地址组请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"ipSetId":"ips-zq8i7q57ubxd"
}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleCreateIpAddressSet.java
IP地址组添加IP地址
函数声明
public void addIpAddressToIpSet(AddIpAddressToIpSetRequest request) {
}
参数含义
请参考OpenAPI文档 IP地址组添加IP地址请求参数
返回值
-
操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleAddIpAddressToIpSet.java
IP地址组删除IP地址
函数声明
public void removeIpAddressFromIpSet(RemoveIpAddressFromIpSetRequest request) {
}
参数含义
请参考OpenAPI文档 IP地址组删除IP地址请求参数
返回值
-
操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleRemoveIpAddressFromIpSet.java
更新IP地址组
函数声明
public void updateIpSet(UpdateIpSetRequest request) {
}
参数含义
请参考OpenAPI文档 更新IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleUpdateIpSet.java
删除IP地址组
函数声明
public void deleteIpSet(DeleteIpSetRequest request) {
}
参数含义
请参考OpenAPI文档 删除IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleDeleteIpSet.java
查询IP地址组列表
函数声明
public QueryIpSetListResponse queryIpSetList(QueryIpSetListRequest request) {
}
参数含义
请参考OpenAPI文档 查询IP地址组列表请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"ipSets": [{
"ipSetId": "ips-w2d4kgc3x0y1",
"name": "test_ipSet",
"description": "",
"ipVersion": "IPv4",
"ipAddressInfo": [{
"ipAddress": "10.101.151.17",
"description": "ip address description"
}],
"bindedInstanceNum": 3
}],
"marker": "ips-w2d4kgc3x0y1",
"isTruncated": true,
"nextMarker": "ips-sd57mmq4irn7",
"maxKeys": 1
}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpSetList.java
查询指定的IP地址组
函数声明
QueryIpSetDetailResponse queryIpSetDetail(QueryIpSetDetailRequest request) {
}
参数含义
请参考OpenAPI文档 查询指定的IP地址组请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"ipSet": "ips-w2d4kgc3x0y1",
"name": "test_ipSet",
"description": "",
"ipVersion": "IPv4",
"ipAddressInfo": [{
"ipAddress": "10.101.151.17",
"description": "ip address description"
}],
"bindedInstances": [{
"instanceId": "esg-w2kmnu1peqxg",
"instanceType": "ESG"
},
{
"instanceId": "esg-7c9yzhkfn9c2",
"instanceType": "ESG"
}
]
}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpSetDetail.java
创建IP地址族
函数声明
public CreateIpAddressGroupResponse createIpAddressGroup(CreateIpAddressGroupRequest request) {
}
参数含义
请参考OpenAPI文档 创建IP地址族请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"ipGroupId":"ipg-pcpvtee8kd6b"
}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleCreateIpAddressGroup.java
IP地址族添加IP地址组
函数声明
public void bindIpSet(BindIpSetRequest request) {
}
参数含义
请参考OpenAPI文档 IP地址族添加IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleBindIpSet.java
IP地址族移除IP地址组
函数声明
public void unBindIpSet(UnBindIpSetRequest request) {
}
参数含义
请参考OpenAPI文档 IP地址族移除IP地址组请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleUnBindIpSet.java
更新IP地址族
函数声明
public void updateIpGroup(UpdateIpGroupRequest request) {
}
参数含义
请参考OpenAPI文档 更新IP地址族请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleUpdateIpGroup.java
删除IP地址族
函数声明
public void deleteIpGroup(DeleteIpGroupRequest request) {
}
参数含义
请参考OpenAPI文档 删除IP地址族请求参数
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleDeleteIpGroup.java
查询IP地址族列表
函数声明
public QueryIpGroupListResponse queryIpGroupList(QueryIpGroupListRequest request) {
}
参数含义
请参考OpenAPI文档 查询IP地址族列表请求参数
返回值
- 操作成功
{
"metadata":具体信息参考附录metadata部分,
"ipGroups": [{
"ipGroupId": "ipg-w2d4kgc3x0y1",
"name": "test_ipGroup",
"description": "",
"ipVersion": "IPv4",
"ipSetIds": ["ips-rpight2b8866"],
"bindedInstanceNum": 3
}],
"marker": "ipg-w2d4kgc3x0y1",
"isTruncated": true,
"nextMarker": "ipg-sd57mmq4irn7",
"maxKeys": 1
}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpGroupList.java
查询指定的IP地址族
函数声明
public QueryIpGroupDetailResponse queryIpGroupDetail(QueryIpGroupDetailRequest request) {
}
参数含义
请参考OpenAPI文档 查询指定的IP地址族请求参数
返回值
{
"metadata":具体信息参考附录metadata部分,
"ipGroupId": "ipg-w2d4kgc3x0y1",
"name": "test_ipGroup",
"description": "",
"ipVersion": "IPv4",
"ipSetIds": ["ips-sd57mmq4irn7"],
"bindedInstances": [{
"instanceId": "esg-w2kmnu1peqxg",
"instanceType": "ESG"
},
{
"instanceId": "esg-7c9yzhkfn9c2",
"instanceType": "ESG"
}
]
}
- 操作失败
操作失败返回异常列表参考异常列表
代码示例
具体代码示例参考:ExampleQueryIpGroupDetail.java
附录
公共返回信息metadata格式
{
"bceRequestId":"f5f0821d-45fe-439b-bbf4-fc48b639f84a",
"contentLength":28,
"contentType":"application/json;charset=UTF-8",
"date":1701917695000,
"server":"openresty/1.15.8.1"
}