すべてのプロダクト
Search

このプロダクト

    Smart Access Gateway:ModifyHealthCheck

    ドキュメントセンター

    Smart Access Gateway:ModifyHealthCheck

    最終更新日:Dec 21, 2025

    ヘルスチェックを変更します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    smartag:ModifyHealthCheck

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    Smart Access Gateway (SAG) インスタンスのリージョン ID。

    cn-shanghai
    HcInstanceId

    string

    必須

    ヘルスチェックの ID。

    hc-k9id4loo3lup57****
    SmartAGId

    string

    必須

    SAG インスタンスの ID。

    sag-i0e85k06v1mzpo****
    Name

    string

    任意

    ヘルスチェックの名前。

    名前は長さが 2～100 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字である必要があります。

    sss333
    Description

    string

    任意

    ヘルスチェックの説明。

    説明は長さが 2～256 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字である必要があります。

    description
    Type

    string

    任意

    ヘルスチェックで使用されるパケットのタイプ。ICMP_ECHO のみがサポートされています。

    ICMP_ECHO
    DstIpAddr

    string

    任意

    ヘルスチェックの宛先 IP アドレス。

    192.XX.XX.1
    DstPort

    integer

    任意

    ヘルスチェックの宛先ポート。

    説明

    このパラメーターはサポートされていません。

    2233
    SrcIpAddr

    string

    任意

    ヘルスチェックの送信元 IP アドレス。

    192.XX.XX.1
    SrcPort

    integer

    任意

    ヘルスチェックの送信元ポート。

    説明

    このパラメーターはサポートされていません。

    3333
    ProbeInterval

    integer

    任意

    プローブが実行される時間間隔。次のプローブは、現在のプローブが完了するまで開始されません。

    有効値：1000～60000。

    デフォルト値：2000。

    単位：ミリ秒。

    2000
    ProbeCount

    integer

    任意

    ヘルスチェックごとに実行されるプローブの数。

    有効値：1～20。

    デフォルト値：1。

    1
    ProbeTimeout

    integer

    任意

    プローブのタイムアウト期間。

    有効値：10～30000。

    デフォルト値：3000。

    単位：ミリ秒。

    3000
    RttThreshold

    integer

    任意

    最大往復レイテンシ (RTT)。

    有効値：-1 および 1～5000。

    デフォルト値：-1。この値は、RTT のしきい値が指定されていないことを示します。

    単位：ミリ秒。

    3
    RttFailThreshold

    integer

    任意

    アラートがトリガーされるまでに最大 RTT を超える回数。

    有効値：1～15。

    デフォルト値：3。

    3
    FailCountThreshold

    integer

    任意

    ヘルスチェックが失敗と判断されるまでの、失敗したプローブの数。

    有効値：1～15。

    デフォルト値：3。

    3

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    F0290F85-8087-4FB7-81F8-84226A4DAAB2

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F0290F85-8087-4FB7-81F8-84226A4DAAB2"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 HC.InstanceNoFound The specified network health check instance does not exist.
    400 HC.InvalidDescription The specified description is invalid.
    400 HC.InvalidDstIpAddr The specified destination IP address is invalid.
    400 HC.InvalidDstPort The specified destination port is invalid.
    400 HC.InvalidFailCountThreshold The maximum number of successive failed probes is exceeded.
    400 HC.InvalidName The specified name is invalid.
    400 HC.InvalidProbeCount The specified number of probes is invalid.
    400 HC.InvalidProbeInterval The specified probe interval is invalid.
    400 HC.InvalidProbeTimeout The specified probe timeout period is invalid.
    400 HC.InvalidRttFailThreshold The RTT threshold has been triggered too many times.
    400 HC.InvalidRttThreshold The specified RTT is invalid.
    400 HC.InvalidSrcIpAddr The specified source IP address is invalid.
    400 HC.InvalidSrcPort The specified source port is invalid.
    400 HC.InvalidType The specified type is invalid.
    400 SAG.InstanceIdEmpty You must specify the SAG instance ID.
    400 SAG.InstanceNoFound The specified SAG instance does not exist.
    400 SAG.SoftwareNotSupportFeature The specified SAG Software instance does not support this feature.
    400 SAG.NoActive The specified SAG instance has not been activated.
    400 SAG.Arrearage The specified SAG instance has overdue payments. Renew the instance first.
    400 HC.AutoGenerated The health check instance is automatically generated and cannot be modified.
    400 HC.RelatedRoute The specified health check instance has associated routes and cannot be deleted.

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

    変更履歴

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