Changes the health check URL for an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request header. For more information, see Common request parameters.

Request syntax

POST /pop/v5/app/modify_hc_url HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
AppId String Query Yes c627c157-560d-43ff-***************

The ID of the application.

hcURL String Query No http://127.0.0.1:8080/_ehc.html The health check URL, which must start with http:// and can be up to 255 characters in length. An example is http://127.0.0.1:8080/_ehc.html. If this parameter is left empty, the health check URL of the application will not be changed.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code.

HealthCheckURL String http://127.0.0.1:8080/_ehc.html

The health check URL.

Message String success

The returned message.

RequestId String D16979DC-4D42-*****************

The ID of the request.

Examples

Sample requests

POST /pop/v5/app/modify_hc_url HTTP/1.1
Common request header
{
"AppId": "c627c157-560d-43ff-***************"
}

Sample success responses

XML format

<RequestId>D16979DC-4D42-*****************</RequestId>
<Message>success</Message>
<HealthCheckURL>http://127.0.0.1:8080/_ehc.html</HealthCheckURL>
<Code>200</Code>

JSON format

{
    "RequestId": "D16979DC-4D42-*****************",
    "Message": "success",
    "HealthCheckURL": "http://127.0.0.1:8080/_ehc.html",
    "Code": 200
}

Error codes

For a list of error codes, visit the API Error Center.