管理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 50 tpm、每用户每API 5 tpm。

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

    请使用最新的1.2.8版本的管理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.2.8</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",          // 地域。
                    "****",      // RAM用户的AccessKey ID。
                    "****"); // RAM用户的AccessKey Secret。
            IAcsClient client = new DefaultAcsClient(profile);
            FindProjectListRequest request = new FindProjectListRequest();
            //设置业务参数。
            request.setCsbId(227L);
            request.setPageNum(1);

            FindProjectListResponse response = client.getAcsResponse(request);
            Gson gson = new Gson();
            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": "asdcdfdsdfddddddsasc",
        "gmtCreate": 1511164185000,
        "gmtModified": 1531134184000,
        "id": 420,
        "ownerId": "********",
        "projectName": "group2",
        "projectOwnerEmail": "group2ddd",
        "projectOwnerName": "group2ddd",
        "projectOwnerPhoneNum": "group2dddqq",
        "status": 1,
        "userId": "********"
      }
    ]
  }
}

Java SDK源代码下载地址

Python SDK

Python SDK下载地址

Python SDK源代码下载地址

PHP SDK

PHP SDK源代码下载地址

NET SDK

仅提供C#签名部分代码,其他均为标准HTTP请求,可自行实现。相关信息,请参见NET SDK说明

FAQ

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

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

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

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

  • 管理API提供哪些SDK?

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