文档首页/ 图像搜索 ImageSearch/ API参考/ API/ 查询用户实例信息
更新时间：2023-12-11 GMT+08:00
查看PDF
分享

查询用户实例信息

功能介绍

查看用户指定实例详细信息。

URI

GET /v1/{project_id}/service/{instance_name}

表1 路径参数

参数

是否必选

参数类型

描述

instance_name

是

String

实例名称。

project_id

是

String

用户的项目ID。获取方法请参见获取项目ID和名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

domain

String

模型展示名或领域名称。

desc

String

描述。

registerDate

Long

注册时间。

expiredDate

Long

过期时间，-1表示永不过期。

level

Integer

规格，即实例的图片数量规格，默认为30000000（单位：张）。

tags

Array of strings

图片自定义标签。

status

String

实例的状态，有以下状态信息：

  • NORMAL：正常。
  • ARREARAGE：欠费。
  • CREATION：创建中。
  • CREATION_FAILD：创建失败。
  • DELETING：删除中。
  • DELETING_FAILED：删除失败。
  • ABNORMAL：异常。

instanceName

String

实例名称。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码，具体请参见错误码。

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

查看用户指定实例详细信息。

GET https://{endpoint}/v1/{project_id}/service/{instance_name}

响应示例

状态码： 200

成功响应示例

{
  "instanceName" : "test-instance",
  "level" : 30000000,
  "expiredDate" : 1530848365207,
  "domain" : "model description",
  "desc" : "register service for instance test.",
  "registerDate" : 1529377136279,
  "tags" : [ "tag1", "tag2" ],
  "status" : "NORMAL"
}

状态码： 400

失败响应示例

{
  "error_code" : "IS.0004",
  "error_msg" : "The authentication token is abnormal."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码。

父主题： API