DescribeVodUserDomains - - Alibaba Cloud ドキュメントセンター

Alibaba Cloud アカウント内の CDN のドメイン名を照会します。

操作説明

ドメイン名とステータスでドメイン名をフィルターできます。ドメイン名ベースのクエリでは、あいまい一致がサポートされています。
この操作は、中国 (上海) リージョンでのみ利用可能です。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:DescribeVodUserDomains

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageSize	integer	任意	ページあたりのエントリ数。デフォルト値：20。最大値：50。有効な値の範囲：1～50。	20
PageNumber	integer	任意	ページ番号。	1
DomainName	string	任意	ドメイン名。このパラメーターの値は、あいまい一致のフィルター条件として使用されます。	example.aliyundoc.com
DomainStatus	string	任意	ドメイン名のステータス。有効な値： online：ドメイン名が有効であることを示します。 offline：ドメイン名が無効であることを示します。 configuring：ドメイン名が設定中であることを示します。 configure_failed：ドメイン名の設定に失敗したことを示します。 checking：ドメイン名がレビュー中であることを示します。 check_failed：ドメイン名のレビューに失敗したことを示します。	online
DomainSearchType	string	任意	検索方法。有効な値： fuzzy_match (デフォルト)：あいまい一致。 pre_match：プレフィックス一致。 suf_match：サフィックス一致。 full_match：完全一致。	fuzzy_match
Tag	array<object>	任意	タグ。
	object	任意	タグのオブジェクト。
Key	string	任意	タグ N のキー。N の有効な値の範囲：1～20。デフォルトでは、すべてのタグキーが照会されます。	key
Value	string	任意	タグ N の値。N の有効な値の範囲：1～20。デフォルトでは、すべてのタグ値が照会されます。	value

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果。
RequestId	string	リクエスト ID。	E4EBD2BF-5EB0-4476-****-9D94E1B15267
PageNumber	integer	ページ番号。	1
PageSize	integer	ページあたりのエントリ数。	20
TotalCount	integer	エントリの総数。	2
Domains	object
PageData	array<object>	各 CDN ドメイン名の詳細情報。返される情報は、PageData パラメーターで指定された形式で表示されます。
	array<object>	返されたデータ。
GmtCreated	string	CDN ドメイン名が追加された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。	2017-08-29T08:40:53Z
SslProtocol	string	HTTPS が有効になっているかどうかを示します。 on：HTTPS は有効です。 off：HTTPS は有効ではありません。	on
Description	string	備考。	Zhejiang ICP Filing No. ****
Sandbox	string	CDN ドメイン名がサンドボックスにあったかどうかを示します。	normal
Cname	string	CDN ドメイン名に割り当てられた CNAME。	learn.developer.aliyundoc.com
DomainStatus	string	CDN ドメイン名のステータス。有効な値： online：ドメイン名が有効であることを示します。 offline：ドメイン名が無効であることを示します。 configuring：ドメイン名が設定中であることを示します。 configure_failed：ドメイン名の設定に失敗したことを示します。 checking：ドメイン名がレビュー中であることを示します。 check_failed：ドメイン名のレビューに失敗したことを示します。	online
GmtModified	string	CDN ドメイン名が最後に変更された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。	2017-12-29T09:24:12Z
DomainName	string	CDN ドメイン名。	example.aliyundoc.com
Sources	object
Source	array<object>	オリジンサーバーに関する情報。
	object	オリジンサーバーに関する情報。
Type	string	オリジンサーバーのタイプ。有効な値： ipaddr：IP アドレス。 domain：オリジンドメイン名。 oss：Object Storage Service (OSS) バケットの OSS ドメイン。	oss
Priority	string	オリジンサーバーの優先度。	5
Port	integer	ポート番号。有効な値：443 および 80。	80
Content	string	オリジンサーバーのアドレス。	192.168.0.1

例

成功レスポンス

JSONJSON

{
  "RequestId": "E4EBD2BF-5EB0-4476-****-9D94E1B15267",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2017-08-29T08:40:53Z",
        "SslProtocol": "on",
        "Description": "Zhejiang ICP Filing No. ****",
        "Sandbox": "normal",
        "Cname": "learn.developer.aliyundoc.com",
        "DomainStatus": "online",
        "GmtModified": "2017-12-29T09:24:12Z",
        "DomainName": "example.aliyundoc.com",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Priority": "5",
              "Port": 80,
              "Content": "192.168.0.1"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.

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

変更履歴

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