全部产品
阿里云办公

管理 API

更新时间:2018-08-28 15:37:04

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

API 列表

目前开放的管理 API 包含:实例管理服务组管理服务管理订阅管理凭证管理级联服务管理 6 类。

实例管理

API 中文名 API 名称 专有云 URL HTTP 方法
获取实例列表 FindInstanceList /api/csbinstance/listCsbs GET

服务组管理

API 中文名 API 名称 专有云 URL HTTP 方法
创建服务组 CreateProject /api/project/createorupdate POST
更新服务组 UpdateProject /api/project/createorupdate POST
获取单个服务组信息 GetProject /api/project/get GET
获取服务组列表 FindProjectList /api/projects/find GET
删除单个服务组信息 DeleteProject /api/project/delete POST
批量删除服务组信息 DeleteProjectList /api/projects/delete GET
获取服务组名称列表 FindProjectsNameList /api/project/createorupdate POST
服务组批量启停 UpdateProjectListStatus /api/projects/status POST

服务管理

API 中文名 API 名称 专有云 URL HTTP 方法
创建服务 CreateService /api/service/addOrUpdate POST
更新服务 UpdateService /api/service/addOrUpdate POST
查询服务列表 FindServiceList /api/services/find GET
批量启停服务 UpdateServiceListStatus /api/services/status POST
获取单个服务 GetService /api/service/find GET
删除单个服务 DeleteService /api/service/delete POST
批量删除服务 DeleteServiceList /api/service/delete POST
获取可订购服务列表 FindOrderableList /api/services/orderable GET
修改服务的总体流控 UpdateServiceQPS /api/service/updateQPS POST
检查服务是否已经存在 CheckServiceExist /api/service/checkExist GET
服务发布待审批的列表 FindApproveServiceList /api/admin/service/approveList GET

订阅管理

API 中文名 API 名称 专有云 URL HTTP 方法
订购服务 CreateOrder /api/order/createOrUpdate POST
更新订购 UpdateOrder /api/order/createOrUpdate POST
获取订购列表 FindOrderedList /api/orders/find GET
获取单个订购 GetOrder /api/order/find GET
批量删除订购 DeleteOrderList /api/orders/delete POST
批量修改订购 UpdateOrderList /api/orders/update POST
获取订购审批列表 FindApprovalOrderList /api/order/approvalList GET
审批订购 ApproveOrderList /api/order/approve POST

凭证管理

API中文名 API名称 专有云URL HTTP方法
创建凭证 CreateCredentials /api/credentials/create POST
获取凭证列表 FindCredentialsList /api/credentials/list GET
更新凭证 RenewCredentials /api/credential/generateNewCredential POST
批量删除凭证 DeleteCredentialsList /api/credential/delete POST
取代凭证 ReplaceCredential /api/credential/replace POST

级联服务管理

API 中文名 API 名称 专有云 URL HTTP 方法
发布级联服务 PublishUnionCasService /api/service/unionCasPublishService POST
发布级联服务(管理员) PublishCasService /api/admin/service/casServicePublish GET
删除级联服务 DeleteUnionCasService /api/service/unionCasDeleteService POST
删除级联服务(管理员) DeleteCasService /api/admin/service/casServiceDelete POST
提交级联服务发布 CommitSuccessedServices /api/admin/service/commitSuccessedServices POST

API 访问

访问地址

目前已部署华东1华东2华北2华南1 四个地域,后续会根据需要开通其它地域的管理 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上的业务服务访问,请参见 CSB 服务 SDK 说明和使用

Java SDK

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

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

  1. <dependency>
  2. <groupId>com.aliyun</groupId>
  3. <artifactId>aliyun-java-sdk-csb</artifactId>
  4. <version>1.1.5</version>
  5. </dependency>

示例代码:

  1. public static void main(String[] args) {
  2. try {
  3. // 创建DefaultAcsClient实例并初始化,设置对应regoin的endPoint
  4. DefaultProfile.addEndpoint("CSB", "cn-hangzhou", "CSB", "csb.cn-hangzhou.aliyuncs.com");
  5. DefaultProfile profile = DefaultProfile.getProfile(
  6. "cn-hangzhou", // The region ID
  7. "****", // The AccessKey ID of the RAM account
  8. "****"); // The AccessKey Secret of the RAM account
  9. IAcsClient client = new DefaultAcsClient(profile);
  10. FindProjectListRequest request = new FindProjectListRequest();
  11. //设置业务参数
  12. request.setCsbId(227L);
  13. request.setPageNum(1);
  14. FindProjectListResponse response = client.getAcsResponse(request);
  15. System.out.println(gson.toJson(response));
  16. } catch (ServerException e) {
  17. e.printStackTrace();
  18. } catch (ClientException e) {
  19. e.printStackTrace();
  20. }
  21. }

示例输出结果:

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "requestId": "40FE0129-41AE-4464-9F0F-56328872623F",
  5. "data": {
  6. "currentPage": 1,
  7. "pageNumber": 1,
  8. "total": 1,
  9. "projectList": [
  10. {
  11. "apiNum": 11,
  12. "csbId": 227,
  13. "deleteFlag": 0,
  14. "description": "asdcdfdsdfddddddsa在sc",
  15. "gmtCreate": 1511164185000,
  16. "gmtModified": 1531134184000,
  17. "id": 420,
  18. "ownerId": "********",
  19. "projectName": "group2",
  20. "projectOwnerEmail": "group2ddd",
  21. "projectOwnerName": "group2ddd",
  22. "projectOwnerPhoneNum": "group2dddqq",
  23. "status": 1,
  24. "userId": "********"
  25. }
  26. ]
  27. }
  28. }

SKD 源代码: 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 接口人。