すべてのプロダクト
Search

このプロダクト

    Server Load Balancer:UpdateServerGroupServersAttribute

    ドキュメントセンター

    Server Load Balancer:UpdateServerGroupServersAttribute

    最終更新日:Dec 21, 2025

    Network Load Balancer (NLB) インスタンスのサーバーグループ内のバックエンドサーバーの重みと説明を変更します。

    操作説明

    UpdateServerGroupServersAttribute は非同期操作です。リクエストが送信されると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。

    1. ListServerGroups 操作を呼び出して、サーバーグループのステータスを照会できます。

      • サーバーグループが 設定中 状態の場合、サーバーグループは変更中です。

      • サーバーグループが 使用可能 状態の場合、サーバーグループは実行中です。

    2. ListServerGroupServers 操作を呼び出して、バックエンドサーバーのステータスを照会できます。

      • バックエンドサーバーが 設定中 状態の場合、バックエンドサーバーは変更中であることを示します。

      • バックエンドサーバーが 使用可能 状態の場合、バックエンドサーバーは実行中であることを示します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    nlb:UpdateServerGroupServersAttribute

    update

    *ServerGroup

    acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ServerGroupId

    string

    必須

    サーバーグループ ID。

    sgp-atstuj3rtoptyui****
    Servers

    array<object>

    必須

    バックエンドサーバー。各呼び出しで最大 200 台のバックエンドサーバーを指定できます。

    object

    任意

    バックエンドサーバー。各呼び出しで最大 200 台のバックエンドサーバーを指定できます。

    ServerId

    string

    必須

    バックエンドサーバー ID。

    • サーバーグループが インスタンス タイプの場合、このパラメーターを Ecs、Eni、または Eci タイプのサーバーの ID に設定します。

    • サーバーグループが IP タイプの場合、このパラメーターを IP アドレスに設定します。

    ecs-bp67acfmxazb4p****
    ServerType

    string

    必須

    バックエンドサーバーのタイプ。有効な値：

    • Ecs：Elastic Compute Service (ECS) インスタンス

    • Eni：Elastic Network Interface (ENI)

    • Eci：Elastic Container Instance

    • Ip：IP アドレス

    Ecs
    ServerIp

    string

    任意

    サーバーの IP アドレス。サーバーグループタイプが IP の場合、ServerId パラメーターを IP アドレスに設定します。

    192.168.6.6
    Port

    integer

    必須

    バックエンドサーバーが使用するポート。有効な値：1～65535。

    説明

    このパラメーターは変更できません。

    443
    Weight

    integer

    任意

    バックエンドサーバーの重み。有効な値：0～100。デフォルト値：100。値を 0 に設定すると、リクエストはサーバーに転送されません。

    100
    Description

    string

    任意

    バックエンドサーバーの説明。

    説明は、長さが 2～256 文字で、文字、数字、カンマ (,)、ピリオド (.)、セミコロン (;)、スラッシュ (/)、アットマーク (@)、アンダースコア (_)、ハイフン (-) を使用できます。

    test
    RegionId

    string

    任意

    NLB インスタンスのリージョン ID。

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

    cn-hangzhou
    DryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。有効な値：

    • true：ドライランのみを実行します。システムは、パラメーター値の不足、リクエスト構文の誤り、サービスの制限など、リクエストに潜在的な問題がないかチェックします。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、DryRunOperation エラーコードが返されます。

    • false (デフォルト)：ドライランを実行し、実際のリクエストを送信します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が実行されます。

    false
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。

    クライアントを使用してこの値を生成できます。値がすべてのリクエストで一意であることを確認してください。ASCII 文字のみが許可されます。

    説明

    このパラメーターを指定しない場合、RequestId の値が使用されます。****各リクエストの RequestId は異なります。

    123e4567-e89b-12d3-a456-426655440000

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    サーバーグループ内のバックエンドサーバーの構成を更新します。

    RequestId

    string

    リクエスト ID。

    54B48E3D-DF70-471B-AA93-08E683A1B45
    ServerGroupId

    string

    サーバーグループ ID。

    sgp-atstuj3rtoptyui****
    JobId

    string

    非同期タスクの ID。

    72dcd26b-f12d-4c27-b3af-18f6aed5****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IncorrectStatus.serverGroup The status of servergroup [%s] is incorrect.
    400 Conflict.Lock The Lock [%s] is conflict. 日文说明1
    400 IllegalParam.%s The param of %s is illegal.
    400 MissingParam.%s The parameter of %s is missing.
    403 Forbidden.%s Authentication is failed for %s.
    403 Forbidden.NoPermission Authentication is failed for NoPermission.
    404 ResourceNotFound.BackendServer The specified resource of BackendServer is not found.
    404 ResourceNotFound.serverGroup The specified resource of serverGroup is not found.

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

    変更履歴

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