全部产品

快速调试接口

背景信息

使用OpenAPI Explorer,可以快速调用调试接口,并且获取SDK示例片段代码。

OpenAPI Explorer地址:https://api.aliyun.com/#/?product=codeup

使用方法

1. 选择接口

接口Action可根据对应接口文档查询。

使用方法1

2. 填写参数

根据接口文档填写对应的参数。

使用方法2

3. 发起调用

点击发起调用,获取调用结果。

使用方法3

4. 获取 SDK 示例

可以在API Explorer右侧选择自己使用的语言,复制示例代码修改后使用;或者查看文档 《SDK 示例》部分查看对应语言的 SDK 示例。

使用方法4

5. 集成至你的应用

在你的应用中使用对应 SDK 或者直接使用 HTTP 方式调用 Codeup 提供的 OpenAPI,即可将 Codeup 的能力集成至你的应用中。

授权方式

Codeup OpenAPI 支持三种授权方式,即支持使用阿里云AK & SK授权、阿里云 STS 临时授权、Codeup AccessToken授权三种。

1. 使用 AK & SK 授权

Codeup 支持使用阿里云 AK & SK 方式授权用户调用对应的 OpenAPI。

  • 创建 AK & SK

https://help.aliyun.com/document_detail/53045.html

注意

:云效主账号子账号是相互隔离的,主子账号企业 & 库等权限不互通。因此如果要通过 OpenAPI 访问主账号的代码库等信息,需要使用主账号的 AK & SK;同理,如果要通过 OpenAPI 访问子账号的代码库等信息,需要使用子账号的 AK & SK。

如果想用子账号的 AK & SK 访问主账号在某个企业下的代码库等资源,可以将子账号加为要访问的企业或者代码库的成员。或者使用 AccessToken 授权的方式。

  • 使用 AK & SK

生成 AK & SK 后,调用接口时使用 AK 和 SK 填入参数 AccessKeyId 和 AccessSecret 即可。

2. 使用 STS 临时授权

Codeup OpenAPI 支持通过 STS 临时授权的方式调用接口,使用方式参考 RAM 提供的文档。

https://help.aliyun.com/document_detail/28756.html

3. 使用 AccessToken 授权(个人访问令牌)

Codeup OpenAPI 支持通过 AccessToken 授权的方式调用接口。如何生成 AccessToken 参考 《个人访问令牌》文档介绍。

使用 AccessToken 授权,可以使用任意有效的 AccessKeyId 和 AccessSecret,最终读写的都是 AccessToken 创建者有权限的资源。