

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# describe-api-clients
<a name="describe-api-clients"></a>

列出已在 Broker 中注册的 Session Manager 客户端。

**Topics**
+ [语法](#sytnax)
+ [输出](#output)
+ [示例](#example)

## 语法
<a name="sytnax"></a>

```
sudo -u root dcv-session-manager-broker describe-api-clients
```

## 输出
<a name="output"></a>

**`name`**  
Session Manager 客户端的唯一名称。

**`id`**  
Session Manager 客户端的唯一 ID。

**`active`**  
指示 Session Manager 客户端的状态。如果客户端处于活动状态，则值为 `true`；否则，值为 `false`。

## 示例
<a name="example"></a>

以下示例列出注册的 Session Manager 客户端。

**--命令**：

```
sudo -u root dcv-session-manager-broker describe-api-clients
```

**输出**：

```
Api clients
[ {
"name" : "client-abc",
"id" : "f855b54b-40d4-4769-b792-b727bEXAMPLE",
"active" : false
}, {
"name" : "client-xyz",
"id" : "21cfe9cf-61d7-4c53-b1b6-cf248EXAMPLE",
"active" : true
}]
```