ListRecords - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

サイト配下のDNSレコードの一覧を照会します。レコード値、優先度、認証設定などの情報を含みます。レコード名やレコードタイプなどの条件によるフィルタリングをサポートしています。

操作説明

エッジコンテナ、エッジファンクション、およびレイヤー4アクセラレーションに対応するDNSレコードは、このAPIでは返されません。

今すぐお試しください

この 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:ListRecords

get

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイトID。 ListSites 操作を呼び出すことでこの値を取得できます。	1234567890123
RecordName	string	任意	レコード名。クエリのフィルター条件として使用されます。	www.example.com
RecordMatchType	string	任意	レコード名の検索マッチングモード。デフォルトは完全一致です。有効な値： prefix：前方一致。 suffix：後方一致。 exact：完全一致。 fuzzy：あいまい一致。	fuzzy
PageNumber	integer	任意	ページネーションクエリのページ番号。値は1 以上である必要があります。デフォルト値：1。	1
PageSize	integer	任意	ページネーションクエリの1ページあたりのエントリ数。有効な値：1～500。デフォルト値：500。	10
SourceType	string	任意	レコードのオリジンタイプ。クエリのフィルター条件として使用されます。このフィールドでフィルタリングできるのはCNAMEレコードのみです。有効な値： OSS：OSSオリジン。 S3：S3オリジン。 LB：ロードバランサーオリジン。 OP：オリジンプール。 Domain：標準ドメインオリジン。	OSS
BizName	string	任意	レコードアクセラレーションのビジネスシナリオ。クエリのフィルター条件として使用されます。有効な値： image_video：画像と動画。 api：API。 web：Webページ。	web
Proxied	boolean	任意	レコードのプロキシアクセラレーションが有効かどうかを指定します。クエリのフィルター条件として使用されます。有効な値： true：プロキシアクセラレーションが有効です。 false：プロキシアクセラレーションが無効です。	true
Type	string	任意	DNSレコードタイプ。クエリのフィルター条件として使用されます。	CNAME

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストID。	15C66C7B-671A-4297-9187-2C4477247A74
PageNumber	integer	現在のページ番号。PageNumberリクエストパラメータと同じ値です。	1
PageSize	integer	1ページあたりに表示されるレコード数。	10
TotalCount	integer	レコードの合計数。	20
Records	array<object>	レコードのDNS 情報。詳細については、ドキュメントを参照してください。
	array<object>	単一レコードの情報。
BizName	string	レコードアクセラレーションのビジネスシナリオ。有効な値： image_video：画像と動画。 api：API。 web：Webページ。	web
Data	object	レコードの具体的なDNS 情報。レコードタイプによって含まれる情報が異なります。	{"value":"1.1.1.1"}
Value	string	レコードの値。このパラメーターは、A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、および URI レコードに適用されます。このパラメーターの意味は、レコードタイプによって異なります： A/AAAA：ターゲット IP アドレス。A レコードには IPv4 アドレス、AAAA レコードには IPv6 アドレスを使用します。 CNAME：ターゲットドメイン名。 NS：指定されたドメインのネームサーバー。 MX：ターゲットメールサーバーのドメイン名。 TXT：テキスト文字列。 CAA：認証局のドメイン名。 SRV：ターゲットホストのドメイン名。 URI：URI 文字列。	CNAME
Priority	integer	レコードの優先度。0 から 65535 までの整数である必要があります。値が小さいほど優先度が高くなります。このパラメーターは、MX、SRV、および URI レコードにのみ適用されます。	0
Flag	integer	レコードのフラグ。CAA レコードの場合、フラグは認証局 (CA) がレコードをどのように処理するかを決定します。値の範囲は 0 から 255 です。このパラメーターは CAA レコードにのみ適用されます。	128
Tags	object		{\"Name\":\"PARAMETER\"}
Weight	integer	レコードの重み。0 から 65535 までの整数である必要があります。このパラメーターは、SRV および URI レコードにのみ適用されます。	0
Port	integer	ポート番号。0 から 65535 までの整数である必要があります。このパラメーターは SRV レコードにのみ適用されます。	80
Type	integer	CERT レコードの証明書タイプ、または SSHFP レコードの公開鍵タイプ。	0
KeyTag	integer	公開鍵識別子。値の範囲は 0 から 65535 です。このパラメーターは CERT レコードにのみ有効です。	0
Algorithm	integer	レコードの暗号化アルゴリズム。値の範囲は 0 から 255 です。このパラメーターは CERT および SSHFP レコードにのみ有効です。	0
Certificate	string	公開鍵証明書。このパラメーターは CERT、SMIMEA、および TLSA レコードにのみ有効です。	dGVzdGFkYWxrcw==
Usage	integer	使用量識別子。値の範囲は 0 から 255 です。このパラメーターは SMIMEA および TLSA レコードにのみ有効です。	0
Selector	integer	レコードの証明書または公開鍵のタイプ。値の範囲は 0 から 255 です。このパラメーターは SMIMEA および TLSA レコードにのみ有効です。	0
MatchingType	integer	証明書を照合または検証するためのアルゴリズムポリシー。値の範囲は 0 から 255 です。このパラメーターは SMIMEA および TLSA レコードにのみ有効です。	0
Fingerprint	string	公開鍵の指紋。このパラメーターは SSHFP レコードにのみ有効です。	abcdef1234567890
Tag	string	レコードのタグ。CAA レコードの場合、タグはその特定のタイプと目的を示します。このパラメーターは CAA レコードにのみ有効です。	issue
CreateTime	string	レコードの作成時刻。日付形式はISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式のUTC 時刻を使用します。	2023-12-24T02:01:11Z
UpdateTime	string	レコードの更新時刻。日付形式はISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式のUTC 時刻を使用します。	2023-06-07T10:02:59Z
Proxied	boolean	レコードのプロキシアクセラレーションが有効かどうかを示します。有効な値： true：プロキシが有効。 false：プロキシアクセラレーションが無効。	true
RecordId	integer	レコードID。	1234567890123
RecordSourceType	string	CNAMEレコードのオリジンタイプ。CNAMEレコードを追加する際に必須のパラメータです。有効な値： OSS：OSSオリジン。 S3：S3オリジン。 LB：ロードバランサーオリジン。 OP：オリジンプール。 Domain：標準ドメインオリジン。このパラメータが指定されていないか空の場合、デフォルト値はDomainで、標準ドメインオリジンタイプを示します。	OSS
RecordName	string	レコード名。	a.example.com
RecordType	string	レコードのDNSタイプ。A/AAAA、CNAME、TXTなど。	A/AAAA
SiteId	integer	レコードが属するサイトのID。	1234567890123
SiteName	string	レコードが属するサイトの名前。	example.com
Ttl	integer	レコードのTTL（Time to Live）。秒単位です。値が1の場合、TTLが自動に設定されていることを示します。	30
RecordCname	string	レコードのCNAME。サイトのアクセス方法がCNAMEアクセスの場合に、レコードに設定する必要があるCNAME 値です。	a.example.com.cnamezone.com
Comment	string	レコードのコメント。	this is a remark.
AuthConf	object	CNAMEレコードのオリジン認証情報。
AuthType	string	オリジン認証タイプ。利用可能な認証タイプは、`RecordSourceType` パラメーターで指定されるオリジンタイプによって異なります。オリジンタイプが OSS または S3 の場合、このパラメーターは必須です。有効値： public：パブリック読み取り。オリジンタイプが OSS または S3 で、オリジンサーバーがパブリック読み取りアクセスを許可する場合にこの値を使用します。 private：プライベート読み取り。オリジンタイプが S3 で、オリジンサーバーがプライベート読み取りアクセスを必要とする場合にこの値を使用します。 private_same_account：同一アカウント内でのプライベート読み取り。オリジンタイプが OSS で、オリジンサーバーが同じ Alibaba Cloud アカウント内にあり、プライベート読み取りアクセスが必要な場合にこの値を使用します。 private_cross_account：異なるアカウント間でのプライベート読み取り。オリジンタイプが OSS で、オリジンサーバーが異なる Alibaba Cloud アカウント内にあり、プライベート読み取りアクセスが必要な場合にこの値を使用します。	private
AccessKey	string	オリジンサーバーを所有するアカウントの AccessKey。オリジンタイプが OSS で認証タイプが `private_cross_account` の場合、またはオリジンタイプが S3 で認証タイプが `private` の場合に必須です。	u0Nkg5gBK***QF5wvKMM504JUHt
SecretKey	string	オリジンサーバーを所有するアカウントの SecretKey。オリジンタイプが OSS で認証タイプが `private_cross_account` の場合、またはオリジンタイプが S3 で認証タイプが `private` の場合に必須です。	VIxuvJSA2S03f***kp208dy5w7
Version	string	署名アルゴリズムのバージョン。オリジンタイプが S3 で認証タイプが `private` の場合に必須です。有効値： v2 v4 デフォルトは `v4` です。	v4
Region	string	オリジンサーバーが配置されているリージョン。オリジンタイプが S3 の場合に必須です。有効なリージョン名については、S3 の公式ドキュメントをご参照ください。	us-east-1
HostPolicy	string	オリジンホストポリシー。レコードタイプがCNAMEの場合に有効になります。オリジンリクエスト時に使用するホストヘッダーのポリシーを設定します。2つのモードが利用可能です： follow_hostname：リクエストホストに従う。 follow_origin_domain：オリジンドメインに従う。	follow_origin_domain

例

成功レスポンス

JSONJSON

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "Records": [
    {
      "BizName": "web",
      "Data": {
        "Value": "CNAME",
        "Priority": 0,
        "Flag": 128,
        "Tags": {
          "test": "test",
          "test2": 1
        },
        "Weight": 0,
        "Port": 80,
        "Type": 0,
        "KeyTag": 0,
        "Algorithm": 0,
        "Certificate": "dGVzdGFkYWxrcw==",
        "Usage": 0,
        "Selector": 0,
        "MatchingType": 0,
        "Fingerprint": "abcdef1234567890",
        "Tag": "issue"
      },
      "CreateTime": "2023-12-24T02:01:11Z",
      "UpdateTime": "2023-06-07T10:02:59Z",
      "Proxied": true,
      "RecordId": 1234567890123,
      "RecordSourceType": "OSS",
      "RecordName": "a.example.com",
      "RecordType": "A/AAAA",
      "SiteId": 1234567890123,
      "SiteName": "example.com",
      "Ttl": 30,
      "RecordCname": "a.example.com.cnamezone.com",
      "Comment": "this is a remark.",
      "AuthConf": {
        "AuthType": "private",
        "AccessKey": "u0Nkg5gBK***QF5wvKMM504JUHt",
        "SecretKey": "VIxuvJSA2S03f***kp208dy5w7",
        "Version": "v4",
        "Region": "us-east-1"
      },
      "HostPolicy": "follow_origin_domain"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InternalException	Failed to call the service. Try again later or contact technical support.

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

変更履歴

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