- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- 开发指南
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
构造请求
本节介绍REST API请求的组成，并以调用VPC服务的“查询VPC列表”说明如何调用API。
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
- URI-scheme：
表示用于传输请求的协议，当前所有API均采用HTTPS协议。
- Endpoint：
指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以获取。
- resource-path：
资源路径，也即API访问路径。例如“查询VPC列表”API的resource-path为“/v1/{project_id}/vpcs”，其中{project_id}为项目ID，获取方法请参见获取项目ID。
- query-string：
查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。
则“查询VPC列表”的URI拼接起来如下所示，其中{endpoint}代表终端节点，调用时请替换为实际值。
https://{endpoint}/v1/{project_id}/vpcs
说明：
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
请求方法
HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
- GET：请求服务器返回指定资源。
- PUT：请求服务器更新指定资源。
- POST：请求服务器新增资源或执行特殊操作。
- DELETE：请求服务器删除指定资源，如删除对象等。
- HEAD：请求服务器资源头部。
- PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。
在“查询VPC列表”的URI部分，您可以看到其请求方法为“GET”，则其请求为：
GET https://{{endpoint}}/v1/{project_id}/vpcs请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
如下公共消息头需要添加到请求中。
- Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。
- Authorization：签名认证信息。
- Host：请求的服务器信息，从服务API的URL中获取。
- X-Sdk-Date：请求的发生时间。
对于“查询VPC列表”接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。
POST https://{{endpoint}}/v1/{project_id}/vpcs
Content-Type: application/json
