UpdateGatewayServiceCheck - Microservices Engine - Alibaba Cloud Documentation Center

Updates the health check policy of a specified service in a cloud-native gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:UpdateGatewayServiceCheck	update	*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ServiceId	string	No	The ID of the service.	12
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-8d410698bd7f4628ab76b*****72dd1d
Check	boolean	No	Specifies whether to enable the health check.	true
ExpectedStatuses	array	No	The expected status code, which is required if the health check protocol is HTTP.
	integer	No	The HTTP status code that indicates the normal health check. This parameter is required if the health check protocol is HTTP. Valid values: http_2xx: 200 http_3xx: 300 http_4xx: 400 http_5xx: 500	200
Protocol	string	No	The health check protocol. Valid values: HTTP TCP	HTTP
Timeout	integer	No	The timeout period of responses to the health check. Unit: seconds.	5
Interval	integer	No	The interval at which the health check is performed.	2
HealthyThreshold	integer	No	The healthy threshold of the health check.	2
UnhealthyThreshold	integer	No	The unhealthy threshold of the health check.	2
HttpPath	string	No	The health check path, which is required if the health check protocol is HTTP.	/healthz
HttpHost	string	No	The health check domain name, which is optional if the health check protocol is HTTP.	example.com
AcceptLanguage	string	No	The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	62CBFCB8-DDC6-588C-BF1B-88828AF*****
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The message returned.	OK
Code	integer	The response code. The status code 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: true and false.	true
Data	long	The service ID of the operation.	12

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.