ApplyHealthCheckTemplateToServerGroup - - Alibaba Cloud ドキュメントセンター

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:ApplyHealthCheckTemplateToServerGroup

update

*HealthCheckTemplate

acs:alb:{#regionId}:{#accountId}:healthchecktemplate/{#healthCheckTemplateId}

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#serverGroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
HealthCheckTemplateId	string	必須	テンプレート ID。	hct-bp1qjwo61pqz3ahltv****
ServerGroupId	string	必須	サーバーグループ ID。	sgp-n80wyad08u0tox****
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値： true：ドライランのみを実行します。システムは、パラメーター値の不足、リクエスト構文の誤り、サービスの制限など、リクエストに潜在的な問題がないか確認します。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに成功すると、2xx の HTTP ステータスコードが返され、操作が実行されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	テンプレートが適用されるサーバーグループ。
JobId	string	非同期タスク ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF34B540710

例

成功レスポンス

JSONJSON

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectStatus.HealthCheckTemplate	The status of %s [%s] is incorrect.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
403	Forbidden.ServerGroup	Authentication has failed for ServerGroup.
404	ResourceNotFound.HealthCheckTemplate	The specified resource %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.

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

変更履歴

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