DescribeDcdnIpaDomainDetail - Edge Security Acceleration

Call DescribeDcdnIpaDomainDetail to get the basic configuration of a specified accelerated domain name.

Operation description

Note

Call frequency for a single user: 30 calls per second.

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:DescribeDcdnIpaDomainDetail

get

*IpaDomain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name accelerated by IP Application Accelerator (IPA). You can query only one domain name at a time.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	09ABE829-6CD3-4FE0-AFEE-556113E29727
DomainDetail	object	The details of the domain name.
GmtCreated	string	The time when the domain name was created.	2017-11-27T06:51:26Z
SSLPub	string	The public key of the certificate if HTTPS is enabled.	SSLPub
Description	string	The description.	audit failed
SSLProtocol	string	Indicates whether an SSL certificate is enabled. Valid values: on: enabled. off: disabled.	on
ResourceGroupId	string	The ID of the resource group.	rg-acfmyuji4b6xxxx
CertName	string	The name of the certificate if HTTPS is enabled.	yourCertName
Scope	string	The acceleration region. Valid values: domestic: the Chinese mainland only. overseas: global (excluding the Chinese mainland). global: global.	overseas
Cname	string	The CNAME of the domain name.	example.com
DomainStatus	string	The status of the accelerated domain name. Valid values: online: enabled. offline: disabled. configuring: configuring. configure_failed: configuration failed. checking: under review. check_failed: review failed.	online
GmtModified	string	The time when the domain name was last modified.	2017-11-27T06:51:26Z
DomainName	string	The domain name that is accelerated by IPA.	example.com
Sources	object
Source	array<object>	The information about the origin server.
	object
Type	string	The type of the origin server. Valid values: ipaddr: an IP address. domain: a domain name. oss: an OSS bucket.	oss
Weight	string	The weight of the origin server.	10
Enabled	string	The status of the origin server.	online
Priority	string	The priority.	50
Port	integer	A custom port. Valid values: 0 to 65535.	80
Content	string	The origin URL.	xxx.oss-cn-hangzhou.aliyuncs.com

Examples

Success response

JSON format

{
  "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727",
  "DomainDetail": {
    "GmtCreated": "2017-11-27T06:51:26Z",
    "SSLPub": "SSLPub",
    "Description": "audit failed",
    "SSLProtocol": "on",
    "ResourceGroupId": "rg-acfmyuji4b6xxxx",
    "CertName": "yourCertName",
    "Scope": "overseas",
    "Cname": "example.com",
    "DomainStatus": "online",
    "GmtModified": "2017-11-27T06:51:26Z",
    "DomainName": "example.com",
    "Sources": {
      "Source": [
        {
          "Type": "oss",
          "Weight": "10",
          "Enabled": "online",
          "Priority": "50",
          "Port": 80,
          "Content": "xxx.oss-cn-hangzhou.aliyuncs.com"
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.