DescribeDcdnOriginSiteHealthStatus - Edge Security Acceleration

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnOriginSiteHealthStatus

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. Only one domain name is supported.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
OriginSiteStatus	array<object>	A list of health statuses for the origin servers of the accelerated domain name.
	object
Host	string	The origin domain name that you configured in the DCDN console. This can be an IPv4 address, an IPv6 address, a generic domain name, or an OSS domain name.	host.com
HealthStatus	string	DCDN nodes periodically send probe requests to your origin domain name. A probe is successful if a response is received from the origin server within 5 seconds. The health status of the origin server is calculated based on the success rate of these probes across all nodes. The health statuses are described as follows: unknown: The probe data for the origin server could not be obtained. This happens because the configuration of the origin server was recently changed. Retry later. healthy: The probe success rate is higher than 80%. degraded: The probe success rate is greater than 0% but less than or equal to 80%. critical: All probe requests to the origin server failed.	healthy

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.