ModifyHealthCheckConfig - Anti-DDoS - Alibaba Cloud Documentation Center

Modifies the Layer 4 or Layer 7 health check configuration of a port forwarding rule.

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
yundun-ddoscoo:ModifyHealthCheckConfig	update	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-mp91j1ao****
ForwardProtocol	string	Yes	The forwarding protocol. Valid values: tcp udp	tcp
FrontendPort	integer	Yes	The forwarding port.	8080
HealthCheck	string	Yes	The details of the health check configuration. This parameter is a JSON string. The string contains the following fields: Type: the protocol type. This field is required and must be of the STRING type. Valid values: tcp (Layer 4) and http (Layer 7). Domain: the domain name, which must be of the STRING type. NoteThis parameter is returned only when the Layer 7 health check configuration is queried. Uri: the check path, which must be of the STRING type. NoteThis parameter is returned only when the Layer 7 health check configuration is queried. Timeout: the response timeout period, which must be of the INTEGER type. Valid values: 1 to 30. Unit: seconds. Port: the port on which you want to perform the health check, which must be of the INTEGER type. Interval: the health check interval, which must be of the INTEGER type. Valid values: 1 to 30. Unit: seconds. Up: the number of consecutive successful health checks that must occur before declaring a port healthy, which must be of the INTEGER type. Valid values: 1 to 10. Down: the number of consecutive failed health checks that must occur before declaring a port unhealthy, which must be of the INTEGER type. Valid values: 1 to 10.	{"Type":"tcp","Timeout":10,"Port":8080,"Interval":10,"Up":10,"Down":40}

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc"
}

Error codes

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