请求的URI
例如:{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
参数 |
描述 |
是否必选 |
URI-scheme |
用于传输请求的协议,当前所有API均采用HTTPS协议。 |
是 |
Endpoint |
当前资源池或者通用的域名 |
是 |
resource-path |
资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户1信息”API的resource-path为“/users/1”。 |
是 |
query-string |
查询参数,其中regionId为必填参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?userID=1”,表示查询用户ID为1的数据。多个参数之间用&分割。 |
是 |
举例(以查询实例列表接口为例): https://drds-global.ctapi.ctyun.cn/v2/instance/list?regionId=a17034a4794111eaaa590242ac110002&pageNow=1&pageSize=10
请求方法
方法 |
说明 |
GET |
请求服务器返回指定资源。 |
PUT |
请求服务器更新指定资源。 |
POST |
请求服务器新增资源或执行特殊操作。 |
DELETE |
请求服务器删除指定资源,如删除对象等。 |
HEAD |
请求服务器资源头部。 |
PATCH |
请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 |
请求消息头
编号 |
header |
类型 |
名称 |
是否必须 |
说明 |
1 |
Content-Type |
string |
https协议字段 |
是 |
application/json |
2 |
ctyun-eop-request-id |
string |
用户请求id |
是 |
用户请求id,通过uuid生成,形如33dfa732-b27b-464f-b15a-21ed6845afd5 |
3 |
Eop-Authorization |
string |
签名 |
是 |
由天翼云官网accessKey和securityKey经签名后生成,签名逻辑详见后续说明 |
4 |
eop-date |
string |
时间 |
是 |
请求时间,形如yyyymmddTHHMMSSZ,例如20211221T163014Z |
5 |
host |
string |
访问控制器 |
是 |
终端节点域名 |