vpc
更新时间:2023-09-11
获取Endpoint
在确认您使用SDK时配置的Endpoint时,可先阅读开发人员指南中关于VPC服务域名的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明中网络产品VPC的部分。
注意: VPC API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性,建议通过HTTPS调用
获取AK/SK
要使用百度智能云VPC,您需要拥有一个有效的 AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问服务做签名验证。 可以通过如下步骤获得并了解您的AK/SK信息:
新建VpcClient
VpcClient是VPC服务的客户端,为开发者与VPC服务进行交互提供了一系列的方法。 新建VpcClient时,需要先使用Endpoint、AK、SK对BceClientConfigurationl类型的config实例进行配置,再使用config实例对VpcClient进行配置,具体配置方法如下:
$configs = array(
'credentials' => array(
'ak' => '',
'sk' => '',
),
'endpoint' => 'bcc.bj.baidubce.com', //bj
);
$client = new VpcClient($configs)
创建VPC
函数定义如下:
/**
* @param string $name
* The name of vpc to be created.
* @param string $cidr
* The CIDR of the vpc.
* @param string $description
* The description of the vpc.
* @param string $clientToken
* An ASCII string whose length is less than 64.
* The request will be idempotent if clientToken is provided.
* If the clientToken is not specified by the user, a random String generated by default algorithm will be used.
* @param array $options
* @return mixed
*/
public function createVpc($name, $cidr, $description = null, $clientToken = null, $options = array()) {
.......
}
参数说明如下:
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
name | string | 是 | vpc名称,不能取值“default”,长度不超过65个字符,可由数字、字符、下划线组成 |
cidr | string | 是 | vpc的cidr |
description | string | 否 | vpc描述,不超过200字符 |
clientToken | string | 否 | 幂等性Token,是一个长度不超过64位的ASCII字符串 |
options | array | 否 | 额外选项 |
使用示例如下:
// testCreateVpc
$vpcName = 'test_vpc_name'
$vpcCidr = '192.168.240.0/20'
$description = 'test_vpc_descrition'
$resp = $client->createVpc($vpcName, $vpcCidr, $description);
print_r($resp);
列举VPC
函数定义如下:
/**
* Return a list of vpcs owned by the authenticated user.
* @param string $marker
* The optional parameter marker specified in the original request to specify
* where in the results to begin listing.
* Together with the marker, specifies the list result which listing should begin.
* If the marker is not specified, the list result will listing from the first one.
* @param int $maxkeys
* The optional parameter to specifies the max number of list result to return.
* The default value is 1000.
* @param boolean $isDefault
* The option param demotes whether the vpc is default vpc.
* @param array $options
* @return mixed
*/
public function listVpcs($marker = null, $maxkeys = null, $isDefault = null, $options = array()) {
......
}
参数说明如下:
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
marker | string | 否 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 |
maxKeys | int | 否 | 每页包含的最大数量,最大数量通常不超过1000,缺省值为1000 |
isDefault | boolean | 否 | 是否为默认vpc,可选值:True、False;当不填写此参数时返回所有vpc |
options | array | 否 | 额外选项 |
使用示例如下:
// testListVpcs
$resp = $client->listVpcs(0, 1000, true);
print_r($resp);
查询VPC
函数定义如下:
/**
* Get the detail information of specified vpc.
* @param string $vpcId
* The id of the vpc
* @param array $options
* @return \stdClass
*/
public function getVpc($vpcId, $options = array()) {
......
}
参数说明如下:
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
vpcId | string | 是 | 待查询vpc的id |
options | array | 否 | 额外选项 |
使用示例如下:
// testGetVpc
$vpcId = ''
$resp = $client->deleteVpc($vpcId);
print_r($resp);
更新VPC
函数定义如下:
/**
* Modify the special attribute to new value of the vpc owned by the user.
* @param string $vpcId
* The id of the specified vpc
* @param string $name
* The name of the specified vpc
* @param string $description
* The option param to describe the vpc
* @param string $clientToken
* An ASCII string whose length is less than 64.
* The request will be idempotent if clientToken is provided.
* If the clientToken is not specified by the user, a random String generated by default algorithm will be used.
* @param array $options
* @return mixed
*/
public function updateVpc($vpcId, $name, $description = null, $clientToken = null, $options = array()) {
......
}
参数说明如下:
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
vpcId | string | 是 | 待更新vpc的id |
name | string | 是 | vpc名称,不能取值“default”,长度不超过65个字符,可由数字、字符、下划线组成 |
description | string | 否 | vpc描述,不超过200字符 |
clientToken | string | 否 | 幂等性Token,是一个长度不超过64位的ASCII字符串 |
options | array | 否 | 额外选项 |
使用示例如下:
// testUpdateVpc
$vpcId = ''
$vpcName = 'vpc-test'
$description = 'description-test'
$resp = $client->updateVpc($vpcId, $vpcName, $description);
print_r($resp);
删除VPC
函数定义如下:
/**
* Delete the specified vpc owned by the user.All resource in the vpc must be deleted before the vpc itself
* can be deleted.
* @param string $vpcId
* The id of the specified vpc
* @param string $clientToken
* An ASCII string whose length is less than 64.
* The request will be idempotent if clientToken is provided.
* If the clientToken is not specified by the user, a random String generated by default algorithm will be used.
* @param array $options
* @return mixed
*/
public function deleteVpc( $vpcId, $clientToken = null, $options = array()) {
.......
}
参数说明如下:
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
vpcId | string | 是 | 待删除vpc的id |
clientToken | string | 否 | 幂等性Token,是一个长度不超过64位的ASCII字符串 |
options | array | 否 | 额外选项 |
使用示例如下:
// testDeleteVpc
$vpcId = ''
$resp = $client->deleteVpc($vpcId);
print_r($resp);