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

ApsaraMQ for MQTT インスタンスに登録されているすべてのデバイス証明書を照会します。デバイス証明書は、認証局 (CA) のルート証明書によってクライアントに発行されるデジタル証明書です。ApsaraMQ for MQTT クライアントを ApsaraMQ for MQTT ブローカーに接続すると、ブローカーはデバイス証明書を使用してクライアントを認証します。クライアントが認証に成功すると、クライアントとブローカーはデバイス証明書内の暗号化された秘密鍵に基づいて相互に通信できます。クライアントが認証に失敗した場合、クライアントからのアクセスリクエストは拒否されます。

操作説明

この操作は、ApsaraMQ for MQTT Enterprise Platinum Edition インスタンスのみでサポートされています。
1 つの 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:ListDeviceCertificate

list

*Instance

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

なし

mq:MqttInstanceAccess

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MqttInstanceId	string	必須	デバイス証明書を表示する ApsaraMQ for MQTT インスタンスの ID。	post-cn-7mz2d******
PageNo	string	必須	返す結果のページ番号を指定します。開始ページは 1 からカウントされます。	2
PageSize	string	必須	1 ページに表示するクエリレコードの最大数。有効値：1～100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	パブリックパラメーター。各リクエスト ID は一意であり、トラブルシューティングや問題の特定に使用できます。	020F6A43-19E6-4B6E-B846-44EB31DF****
Data	object	クエリ結果。
Total	integer	クエリ結果の最大ページ数。	1
PageNo	integer	返されたクエリレコードの現在のページ番号。	2
PageSize	integer	1 ページに表示する結果の最大数。	10
DeviceCertificateVOS	array<object>	デバイス証明書の詳細。
	object
ValidBegin	string	デバイス証明書が有効になる開始時刻。フォーマットはミリ秒単位の UNIX タイムスタンプです。	1654137303000
ValidEnd	string	デバイス証明書が有効になる終了時刻。フォーマットはミリ秒単位の UNIX タイムスタンプです。	1969497303000
DeviceSn	string	デバイス証明書の SN シリアル番号。デバイス証明書を一意に識別するために使用されます。	356217374433******
DeviceContent	string	デバイス証明書の内容。 `\n` は改行を表します。	-----BEGIN DEVICECERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END DEVICECERTIFICATE-----
Status	string	デバイス証明書のステータス。値は次のとおりです： 0: 証明書が非アクティブな状態であることを示します。- 1: 証明書がアクティブな状態であることを示します。デバイス証明書が登録されると、デフォルトでアクティブな状態になります。	1
CaSn	string	デバイス証明書が属する CA 証明書の SN シリアル番号。CA 証明書を一意に識別するために使用されます。	00f26900ba87******
DeviceName	string	デバイス証明書の名前。	mqtt_device

例

成功レスポンス

JSONJSON

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Data": {
    "Total": 1,
    "PageNo": 2,
    "PageSize": 10,
    "DeviceCertificateVOS": [
      {
        "ValidBegin": "1654137303000",
        "ValidEnd": "1969497303000",
        "DeviceSn": "356217374433******",
        "DeviceContent": "-----BEGIN DEVICECERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END DEVICECERTIFICATE-----",
        "Status": "1",
        "CaSn": "00f26900ba87******",
        "DeviceName": "mqtt_device"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.
400	MqttOwnerCheckError	Failed to validate the instance permission
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.

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

変更履歴

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