All Products
Search
Document Center

Edge Security Acceleration:GetCnameFlattening

Last Updated:Apr 16, 2025

Queries the CNAME flattening configuration of a website

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
esa:GetCnameFlatteningget
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

The website ID, which can be obtained by calling the ListSites operation.

123456****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

F61CDR30-E83C-4FDA-BF73-9A94CDD44229
FlattenModestring

The CNAME flattening mode. Valid values:

  • flatten_all: flattens all CNAMEs.
  • flatten_all (default): flattens only the root domain.
Enumeration Value:
  • flatten_at_root: flatten_at_root.
  • flatten_all: flatten_all.
flatten_all

Examples

Sample success responses

JSONformat

{
  "RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
  "FlattenMode": "flatten_all"
}

Error codes

HTTP status codeError codeError messageDescription
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

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