QueryClientIds - IoT Platform - Alibaba Cloud ドキュメントセンター

デバイスの ClientID をクエリします。この API 操作は、製品ごとの一意の証明書認証に適用されます。

制限

各 Alibaba Cloud アカウントは、最大 10 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	QueryClientIds	実行する操作。値を QueryClientIds に設定します。
IotId	String	Yes	y4u2weAIrpp****WHMle1234	QueryDeviceInfo 操作を呼び出して、IotId パラメーターをクエリできます。
IotInstanceId	String	No	iot-a****13l	インスタンスの ID。IoT Platform コンソールの概要ページでインスタンス ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	Success	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返される ClientID。詳細については、DynamicRegClientIds をご参照ください。
DynamicRegClientIds	Array of DynamicRegClientId		ClientID のリスト。
ClientId	String	9rSzYt4js92********f000112	デバイスの ClientID。
CreateTime	Long	1636514022424	ClientID が作成された時刻。
IotId	String	y4u2weAI********HMle1234	デバイスの ID。
ErrorMessage	String	request parameter error	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	89F22330-BAEE-**-**-41BA46D6E267	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryClientIds
&IotId=y4u2weAIrpp****WHMle1234
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryClientIdsResponse>
  <RequestId>CA991E7C-BDE7-5887-B3B7-E08C68C0D346</RequestId>
  <Data>
        <IotId>kRLP***0000</IotId>
        <DynamicRegClientIds>
              <CreateTime>1635847637823</CreateTime>
              <ClientId>K19uYV***000100</ClientId>
        </DynamicRegClientIds>
        <DynamicRegClientIds>
              <CreateTime>1635846982286</CreateTime>
              <ClientId>bpQwyW***000100</ClientId>
        </DynamicRegClientIds>
        <DynamicRegClientIds>
              <CreateTime>1635847426368</CreateTime>
              <ClientId>ntnIvez***000100</ClientId>
        </DynamicRegClientIds>
  </Data>
  <Success>true</Success>
</QueryClientIdsResponse>

JSON 形式

{
    "RequestId": "CA991E7C-BDE7-5887-B3B7-E08C68C0D346",
    "Data": {
        "IotId": "kRLP***0000",
        "DynamicRegClientIds": [
            {
                "CreateTime": 1635847637823,
                "ClientId": "K19uYV***000100"
            },
            {
                "CreateTime": 1635846982286,
                "ClientId": "bpQwyW***000100"
            },
            {
                "CreateTime": 1635847426368,
                "ClientId": "ntnIvez***000100"
            }
        ]
    },
    "Success": true
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。