接口请求参数

最近更新时间:2020-01-14 17:17:27

一个完整的腾讯云 API 请求需要两类请求参数:公共请求参数和接口请求参数。本文将介绍腾讯云 API 请求需要用到的接口请求参数,有关公共请求参数的详细说明请参见 公共请求参数 章节。
接口请求参数与具体的接口有关,不同的接口支持的接口请求参数也不一样。接口请求参数的首字母均为小写,以此区分于公共请求参数。

注意:

文章中的参数以腾讯云 Ckafka 为例,各腾讯云产品的实际参数请对应实际产品 API 参数说明。

以下参数列表以腾讯云 Ckafka 查询实例列表 接口(ListInstances)为例,该 API 支持的接口请求参数如下:

参数名称 描述 类型 必选
instanceId (过滤条件)按照实例 ID 过滤。 String
searchWord (过滤条件)按照实例名称过滤,支持模糊查询。 String
status (过滤条件)实例的状态。0:创建中,1:运行中,2:删除中,不填默认返回全部。 Int
offset 记录开始的偏移,第一条记录为0,以此类推。 Int
limit 一次最多可查询的服务器数量,默认为10,最大为20。 Int
tagKey 匹配标签key值。 String

其中各字段的说明如下:

参数名称:该接口支持的请求参数名,用户可以在使用此接口时将其作为接口请求参数。如果参数名称以“.n”结尾,则表明此参数为一个数组,使用时需要依次传入数组参数。
必选:标志此参数是否是必须的,若为“是”,则表明调用该接口必须传入此参数;若为“否”,表示可以不传入。
类型:此接口参数的数据类型。
描述:简要描述了此接口请求参数的内容。

使用示例

腾讯各云产品 API 请求链接中,接口请求参数的形式如下,以腾讯云 Ckafka 为例,假设用户想要查询伸缩组列表,则其请求链接的形式为:

https://ckafka.api.qcloud.com/v2/index.php?
&<公共请求参数>
&instanceId=ckafka-0hm4gvho
&offset=0
&limit=20
&status=1
目录