All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnOriginSiteHealthStatus

Last Updated:Apr 11, 2024

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

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
dcdn:DescribeDcdnOriginSiteHealthStatusWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name in each request.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0AEDAF20-4DDF-4165-8750-47FF9C1929C9
OriginSiteStatusobject []

The information about the origin server of the accelerated domain name.

Hoststring

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
HealthStatusstring

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 codeError codeError messageDescription
404InvalidDomain.NotFoundThe 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 timeSummary of changesOperation
No change history