GetRecord API Overview for DNS Record Management - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Retrieves the detailed configuration of a single DNS record, including the record value, priority, and back-to-origin authentication configuration (exclusive to CNAME records).

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

esa:GetRecord

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RecordId	integer	Yes	The ID of the record. You can obtain this value by calling ListRecords.	1234567890123

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F32C57AA-7BF8-49AE-A2CC-9F42390F5A19
RecordModel	object	The information about the queried record.
BizName	string	The business scenario when the record is accelerated. Valid values: image_video: video and image. api: API. web: web page.	image_video
Data	object	The DNS information of the record. The content returned in this field varies by record type.	{"value":"1.1.1.1"}
Value	string	O valor do registro ou conteúdo parcial. O significado varia de acordo com o tipo de registro: A/AAAA: O endereço IP para o qual o registro aponta. Separe vários endereços IP com vírgulas (,). Pelo menos um endereço IPv4 é obrigatório. CNAME: O nome de domínio de destino para o qual o registro aponta. NS: O servidor de nomes para o nome de domínio especificado. MX: O nome de domínio válido do servidor de e-mail de destino. TXT: Uma string de texto válida. CAA: Um nome de domínio de autoridade de certificação válido. SRV: Um nome de domínio válido do host de destino. URI: Uma string URI válida.	example.com
Priority	integer	A prioridade do registro. Valores válidos: 0 a 65535. Um valor menor indica uma prioridade maior.	10
Flag	integer	O flag do registro. O Flag de um registro CAA indica sua prioridade e método de processamento. Valores válidos: 0 a 255.	128
Tags	object	As tags do registro.	{\"test\": \"test val1\"}
Weight	integer	O peso do registro. Valores válidos: 0 a 65535.	0
Port	integer	A porta do registro. Valores válidos: 0 a 65535.	8707
Type	integer	O tipo de certificado do registro (para registros CERT) ou o tipo de chave pública (para registros SSHFP).	0
KeyTag	integer	O identificador de chave pública do registro. Valores válidos: 0 a 65535.	1
Algorithm	integer	O algoritmo de criptografia usado pelo registro. Valores válidos: 0 a 255.	1
Certificate	string	As informações do certificado de chave pública do registro.	dGVzdGFkYWxrcw==
Usage	integer	O identificador de uso do registro. Valores válidos: 0 a 255.	0
Selector	integer	O tipo de certificado ou chave pública usado pelo registro. Valores válidos: 0 a 255.	1
MatchingType	integer	A política de algoritmo usada para corresponder ou verificar o certificado. Valores válidos: 0 a 255.	1
Fingerprint	string	O valor da impressão digital da chave pública do registro.	abcdef1234567890
Tag	string	A tag do registro. A Tag de um registro CAA indica seu tipo e propósito específicos.	issue
CreateTime	string	The creation time of the record. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-03-10T13:30:39Z
UpdateTime	string	The update time of the record. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-01-27T02:26:22Z
Proxied	boolean	Indicates whether proxy acceleration is enabled for the record. Only CNAME and A/AAAA records support proxy acceleration. Valid values: true: Proxy acceleration is enabled. false: Proxy acceleration is disabled.	true
RecordId	integer	The record ID.	1234567890123
RecordName	string	The record name.	a.example.com
RecordType	string	The DNS type of the record, such as A/AAAA, CNAME, or TXT.	A/AAAA
SiteId	integer	The site ID.	1234567890123
SiteName	string	The site name.	example.com
Ttl	integer	The Time-to-Live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.	20
RecordSourceType	string	The origin type of the CNAME record. Valid values: OSS: OSS origin. S3: S3 origin. LB: load balancing origin. OP: IPAM pool origin. Domain: standard domain name origin. If this parameter is not specified or is left empty, the default value is Domain, which indicates a standard domain name origin type.	OSS
RecordCname	string	The CNAME of the record.	a.example.com.cnamezone.com
Comment	string	The comment of the record.	Remarks
AuthConf	object	The back-to-origin authentication information of the CNAME record.
AuthType	string	O tipo de autenticação de origem. Valores válidos: public: Leitura pública. Selecione este valor quando o tipo de origem for OSS ou S3 e a origem permitir acesso de leitura pública. private: Leitura privada. Selecione este valor quando o tipo de origem for S3 e a origem permitir apenas acesso de leitura privada. private_same_account: Leitura privada na mesma conta. Selecione este valor quando o tipo de origem for OSS, a origem estiver na mesma conta Alibaba Cloud e a origem permitir apenas acesso de leitura privada. private_cross_account: Leitura privada entre contas. Selecione este valor quando o tipo de origem for OSS, a origem estiver em uma conta Alibaba Cloud diferente e a origem permitir apenas acesso de leitura privada.	public
SecretKey	string	O AccessKey Secret da conta à qual a origem pertence.	u0Nkg5gBK*******QF5wvKMM504JUHt
AccessKey	string	O AccessKey ID da conta à qual a origem pertence.	VIxuvJSA2S03f******kp208dy5w7
Version	string	A versão do algoritmo de assinatura. Valores válidos: v2 v4 Valor padrão: v4.	v2
Region	string	A região onde a origem reside. Obtenha a região no site oficial do S3.	us-east-1
HostPolicy	string	The back-to-origin HOST policy. This parameter takes effect when the record type is CNAME. It specifies the HOST header policy for back-to-origin requests. Valid values: follow_hostname: follows the host record. follow_origin_domain: follows the origin domain name.	follow_origin_domain

Examples

Success response

JSON format

{
  "RequestId": "F32C57AA-7BF8-49AE-A2CC-9F42390F5A19",
  "RecordModel": {
    "BizName": "image_video",
    "Data": {
      "Value": "example.com",
      "Priority": 10,
      "Flag": 128,
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "Weight": 0,
      "Port": 8707,
      "Type": 0,
      "KeyTag": 1,
      "Algorithm": 1,
      "Certificate": "dGVzdGFkYWxrcw==",
      "Usage": 0,
      "Selector": 1,
      "MatchingType": 1,
      "Fingerprint": "abcdef1234567890",
      "Tag": "issue"
    },
    "CreateTime": "2023-03-10T13:30:39Z",
    "UpdateTime": "2023-01-27T02:26:22Z",
    "Proxied": true,
    "RecordId": 1234567890123,
    "RecordName": "a.example.com",
    "RecordType": "A/AAAA",
    "SiteId": 1234567890123,
    "SiteName": "example.com",
    "Ttl": 20,
    "RecordSourceType": "OSS ",
    "RecordCname": "a.example.com.cnamezone.com",
    "Comment": "Remarks",
    "AuthConf": {
      "AuthType": "public",
      "SecretKey": "u0Nkg5gBK*******QF5wvKMM504JUHt",
      "AccessKey": "VIxuvJSA2S03f******kp208dy5w7",
      "Version": "v2",
      "Region": "us-east-1"
    },
    "HostPolicy": "follow_origin_domain"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
404	Record.NotFound	The record does not exist. Check your configurations and try again.	The record does not exist. Check your configurations and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.