You can call this operation to configure 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 only uses common request headers. For more information, see the Common request parameters topic.

Request syntax

POST /pop/v5/app/modify_hc_url HTTPS|HTTP

Request parameters

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

The ID of the application for which you want to configure the health check URL.
hcURL String No ""

The health check URL that you want to configure. The URL must start with http:// and be up to 255 characters in length. For example, the value can be http:// 127.0.0.1:8080/_ehc.html. If this parameter is not set, the URL is not modified.

Response parameters

Parameter Type Example Description
Code Integer 200

The returned code.
Message String success

The returned message.
HealthCheckURL String {}

The health check URL that was configured for the application.
RequestId String D16979DC-4D42-*****************

Examples

Sample requests

POST /pop/v5/app/modify_hc_url HTTP/1.1
Common request headers
{
  "AppId": ""
}

Sample success responses

JSON format 

{
    "Message": "success",
    "HealthCheckURL": {},
    "Code": 200
}

XML format 

<Message>success</Message>
<HealthCheckURL/>
<Code>200</Code>

Error codes

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