查询虚拟服务器组列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| slb:DescribeVServerGroups | get | *loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId} | 
 | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| RegionId | string | 是 | 传统型负载均衡实例的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou | 
| LoadBalancerId | string | 是 | 传统型负载均衡实例 ID。 | lb-bp1o94dp5i6ea******* | 
| IncludeRule | boolean | 否 | 是否返回关联的转发规则信息。取值: 
 | false | 
| IncludeListener | boolean | 否 | 是否返回关联的监听信息。取值: 
 | false | 
| Tag | array<object> | 否 | 资源标签。 | |
| object | 否 | 资源标签。 | ||
| Key | string | 否 | 资源的标签键。N 的取值范围:1~20。一旦输入该值,则不允许为空字符串。 最多支持 64 个字符,不能以 | TestKey | 
| Value | string | 否 | 资源的标签值。N 的取值范围:1~20。一旦输入该值,可以为空字符串。
最多支持 128 个字符,不能以 | TestValue | 
| Description | string | 否 | 虚拟服务器组名称。 | Group3 | 
返回参数
示例
正常返回示例
JSON格式
{
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08******",
  "VServerGroups": {
    "VServerGroup": [
      {
        "VServerGroupId": "rsp-0bf******",
        "VServerGroupName": "Group3",
        "AssociatedObjects": {
          "Listeners": {
            "Listener": [
              {
                "Port": 80,
                "Protocol": "tcp"
              }
            ]
          },
          "Rules": {
            "Rule": [
              {
                "Url": "/example",
                "Domain": "www.example.com",
                "RuleName": "test",
                "RuleId": "rule-a3x3pg1******"
              }
            ]
          }
        },
        "ServerCount": 1,
        "CreateTime": "2022-08-31T02:49:05Z",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        }
      }
    ]
  }
}错误码
| HTTP status code | 错误码 | 错误信息 | 
|---|---|---|
| 400 | MissingParam.TagKey | The param of TagKey is missing. | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2023-10-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 | 
| 2023-07-04 | OpenAPI 错误码发生变更 | 查看变更详情 | 
