SetLiveDomainCertificate API による SSL 証明書でライブドメインを保護 - LIVE - Alibaba Cloud - ApsaraVideo Live

ドメインの証明書特徴の有効/無効をセットし、証明書情報を変更します。

操作説明

まずライブストリーミングドメインを取得し、次にこの API オペレーションを呼び出して、ドメインの証明書の有効/無効をセットし、証明書情報を変更します。

QPS 制限

この API オペレーションのシングルユーザー QPS 制限は 1 秒あたり 30 回です。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。適切に呼び出しを行ってください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:SetLiveDomainCertificate

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DomainName	string	必須	証明書が属するアクセラレーションドメイン名。このパラメーターは `https` アクセラレーションタイプに属します。	developer.aliyundoc.com
CertName	string	任意	証明書名。	Cert-****
CertType	string	任意	証明書タイプ。有効な値: upload: アップロード証明書。 cas: Certificate Authority サービス証明書。 free: 個人テスト証明書（無料版）。列挙値: cas : Certificate Authority サービス証明書 upload : アップロード証明書。 free : 個人テスト証明書。	free
SSLProtocol	string	必須	HTTPS 証明書を有効にするかどうかを指定します。有効な値: on: 有効。このパラメーターを on に設定する場合、SSLPub および SSLPri リクエストパラメーターも指定する必要があります。 off（デフォルト）: 無効。	off
SSLPub	string	任意	公開鍵の内容。説明このパラメーターは SSLProtocol が on に設定されている場合にのみ必須です。	****
SSLPri	string	任意	秘密鍵の内容。説明このパラメーターは SSLProtocol が on に設定されている場合にのみ必須です。	****
ForceSet	string	任意	重複する証明書名のチェックを無視し、同じ名前の既存の証明書情報を上書きします。固定値: 1。	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

例

成功レスポンス

JSONJSON

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidSSLProtocol.ValueNotSupported	The specified value of parameter SSLProtocol is not supported.
400	SSLPub.MissingParameter	An input parameter "SSLPub" that is mandatory for processing the request is not supplied.
400	SSLPri.MissingParameter	An input parameter "SSLPri" that is mandatory for processing the request is not supplied.
400	InvalidSSLPub	The SSLPub you provided is malformed!
400	InvalidSSLPri	The SSLPri you provided is malformed!
400	Certificate.MissMatch	The SSLPri does not math the specified Certificate!
400	InvalidCertificate.TooLong	The Certificate you provided is over the max length!
400	InvalidCertName.TooLong	The Certificate name you provided is over the max length 128!
400	IllegalOperationDomain	You are not authorized to operate the domain.
400	Certificate.NotPermittedOff	Turn off certificate will change domain scheduling, please contact customer service
400	Certificate.SettedNotEffect	Certificate was successfully setted but does't take effect for protecting current service, please contact customer service
400	Certificate.NotFind	Not find the certificate info.
400	AuthenticationFailed	Authentication failed.
400	SetDomainCertificate.ParameterError	Parameters have error.
400	InvalidSSLPubOrInvalidSSLPri	The SSLPri or SSLPub you provided is malformed!
400	Certificate.StatusError	Certificate is not exist or its status is error.
400	DeleteFailed	Delete certificate is failed.
400	Certificate.Duplicated	The certificate name is duplicated.
400	Certificate.FormatError	The certificate format is error.
400	Certificate.KeyNull	The private key is not null.
400	Key.Malformed	The private key format is error.
400	CertStorage.failed	The certificate storage failed.
400	CertificateContent.Duplicated	The certificate is already uploaded, please don't upload again.
400	Certificate.Expired	The certificate is expired.
400	InvalidDomain.notOnline	The domain is not online, please check the domain status and try again later.
400	Decode.Error	The certificate sslpub or sslpri decode error.
400	sslPub.Error	The SSLPub encoded failed.
400	sslPri.Error	The SSLPri encoded failed.
400	DomainInSafeMode	This domain is in the safe mode. if you want to do this operation, please contact us!
400	DomainInProtectedMode	This domain is in the protected mode. if you want to do this operation, please contact us!
400	FunctionMutex	Function is mutex with other function.
400	DomainOffline	The domain is not online, please check the domain status and try again later.
403	IllegalOperation	Illegal domain operate is not permitted.
404	CertName.MissingParameter	The CertName parameter is required.

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

変更履歴

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