文档首页/ 天筹求解器服务 OptVerse/ 用户指南/
更新时间：2024-12-02 GMT+08:00
查看PDF
分享
构造请求

构造请求

本节介绍REST API请求的组成，并说明如何调用OptVerse服务的API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

请求URI

请求URI由如下部分组成。

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

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

表1 URI中的参数说明

参数

说明

URI-scheme

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

Endpoint

指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。

例如OptVerse服务在“华北-北京四”区域的Endpoint为“optverse.cn-north-4.myhuaweicloud.com”。

resource-path

资源路径，也即API访问路径。

从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。

query-string

查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

图1 URI示意图

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

请求方法

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

表2 HTTP方法

方法

说明

GET

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

PUT

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

POST

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

DELETE

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

HEAD

请求服务器资源头部。

PATCH

请求服务器更新资源的部分内容。

当资源不存在的时候，PATCH可能会去创建一个新的资源。

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

POST https://optverse.cn-north-4.myhuaweicloud.com/v2/{{project_id}}/optverse/{service_type}/tasks

请求消息头

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

如下公共消息头需要添加到请求中。

表3 公共请求消息头

名称

说明

是否必选

示例

Content-Type

发送的实体的MIME类型。

是

application/json; charset=utf-8

X-Auth-Token

用户Token。

是

-

对于创建任务接口，需要在请求消息头中添加“X-Auth-Token”。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，添加消息头后的请求如下所示。

POST https://optverse.cn-north-4.myhuaweicloud.com/v2/{{project_id}}/optverse/{service_type}/tasks
Content-Type: application/json 
X-Auth-Token: ABCDEFJ....

请求消息体

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

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

{
    "input_json": {
        "input": {
            "type": "obs",
            "data": {
                "bucket": "oroas-bi-data",
                "object": "oroas-optvsolver/input/dcmulti.mps"
            }
        },
        "output": {
            "type": "obs",
            "data": {
                "bucket": "oroas-bi-data",
                "object": "oroas-optvsolver/output"
            }
        },
        "parameters": {
            "time_limit": 60.0,
            "gap": 0.0
        }
    }
}

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

相关文档