ロボットの詳細を取得
この記事の内容
ロボットの情報を取得
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
コンソールの「ロボット管理」に移動して、ロボットのアカウントまたはロボットのuuidをコピーする必要があります。現在、ロボットのuuidは、F12で通信をキャプチャし、client/list APIからuuidを取得する必要があります。
説明: このAPIはロボットの情報を取得できます。ロボットの名称またはロボットのuuidによる取得に対応しており、どちらか一方を入力するだけで利用できます。両方を入力する場合は、名称とuuidが対応していることを確認してください。ロボットを除外した後、再びスケジューリングモードに切り替えると、ロボットのuuidが新しく生成されるため、ロボットの名称で取得することを推奨します。
テンプレート
postManテンプレート
apiロボットの情報を取得.json(右ボタンをクリックして「名前を付けて保存」)
Javaテンプレート
リクエストモデル: ClientQueryReq.java(右ボタンをクリックして「名前を付けて保存」)
レスポンスモデル: ClientQueryRep.java(右ボタンをクリックして「名前を付けて保存」)
リクエスト
| 基本 | 説明 | |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/client/query | 専用クラウドを利用する企業は、専用クラウドのアドレスを使用してください |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | 説明 | |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認証APIが返すaccess Tokenに置き換える必要があります |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須 | 説明 |
|---|---|---|---|---|
| accountName | string | ロボットのアカウント名 | いいえ | accountNameとrobotClientUuidは相互排他的で、どちらか一方を選択すれば十分です。ロボットのアカウントの使用を推奨します |
| robotClientUuid | string | ロボットのuuid | いいえ | accountNameとrobotClientGroupUuidは相互排他的で、どちらか一方を選択すれば十分です。現在、ロボットのuuidは、F12で通信をキャプチャし、client/list APIからuuidを取得する必要があります |
リクエスト例
ロボットのアカウントを指定して取得する例:
{
"accountName": "boyi@csqy"
}
ロボットのuuidを指定して取得する例:
{
"robotClientUuid": "2cadec88-b93b-4812-8d10-eb2a48ef5111"
}
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| msg | string | はい | ステータスコードの説明 |
| data | object | はい | レスポンスデータ |
| ∟ robotClientUuid | string | はい | ロボットのuuid |
| ∟ robotClientName | string | はい | ロボットの名称です。accountNameと同じです |
| ∟ status | string | はい | ロボットの状態です。ロボットの状態の列挙値の説明を参照してください |
| ∟ description | string | いいえ | ロボットの備考説明 |
| ∟ remark | string | いいえ | 実行時の備考 |
| ∟ clientIp | string | はい | クライアントのip |
レスポンスボディの例
{
"data": {
"robotClientUuid": "0d6a835a-2e08-414a-af73-1e43f9d9c8ff",
"robotClientName": "ceshi1@csqy1",
"status": "idle",
"description": "ceshi1",
"clientIp": "172.16.28.156",
"remark": "运行成功"
},
"code": 200,
"success": true
}
エラーが発生した場合は、次のリンクに移動してください:ステータスコードの説明