RegisterCaCertificate API の呼び出しによる CA 証明書の追加 - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

RegisterCaCertificate

操作説明

この操作は、ApsaraMQ for MQTT Enterprise Platinum Edition インスタンスでのみサポートされています。
この操作は Alibaba Cloud アカウントごとに 1 秒あたり最大 500 回まで呼び出すことができます。上限を引き上げる場合は、DingTalk グループ (ID：35228338) に参加して ApsaraMQ for MQTT のテクニカルサポートにお問い合わせください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:RegisterCa

create

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

なし

mq:MqttInstanceAccess

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MqttInstanceId	string	必須	CA 証明書をバインドする ApsaraMQ for MQTT インスタンスの ID。	post-cn-7mz2d******
CaName	string	必須	ApsaraMQ for MQTT ブローカーに登録する CA 証明書の名前。	mqtt_ca
CaContent	string	必須	ApsaraMQ for MQTT ブローカーに登録する CA 証明書の内容。説明例では、\n は改行を示します。	-----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE-----
VerificationContent	string	必須	ApsaraMQ for MQTT ブローカーに登録する CA 証明書が発行した検証証明書の内容。検証証明書は、CA 証明書の登録コードと併せて使用し、CA 証明書の秘密鍵を検証する必要があります。説明例では、\n は改行を示します。	-----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE-----

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ
RequestId	string	リクエスト ID。	020F6A43-19E6-4B6E-B846-44EB31DF****
Sn	string	登録した CA 証明書のシリアル番号。シリアル番号は CA 証明書の一意の識別子です。	007269004887******

例

成功レスポンス

JSONJSON

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Sn": "007269004887******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	MqttOwnerCheckError	Failed to validate the instance permission
400	RegisterCodeError	Register code error in verification certificate.
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
400	MqttApplyCluster4InstanceFailed	the instance can not find cluster.
400	SystemError	system error.
400	MqttInstanceNotFound	Specified instance is not found
401	RegisterCodeUsed	Register code has been used.
401	GetCaNumError	Failed to get ca num. Try again later.
401	CaNumExceed	CA certificate num exceed
401	CertificateContentError	Certificate content error, please check ca/verification certificate content. BasicConstraints extension should be set to true in CA certificate
401	SnNotUnique	Sn is not unique in gloabal
403	PermissionCheckFailed	Failed to verify API permissions.

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

変更履歴

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