文档首页/ 云空间服务 KooDrive/ API参考/ 如何调用API/ 构造请求
更新时间：2024-06-14 GMT+08:00
查看PDF
分享

构造请求

本节介绍REST API请求的组成，并以调用KooDrive服务的批量处理文件接口说明如何调用API。

请求URI

请求URI由如下部分组成。

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

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

表1 URI中的参数说明

参数

描述

URI-scheme

表示用于传输请求的协议，当前KooDrive所有API均采用HTTPS协议。

Endpoint

指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，当前KooDrive只在“华北-北京四”部署，Endpoint为“cn.myhuaweicloud-koodrive.com”。

resource-path

资源路径，即API访问路径。从具体API的URI模块获取，例如“创建批量任务”API的resource-path为“/koodrive/ose/v1/jobs”。

query-string

可选参数，用于查询指定参数数据。设置查询参数时，查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。

例如您需要使用KooDrive创建批量任务接口，则需使用“华北-北京四”区域的Endpoint（cn.myhuaweicloud-koodrive.com），并在创建批量任务的URI部分找到resource-path（/koodrive/ose/v1/jobs），拼接起来如下所示。

https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/jobs

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

请求方法

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

表2 HTTP方法

方法

说明

GET

请求服务器返回指定资源。

POST

请求服务器新增资源或执行特殊操作。

DELETE

请求服务器删除指定资源，如删除对象等。

PUT

请求服务器更新指定资源。

在创建批量任务接口的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/jobs

请求消息头

  • Content-Type：消息体的类型（格式），可选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。
  • Authorization：鉴权。

请求消息头示例如下：

POST https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/jobs
Content-Type: application/json
Authorization: xxx

请求消息体

请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。

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

对于批量文件处理接口，请求消息体示例如下：

{
    "taskType":1    
    "actionType":101   
    "dstContainerId": IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4   
    "taskInfo": {
        "srcContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4"   
        "newFilePath": "Fm9UdqBNTAQDos6l1xPlFnIqXJg2-UdqA"   
        "fileInfo": [
            {
                "fileId": "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3"  
            }
       
        ]
    }
}

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

父主题： 如何调用API

相关文档