本节介绍REST API请求的组成,并以调用新建通用类型应用来说明如何调用API,该API用来创建通用类型应用,此种类型应用可以应用到流水线中。
请求URI
请求URI由如下部分组成:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
表1 URI中的参数说明
参数 | 描述 |
---|---|
URI-scheme | 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint | 指定承载REST服务端点的服务器域名或IP,Endpoint地址可以在“调用前须知”页面中查看。 |
resource-path | 资源路径,即API访问路径。从具体API的URI模块获取,例如“新建通用类型应用v1/app/createApplication ”。 |
query-string | 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 |
说明:
为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
HTTP请求方法(也称为操作或动词),它告诉您服务正在请求什么类型的操作。
表2 HTTP方法
方法 | 说明 |
---|---|
GET | 请求服务器返回指定资源。 |
PUT | 请求服务器更新指定资源。 |
POST | 请求服务器新增资源或执行特殊操作。 |
DELETE | 请求服务器删除指定资源,如删除对象等。 |
HEAD | 请求服务器资源头部。 |
PATCH | 请求服务器更新资源的部分内容。 |
在新建通用类型应用的URI部分,您可以看到请求方法为“POST”,则其请求为:
POST https://msap-global.ctapi.ctyun.cn/v1/app/createApplication
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
详细的公共请求消息头字段请参见表3。
表3 公共请求消息头
名称 | 描述 | 是否必选 | 示例 |
---|---|---|---|
Content-Type | 消息体的类型 | 是 | application/json |
ctyun-eop-request-id | 流水号 | 是 | 0ffb9b07-d5a8-4e19-b3ce-12dfb9705a1d |
Eop-Authorization | 签名认证信息 | 是 | 4a4bdc57e06542199b5f98d4cd107be2 Headers=ctyun-eop-request-id;eop-date Signature=b2WEo4nh9ewn6SWOP0ii5g8L0z9CT5gprpDWntlCX9I= |
Eop-date | 时间,15分钟有效期 | 是 | 20221107T093029Z |
说明:公共请求头签名认证信息请在基本签名流程中查看。