下发查询会话列表任务
功能介绍
下发查询会话列表任务。
URI
POST /v2/{project_id}/instances/{instance_id}/clients
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： 实例ID。可通过DCS控制台进入实例详情界面查看。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
node_id |
是 |
String |
参数解释： 节点ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
clean_cache |
否 |
Boolean |
参数解释： 是否重新查询并保存会话列表。 约束限制： 不涉及。 取值范围：
默认取值： false。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
参数解释： 下发查询会话列表任务ID。 取值范围： 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 |
|
error_code |
String |
错误码。 |
|
error_ext_msg |
String |
扩展错误信息。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 |
|
error_code |
String |
错误码。 |
|
error_ext_msg |
String |
扩展错误信息。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 |
|
error_code |
String |
错误码。 |
|
error_ext_msg |
String |
扩展错误信息。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 |
|
error_code |
String |
错误码。 |
|
error_ext_msg |
String |
扩展错误信息。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 |
|
error_code |
String |
错误码。 |
|
error_ext_msg |
String |
扩展错误信息。 |
请求示例
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/clients
{
"node_id" : "8f7ee181-88e2-49b7-a4bf-81f18f93a135",
"clean_cache" : true
}
响应示例
状态码：200
下发查询会话列表任务成功。
{
"job_id" : "8abf6e1e824e204401824e3e621b0042"
}
状态码：400
非法请求。
{
"error_code" : "DCS.4957",
"error_msg" : "This operation is not allowed when the task is in the current state."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
下发查询会话列表任务成功。 |
|
400 |
非法请求。 |
|
401 |
认证信息非法。 |
|
403 |
请求被拒绝访问。 |
|
404 |
所请求的资源不存在。 |
|
500 |
内部服务错误。 |
错误码
请参见错误码。
