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

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:MqttInstanceAccess

list

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	ApsaraMQ for MQTT インスタンスの ID です。クライアントが使用する実際のインスタンス ID と一致している必要があります。この ID は、コンソールの [インスタンスの詳細] ページから取得できます。	mqtt-xxxxxxxx
GroupId	string	必須	マイクロメッセージキューの MQTT バージョンのグループ ID です。	GID_xxx
PageNo	string	任意	返される結果のページ番号を示します。開始ページは 1 からカウントされます。	1
PageSize	string	必須	1 ページに表示するクエリレコードの最大数です。有効値：1～100。	100
NextToken	string	任意	次のページのクエリを開始するためのトークンです。	FFdXXXXXWa

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	パブリックパラメーターです。各リクエスト ID は一意であり、トラブルシューティングや問題の特定に使用できます。	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceCredentialClientIdList	object	情報リストを返します。
Total	string	クエリ結果の総数です。	10
ClientIdList	array	クライアントリストです。
	string	クライアント ID です。	GID_test@@@pub-1
PageNo	string	返されたクエリレコードの現在のページ番号です。	1
PageSize	string	1 ページに表示される結果の最大数です。	100
NextToken	string	次のクエリのためのトークン (Token) があるかどうかを示します。値：最初のクエリや次のクエリがない場合、このフィールドを埋める必要はありません。次のクエリがある場合、値は前の API 呼び出しから返された NextToken である必要があります。	634dxxxxx75b5f

例

成功レスポンス

JSONJSON

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "DeviceCredentialClientIdList": {
    "Total": "10",
    "ClientIdList": [
      "GID_test@@@pub-1"
    ],
    "PageNo": "1",
    "PageSize": "100",
    "NextToken": "634dxxxxx75b5f"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ApplyTokenOverFlow	You have applied for tokens too many times. Please try again later.
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.
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	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.
400	PermissionCheckFailed	An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
500	InternalError	An error occurred while processing your request. Try again later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.

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

変更履歴

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