CreateRecord API で DNS レコードを作成 - ESA - Alibaba Cloud - Edge Security Acceleration

サイト配下に DNS レコードを作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:CreateRecord

create

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。 ListSites API を呼び出して取得できます。	1234567890123
RecordName	string	必須	Record 名。	www.example.com
Proxied	boolean	任意	Record のプロキシアクセラレーションを有効にするかどうかを指定します。CNAME レコードまたは A/AAAA レコード (type パラメーターが A/AAAA または CNAME にセットされている場合) のみプロキシアクセラレーションを有効にできます。有効な値: true: プロキシアクセラレーションを有効にします。 false: プロキシアクセラレーションを無効にします。	true
Type	string	必須	Record の DNS タイプ。A/AAAA、CNAME、TXT などです。	A/AAAA
SourceType	string	任意	CNAME レコードのオリジンタイプ。CNAME レコードを追加する場合 (type パラメーターが CNAME にセットされている場合) に必須です。有効な値: OSS: OSS オリジン。 S3: S3 オリジン。 LB: ロードバランサーオリジン。 OP: オリジンプールオリジン。 Domain: 標準ドメインオリジン。このパラメーターが指定されていないか空の場合、デフォルトは Domain (標準ドメインオリジンタイプ) になります。	OSS
BizName	string	任意	DNS レコードのビジネスシナリオをタグ付けするために使用します。DNS レコードのプロキシアクセラレーションが有効な場合 (proxied パラメーターが true にセットされている場合) に必須であり、プロキシアクセラレーションが無効な場合 (proxied パラメーターが false にセットされている場合) は不要です。有効な値: image_video: イメージと動画。 api: API。 web: Web ページ。	web
Ttl	integer	必須	Record の TTL (Time-To-Live)。単位: 秒。1 にセットすると、TTL は自動になります。	30
Data	object	必須	Record の DNS 情報。Record タイプによって、このフィールドに必要な内容が異なります。詳細については、ドキュメントを参照してください。	{ "value":"2.2.2.2" }
Value	string	任意	Record の値または部分的な内容。RecordType が A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、または URI の場合に必須です。RecordType によって異なる意味を表します: A/AAAA: ポイント先の IP アドレス。複数の IP はカンマ (,) で区切ります。少なくとも 1 つの IPv4 アドレスが必要です。 CNAME: ポイント先のターゲットドメイン名。 NS: 指定されたドメインのネームサーバー。 MX: 有効なターゲットメールサーバーのドメイン名。 TXT: 有効なテキスト文字列。 CAA: 有効な認証局のドメイン名。 SRV: 有効なターゲットホストのドメイン名。 URI: 有効な URI 文字列。	example.com
Priority	integer	任意	Record の優先度。有効値は 0～65535 です。値が小さいほど優先度が高くなります。MX、SRV、または URI Record を追加する場合に必須のパラメーターです。	10
Flag	integer	任意	Record のフラグ。CAA Record の Flag は優先度と処理メソッドを示し、有効値は 0～255 です。CAA Record を追加する場合に必須のパラメーターです。	128
Tag	string	任意	Record のタグ。CAA Record の Tag は具体的なタイプと用途を示します。CAA Record を追加する場合に必須のパラメーターです。Tag の有効な値: issue: 特定の CA にドメインの証明書を発行する権限を付与します。通常、CA のドメイン名がフォローします。 issuewild: 特定の CA にドメインのワイルドカード証明書 (例: .example.com) を発行する権限を付与します。 iodef*: CAA Record の違反に関するレポートを受信するための URI を指定します。	issue
Weight	integer	任意	Record の重み。有効値は 0～65535 です。SRV または URI Record を追加する場合に必須のパラメーターです。	0
Port	integer	任意	Record のポート。有効値は 0～65535 です。SRV レコードを追加する場合に必須のパラメーターです。	0
Type	integer	任意	Record の証明書タイプ (CERT Record の場合) または公開鍵タイプ (SSHFP Record の場合)。CERT または SSHFP Record を追加する場合に必須のパラメーターです。	0
KeyTag	integer	任意	Record の公開鍵識別子。有効値は 0～65535 です。CERT Record を追加する場合に必須のパラメーターです。	0
Algorithm	integer	任意	Record で使用される暗号化アルゴリズム。有効値は 0～255 です。CERT または SSHFP Record を追加する場合に必須のフィールドです。	1
Certificate	string	任意	Record の公開鍵証明書情報。CERT、SMIMEA、または TLSA Record を追加する場合に必須のパラメーターです。	dGVzdGFkYWxrcw==
Usage	integer	任意	Record の使用量識別子。有効値は 0～255 です。SMIMEA または TLSA Record を追加する場合に必須のパラメーターです。	1
Selector	integer	任意	Record で使用される証明書または公開鍵のタイプ。有効値は 0～255 です。SMIMEA または TLSA Record を追加する場合に必須のパラメーターです。	1
MatchingType	integer	任意	Record が証明書の照合または検証に使用するアルゴリズムポリシー。有効値は 0～255 です。SMIMEA または TLSA Record を追加する場合に必須のパラメーターです。	1
Fingerprint	string	任意	Record の公開鍵の指紋値。SSHFP Record を追加する場合に必須のパラメーターです。	abcdef1234567890
Comment	string	任意	Record のコメント。最大値は 100 文字です。	This is a remark.
AuthConf	object	任意	CNAME レコードのオリジン認証情報。
AuthType	string	任意	オリジン認証タイプ。オリジンタイプによってサポートされる認証タイプが異なります。オリジンタイプはこの API の SourceType パラメーターを指します。オリジンタイプが OSS または S3 の場合、オリジン認証タイプを指定する必要があります。有効な値: public: パブリック読み取り。オリジンタイプが OSS または S3 で、オリジンがパブリック読み取りアクセスを持つ場合にこの値を選択します。 private: 非公開読み取り。オリジンタイプが S3 で、オリジンが非公開読み取りアクセスを持つ場合にこの値を選択します。 private_same_account: 非公開同一アカウント読み取り。オリジンタイプが OSS で、オリジンが同じ Alibaba Cloud アカウント配下にあり、オリジンが非公開読み取りアクセスを持つ場合にこの値を選択します。 private_cross_account: 非公開クロスアカウント読み取り。オリジンタイプが OSS で、オリジンが同じ Alibaba Cloud アカウント配下にない場合で、オリジンが非公開読み取りアクセスを持つ場合にこの値を選択します。	private
AccessKey	string	任意	オリジンを所有するアカウントの AccessKey。オリジンタイプが OSS で認証タイプが非公開クロスアカウント読み取りの場合、またはオリジンタイプが S3 で認証タイプが非公開読み取りの場合にこの値が必須です。	u0Nkg5gBK*******QF5wvKMM504JUHt
SecretKey	string	任意	オリジンを所有するアカウントの SecretKey。オリジンタイプが OSS で認証タイプが非公開クロスアカウント読み取りの場合、またはオリジンタイプが S3 で認証タイプが非公開読み取りの場合にこの値が必須です。	VIxuvJSA2S03f******kp208dy5w7
Version	string	任意	署名アルゴリズムのバージョン。オリジンタイプが S3 で認証タイプが非公開読み取りの場合に必須です。以下の 2 つのバージョンがサポートされています: v2 v4 指定しない場合、デフォルト値は v4 です。	v4
Region	string	任意	オリジンが配置されているリージョン。オリジンタイプが S3 の場合にこの値が必須です。リージョン情報は S3 の公式 Web サイトから取得できます。	us-east-1
HostPolicy	string	任意	back-to-origin ホストポリシー。RecordType が CNAME の場合に効果があります。back-to-origin リクエストのホストポリシーを指定します。2 つのモードが利用可能です: follow_hostname: リクエストホストをフォローします。 follow_origin_domain: オリジンドメインをフォローします。	follow_origin_domain

Record の Data セクション。Record の DNS 情報を含みます。Record タイプによって、このフィールドに必要な内容が異なります。詳細については、ドキュメントを参照してください。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	F61CDR30-E83C-4FDA-BF73-9A94CDD44229
RecordId	integer	作成された Record の ID。	1234567890123

例

成功レスポンス

JSONJSON

{
  "RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
  "RecordId": 1234567890123
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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	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.
400	Record.NoResource	Failed to allocate resources for the record. Please submit a ticket for processing.
400	InvalidParameter.InvalidBiz	The incoming parameter value of the business type is empty or incorrect.
400	Record.RecordValueContainSourceInBlacklist	The record value contains the blacklist address, and the details can be submitted for work order consultation.
400	InvalidParameter.InvalidRecordNameSuffix	If you add other records, the suffix of the host record must be the same as the site name.
400	InvalidParameter.RecordNameExceedLimit	The length of the record name exceeds the maximum limit.
400	InvalidParameter.InvalidHostPolicy	The host parameter in the origin fetch request is invalid.
400	InvalidParameter.CnameSiteRecordUnsupport	The current record type is not supported for a website connected by CNAME setup.
400	InvalidParameter.RecordCommentExceedLimit	The number of incoming record comment exceeds the maximum limit.
400	Record.AorAAAARecordValueContainInvalidIP	The A/AAAA record value contains the invalid IP.
400	Record.AorAAAARecordValueIPExceedLimit	The number of IP addresses exceeds the limit for the A/AAAA record.
400	Record.CAARecordFlagExceedLimit	The value of the flag parameter for a CAA record is out of range.
400	Record.CAARecordTagExceedLimit	The CAA record tag has illegal characters other than issue, issuewild, and iodef.
400	Record.CERTRecordAlgorithmExceedLimit	The value of the algorithm parameter for the CERT record is out of range.
400	Record.CERTRecordKeyTagExceedLimit	The value of the keyTag parameter for a CERT record is out of range.
400	Record.CERTRecordTypeExceedLimit	The CERT record type is out of range.
400	Record.CNameRecordValueCannotEqualExistedIPASource	The CNAME record cannot be the origin of the added Layer 4 application. Check the values of other Layer 4 proxy records and try again.
400	Record.CNameRecordValueCannotEqualExistedPoolSource	The CNAME record cannot be the origin of the added source address pool. Check and try again.
400	Record.CNameRecordValueCannotEqualExistedRecordSource	The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.
400	Record.CNameRecordValueCannotEqualOtherExistedIPARecord	The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.
400	Record.CNameRecordValueCannotEqualOtherExistedRecord	The record value of a CNAME record cannot be the same as the name of another existing CNAME record.
400	Record.CNameRecordValueCannotEqualHostRecord	The record value of the CNAME record cannot be exactly the same as the host record.
400	Record.CNameRecordValueExceedLimit	The CNAME record value cannot exceed 253 characters, please delete and try again.
400	Record.CNameRecordValueInvalidDomainUnderline	Record values (DNS-only records) generally start with an underscore, a lowercase letter a-z, and the numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.
400	Record.CNameRecordValueInvalidRecordDomain	Record values (records with agent acceleration enabled) must start with a lowercase letter a-z and numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.
400	Record.EmptyRecordValue	The record value is empty, please fill it in correctly and try again.
400	Record.InvalidCertEncodeWithCERTRecord	The certificate value of the CERT record is not base64-encoded.
400	Record.InvalidFingerprintWithSSHFPRecord	The SSHFP record fingerprint value is not hexadecimal encoded.
400	Record.InvalidIssueDataWithCAARecordTag	The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.
400	Record.InvalidMailAddressWithCAARecordTag	The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.
400	Record.InvalidSmimeaEncodeWithSMIMEARecord	The certificate value of the SMIMEA record is not base64-encoded.
400	Record.InvalidTslaEncodeWithTSLARecord	The certificate value passed in is not hexadecimal encoded with TSLA record.
400	Record.InvalidURLWithURIRecord	The URI record value must be a valid URL address.
400	Record.NoRecordNameConflictWithNSRecord	No record name can conflict with an NS record name.
400	Record.NSRecordCannotEqualSiteName	An NS record with the exact same name as the site name is not allowed.
400	Record.OSSSourceInvalidAuthType	The recorded OSS origin station authentication type is not supported.
400	Record.ParseJSONRecordValueFailed	The JSON data format of the record data is incorrect. Please adjust and try again.
400	Record.PoolSourceNotExistPool	If the source station type of the record is source address pool, the input source address pool does not exist.
400	Record.RecordNameConflictForSpecifiedRecordType	The A/AAAA and CNAME records cannot have the same name.
400	Record.RecordNameConflictWithIPAName	The record name cannot have the same name as the Layer 4 proxy record.
400	Record.RecordNameConflictWithLBName	The record name cannot be the same as the Server Load Balancer record name.
400	Record.RecordNameConflictWithNSRecord	The NS record name cannot be the same as any other type of record name.
400	Record.RecordNameConflictWithPoolName	The record name cannot be the same as the source address pool record name.
400	Record.RecordNameInBlacklist	The record name is in blacklist.
400	Record.S3SourceInvalidAuthRegion	The recorded S3 origin belongs to a region that is not in the supported range.
400	Record.S3SourceInvalidAuthType	The recorded S3 origin authentication type is not supported.
400	Record.S3SourceInvalidAuthVersion	The version of the authentication signature algorithm of the S3 origin is not supported.
400	Record.SourceAccessKeyExceedLimit	The character length of the AccessKey parameter value for the record source station is out of range.
400	Record.SourceEmptyAK	The AccessKey of the account to which the origin site belongs is empty.
400	Record.SourceEmptyAuthConf	The authentication information of the origin station is empty.
400	Record.SourceEmptySecretKey	The SecretKey of the account to which the recorded origin site belongs is empty.
400	Record.SourceSecretKeyExceedLimit	The character length of the SecretKey parameter value for the record source station is out of range.
400	Record.SRVRecordInvalidRecordName	SRV host record name is not valid. The SRV host record name must begin with an underscore (-) followed by a lowercase letter (a-z), a number (0-9), and a hyphen (-), followed by 1 arbitrary character, followed by an underscore (-) and a lowercase letter, number, or hyphen.
400	Record.SRVRecordPortExceedLimit	The SRV record port is out of range.
400	Record.SSHFPRecordAlgorithmExceedLimit	The algorithm parameter value for the SSHFP record is out of range.
400	Record.TTLExceedLimit	The TTL parameter value for a record is out of range.
400	Record.TXTRecordValueExceedLimit	The TXT record value cannot exceed 450 characters.
400	Record.TypeExceedLimitWithSSHFPRecord	The SSHFP record Type parameter value is out of range.
400	Record.UnmatchedRecordNameContainDoubleConsecutiveDot	Illegal host record name. The host record cannot contain consecutive dot.
400	Record.UnmatchedRecordNameForbidStarSev	Illegal host record name, SRV record name disallowed asterisk.
400	Record.UnmatchedRecordNameInvalidATChar	Illegal host record name. The at symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.
400	Record.UnmatchedRecordNameInvalidNamePrefixSuffix	Illegal host record name. Host record values cannot start or end with a dot, a hyphens.
400	Record.UnmatchedRecordNameInvalidStartSymbol	Illegal host record name. The asterisk is only allowed in the first place of the host record, and only the following dot is allowed after the asterisk.
400	Record.UnmatchedRecordNameSeperateStringTooLarge	Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.
400	Record.UnsupportedSourceType	The recorded source station type is not in the supported range.
400	Record.UnsupportedType	The record type parameter is unsupported.
400	Record.ValidProxiedForSpecifedRecordType	Only A/AAAA and CNAME types support proxy acceleration.
400	Record.RecordUsageExceedLimit	The usage parameter value filled in is out of range.
400	Record.RecordSelectorExceedLimit	The selector parameter value filled in is out of range.
400	Record.RecordMatchingTypeExceedLimit	The matchingType parameter value filled in is out of range.
400	Record.RecordPriorityExceedLimit	The record priority parameter value filled in is out of range.
400	Record.RecordWeightExceedLimit	The record weight parameter value filled in is out of range.
400	Record.RecordNameConflictWithSameRecordType	Record conflicts with an existing host record that has the same name and value.
400	Record.UnmatchedRecordNameInvalidUnderLine	The host record name contains an illegal underscore. The underscore is only supported at the beginning of the TXT, CNAME, MX, SRV, and NS records. Proxy acceleration cannot be enabled, and records can only be added in the DNS mode.
400	InvalidParameter.InvalidDSRecordName	Please add/import an NS record with the same name before adding this DS record.
400	InvalidParameter.CnameSiteRecordNoProxied	A non-proxied record was added for a website using a CNAME setup.
400	Record.InvalidIodefDataWithCAARecordTag	The CAA record Tag value cannot start with mailto: or http:// or https.
400	Record.WildcardConflictForSpecifiedRecordType	The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.
400	Record.UnmatchedRecordNameOnlyContainSymbol	The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.
400	SameNameRecordExceedLimit	The number of records with the same name exceeds the upper limit.
400	InvalidParameter.PrivateIpAsSourceUnsupported	The provided source is an invalid private IP address. Please verify and resubmit.
400	InvalidParameter.SourceIpInBlacklist	The provided source is an invalid private IP address. Please verify and resubmit.
400	Record.InvalidHTTPURLValueWithCAARecordTag	The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.
400	Record.UnmatchedRecordNameOnlyRangeChars	Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, some special characters are supported as valid characters in host records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。