文档中心 API中心调用方法说明

调用方法说明

交大云提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用。

请求URI

请求URI由如下部分组成：

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

URI中的参数说明：

参数	描述
URI-scheme	表示用于传输请求的协议，当前所有API均采用HTTPS协议。
Endpoint	指定承载REST服务端点的服务器域名或IP，当前均为：home.jcloud.sjtu.edu.cn:8774。
resource-path	资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取项目下云主机列表”API的resource-path为“v2.1/{tenant_id}/servers”。
query-string	查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

例如：您需要获取指定项目(tenant_id)下的云主机列表，URI-scheme（https)，Endpoint（home.jcloud.sjtu.edu.cn:8774），并在[获取云主机列表的URI部分找到resource-path（v2.1/{tenant_id}/servers），拼接起来如下所示。

1	https://home.jcloud.sjtu.edu.cn:8774/v2.1/{tenant_id}/servers

说明：

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

方法	说明
GET	请求服务器返回指定资源。
PUT	请求服务器更新指定资源。
POST	请求服务器新增资源或执行特殊操作。
DELETE	请求服务器删除指定资源，如删除对象等。
HEAD	请求服务器资源头部。
PATCH	请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。

在获取项目下云主机列表的URI部分，您可以看到其请求方法为“GET”，则其请求为：

1	GET https://home.jcloud.sjtu.edu.cn:8774/v2.1/{tenant_id}/servers

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”等。

名称	描述	是否必选	示例
Content-Type	消息体的类型（格式）。推荐用户使用默认值application/json。	是	application/json
Content-Length	请求body长度，单位为Byte。	否	3495
X-Auth-Token	用户Token证书。	是	注：以下仅为Token示例片段MIIPAgYJKoZIhvcNAQcCo…ggg1BBIINPXsidG9rZ

对于获取指定项目下的云主机信息接口，需要“X-Auth-Token”和“Content-Type”，添加消息头后的请求如下所示，其中变量：$OS_TOKEN需要通过获取用户Token后填入。

1 2	GET https://home.jcloud.sjtu.edu.cn:8774/v2.1/{tenant_id}/servers X-Auth-Token: $OS_TOKEN Content-Type: application/json

请求消息体（可选）

该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见HTTP状态码。

对于获取项目信息接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息体（可选）

该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应。

对于获取项目下云主机信息接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

 {
    "servers": [
        {
            "id": "4e3c63ca-xxxx-xxxx-xxxx-xxxxxxxxb2b78",
            "links": [
                {
                    "href": "https://home.jcloud.sjtu.edu.cn:8774/v2.1/servers/4e3c63ca-xxxx-xxxx-xxxx-xxxxxxxxb2b78",
                    "rel": "self"
                },
                {
                    "href": "https://home.jcloud.sjtu.edu.cn:8774/servers/4e3c63ca-xxxx-xxxx-xxxx-xxxxxxxxb2b78",
                    "rel": "bookmark"
                }
            ],
            "name": "1234",
            "result_count": 7
        },
.......

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{
    "error": {
        "code": 401,
        "message": "The request you have made requires authentication.",
        "title": "Unauthorized"
    }
}

其中，code表示错误码，message表示错误描述信息。