VPC環境で利用できます。
概要
ターゲットグループのヘルスチェック設定を変更します。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須有無 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| regionCode | No | String | リージョンコード ヘルスチェック設定を変更するターゲットグループのリージョン(Region)を決定できます。 regionCodeはgetRegionListアクションを通じて取得できます。 Default：getRegionList照会結果の最初のリージョンを選択 |
|
| targetGroupNo | Yes | String | ヘルスチェック設定を変更するターゲットグループ番号 targetGroupNoはgetTargetGroupListアクションを通じて取得できます。 |
|
| healthCheckPort | Conditional | Integer | Min : 1, Max : 65534 | ヘルスチェックのポート ヘルスチェックに使用するポートを変更することができます。 |
| healthCheckUrlPath | Conditional | String | ヘルスチェックのURLパス ヘルスチェックに使用するURLパスを変更することができます。 選択したターゲットグループのヘルスチェックプロトコルタイプがHTTPまたはHTTPSである場合にのみ変更できます。 /文字で始まるURLパスを入力します。 |
|
| healthCheckHttpMethodTypeCode | Conditional | String | ヘルスチェックHTTP Methodタイプコード ヘルスチェックに使用するHTTP Methodを変更することができます。 選択したターゲットグループのヘルスチェックプロトコルタイプがHTTPまたはHTTPSである場合にのみ変更できます。 Options : HEAD | GET |
|
| healthCheckCycle | Conditional | Integer | Min：5、Max：300秒 | ヘルスチェックの周期 ヘルスチェックの周期を変更することができます。 |
| healthCheckUpThreshold | Conditional | Integer | Min : 2, Max : 10 | ヘルスチェックの正常なしきい値 ヘルスチェックで正常な状態とみなされるまで連続する、必要な成功回数を変更できます。 |
| healthCheckDownThreshold | Conditional | Integer | Min : 2, Max : 10 | ヘルスチェックの失敗したしきい値 ヘルスチェックで失敗状態とみなされるまで連続する、必要な失敗回数を変更できます。 |
| responseFormatType | No | String | レスポンス結果のフォーマットタイプ Options : xml | json Default : xml |
レスポンス
レスポンスデータのタイプ
- TargetGroupListタイプ
| TargetGroupList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| TargetGroup |
|---|
| private String targetGroupNo; |
| private String targetGroupName; |
| private CommonCode targetType; |
| private String vpcNo; |
| private CommonCode targetGroupProtocolType; |
| private Integer targetGroupPort; |
| private String targetGroupDescription; |
| private Boolean useStickySession; |
| private Boolean useProxyProtocol; |
| private CommonCode algorithmType; |
| private Date createDate; |
| private String regionCode; |
| private String loadBalancerInstanceNo; |
| private CommonCode healthCheckProtocolType; |
| private Integer healthCheckPort; |
| private String healthCheckUrlPath; |
| private CommonCode healthCheckHttpMethodType; |
| private Integer healthCheckCycle; |
| private Integer healthCheckUpThreshold; |
| private Integer healthCheckDownThreshold; |
| private TargetNoList targetNoList; |
| TargetNoList |
|---|
| private List |
例
リクエスト例
ncloud vloadbalancer changeTargetGroupHealthCheckConfiguration --regionCode KR --targetGroupNo ***095 --healthCheckPort 80 --healthCheckUrlPath "/" --healthCheckHttpMethodTypeCode GET --healthCheckCycle 30 --healthCheckUpThreshold 2 --healthCheckDownThreshold 2
レスポンス例
<changeTargetGroupHealthCheckConfigurationResponse>
<requestId>b644e5ed-6ca8-48d5-9b7f-2a3549ef3c96</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<targetGroupList>
<targetGroup>
<targetGroupNo>***095</targetGroupNo>
<targetGroupName>test-***</targetGroupName>
<targetType>
<code>VSVR</code>
<codeName>Server (VPC)</codeName>
</targetType>
<vpcNo>***04</vpcNo>
<targetGroupProtocolType>
<code>HTTP</code>
<codeName>HTTP protocol</codeName>
</targetGroupProtocolType>
<targetGroupPort>80</targetGroupPort>
<targetGroupDescription></targetGroupDescription>
<useStickySession>false</useStickySession>
<useProxyProtocol>false</useProxyProtocol>
<algorithmType>
<code>RR</code>
<codeName>Round Robin</codeName>
</algorithmType>
<createDate>2020-12-17T21:06:45+0900</createDate>
<regionCode>KR</regionCode>
<loadBalancerInstanceNo></loadBalancerInstanceNo>
<healthCheckProtocolType>
<code>HTTP</code>
<codeName>HTTP protocol</codeName>
</healthCheckProtocolType>
<healthCheckPort>80</healthCheckPort>
<healthCheckUrlPath>/</healthCheckUrlPath>
<healthCheckHttpMethodType>
<code>GET</code>
<codeName>get</codeName>
</healthCheckHttpMethodType>
<healthCheckCycle>30</healthCheckCycle>
<healthCheckUpThreshold>2</healthCheckUpThreshold>
<healthCheckDownThreshold>2</healthCheckDownThreshold>
<targetNoList/>
</targetGroup>
</targetGroupList>
</changeTargetGroupHealthCheckConfigurationResponse>