tencent cloud

负载均衡

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
使用场景
技术原理
产品对比
使用约束
Service Regions and Service Providers
购买指南
计费概述
计费项
CLB 资源包
购买方式
欠费说明
产品属性选择
快速入门
域名化负载均衡快速入门
负载均衡快速入门
IPv6 负载均衡快速入门
CentOS 下部署 Nginx
CentOS 下部署 Java Web
操作指南
负载均衡实例
负载均衡监听器
后端服务器
健康检查
证书管理
日志管理
监控告警
访问管理
传统型负载均衡
实践教程
部署证书到负载均衡（双向认证）
负载均衡开启 Gzip 配置及检测方法说明
HTTPS 转发配置入门指南
如何获取客户端真实 IP
负载均衡配置监控告警最佳实践
产品高可用说明
均衡算法选择与权重配置示例
配置 WAF 对负载均衡的监听域名进行 Web 安全防护
配置 IAP 对负载均衡的域名和路径的web访问进行身份验证
配置 IAP 对负载均衡的域名和路径的程序化访问进行身份验证
运维指南
客户端 timewait 过多解决方案
负载均衡HTTPS服务性能测试
压力测试常见问题
CLB 证书操作权限问题
故障处理
UDP 健康检查出现异常
API 文档
History
Introduction
API Category
Instance APIs
Listener APIs
Backend Service APIs
Target Group APIs
Redirection APIs
Other APIs
Classic CLB APIs
Load Balancing APIs
Making API Requests
Data Types
Error Codes
CLB API 2017
常见问题
计费相关
负载均衡配置相关
健康检查异常排查
HTTPS 相关
WS/WSS 协议支持相关
HTTP/2 协议支持相关
默认域名阻断提示
服务等级协议
联系我们
词汇表
文档负载均衡API 文档CLB API 2017Making API RequestsRequest StructureAPI Request Parameters

API Request Parameters

PDF
聚焦模式
字号
最后更新时间： 2024-12-19 10:50:42
A complete TencentCloud API request consists of two types of parameters: common request parameters and API request parameters. This document describes API request parameters. API request parameters vary by API. API request parameters should always begin with a lowercase letter so that they can be differentiated from common request parameters.
Note:
This document illustrates parameters specific to Tencent Cloud CVMs. For other Tencent Cloud services, see their API documentation for specific parameters.
The list below uses the DescribeInstances API as an example and contains its request parameters:
Parameter
Description
Type
Required
instanceIds.n
Array of the IDs of CVM instances to query, with the array subscript starting from 0. You can use instanceId or unInstanceId, and we recommend using the uniform resource ID unInstanceId.
String
No
lanIps.n
Array of private IPs of CVM instances to query.
String
No
searchWord
User-defined CVM alias.
String
No
offset
The offset at which the entries start. The entry starts from 0.
Int
No
limit
The maximum number of instances that can be queried at a time. The default is 20 and the maximum is 100.
Int
No
status
Status of the CVM to query.
Int
No
projectId
Project ID. CVM instances of all projects will be queried if this parameter is not passed in. The value 0 indicates the default project. If you want to query a specified project, call the DescribeProjects API.
String
No
simplify
Non-real time data obtained if simplify=1 is included in the input parameter
Int
No
zoneId
Availability zone ID. CVM instances in all availability zones will be queried if this parameter is not passed in. If you want to query a specified availability zone, call the DescribeZones API.
Int
No
The above fields are described as follows:
Parameter: name of the request parameter supported by the API, which may be used in the API calling. A parameter name that ends with .n represents an array, for which you need to input the array parameters individually. Required: indicates whether this parameter is required. "Yes" means the parameter is required for the API calling. "No" means the parameter can be left empty. Type: data type of the API parameter. Description: a brief description of the API request parameter.

Example

The example shows you how to configure API request parameters for a TencentCloud API. For example, if you want to query the list of scaling groups for a Tencent Cloud CVM, use the following request link:
https://cvm.api.qcloud.com/v2/index.php?
&instanceIds.0=ins-0hm4gvho
&instanceIds.1=ins-8oby8q00
&offset=0
&limit=20
&status=2
&zoneId=100003
上一篇: Common Request Parameters下一篇: Final Request Format

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈