ActiveCaCertificate API で CA 証明書を再有効化 - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

ApsaraMQ for MQTT は、X.509 証明書を使用したデバイス認証をサポートしています。これらのデバイス証明書を発行および検証するには CA 証明書が必要であり、使用するにはアクティブである必要があります。CA 証明書は登録時にデフォルトでアクティブになりますが、この操作により、非アクティブになった証明書を再アクティブ化することができます。

操作説明

この操作は、ApsaraMQ for MQTT Enterprise Platinum Edition インスタンスでのみサポートされています。
この操作は、Alibaba Cloud アカウントあたり 1 秒間に最大 500 回呼び出すことができます。上限を引き上げたい場合は、DingTalk グループ (ID: 35228338) に参加して ApsaraMQ for MQTT テクニカルサポートにお問い合わせください。
この操作では、ApsaraMQ for MQTT ブローカーに登録されている CA 証明書のみを再アクティブ化できます。ApsaraMQ for MQTT インスタンスに登録されている CA 証明書を照会するには、ListCaCertificate 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:ActiveCaCertificate

none

*Instance

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

なし

mq:MqttInstanceAccess

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MqttInstanceId	string	必須	CA 証明書が紐付けられている ApsaraMQ for MQTT インスタンスの ID。	post-cn-7mz2d******
Sn	string	必須	再アクティブ化する CA 証明書のシリアル番号。シリアル番号は CA 証明書の一意の識別子です。 CA 証明書のシリアル番号は 128 バイトを超えることはできません。	007269004887******

レスポンスフィールド

フィールド	型	説明	例
	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	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
400	MqttApplyCluster4InstanceFailed	the instance can not find cluster.
400	FindCaBySnError	Failed to find the CA by the SN. Please check sn is valid.
400	MqttInstanceNotFound	Specified instance is not found
400	SystemError	system error.
403	PermissionCheckFailed	Failed to verify API permissions.
403	MqttOwnerCheckError	Failed to validate the instance permission

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

変更履歴

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