接口请求参数

最近更新时间:2017-10-11 12:26:52

接口请求参数与具体的接口有关,不同的接口支持的接口请求参数也不一样。接口请求参数的首字母均为小写,以此区分于公共请求参数。
绑定服务器EIP为例,其支持的接口请求参数如下:

参数名称 必选 类型 描述
eipId String EIP实例ID
instanceId String 服务器实例ID,可通过查询服务器接口返回字段中的unInstanceId获取

其中各字段的说明如下:

字段 说明
参数名称 该接口支持的请求参数名,用户可以在使用此接口时将其作为接口请求参数。该接口支持的请求参数名,用户可以在使用此接口时将其作为接口请求参数。
是否必选 标志此参数是否是必须的,若为“是”,则表明调用该接口必须传入此参数;若为“否”,表示可以不传入。
类型 此接口参数的数据类型。
描述 简要描述了此接口请求参数的内容。

假设用户想要绑定EIP到黑石服务器,则其请求链接的形式可能如下:

  https://bmeip.api.qcloud.com/v2/index.php?
  &<公共请求参数>
  &instanceId=cpm-xxxxxx&eipId=eip-vvvvvvv

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

如果有其他疑问,你也可以通过提问形式与我们联系探讨