すべてのプロダクト
Search

このプロダクト

    :DescribeVServerGroups

    ドキュメントセンター

    :DescribeVServerGroups

    最終更新日:Dec 14, 2025

    vServer グループをクエリします。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    slb:DescribeVServerGroups

    get

    *loadbalancer

    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
    • slb:tag
    • slb:tag
    • slb:tag
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    Classic Load Balancer (CLB) インスタンスが属するリージョン ID。

    最新のリージョンリストは、DescribeRegions 操作を呼び出して照会できます。

    cn-hangzhou
    LoadBalancerId

    string

    必須

    CLB インスタンスの ID。

    lb-bp1o94dp5i6ea*******
    IncludeRule

    boolean

    任意

    vServer グループに関連付けられている転送ルールを返すかどうかを指定します。有効な値：

    • true：はい

    • false (デフォルト)：いいえ

    false
    IncludeListener

    boolean

    任意

    関連付けられているリスナーに関する情報を返すかどうかを指定します。有効な値：

    • true：はい

    • false (デフォルト)：いいえ

    false
    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    Key

    string

    任意

    タグ N のキー。N の有効値の範囲は 1～20 です。タグキーは空の文字列にできません。

    タグキーは最大 64 文字で、`http://` または `https://` を含めることはできません。タグキーの先頭に `aliyun` または `acs:` を使用することはできません。

    TestKey
    Value

    string

    任意

    タグ値。N の有効値の範囲は 1～20 です。タグ値は空の文字列にできます。

    タグ値は最大 128 文字で、先頭に `acs:` または `aliyun` を使用することはできません。タグ値に `http://` または `https://` を含めることはできません。

    TestValue
    Description

    string

    任意

    vServer グループの名前。

    Group3

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
    VServerGroups

    object

    VServerGroup

    array<object>

    バックエンドサーバー。

    array<object>

    vServer グループの詳細。

    VServerGroupId

    string

    サーバーグループ ID。

    rsp-0bfuc*****
    VServerGroupName

    string

    サーバーグループ名。

    Group3
    AssociatedObjects

    object

    関連リソース。

    Listeners

    object

    Listener

    array<object>

    リスナー。

    object

    リスナー。

    Port

    integer

    リスナーポート。

    80
    Protocol

    string

    リスナープロトコル。有効な値：tcp、udp、http、https。

    tcp
    Rules

    object

    Rule

    array<object>

    転送ルール。

    object

    転送ルール。

    Url

    string

    リクエスト URL。

    /example
    Domain

    string

    リクエストされたドメイン名。

    www.example.com
    RuleName

    string

    転送ルールの名前。

    test
    RuleId

    string

    転送ルールの ID。

    rule-a3x3pg1yohq3lq****
    ServerCount

    integer

    サーバーの数。

    このパラメーターはデフォルトでは使用できません。このパラメーターを使用するには、チケットを送信するか、アカウントマネージャーにご連絡ください。

    1
    CreateTime

    string

    CLB インスタンスが作成された時間。時間は `YYYY-MM-DDThh:mm:ssZ` フォーマットに従います。

    2022-08-31T02:49:05Z
    Tags

    object

    Tag

    array<object>

    タグ。

    object

    タグオブジェクト。

    TagKey

    string

    タグキー。

    TestKey
    TagValue

    string

    タグ値。

    TestValue

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 MissingParam.TagKey The param of TagKey is missing.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。