DescribeDcdnOriginSiteHealthStatus - Edge Security Acceleration

Queries the status of the origin server for a DCDN-accelerated domain name.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify only one domain name in each request.	example.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
OriginSiteStatus	array<object>	The information about the origin server of the accelerated domain name.
OriginSiteStatus	object
Host	string	The origin domain name that you configured in the DCDN console, which can be an IPv4 address, IPv6 address, common domain name, or Object Storage Service (OSS) domain name.	host.com
HealthStatus	string	The health status of the origin server. Each point of presence (POP) periodically initiates a probe request to the configured origin domain name. If the POP receives a response from the origin server in 5 seconds, the probe is considered successful. After the probe data for each POP is collected, the health status of the origin server is calculated based on the proportion of successful probes. Valid values: unknown: The probe data of the origin server is not obtained because the configurations of the origin server have been changed recently. Try again later. healthy: The proportion of successful probes is higher than 80%. degraded: The proportion of successful probes is higher than 0% and lower than or equal to 80%. critical: All probing requests to the origin server failed.	healthy

Examples

Sample success responses

JSONformat

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "OriginSiteStatus": [
    {
      "Host": "host.com",
      "HealthStatus": "healthy"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDomain.NotFound	The domain does not exist, or it does not belong to you.	The specified domain name does not exist or does not belong to the current account. Check whether the domain name is valid, belongs to the current account, or has expired.

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

Change history

Change time	Summary of changes	Operation

No change history