CSN

更新时间：2024-01-11

获取Endpoint

在确认您使用SDK时配置的Endpoint时，可先阅读开发人员指南中关于CSN服务域名的部分，理解Endpoint相关的概念。

注意： CSN API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性，建议通过HTTPS调用

获取AK/SK

要使用百度智能云CSN，您需要拥有一个有效的 AK（Access Key ID）和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的，均为字符串，用于标识用户，为访问服务做签名验证。可以通过如下步骤获得并了解您的AK/SK信息：

新建CsnClient

CsnClient是CSN服务的客户端，为开发者与CSN服务进行交互提供了一系列的方法。新建CsnClient时，需要先使用Endpoint、AK、SK对BceClientConfigurationl类型的config实例进行配置，再使用config实例对CsnClient进行配置，具体配置方法如下：

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

BceClientConfiguration config = new BceClientConfiguration();
config.setCredentials(new DefaultBceCredentials(AK, SK));
config.setEndpoint(ENDPOINT);
CsnClien csnClient = new CsnClien(config);

创建云智能网

函数声明

public CreateCsnResponse createCsn(CreateCsnRequest body, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档创建云智能网请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "csnId":"csn-c5s0isempeiscgyc"
}

操作失败

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

代码示例

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

更新云智能网

函数声明

public void updateCsn(String csnId, UpdateCsnRequest body, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档更新云智能网请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

删除云智能网

函数声明

public void deleteCsn(String csnId, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档删除云智能网请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询云智能网列表

函数声明

public ListCsnResponse listCsn(String marker, Integer maxKeys) {
    ......
}

参数含义

请参考OpenAPI文档查询云智能网列表请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "nextMarker": "csn-pls0isempeiscg65",
    "marker": "csn-c5s0isempeiscgyc",
    "maxKeys": 1,
    "isTruncated": true,
    "csns": [
        {
          "csnId":"csn-c5s0isempeiscgyc",
          "name":"csn",
          "description":"desc",
          "instanceNum":5,
          "csnBpNum":3
        }
    ]
}

操作失败

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

代码示例

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

查询云智能网网络实例列表

函数声明

public ListInstanceResponse listInstance(String csnId, String marker, Integer maxKeys) {
    ......
}

参数含义

请参考OpenAPI文档查询云智能网网络实例列表请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "nextMarker": "tgwAttach-lo3tykku6sga06",
    "marker": "tgwAttach-zuk33tykku6sgabu",
    "maxKeys": 1,
    "isTruncated": true,
    "instances": [
        {
            "attachId": "tgwAttach-rvu8tkaubphb78eg",
            "instanceType": "vpc",
            "instanceId": "vpc-3f2380nmcfn1",
            "instanceName": "hzb_2_csn",
            "instanceRegion": "bj",
            "instanceAccountId": "1beb4ad4762746db96941a5ad253ac8c",
            "status": "attached"
        }
    ]
}

操作失败

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

代码示例

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

查询云智能网详情

函数声明

public GetCsnResponse getCsn(String csnId) {
    ......
}

参数含义

请参考OpenAPI文档查询云智能网详情请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "name":"csn",
    "description":"desc",
    "csnId":"csn-c5s0isempeiscgyc",
    "status": "active",
    "instanceNum":5,
    "csnBpNum":3
}

操作失败

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

代码示例

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

云智能网卸载网络实例

函数声明

public void detachInstance(String csnId, DetachInstanceRequest detachInstanceRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档云智能网卸载网络实例请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

云智能网加载网络实例

函数声明

public void attachInstance(String csnId, AttachInstanceRequest attachInstanceRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档云智能网加载网络实例请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

添加路由条目

函数声明

public void createRouteRule(String csnRtId, CreateRouteRuleRequest createRouteRuleRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档添加路由条目请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询路由条目

函数声明

public ListRouteRuleResponse listRouteRule(String csnRtId, String marker, Integer maxKeys) {
    ......
}

参数含义

请参考OpenAPI文档查询路由条目请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "nextMarker": "csnrr-IyWRn123",
    "marker": "csnrr-IyWRnII7",
    "maxKeys": 1,
    "isTruncated": true,
    "csnRtRules": [
          {
                "ruleId": "cnrr-1db26d78-1781",
                "routeType": "propagated",
                "csnId": "csn-m3dwj6tfysnmxmcy",
                "csnRtId": "csnRt-w3x16fk8nr5kpxkx",
                "description": null,
                "fromAttachId": "tgwAttach-wg3z1z5baq3ry1a6",
                "status": "conflicted",
                "sourceAddress": null,
                "destAddress": "192.168.0.0/20",
                "nextHopId": "vpc-fh43ygs8yp0d",
                "nextHopName": "默认私有网络",
                "nextHopRegion": "su",
                "nextHopType": "vpc",
                "asPath": "",
                "community": "",
                "blackHole": false
           }
   ]
}

操作失败

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

代码示例

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

删除路由条目

函数声明

public void deleteRouteRule(String csnRtId, String csnRtRuleId, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档删除路由条目请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

创建学习关系

函数声明

public void createPropagation(String csnRtId, CreatePropagationRequest createPropagationRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档创建学习关系请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询学习关系

函数声明

public ListPropagationResponse listPropagation(String csnRtId) {
    ......
}

参数含义

请参考OpenAPI文档查询学习关系请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "propagations":[
        {
            "attachId":"tgwAttach-kfdccn8a6pip0qd1",
            "description":"default",
            "instanceName":"test-03",
            "instanceRegion":"bj",
            "instanceId":"vpc-v3ku2mhsyxvn",
            "instanceType":"vpc",
            "status":"enable"
        }
    ]
}

操作失败

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

代码示例

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

删除学习关系

函数声明

public void deletePropagation(String csnRtId, String attachId, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档删除学习关系请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

创建关联关系

函数声明

public void createAssociation(String csnRtId, CreateAssociationRequest createAssociationRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档创建关联关系请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询关联关系

函数声明

public ListAssociationResponse listAssociation(String csnRtId) {
    ......
}

参数含义

请参考OpenAPI文档查询关联关系请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "associations":[
        {
            "attachId":"tgwAttach-kfdccn8a6pip0qd1",
            "description":"desc",
            "instanceId":"vpc-v3ku2mhsyxvn",
            "instanceName":"test-03",
            "instanceRegion":"bj",
            "instanceType":"vpc",
            "status":"active"
        }
    ]
}

操作失败

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

代码示例

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

删除关联关系

函数声明

public void deleteAssociation(String csnRtId, String attachId, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档删除关联关系请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询路由表列表

函数声明

public ListRouteTableResponse listRouteTable(String csnId, String marker, Integer maxKeys) {
    ......
}

参数含义

请参考OpenAPI文档查询路由表列表请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "marker": null,
    "isTruncated": true,
    "nextMarker": "csnBp-iuc756n5kkda",
    "maxKeys": 1,
    "csnRts": [
         {
            "csnRtId": "csn-rt-uezhhw306g5be3gb",
            "name": "csnRtName",
            "description": "desc",
            "type": "default"
        }
    ]
}

操作失败

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

代码示例

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

查询带宽包列表

函数声明

public ListCsnBpResponse listCsnBp(String marker, Integer maxKeys) {
    ......
}

参数含义

请参考OpenAPI文档查询带宽包列表请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "marker": "csnBp-gdrf6fukb36u",
    "isTruncated": true,
    "nextMarker": "csnBp-iuc756n5kkda",
    "maxKeys": 1,
    "csnBps": [
                {
                    "csnBpId": "csnBp - gdrf6fukb36u",
                    "name": "csnBp",
                    "bandwidth": 100,
                    "usedBandwidth": 10,
                    "csnId": "",
                    "interworkType": "center",
                    "interworkRegion": "chinesemainland",
                    "status": "available",
                    "paymentTiming": "Prepaid",
                    "expiredTime": "2018-08-13T08:10:59Z",
                    "createTime": "2021-04-25 17:22:34"
                }
    ]
}

操作失败

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

代码示例

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

查询指定带宽包详情

函数声明

public GetCsnBpResponse getCsnBp(String csnBpId) {
    ......
}

参数含义

请参考OpenAPI文档查询指定带宽包详情请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "csnBpId":"csnBp-gdrf6fukb36u",
    "name":"csnBp",
    "bandwidth":100,
    "usedBandwidth":10,
    "csnId":"",
    "interworkType":"center",
    "interworkRegion":"chinesemainland",
    "status":"available",
    "paymentTiming":"Prepaid",
    "expireTime":"2018-08-13T08:10:59Z",
    "createdTime":"2021-04-25 17:22:34"
}

操作失败

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

代码示例

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

创建带宽包

函数声明

public CreateCsnBpResponse createCsnBp(CreateCsnBpRequest createCsnBpRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档创建带宽包请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "csnBpId":"csnBp-gdrf6fukb36u"
}

操作失败

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

代码示例

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

更新带宽包

函数声明

public void updateCsnBp(String csnBpId, UpdateCsnBpRequest updateCsnBpRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档更新带宽包请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

删除带宽包

函数声明

public void deleteCsnBp(String csnBpId, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档删除带宽包请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

带宽包的带宽升降级

函数声明

public void resizeCsnBp(String csnBpId, ResizeCsnBpRequest resizeCsnBpRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档带宽包的带宽升降级请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

带宽包解绑云智能网

函数声明

public void unbindCsnBp(String csnBpId, UnbindCsnBpRequest unbindCsnBpRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档带宽包解绑云智能网请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

带宽包绑定云智能网

函数声明

public void bindCsnBp(String csnBpId, BindCsnBpRequest bindCsnBpRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档带宽包绑定云智能网请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询地域带宽

函数声明

public ListCsnBpLimitResponse listCsnBpLimit(String csnBpId) {
    ......
}

参数含义

请参考OpenAPI文档查询地域带宽请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "bpLimits":[
        {
            "csnBpId": "csnBp-nkyiykbbu9js",
            "localRegion": "cn-hangzhou-cm",
            "peerRegion": "bj",
            "bandwidth": 4,
            "csnId": "csn-uftcf4rvrbjii95r"
        }
    ]
}

操作失败

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

代码示例

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

创建地域带宽

函数声明

public void createCsnBpLimit(String csnBpId, CreateCsnBpLimitRequest createCsnBpLimitRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档创建地域带宽请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

更新地域带宽

函数声明

public void updateCsnBpLimit(String csnBpId, UpdateCsnBpLimitRequest updateCsnBpLimitRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档更新地域带宽请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

删除地域带宽

函数声明

public void deleteCsnBpLimit(String csnBpId, DeleteCsnBpLimitRequest deleteCsnBpLimitRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档删除地域带宽请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询指定云智能网的地域带宽

函数声明

public ListCsnBpLimitByCsnIdResponse listCsnBpLimitByCsnId(String csnId) {
    ......
}

参数含义

请参考OpenAPI文档查询指定云智能网的地域带宽请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "bpLimits":[
        {
            "csnBpId": "csnBp-nkyiykbbu9js",
            "localRegion": "cn-hangzhou-cm",
            "peerRegion": "bj",
            "bandwidth": 4,
            "csnId": "csn-uftcf4rvrbjii95r"
        }
    ]
}

操作失败

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

代码示例

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

查询TGW列表

函数声明

public ListTgwResponse listTgw(String csnId, String marker, Integer maxKeys) {
    ......
}

参数含义

请参考OpenAPI文档查询TGW列表请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "nextMarker": "tgw-jkxx0kmm0t86vkfk",
    "marker": "tgw-qhxx0kmm0t86vmpk",
    "maxKeys": 1,
    "isTruncated": true,
    "tgws": [
        {
            "tgwId": "tgw-vhw0idtdwbxi7n0p",
            "csnId": "csn-3cq38gxc8irzuu0x",
            "name": "tgw_1",
            "description": "desc",
            "region": "bj"
        }
    ]
}

操作失败

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

代码示例

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

更新TGW信息

函数声明

public void updateTgw(String csnId, String tgwId, UpdateTgwRequest updateTgwRequest, String clientToken) {
    ......
}

参数含义

请参考OpenAPI文档更新TGW信息请求参数

返回值

操作成功

无返回值

操作失败

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

代码示例

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

查询TGW路由条目

函数声明

public ListTgwRuleResponse listTgwRule(String csnId, String tgwId, String marker, Integer maxKeys) {
    ......
}

参数含义

请参考OpenAPI文档查询TGW路由条目请求参数

返回值

操作成功

{
    "metadata":具体信息参考附录metadata部分,
    "nextMarker": "tgw-jkxx0kmm0t86vkfk",
    "marker": "tgw-qhxx0kmm0t86vmpk",
    "maxKeys": 1,
    "isTruncated": true,
    "tgwRtRules": [
        {
            "ruleId": "cnrr-1db26d78-1781",
            "routeType": "custom",
            "csnId": "csn-m3dwj6tfysnmxmcy",
            "csnRtId": "csnRt-w3x16fk8nr5kpxkx",
            "fromAttachId": "tgwAttach-wg3z1z5baq3ry1a6",
            "status": "conflicted",
            "destAddress": "192.168.0.0/20",
            "nextHopId": "vpc-fh43ygs8yp0d",
            "nextHopName": "默认私有网络",
            "nextHopRegion": "su",
            "nextHopType": "vpc",
            "asPath": "",
            "community": "",
            "blackHole": false
        }
    ]
}

操作失败

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

代码示例

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

附录

公共返回信息metadata格式

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

初始化

异常处理

云智能网 CSN

CSN

获取Endpoint

获取AK/SK

新建CsnClient

创建云智能网

更新云智能网

删除云智能网

查询云智能网列表

查询云智能网网络实例列表

查询云智能网详情

云智能网卸载网络实例

云智能网加载网络实例

添加路由条目

查询路由条目

删除路由条目

创建学习关系

查询学习关系

删除学习关系

创建关联关系

查询关联关系

删除关联关系

查询路由表列表

查询带宽包列表

查询指定带宽包详情

创建带宽包

更新带宽包

删除带宽包

带宽包的带宽升降级

带宽包解绑云智能网

带宽包绑定云智能网

查询地域带宽

创建地域带宽

更新地域带宽

删除地域带宽

查询指定云智能网的地域带宽

查询TGW列表

更新TGW信息

查询TGW路由条目

附录