全部产品

请求结构

云效 API 支持基于 URL 发起 HTTP/HTTPS GET 请求。请求参数需要包含在 URL 中。本文列举了 GET 请求中的结构解释,并提供了云效的服务接入地址(Endpoint)。

结构示例

以下为ExecutePipeline一条未编码的URL请求示例:

https://api-devops.cn-beijing.aliyuncs.com/?Action=ExecutePipeline
&OrgId=aaa&PipelineId=bbb&params=ccc
&<公共请求参数>
  • https指定了请求通信协议。

  • api-devops.cn-beijing.aliyuncs.com指定了云效服务接入地址(Endpoint)。

  • Action=ExecutePipeline指定了要调用的API,OrgId=aaa&PipelineId=bbb&params=ccc是ExecutePipeline规定的参数。

  • <公共请求参数>是系统规定的公共参数

通信协议

支持HTTP或HTTPS协议请求通信。为了获得更高的安全性,推荐您使用HTTPS协议发送请求。

涉及敏感数据时,如用户密码和 SSH 密钥对,推荐使用 HTTPS 协议。

接入地址

ECS API的服务接入地址,参见以下表格。为减少网络延时,建议您根据业务调用来源配置接入地址。

API i类型

接入地址

流水线相关api

api-devops.cn-beijing.aliyuncs.com

请求参数

您需要通过Action参数指定目标操作,例如 Action=ExecutePipeline。还需要指定接口的其他参数以及公共请求参数,详情请参见 公共参数

字符编码

请求及返回结果都使用UTF-8字符集编码。