文档

DescribeVServerGroups - 查询服务器组列表

更新时间:

查询服务器组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
slb:DescribeVServerGroupsRead
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag

请求参数

名称类型必填描述示例值
RegionIdstring

传统型负载均衡实例的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
LoadBalancerIdstring

传统型负载均衡实例 ID。

lb-bp1o94dp5i6ea*******
IncludeRuleboolean

是否返回关联的转发规则信息。取值:

  • true:是。
  • false(默认值):否。
false
IncludeListenerboolean

是否返回关联的监听信息。取值:

  • true:是。
  • false(默认值):否。
false
Tagobject []

资源标签。

Keystring

资源的标签键。N 的取值范围:1~20。一旦输入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

TestKey
Valuestring

资源的标签值。N 的取值范围:1~20。一旦输入该值,可以为空字符串。 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

TestValue
Descriptionstring

虚拟服务器组名称。

Group3

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
VServerGroupsobject []

后端服务器列表。

VServerGroupIdstring

服务器组 ID。

rsp-0bfucwuotx
VServerGroupNamestring

服务器组名称。

Group3
AssociatedObjectsobject

关联信息。

Listenersobject []

监听列表。

Portinteger

监听端口。

80
Protocolstring

监听协议。取值:tcpudphttphttps

tcp
Rulesobject []

转发规则列表。

Urlstring

访问路径。

/example
Domainstring

请求域名。

www.example.com
RuleNamestring

转发规则名称。

test
RuleIdstring

转发规则 ID。

rule-a3x3pg1yohq3lq****
ServerCountlong

服务器个数。

说明 该参数对应的功能默认不开放,如需使用,请提交工单
1
CreateTimestring

传统型负载均衡实例的创建时间,格式:YYYY-MM-DDThh:mm:ssZ

2022-08-31T02:49:05Z
Tagsobject []

标签列表。

TagKeystring

资源的标签键。

TestKey
TagValuestring

资源的标签值。

TestValue

示例

正常返回示例

JSON格式

{
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "VServerGroups": {
    "VServerGroup": [
      {
        "VServerGroupId": "rsp-0bfucwuotx",
        "VServerGroupName": "Group3",
        "AssociatedObjects": {
          "Listeners": {
            "Listener": [
              {
                "Port": 80,
                "Protocol": "tcp"
              }
            ]
          },
          "Rules": {
            "Rule": [
              {
                "Url": "/example",
                "Domain": "www.example.com",
                "RuleName": "test",
                "RuleId": "rule-a3x3pg1yohq3lq****"
              }
            ]
          }
        },
        "ServerCount": 1,
        "CreateTime": "2022-08-31T02:49:05Z",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400MissingParam.TagKeyThe param of TagKey is missing.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Description
2023-07-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈