DescribeUserDomains オペレーションを呼び出して、アカウントの CDN ドメインとそのステータスを照会できます。 ドメインは、名前またはステータスでフィルター処理できます。 あいまい一致がサポートされています。

CDN ドメインは、次のステータスをサポートしています。

  • 有効
  • 無効
  • 設定中
  • 設定失敗
  • 審査中
  • 審査失敗

デバッグ

API の使用を簡単にするため、Alibaba Cloud では、OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、および SDK サンプルコードの動的な生成を行うことができます。

リクエストパラメーター

パラメーター データ型 必須/省略可能 説明
Action String 必須 実行する操作です。 このパラメーターを DescribeUserDomains に設定します。
Pagesize Long 省略可能 各ページに返されるエントリの最大数です。 有効値: 1~50。 デフォルト値: 20 。
PageNumber Long 省略可能 返すページの番号です。 有効値: 1~100000。
DomainName String 省略可能 ドメイン名です。ドメイン名を照合およびフィルター処理する条件として使用されます。
DomainSearchType String 省略可能 検索方法です。 有効値:
  • fuzzy_match: あいまい一致。
  • pre_match: プレフィックス一致
  • suf_match: サフィックス一致
  • full_match: 完全一致

デフォルト値:fuzzy_match

CdnType String 省略可能 ビジネス タイプです。 複数のドメイン名を指定する場合は、カンマ (,) で区切ります。
DomainStatus String 省略可能 ドメインのステータスです。ドメイン名をフィルター処理する条件として使用されます。
ResourceGroupId String 省略可能 リソースグループの ID です。
FuncFilter String 省略可能 指定された機能の設定ステータスです。ドメイン名をフィルター処理する条件として使用されます。 有効値:
  • config: FuncId パラメーターによって指定された機能が設定されています。
  • unconfig: FuncId パラメーターによって指定された機能は、設定されていません。
FuncId String 省略可能 機能の ID です。 たとえば、不正なコンテンツのモデレーション機能の ID は 98 です。

レスポンスパラメーター

パラメーター データ型 説明
RequestId String リクエストの ID です。
PageNumber Long 返されたページの番号です。
PageSize Long 各ページで返すことができるエントリの最大数です。
TotalCount Long 返されたエントリの合計数です。
Domains Domains 返された各 CDN ドメインに関する詳細情報です。

Domains のパラメーター

パラメーター データ型 説明
DomainName String CDN ドメインの名前です。
Cname String CNAME です。
DomainStatus String CDN ドメインのステータスです。
  • online: ドメインが有効です。
  • offline: ドメインが無効です。
  • configuring: ドメインが設定中です。
  • configure_failed: ドメインの設定に失敗しました。
  • checking: ドメインの審査中です。
  • check_failed: ドメインの審査が失敗しました。
CdnType String CDN ドメインのビジネスタイプです。
  • web:画像と小さなファイルの配布を高速化します。
  • download: 大きなファイルのダウンロードを高速化します。
  • video:オンデマンドビデオとオーディオストリーミングを高速化します。
  • livestream:ライブストリーミングを高速化します。
  • httpsdelivery: HTTPS を安全に高速化します。
GmtCreated String CDN ドメインが追加された時刻です。
GmtModified String CDN ドメインが最後に変更された時刻です。
Description String 審査の失敗を引き起こす原因です。
ResourceGroupId String リソースグループの ID です。
SslProtocol String HTTPS プロトコルのステータスです。
  • on: 有効
  • off: 無効
Sources Source[] CDN ドメインのオリジン情報です。

Source のパラメーター

パラメーター データ型 説明
Type String オリジンのタイプです。
Content String オリジンのアドレスです。
Port Integer オリジンのポートです。
Priority String 複数のオリジンが指定されている場合のオリジンの優先度です。
Weight String 複数のオリジンが指定されている場合のオリジンの重みです。

リクエストの例

https://cdn.aliyuncs.com?&Action=DescribeUserDomains&PageNumber=1&PageSize=5&DomainSearchType=fuzzy_match&<Common request parameters>

成功したレスポンスの例

JSON 形式

{
   "PageNumber": 1,
   "TotalCount": 16,
   "PageSize": 5,
   "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
   "Domains": {
     "PageData": [
       {
         "CdnType": "download",
         "DomainStatus": "configure_failed",
         "DomainName": "example.com",
         "GmtModified": "2015-10-28T11:05:52Z",
         "GmtCreated": "2015-10-28T09:32:51Z",
         "Description": "audit failed",
         "ResourceGroupId":"abcd1234abcd1234"
       },
       {
         "CdnType": "web",
         "DomainStatus": "configure_failed",
         "DomainName": "aadda.cdnpe.com",
         "GmtModified": "2015-10-28T11:05:50Z",
         "GmtCreated": "2015-10-28T09:31:59Z",
         "ResourceGroupId":"abcd1234abcd1234"
       },
       {
         "Cname": "example.com.w.alikunlun.net",
         "CdnType": "video",
         "DomainStatus": "online",
         "DomainName": "example.com",
         "GmtModified": "2015-10-27T06:26:34Z",
         "GmtCreated": "2015-10-23T09:30:00Z",
         "ResourceGroupId":"abcd1234abcd1234"
       },
       {
         "Cname": "example.com.w.kunlunAr.com",
         "CdnType": "video",
         "DomainStatus": "online",
         "DomainName": "example.com",
         "GmtModified": "2015-10-23T09:23:29Z",
         "GmtCreated": "2015-10-23T09:23:20Z",
         "ResourceGroupId":"abcd1234abcd1234"
       },
       {
         "Cname": "example.com.w.alikunlun.com",
         "CdnType": "video",
         "DomainStatus": "online",
         "DomainName": "example.com",
         "GmtModified": "2015-10-23T09:02:11Z",
         "GmtCreated": "2015-10-23T09:01:57Z",
         "ResourceGroupId":"abcd1234abcd1234"
       }
     ]
   }
 }

エラーコード

エラーコード エラーメッセージ HTTP ステータスコード 説明
InvalidPageNumber.ValueNotSupported The specified value of parameter PageNumber is not supported. 400 指定された PageNumber パラメーターがサポートされていないため、エラーメッセージが返されました。
InvalidPageSize.ValueNotSupported The specified value of parameter PageSize is not supported. 400 指定された PageSize パラメーターがサポートされていないため、エラーメッセージが返されました。
InvalidDomainName.Malformed The specific value of parameter DomainName is malformed. 400 指定された DomainName パラメーターが無効のため、エラーメッセージが返されました。
InvalidDomainStatus.ValueNotSupported The specified value of parameter DomainStatus is not supported. 400 指定された DomainStatus パラメーターがサポートされていないため、エラーメッセージが返されました。
InvalidDomainSearchType.ValueNotSupported The specified value of parameter DomainSearchType is not supported. 400 指定された DomainSearchType パラメーターがサポートされていないため、エラーメッセージが返されました。