Queries the certificate information about a domain name.

Usage note

ドメイン名は、このAPIを呼び出すために必須です。

QPS制限

A single user can perform a maximum of 100 queries per second (QPS). 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeLiveDomainCertificateInfo

実行したい操作。 Set the value to DescribeLiveDomainCertificateInfo.

DomainName String 必須 example.com

The streaming domain name or ingest domain.
RegionId String 任意 cn-shanghai

ストリーミングドメインが存在するリージョンのID。

レスポンスパラメーター

パラメーター データ型 例 説明
CertInfos CertInfoの配列

ドメイン名に関する証明書情報。
CertInfo
CertDomainName String example.com

証明書と一致するドメイン名。
CertExpireTime String 2018-06-03T22:03:39Z

証明書の有効期限が切れる時刻。 時間は、 Z形式のISO 8601標準に従います。 時刻はUTCで表示されます。
CertLife String 3ヶ月
証明書の有効期間。 単位: 月または年。
  • 有効期間が12か月を超える場合、XX年XXか月が表示されます。 たとえば、2年3か月は、有効期間が2年3か月であることを示します。
  • 有効期間が12か月未満の場合、XXか月が表示されます。 たとえば、3か月は、有効期間が3か月であることを示します。
CertName String Cert-****

証明書の名前。
CertOrg String 暗号化しましょう

証明書を発行した認証局 (CA) 。
CertType String cas

証明書のタイプ。 設定可能な値は以下のとおりです。

  • free: 無料の証明書。
  • cas: Alibaba Cloud SSL証明書サービスから購入した証明書。
  • upload: ユーザーがアップロードした証明書。
DomainName String example.com

ストリーミングドメイン名。
SSLProtocol String on

HTTPSのステータス。 設定可能な値は以下のとおりです。

  • on: HTTPSは有効です。
  • off: HTTPSは無効です。
SSLPub String yourSSLPub

証明書の公開鍵。
ステータス String success

証明書のステータス。 設定可能な値は以下のとおりです。

  • success: 証明書は有効です。
  • checking: システムは、ドメイン名がApsaraVideo Liveによって割り当てられた正規名 (CNAME) にマップされているかどうかをチェックしています。
  • cname_error: ドメイン名は、ApsaraVideo Liveによって割り当てられたcnameにマッピングされていません。
  • domain_invalid: ドメイン名に無効な文字が含まれています。
  • unsupport_wildcard: ワイルドカードドメイン名はサポートされていません。
  • applying: 証明書はアプリケーションの進行状況にあります。
  • failed: 証明書の申請が失敗しました。
RequestId String 5C1E43DC-9E51-4771-82C0-7D5ECEB547A1

リクエストの ID です。

例

リクエストの例

http(s):// live.aliyundoc.com/?Action=DescribeLiveDomainCertificateInfo
&DomainNam e=example.com
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<SetLiveDomainCertificateResponse>
  <CertInfos>
        <CertInfo>
              <ステータス> 成功 </ステータス>
              <CertLife>3か月 </CertLife>
              <DomainNam e>example.com</DomainName>
              <SSLPub>yourSSLPub</SSLPub>
              <CertOrg> 暗号化しよう </CertOrg>
              <CertDomainNam e>example.com</CertDomainName>
              <CertType>cas</CertType>
              <CertExpireTime>2018-06-03T22:03:39Z</CertExpireTime>
              <CertName>Cert-****</CertName>
              <SSLProtocol>on</SSLProtocol>
        </CertInfo>
  </CertInfos>
  <RequestId>5C1E43DC-9E51-4771-82C0-7D5ECEB547A1</RequestId>
</SetLiveDomainCertificateResponse>

JSON 形式 

{
    "SetLiveDomainCertificateResponse": {
        "CertInfos": {
            "CertInfo": {
                "ステータス": "成功" 、
                "CertLife": "3ヶ月" 、
                "DomainName": "example.com",
                "SSLPub": "yourSSLPub" 、
                "CertOrg": "Let's Encrypt" 、
                "CertDomainName": "example.com" 、
                "CertType": "cas" 、
                "CertExpireTime": "2018-06-03T22:03:39Z" 、
                "CertName": "Cert-****" 、
                "SSLProtocol": "on"
            }
        },
        "RequestId": "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1"
    }
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。

特殊エラーコード

エラーコード

エラーメッセージ

HTTP ステータスコード

説明

InvalidDomain.NotFound

The domain provided does not belong to you.

404

ドメイン名が存在しないか、ユーザーに属していない場合に返されるエラーメッセージ。