构造请求
本节介绍以调用TICS的获取token接口为例，说明如何调用TICS的API。
Token是用户的访问令牌，承载身份与权限信息，可以用于调用其他API时鉴权。
请求URI
请求URI由如下部分组成：
{URI-scheme}://{Ip:port}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
参数 |
描述 |
|---|---|
URI-scheme |
表示用于传输请求的协议，当前所有API均采用HTTPS协议。 |
Ip:port |
计算节点所在虚机的IP地址及开放端口，可参考计算节点所在虚机的IP:Port获取。 |
resource-path |
资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v1/agent/user/token”。 |
query-string |
查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 |
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Ip:port在同一个计算节点 也相同，所以简洁起见将这两部分省略。
请求方法
方法 |
说明 |
|---|---|
GET |
请求服务器返回指定资源。 |
PUT |
请求服务器更新指定资源。 |
POST |
请求服务器新增资源或执行特殊操作。 |
DELETE |
请求服务器删除指定资源，如删除对象等。 |
HEAD |
请求服务器资源头部。 |
PATCH |
请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 |
在获取token的URI部分，您可以看到其请求方法为“POST”，则其请求为：
POST https://Ip:port/v1/agent/user/token
请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
名称 |
描述 |
是否必选 |
示例 |
|---|---|---|---|
Content-Type |
发送的实体的MIME类型。推荐用户默认使用application/json，有其他取值时会在具体接口中专门说明。 |
是 |
application/json |
X-Language |
根据自己偏好的语言来获取不同语言的返回内容 |
是 |
zh-cn或者en_us |
X-Auth-Token |
用户Token。 用户Token也就是调用计算节点API“获取用户Token”接口的响应值，因此调用该接口时，不用填写本字段。 请求响应成功后在响应体中包含的“token”的值即为Token值。 |
TICS仅支持Token认证，该字段必选。 |
注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
请求消息体
请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于获取token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
POST https://Ip:port/v1/agent/user/token
{
"user_name":"user_name",
"password":"password"
}
到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取token接口，返回的响应体中“token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
