全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多

CSB管理API

更新时间:2018-03-18 08:29:22

CSB管理API

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

API范围

目前开放的管理API包含:服务组管理、服务管理、订阅管理和凭证管理 等四类。

实例管理

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(杭州) https://csb.cn-hangzhou.aliyuncs.com
华东2(上海) https://csb.cn-shanghai.aliyuncs.com
华北2(北京) https://csb.cn-beijing.aliyuncs.com
华南1(深圳) https://csb.cn-shenzhen.aliyuncs.com

访问权限

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

流量控制

目前配置和管理API的流量控制:每API 50tpm、每用户每API 5tpm。
如果此流控阀值不满足您的要求,请您联系CSB接口人。

API访问方法

请使用最新的 1.1.1 版本的管理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.1</version>
  5. </dependency>

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.1
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方式访问吗?

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

管理API提供哪些SDK?

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

本文导读目录