Update a Member#
プールメンバーを更新します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://loadbalancer.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://loadbalancer.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/v2.0/lbaas/pools/{pool_id}/members/{member_id}
HTTPステータスコード#
正常時:202
エラー時:400,401,403,404,409,500
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
admin_state_up | body | boolean | 任意 | リソースの管理状態 「true」または「false」を指定します。 |
member | body | object | 必須 | メンバーオブジェクト |
member_id | path | uuid | 必須 | メンバーID 📒注: 対象のメンバーIDがpool_idで指定したプールに存在することを必ず確認してください。そのメンバーが存在するプールと異なるpool_idを指定した場合、provisioning_statusが「PENDING_UPDATE」の状態から「ACTIVE」に戻らなくなります。 |
monitor_address | body | string | 任意 | ヘルスモニター用のIPアドレス |
monitor_port | body | integer | 任意 | ヘルスモニター用のポート番号 |
name | body | string | 任意 | リソース名 |
pool_id | path | uuid | 必須 | プールID |
weight | body | integer | 任意 | メンバーのウェイト 他のプールのメンバーと比べて、そのメンバーのリクエストまたはコネクションを提供する割合を指定します。 例えば、ウェイトが10であるメンバーはウェイトが2であるメンバーの5倍のリクエストを受け取ります。 ウェイトが0の場合は、そのメンバーは新しいコネクションを受け入れずに既存のコネクションだけにサービスを提供します。 0~256の値が指定可能です。 デフォルトは1です。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
address | string | メンバーのIPアドレス |
admin_state_up | boolean | リソースの管理状態 「true」または「false」が表示されます。 |
created_at | string | リソースが作成された日時(UTC)のタイムスタンプ |
id | uuid | メンバーID |
member | object | メンバーオブジェクト |
monitor_address | string | ヘルスモニター用のIPアドレス |
monitor_port | integer | ヘルスモニター用のポート番号 |
name | string | リソース名 |
operating_status | string | リソースの運用状況 「ONLINE」、「OFFLINE」、「NO_MONITOR」、「DRAINING」または「ERROR」が表示されます。 operating_statusの詳細は「Operating Status Codes」を参照してください。 |
project_id | string | プロジェクトID |
protocol_port | integer | リスニングするTCPポート番号 |
provisioning_status | string | リソースの提供状況 「ACTIVE」、「PENDING_UPDATE」または「ERROR」が表示されます。 provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。 |
subnet_id | uuid | メンバーが属するサブネットID |
updated_at | string | リソースの更新日時(UTC)のタイムスタンプ |
weight | integer | メンバーのウェイト 他のプールのメンバーと比べて、そのメンバーのリクエストまたはコネクションを提供する割合が表示されます。 例えば、ウェイトが10であるメンバーはウェイトが2であるメンバーの5倍のリクエストを受け取ります。 ウェイトが0の場合は、そのメンバーは新しいコネクションを受け入れずに既存のコネクションだけにサービスを提供します。 0~256の値がが表示されます。 デフォルトは1です。 |
リクエスト例#
{ "member":{ "monitor_port":"22", "name":"server-1", "weight":"0" } }
レスポンス例#
{ "member": { "address": "192.168.0.7", "admin_state_up": true, "created_at": "2019-03-22T08:56:44", "id": "f2aed3d5-5cc3-4088-8ffc-da7a263e2548", "monitor_address": null, "monitor_port": null, "name": "", "operating_status": "NO_MONITOR", "project_id": "51ed616c4bf0440ab6cfe5ff96edce91", "protocol_port": 80, "provisioning_status": "PENDING_UPDATE", "subnet_id": null, "updated_at": "2019-03-22T09:23:31", "weight": 1 } }