在站点下创建一条DNS解析记录。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
esa:CreateRecord | create | *Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SiteId | long | 是 | 站点 ID,可通过调用 ListSites 接口获取。 | 1234567890123 |
RecordName | string | 是 | 记录名称。 | www.example.com |
Proxied | boolean | 否 | 记录是否开启代理加速。只有 CNAME 记录与 A/AAAA 记录可以开启代理加速。取值:
| true |
Type | string | 是 | 记录的 DNS 类型。例如A/AAAA、CNAME、TXT 等。 | A/AAAA |
SourceType | string | 否 | CNAME 记录的源站类型。添加 CNAME 记录时,需要填写此参数。取值:
该参数不传或传空时,则默认为 Domain,即普通域名源站类型。 | OSS |
BizName | string | 否 | 记录加速时的业务场景,不开启加速的记录不需要传,取值:
| web |
Ttl | integer | 否 | 记录的过期时间,单位秒。当取值为 1 时,表示记录的过期时间为自动。 | 30 |
Data | object | 是 | 记录的 DNS 信息。不同类型的记录,该字段需要传的内容也不同,请参考 说明文档 。 | |
Value | string | 否 | 记录值或部分内容。添加 A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI 记录时,该参数必填。在不同类型的记录中,分别表示不同的含义:
| example.com |
Priority | integer | 否 | 记录的优先级,范围为0~65535。数值越小,优先级越高。添加 MX、SRV、URI 记录时,该参数必填。 | 10 |
Flag | integer | 否 | 记录的标志位。CAA 记录的 Flag 指示其优先级和处理方式,取值范围为0~255。添加 CAA 记录时,该参数必填。 | 128 |
Tag | string | 否 | 记录的标签。CAA 记录的 Tag 表示其具体类型和用途。添加 CAA 记录时,该参数必填。Tag 取值:
| issue |
Weight | integer | 否 | 记录的权重,范围为0~65535。添加 SRV、URI 记录时,该参数必填。 | 0 |
Port | integer | 否 | 记录的端口,范围为0~65535。添加 SRV 记录时,该参数必填。 | 0 |
Type | integer | 否 | 记录的证书类型(在 CERT 记录中),或公钥类型(在 SSHFP 记录中)。添加 CERT、SSHFP 记录时,该参数必填。 | RSA |
KeyTag | integer | 否 | 记录的公钥标识,范围为0~65535。添加 CERT 记录时,该参数必填。 | 0 |
Algorithm | integer | 否 | 记录所采用的加密算法,范围为0~255。添加 CERT、SSHFP 记录时,该字段必填。 | 1 |
Certificate | string | 否 | 记录的公钥证书信息。添加 CERT、SMIMEA 和 TLSA 记录时,该参数必填。 | dGVzdGFkYWxrcw== |
Usage | integer | 否 | 记录的用途标识,范围为0~255。添加 SMIMEA 和 TLSA 时,该参数必填。 | 1 |
Selector | integer | 否 | 记录所使用的证书或公钥的类型,范围为0~255。添加 SMIMEA 和 TLSA 时,该参数必填。 | 1 |
MatchingType | integer | 否 | 记录用于匹配或验证证书的算法策略,范围为0~255。添加 SMIMEA 和 TLSA 记录时,该参数必填。 | 1 |
Fingerprint | string | 否 | 记录的公钥指纹值。添加 SSHFP 记录时,该参数必填。 | abcdef1234567890 |
Comment | string | 否 | 记录的备注信息,最大长度为 100 字符。 | This is a remark. |
AuthConf | object | 否 | CNAME 记录的源站鉴权信息。 | |
AuthType | string | 否 | 源站鉴权类型,不同的源站类型,支持的鉴权类型不同,源站类型是指本接口中的 SourceType 参数,现在源站类型为 OSS 和 S3 时,需要填写源站鉴权类型,可选值:
| private |
AccessKey | string | 否 | 源站所属账号的 AccessKey,当源站类型为 OSS 且源站鉴权类型为私有跨账号读,或者源站类型为 S3 且源站鉴权类型为私有读时,需要填写此值。 | u0Nkg5gBK*******QF5wvKMM504JUHt |
SecretKey | string | 否 | 源站所属账号的 SecretKey,当源站类型为 OSS 且源站鉴权类型为私有跨账号读,或者源站类型为 S3 且源站鉴权类型为私有读时,需要填写此值。 | VIxuvJSA2S03f******kp208dy5w7 |
Version | string | 否 | 签名算法版本,当源站类型为 S3 且源站鉴权类型为私有读时需要,支持以下两种:
不传时,默认为 v4。 | v4 |
Region | string | 否 | 源站所属区域,当源站类型为 S3 时,需要填写此值,源站所属的区域需要在 S3 的官方网站上获取。 | us-east-1 |
HostPolicy | string | 否 | 回源 HOST 策略,记录类型为 CNAME 时生效,设置回源时带 HOST 的策略,有两种模式:
| follow_origin_domain |
记录的 Data 部分,包括记录的 DNS 信息。不同类型的记录,该字段需要传的内容也不同。详细说明请参考 说明文档 。
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
"RecordId": 1234567890123
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 输入参数规范校验失败。 |
400 | InvalidParameter.InvalidRecordName | The record name you entered does not meet the specifications. Change the record name according to the product documentation. | 您输入的记录名称不符合规范,请根据产品文档调整记录名称。 |
400 | ServiceInvokeFailed | The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
400 | InvalidParameter.RecordData | Invalid record content. Adjust your configurations based on the API documentation. | 记录内容参数错误,请根据接口文档调整参数内容。 |
400 | InvalidParameter.RecordType | Invalid record type. Adjust your configurations based on the API documentation. | 记录类型错误,请根据接口文档调整参数内容。 |
400 | Instance.NotOnline | Your plan is unavailable due to an overdue payment. Complete the payment first. | 您的套餐实例因欠费当前处于非上线状态,请先完成续费操作以继续使用。 |
400 | QuotaExceed.RecordCount | The maximum number of records has been reached. Delete some and try again or upgrade your plan. | 记录数量已达上限,请删除部分记录后重试或升级套餐。 |
400 | Record.Conflict | The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation. | 和已有记录冲突,请根据冲突规则的产品文档调整记录内容。 |
400 | Site.ServiceBusy | This website is being configured. Try again later. | 该站点正在配置中,请稍后再试。 |
400 | SourceCircleExist | The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry. | 当前要操作资源的主机记录已经是其他资源的源站,或者当前资源的源站已经被添加为主机记录,为避免回环产生,请修改主机记录或者源站后进行重试。 |
400 | QuotaExceed.WildCardRecord | The maximum number of wildcard records has been reached. Delete some and try again. | 泛域名记录数量已达上限,请删除部分泛域名记录后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-05 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-10-10 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-24 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |