すべてのプロダクト
Search
ドキュメントセンター

Edge Security Acceleration:GetCustomHostname

最終更新日:Jun 24, 2026

単一の SaaS ドメイン名の詳細な構成を取得します。ドメイン検証の TXT 名、ドメイン検証の TXT コンテンツ、証明書の有効期限の時間(SSL が有効な場合)が含まれます。

今すぐお試しください

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

HostnameId

integer

必須

SaaS ドメイン名の ID。この値は ListCustomHostnames 操作を呼び出して取得できます。

1234567890123

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。Alibaba Cloud がこのリクエストに対して生成した一意の識別子です。

7C414690-9D7B-5D66-9CD9-AD0B3F25ED49

CustomHostnameModel

object

照会された SaaS ドメイン名の情報。フォーマットはオブジェクトです。

HostnameId

integer

SaaS ドメイン名の ID。

1234567890123

Hostname

string

SaaS ドメイン名。

custom.site.com

SiteId

integer

サイト ID。

890601022130656

SiteName

string

サイト名。

example.com

RecordId

integer

Record ID。

4042843419650112

RecordName

string

Record 名。

origin.example.com

Status

string

SaaS ドメイン名のステータス。有効な値:

  • pending: 検証待ち。

  • active: アクティブな状態。

  • conflicted: 占有済み。

  • offline: オフライン。

  • configuring: 構成中。

列挙値:

  • conflicted :

    占有済み。

  • offline :

    オフライン。

  • configuring :

    構成中。

  • pending :

    検証待ち。

  • active :

    アクティブ。

active

VerifyHost

string

ドメイン検証の TXT 名。

_esa_custom_hostname.custom.site.com

VerifyCode

string

ドメイン検証の TXT コンテンツ。

verify_16ab7f4d389d4dff6655f995c6a997bd

SslFlag

string

SSL スイッチ。有効な値:

  • on: SSL が有効。

  • off: SSL が無効。

列挙値:

  • off :

    SSL が無効。

  • on :

    SSL が有効。

on

CertType

string

証明書のタイプ。有効な値:

  • free: 無料証明書。

  • upload: アップロード済み証明書。

  • cas: SSL 証明書サービス証明書。

列挙値:

  • cas :

    SSL 証明書サービス証明書。

  • upload :

    アップロード済み証明書。

  • free :

    無料証明書。

free

CasId

integer

SSL 証明書サービス証明書の ID。

30000478

CertId

string

証明書の ID。

baba2c9e90e840b3b55698cedf02b308

Certificate

string

証明書のコンテンツ。

-----BEGIN CERTIFICATE-----

CertStatus

string

証明書のステータス。有効な値:

  • OK: 法線。

  • Applying: 申請中。

  • ApplyFailed: アプリケーションが失敗した。

  • Expiring: まもなく有効期限切れ。

  • Expired: 期限切れ。

列挙値:

  • Expiring :

    まもなく有効期限切れ。

  • ApplyFailed :

    アプリケーションが失敗した。

  • Expired :

    期限切れ。

  • Applying :

    申請中。

  • OK :

    法線。

OK

CertTxtKey

string

証明書検証の TXT 名。

_acme-challenge.custom.site.com

CertTxtValue

string

証明書検証の TXT コンテンツ。

lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM

CertHttpKey

string

証明書検証の HTTP アドレス。

http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc

CertHttpValue

string

証明書検証の HTTP コンテンツ。

jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0

CertNotAfter

string

証明書の有効期限の時間。ISO 8601 フォーマットで協定世界時 (UTC) を使用します。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。

2026-04-19T11:15:20Z

CertApplyMessage

string

無料証明書アプリケーションのエラーメッセージ。

canceled

CertApplyCode

integer

無料証明書アプリケーションのエラーコード。

2

CreateTime

string

SaaS ドメイン名が作成された時間。ISO 8601 フォーマットで協定世界時 (UTC) を使用します。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。

2026-04-19T11:15:20Z

UpdateTime

string

SaaS ドメイン名が最後に更新された時間。ISO 8601 フォーマットで協定世界時 (UTC) を使用します。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。

2026-04-19T11:15:20Z

OfflineReason

string

SaaS ドメイン名がオフラインになった理由。有効な値:

  • expiration_arrears: サブスクリプションプランが有効期限切れになったか、アカウントに支払い遅延があります。

  • internally_disabled: システムによって無効化されました。

  • missing_icp: ドメイン名に ICP 登録がありません。

  • content_violation: コンテンツ違反。

  • proactively_disabled: ドメイン名をアクティブな状態から自主的に無効化したか、構成した使用量の上限に達しました。

列挙値:

  • expiration_arrears :

    サブスクリプションプランが有効期限切れになったか、アカウントに支払い遅延があります。

  • proactively_disabled :

    アクティブな状態から自主的に無効化されたか、使用量の上限に達しました。

  • content_violation :

    コンテンツ違反。

  • internally_disabled :

    システムによって無効化されました。

  • missing_icp :

    ドメイン名に ICP 登録がありません。

missing_icp

ConflictWith

string

SaaS ドメイン名のホスト名が占有されている理由。有効な値:

  • existing_custom_hostname: 既存の SaaS ドメイン名のホスト名と競合しています。

  • existing_record: 既存のサイト Record と競合しています。

  • existing_load_balancer: 既存の負荷分散インスタンスと競合しています。

  • existing_origin_pool: 既存のオリジン IPAM プールと競合しています。

  • existing_site: 既存のサイトと競合しています。

列挙値:

  • existing_load_balancer :

    既存の負荷分散インスタンスと競合しています。

  • existing_custom_hostname :

    既存の SaaS ドメイン名と競合しています。

  • existing_site :

    既存のサイトと競合しています。

  • existing_record :

    既存のサイト Record と競合しています。

  • existing_origin_pool :

    既存のオリジンプールと競合しています。

existing_custom_hostname

PrivateKey

string

証明書の秘密鍵。

-----BEGIN RSA PRIVATE KEY-----

成功レスポンス

JSONJSON

{
  "RequestId": "7C414690-9D7B-5D66-9CD9-AD0B3F25ED49",
  "CustomHostnameModel": {
    "HostnameId": 1234567890123,
    "Hostname": "custom.site.com",
    "SiteId": 890601022130656,
    "SiteName": "example.com",
    "RecordId": 4042843419650112,
    "RecordName": "origin.example.com",
    "Status": "active",
    "VerifyHost": "_esa_custom_hostname.custom.site.com",
    "VerifyCode": "verify_16ab7f4d389d4dff6655f995c6a997bd",
    "SslFlag": "on",
    "CertType": "free",
    "CasId": 30000478,
    "CertId": "baba2c9e90e840b3b55698cedf02b308",
    "Certificate": "-----BEGIN CERTIFICATE-----",
    "CertStatus": "OK",
    "CertTxtKey": "_acme-challenge.custom.site.com",
    "CertTxtValue": "lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM",
    "CertHttpKey": "http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc",
    "CertHttpValue": "jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0",
    "CertNotAfter": "2026-04-19T11:15:20Z",
    "CertApplyMessage": "canceled",
    "CertApplyCode": 2,
    "CreateTime": "2026-04-19T11:15:20Z",
    "UpdateTime": "2026-04-19T11:15:20Z",
    "OfflineReason": "missing_icp",
    "ConflictWith": "existing_custom_hostname",
    "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----"
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InternalException Failed to call the service. Try again later or contact technical support.
400 InvalidParameter The specified parameter is invalid.
404 CustomHostname.NotFound The custom hostname does not exist. Modify it and try again.
404 CustomHostname.ApplyCertFailed Fail to apply a free cert for custom hostname. Please try again later.
404 CustomHostname.SetCertFailed Fail to deploy a cert for custom hostname. Please try again later.

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

変更履歴

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