全部產品
Search
文件中心

Microservices Engine:UpdateGatewayServiceCheck - 更新服務健全狀態檢查策略

更新時間:Dec 16, 2025

更新雲原生網關指定服務的健全狀態檢查策略。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:UpdateGatewayServiceCheck

update

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

請求參數

名稱

類型

必填

描述

樣本值

ServiceId

string

服務 ID

12

GatewayUniqueId

string

網關唯一 ID

gw-8d410698bd7f4628ab76b*****72dd1d

Check

boolean

是否開啟健全狀態檢查

true

ExpectedStatuses

array

正常狀態代碼(健全狀態檢查協議為 HTTP 時必填)

integer

用於判斷健全狀態檢查正常的 HTTP 狀態代碼(健全狀態檢查協議為 HTTP 時必填):

  • http_2xx: 200

  • http_3xx: 300

  • http_4xx: 400

  • http_5xx: 500

200

Protocol

string

健全狀態檢查協議,目前支援:

  • HTTP

  • TCP

HTTP

Timeout

integer

健全狀態檢查響應逾時時間(秒)

5

Interval

integer

健全狀態檢查間隔時間(秒)

2

HealthyThreshold

integer

健全狀態檢查健康閾值

2

UnhealthyThreshold

integer

健全狀態檢查不健康閾值

2

HttpPath

string

健全狀態檢查路徑(健全狀態檢查協議為 HTTP 時必填)

/healthz

HttpHost

string

健全狀態檢查網域名稱(健全狀態檢查協議為 HTTP 時選填)

example.com

AcceptLanguage

string

返回結果顯示的語言。取值:zh(預設值):中文,en:英文

zh

返回參數

名稱

類型

描述

樣本值

object

返回體結構。

RequestId

string

請求 ID。

62CBFCB8-DDC6-588C-BF1B-88828AF*****

HttpStatusCode

integer

HTTP 狀態代碼

200

Message

string

返回資訊。

OK

Code

integer

code 僅僅用來和 success 同步。

200

Success

boolean

請求結果,取值如下:true:請求成功。 false:請求失敗。

true

Data

integer

操作的服務 ID。

12

樣本

正常返回樣本

JSON格式

{
  "RequestId": "62CBFCB8-DDC6-588C-BF1B-88828AF*****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 12
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 IllegalRequest Invalid request:%s 非法請求: %s
400 InvalidParameter Parameter error:%s 請求參數錯誤:%s
500 InternalError Console error. Try again later:%s 控制台錯誤.稍後重試:%s
403 NoPermission You are not authorized to perform this operation:%s 沒有許可權使用此介面:%s
404 NotFound Not found:%s 資源不存在:%s

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

變更歷史

更多資訊,參考變更詳情