管理 API 是 CSB 提供给用户和第三方开发者使用的 CSB 管理接口。

API 访问

  • 访问地址
    目前已部署 5 个地域,后续会根据需要开通其它地域的管理 API。各个区域的访问地址如下表:
    地域 访问地址
    华东1(杭州) csb.cn-hangzhou.aliyuncs.com
    华东2(上海) csb.cn-shanghai.aliyuncs.com
    华北2(北京) csb.cn-beijing.aliyuncs.com
    华南1(深圳) csb.cn-shenzhen.aliyuncs.com
    中国香港 csb.cn-hongkong.aliyuncs.com
  • 访问权限

    目前只开通白名单用户有权访问管理 API,需要使用此管理 API 的用户,请您管理 CSB 接口人。

  • 流量控制

    目前配置和管理 API 的流量控制:每 API 50tpm、每用户每 API 5tpm。

    说明 如果此流控阈值不满足您的要求,请您联系 CSB 接口人。
  • API 访问方法

    请使用最新的 1.1.5 版本的管理 API SDK。

    此 SDK 是访问 CSB 管理 API 的 SDK,不能用于访问 CSB 上发布的业务服务。CSB上的业务服务访问,请参见 SDK 参考

Java SDK

使用方法参见 阿里云 SDK 说明

CSB 管理 API SDK 的 Maven 依赖(详细信息可查看Maven 仓库):

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-csb</artifactId>
  <version>1.1.5</version>
</dependency>

示例代码:

 public static void main(String[] args) {
        try {
            // 创建DefaultAcsClient实例并初始化,设置对应regoin的endPoint
            DefaultProfile.addEndpoint("CSB", "cn-hangzhou", "CSB", "csb.cn-hangzhou.aliyuncs.com");
            DefaultProfile profile = DefaultProfile.getProfile(
                    "cn-hangzhou",          // The region ID
                    "****",      // The AccessKey ID of the RAM account
                    "****"); // The AccessKey Secret of the RAM account
            IAcsClient client = new DefaultAcsClient(profile);
            FindProjectListRequest request = new FindProjectListRequest();
            //设置业务参数
            request.setCsbId(227L);
            request.setPageNum(1);

            FindProjectListResponse response = client.getAcsResponse(request);
            System.out.println(gson.toJson(response));
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            e.printStackTrace();
        }
    }

示例输出结果:

{
  "code": 200,
  "message": "success",
  "requestId": "40FE0129-41AE-4464-9F0F-56328872623F",
  "data": {
    "currentPage": 1,
    "pageNumber": 1,
    "total": 1,
    "projectList": [
      {
        "apiNum": 11,
        "csbId": 227,
        "deleteFlag": 0,
        "description": "asdcdfdsdfddddddsa在sc",
        "gmtCreate": 1511164185000,
        "gmtModified": 1531134184000,
        "id": 420,
        "ownerId": "********",
        "projectName": "group2",
        "projectOwnerEmail": "group2ddd",
        "projectOwnerName": "group2ddd",
        "projectOwnerPhoneNum": "group2dddqq",
        "status": 1,
        "userId": "********"
      }
    ]
  }
}

SDK 源代码: https://github.com/aliyun/aliyun-openapi-java-sdk/tree/master/aliyun-java-sdk-csb

Python SDK

SDK 地址: https://pypi.python.org/pypi/aliyun-python-sdk-csb/1.1.5

SDK 源代码: https://github.com/aliyun/aliyun-openapi-python-sdk/tree/master/aliyun-python-sdk-csb

PHP SDK

SDK 源代码: https://github.com/aliyun/aliyun-openapi-php-sdk/tree/master/aliyun-php-sdk-csb

FAQ

  • 专有云里有些 API,在公有云的管理 API 列表里没有?

    目前只开放了用户需要的部分 API,根据需要,后续可增加开放 API 的类别和数量。

  • 管理 API 支持 HTTP 方式访问吗?

    出于安全考虑,管理 API 只支持 HTTPS 方式访问。

  • 管理 API 提供哪些 SDK?

    目前只提供了 Java、Python 和 PHP,如果您有其它语言的需求,请您联系 CSB 接口人。