単一の SaaS ドメイン名の詳細な構成を取得します。ドメイン検証の TXT 名、ドメイン検証の TXT コンテンツ、証明書の有効期限の時間(SSL が有効な場合)が含まれます。
今すぐお試しください
テスト
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 ドメイン名のステータス。有効な値:
列挙値:
|
active |
| VerifyHost |
string |
ドメイン検証の TXT 名。 |
_esa_custom_hostname.custom.site.com |
| VerifyCode |
string |
ドメイン検証の TXT コンテンツ。 |
verify_16ab7f4d389d4dff6655f995c6a997bd |
| SslFlag |
string |
SSL スイッチ。有効な値:
列挙値:
|
on |
| CertType |
string |
証明書のタイプ。有効な値:
列挙値:
|
free |
| CasId |
integer |
SSL 証明書サービス証明書の ID。 |
30000478 |
| CertId |
string |
証明書の ID。 |
baba2c9e90e840b3b55698cedf02b308 |
| Certificate |
string |
証明書のコンテンツ。 |
-----BEGIN CERTIFICATE----- |
| CertStatus |
string |
証明書のステータス。有効な値:
列挙値:
|
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 ドメイン名がオフラインになった理由。有効な値:
列挙値:
|
missing_icp |
| ConflictWith |
string |
SaaS ドメイン名のホスト名が占有されている理由。有効な値:
列挙値:
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。