云主机

  • 云主机服务 > API Reference > OpenAPI快速入门 >API请求结构

    API请求结构

    最近更新时间:2019-01-17 18:57:53

    我们支持基于URL发起 HTTP/HTTPS 请求。

    以下为 查看云主机实例列表 的URL请求示例:

    GET https://qvm.qiniuapi.com/v1/instance?code=ecs
    &page=1&page_size=20
    &<公共请求参数>
    
    • https 指定了请求通信协议。
    • qvm.qiniuapi.com 是云主机服务的OpenAPI服务的接入地址(Endpoint)。
    • GET 指定了HTTP的Method调用方式
    • code 指定了需要调用的产品代号
    • /v1/instance 指定请求的API路径地址,page=1page_size=20 是 查看云主机列表的 规定的参数。
    • <公共请求参数> 是系统规定的公共参数。

    通信协议

    支持HTTP或HTTPS协议请求通信。为了获得更高的安全性,推荐您使用HTTPS协议发送请求。

    涉及敏感数据时,如用户密码和SSH密钥对,推荐使用HTTPS协议。例如,在 创建云主机接口 中指定 Password 参数时。

    HTTP METHOD

    根据不同的接口功能,需要匹配不同的 HTTP Method 进行调用。

    例如查看云主机是GET,创建云主机是POST。

    产品代号

    产品名称 产品代号
    云主机(弹性计算) ecs

    请求路径

    根据不同的功能,会使用不一样的请求路径。

    比如 /v1/instance

    当查询某些指定的资源详情时,路径中可能会需要包含需要查询的ID

    比如查看某个云主机实例的详情,/v1/instance/<instance_id> 中的 <instance_id> 就需要替换成对应的资源ID

    公共请求参数

    详情可以参考 公共参数结构 章节

    字符编码

    请求及返回结果都使用 UTF-8 字符集编码。

    以上内容是否对您有帮助?
  • Icon free helper
    Close