接口请求参数

最近更新时间:2018-08-13 10:00:12

接口请求参数与具体的接口有关,不同的接口支持的接口请求参数也不一样。接口请求参数的首字母均为小写,以此区分于公共请求参数。
启动 DSA 域名 (OnlineDsaHost) 为例,其支持的接口请求参数如下:

参数名称 必选 类型 描述
hostId Unsigned 域名接入DSA后的标识ID

其中各字段的说明如下:

参数名称 该接口支持的请求参数名,用户可以在使用此接口时将其作为接口请求参数。
注意:如果参数名称以“.n”结尾,则表明此参数为一个数组,使用时需要依次传入数组参数。
必选 标志此参数是否是必须输入的参数。
若为“是”,则表明调用该接口必须传入此参数;
若为“否”,表示可以不传入;
当所有接口请求参数均不是必选时,仅使用公共请求参数就能完成正常的接口调用。
类型 此接口参数的数据类型。
描述 简要描述了此接口请求参数的内容及调用说明。

举例说明:
假设用户想要启动 hostId 为 12345 的域名(hostID 可通过域名列表查询接口获取),则其请求链接的形式可能如下:

https://dsa.api.qcloud.com/v2/index.php?
&<公共请求参数>
&hostID=12345

一个完整的请求需要两类请求参数:公共请求参数和接口请求参数。这里只列出了接口请求参数,并未列出公共请求参数,有关公共请求参数的说明可见 公共请求参数小节。