edit-icon download-icon

Query the domain name

最終更新日: Dec 13, 2018

詳述

本関数では、自動的に割り当てられた第 2 レベル ドメイン名、カスタム ドメイン名および SSL 証明書といったバインド済みカスタム ドメインの詳細を照会します。

  • 本関数は API プロバイダーを対象にしています。

リクエスト パラメーター

名前 必須 説明
Action String はい インターフェイス名。必須パラメーター。値は、DescribeDomain
GroupId String はい API グループ ID。システムが生成し、グローバルに一意である
DomainName String はい カスタム ドメイン名

レスポンス パラメーター

名前 説明
RequestId String 一意のリクエスト ID
GroupID String API グループ ID。システムが自動生成し、グローバルに一意である
DomainName String カスタム ドメイン名
SubDomain String API グループに自動的に割り当てられる第 2 レベル ドメイン名
CertificateId String ユニークな SSL 証明書 ID。システムが自動生成
CertificateName String SSL 証明書名
CertificateBody String 証明書のコンテンツ
CertificatePrivateKey String 証明書の秘密鍵
DomainBindingStatus String カスタム ドメインのバインド状況。値は、
  • BINDING:ドメインは正常です。
  • BOUND:ドメインは有効にはなりません。
DomainCNAMEStatus String ドメインの解決状況。値は、
  • RESOLVED:ドメイン名は解決されました。
  • UNRESOLVED:ドメイン名は解決されていません。
DomainLegalStatus String ドメインの正当性状況。値は、
  • NORMAL:ドメインは有効です。
  • ABNORMAL:ドメインは無効であり、API を利用できません。至急対応する必要があります。
DomainRemark String ドメインに関する備考。たとえば、異常である理由

リクエスト例

  1. https://apigateway.cn-hangzhou.aliyuncs.com/?Action=DescribeDomain
  2. &GroupId=927d50c0f2e54b359919923d908bb015
  3. &DomainName=api.demo.com
  4. &<Public request parameters>

レスポンス例

XML 形式

  1. <DescribeDomainResponse>
  2. <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>
  3. <GroupId>927d50c0f2e54b359919923d908bb015</GroupId>
  4. <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
  5. <DomainName>api.demo.com</DomainName>
  6. <CertificateId>6EF60BEC-0242-43AF-BB20-270359FB54A7</CertificateId>
  7. <CertificateName>myCertificate</CertificateName>
  8. <CertificateBody>..</CertificateBody>
  9. <CertificatePrivateKey>..</CertificatePrivateKey>
  10. <DomainBindingStatus>BINDING</DomainBindingStatus>
  11. <DomainCNAMEStatus>RESOLVED</DomainCNAMEStatus>
  12. <DomainLegalStatus>ABNORMAL</DomainLegalStatus>
  13. <DomainRemark>The domain did not put on record</DomainRemark>
  14. </DescribeDomainResponse>

JSON 形式

  1. {
  2. "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
  3. "GroupId": "927d50c0f2e54b359919923d908bb015",
  4. "SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
  5. "DomainName": "api.demo.com",
  6. "CertificateId":"6EF60BEC-0242-43AF-BB20-270359FB54A7",
  7. "CertificateName": "myCertificate",
  8. "CertificateBody":"..",
  9. "CertificatePrivateKey":"..",
  10. "DDomainBindingStatus": "BINDING",
  11. "DomainCNAMEStatus": "RESOLVED",
  12. "DomainLegalStatus":"ABNORMAL",
  13. "DomainRemark":"The domain did not put on record"
  14. }