InactivateDeviceCertificate - - Alibaba Cloud ドキュメントセンター

デバイス証明書は、ルート認証局（CA）がクライアントデバイスに発行するデジタル証明書です。サービスは、接続中にクライアントを認証するためにこの証明書を使用します。認証に成功すると、サービスとクライアントは証明書の暗号鍵を使用して安全に通信できます。認証に失敗した場合、サービスはクライアントの接続を拒否します。デバイス証明書を一時的に使用する必要がない場合は、この操作を呼び出してデバイス証明書を無効化し、ステータスを非アクティブに変更できます。

操作説明

Platinum エディションインスタンスのみが InactivateDeviceCertificate 操作をサポートしています。
単一ユーザーのリクエスト頻度は、1 秒あたり 500 呼び出しに制限されています。特別な要件については、ApsaraMQ for MQTT テクニカルサポートに連絡してください。DingTalk グループ番号は 35228338 です。

今すぐお試しください

この 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:UnregisterDeviceCertificate

none

*Instance

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

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
MqttInstanceId	string	必須	デバイス証明書がアタッチされている ApsaraMQ for MQTT インスタンスの ID です。	post-cn-7mz2d******
DeviceSn	string	必須	無効化するデバイス証明書のシリアル番号（SN）です。SN はデバイス証明書を一意に識別します。	356217374433******
CaSn	string	必須	デバイス証明書が属する CA 証明書の SN です。SN は CA 証明書を一意に識別します。値の長さは最大 128 バイトです。	007269004887******

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンスのスキーマ
RequestId	string	リクエストの ID です。この共通パラメーターは、各リクエストで一意です。この ID を使用して問題のトラブルシューティングを行います。	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceSn	string	無効化されたデバイス証明書の SN です。SN はデバイス証明書を一意に識別します。	356217374433******

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
500	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
500	FindDeviceBySnError	Failed to find the device certificate by the SN. Please check sn is valid
500	MqttInstanceNotFound	Specified instance is not found
403	PermissionCheckFailed	Failed to verify API permissions.
403	MqttOwnerCheckError	Failed to validate the instance permission

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

変更履歴

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