服务地址
https://open.didiyunapi.com
通信协议
滴滴云API的所有接口均通过HTTPS进行通信,提供高安全性的通信通道。
请求方法
滴滴云API的所有接口接受的HTTP方法均为GET或POST中的一种,在具体API文档中会进行说明。
请求参数
滴滴云API的参数格式根据请求方法的不同分为两种。
- 当请求方法为GET时,所有的参数均需要在Url Params中,例:
curl -X GET https://open.didiyunapi.com/dicloud/i/result?jobUuids=c23fd05f26ef5b718507f1926a4271cc®ionId=gz \
-H 'Authorization: Bearer 9a609744ad675e8fbfcdbf14511b24e6ddd6b427b4d256969534a81d0773f4d7'
- 当请求方法为POST时,所有的参数均需要在Http Request Body中,且为Json格式,例:
curl -X POST https://open.didiyunapi.com/dicloud/i/region/list \
-H 'Authorization: Bearer 9a609744ad675e8fbfcdbf14511b24e6ddd6b427b4d256969534a81d0773f4d7' \
-H 'Content-Type: application/json' \
-d '{"condition":{"product":"dc2"}}'
字符编码
滴滴云API均使用UTF-8编码。
公共参数
公共参数每次请求均需携带,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明:
参数名称 | 参数位置 | 类型 | 必选 | 描述 |
---|---|---|---|---|
Content-Type | 请求头(Header) | string | 否 | POST请求,均使用"application/json"方式传输内容。 |
regionId | 请求体(Body)/请求链接(Url) | string | 是 | 地域参数,用来标识希望查询/操作哪个地域的数据。当为GET方法时,为url中参数。当为POST方法时,为body中参数。 |
zoneId | 请求体(Body)/请求链接(Url) | string | 否 | 可用区参数,在某些与可用区相关的资源类型中(如DC2,EBS)起作用,用来表示希望查询/操作哪个可用区的数据。当为GET方法时,为url中参数。当为POST方法时,为body中参数。 |
说明
Content-Type
为内容类型标识,如果所请求的API是POST方法,则需要在HTTP Header中添加此项为application/json
。 部分语言的Http框架在请求时会自带此Header,如果没有则需要手动添加。regionId/zoneId
为 地域/可用区 参数,当所请求的API是POST方法,则需要添加在Body中,如果为GET方法,则需要在Url中添加此参数。目前滴滴云的区域/可用区如下:
地域 | 地域Id(regionId) | 可用区 | 可用区Id (zoneId) |
---|---|---|---|
广州 | gz | 广州一区 | gz01 |
广州二区 | gz02 | ||
北京 | bj | 北京一区 | bj01 |