全部產品
Search
文件中心

Smart Access Gateway:ModifyHealthCheck - 修改健全狀態檢查配置

更新時間:Dec 21, 2025

調用ModifyHealthCheck修改健全狀態檢查配置。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

smartag:ModifyHealthCheck

update

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

Smart Access Gateway執行個體的地區 ID。

cn-shanghai

HcInstanceId

string

健全狀態檢查執行個體 ID。

hc-k9id4loo3lup57****

SmartAGId

string

Smart Access Gateway執行個體 ID。

sag-i0e85k06v1mzpo****

Name

string

健全狀態檢查執行個體名稱。

長度為 2~100 個字元,以大小字母或中文開頭,可包含數字、半形句號(.)、底線(_)或短劃線(-)。

sss333

Description

string

健全狀態檢查執行個體描述。

描述長度為 2~256 個字元,以大小字母或中文開頭,可包含數字、半形句號(.)、底線(_)或短劃線(-)。

健全狀態檢查執行個體1

Type

string

健全狀態檢查的報文類型,目前僅支援ICMP_ECHO

ICMP_ECHO

DstIpAddr

string

健全狀態檢查的目的地址。

192.XX.XX.1

DstPort

integer

健全狀態檢查的目的連接埠。

說明

該功能目前不支援。

2233

SrcIpAddr

string

健全狀態檢查的源地址。

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

時延警示閾值。

取值範圍:-11~5000

預設值:-1,表示不設定時延警示閾值。

單位:毫秒。

3

RttFailThreshold

integer

時延閾值觸發次數。

取值範圍:1~15

預設值:3

3

FailCountThreshold

integer

連續探測失敗數閾值。

取值範圍:1~15

預設值:3

3

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

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

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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. Smart Access Gateway執行個體ID為空白。
400 SAG.InstanceNoFound The specified SAG instance does not exist. Smart Access Gateway執行個體不存在。
400 SAG.SoftwareNotSupportFeature The specified SAG Software instance does not support this feature. Smart Access Gateway軟體版執行個體不支援當前特性。
400 SAG.NoActive The specified SAG instance has not been activated. Smart Access Gateway執行個體還未啟用,請先啟用。
400 SAG.Arrearage The specified SAG instance has overdue payments. Renew the instance first. Smart Access Gateway執行個體已經欠費,請先續約。
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. 健全狀態檢查執行個體已經關聯路由,無法刪除。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情