/connmgr/v1/scan/<connection_name>: 获取

获取单个连接的当前扫描状态。

/connmgr/v1/scan/<connection_name>: GET 端点获取单个连接的当前扫描状态。 只有具有数据管理员角色或集合管理员角色的 IBM 数据编目用户才能获取扫描状态。 下表显示了哪些角色可以访问此 REST API 端点:
表 1. 按角色访问
数据管理 数据用户 集合管理员 管理员 Service 用户
Χ ✓1 Χ Χ
1 "集合管理员" 用户可以启动,停止和获取应用于其具有 "集合管理员" 角色的集合的扫描的状态。

申请概要 URL

curl -k -H “Authorization: Bearer <token>” -X GET https://<data_cataloging_host>/connmgr/v1/scan/<connection_name>

支持的请求类型,输入字段和响应格式

支持的请求类型:
  • POST
支持的响应格式:
  • JSON

示例

执行以下步骤以获取连接的扫描状态:

  1. 使用数据管理用户的凭证获取认证令牌,如下所示:
    curl -k https://<data_cataloging_host>/auth/v1/token -u “<user_name>:<password>

    对于有效用户,将在 X-Auth-Token 响应头中返回认证令牌。

  2. 使用以下请求获取名称为 sdconnection 的连接的扫描状态:
    curl -k -H “Authorization: Bearer <token>” -X GET https://<data_cataloging_host>/connmgr/v1/scan/sdconnection

响应

下表显示了公共响应状态:
表 2. 公共响应状态
状态码 消息 描述
200 扫描状态 JSON。 已成功检索扫描状态。
注: 具有集合管理员角色的用户只能获取连接的扫描状态 (如果设置了关联的集合) ,如果是集合,那么集合管理员用户将进行管理。 因此,在响应中,仅向集合管理员用户提供属于集合管理员用户管理的连接的连接状态。
成功扫描将显示以下响应:
[
{
"Name":"sdconnection",
"status":"Running",
"message":"Crawling NFS mount",
"Phase":2,
"Total_phases":3
},
{
"Name":"ss",
"status":"Running",
"message":"Preparing to scan connection",
"Phase":1,
"total_phases":4
}
]