All Products
Search
Document Center

Enterprise Distributed Application Service:UpdateHealthCheckUrl

Last Updated:Mar 01, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ManageApplicationWrite
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/v5/app/modify_hc_url

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

c627c157-560d-43ff-***************
hcURLstringNo

The health check URL of the application. The URL must start with http://, and can be up to 255 characters in length. Example: http://127.0.0.1:8080/_ehc.html. If this parameter is not specified, the health check URL of the application is not changed.

http://127.0.0.1:8080/_ehc.html

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The message that is returned.

success
RequestIdstring

The ID of the request.

D16979DC-4D42-*****************
HealthCheckURLstring

The health check URL.

http://127.0.0.1:8080/_ehc.html

Examples

Sample success responses

JSONformat

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

Error codes

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