文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 设备集成API/ 服务管理/ 查询服务
更新时间：2022-12-05 GMT+08:00
查看PDF
分享

查询服务

功能介绍

查询服务

URI

GET /v2/{project_id}/link/instances/{instance_id}/services

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度：0

最大长度：32

instance_id

是

String

实例ID

最小长度：0

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示条目数量，最大数量999，超过999后只返回999

最小值：0

最大值：999999

缺省值：10

service_id

否

Integer

服务ID

最小值：1

最大值：99999999999999999

service_name

否

String

服务名称

最小长度：0

最大长度：64

product_template_id

否

Integer

归属产品模板ID，product_template_id和product_id二选一

最小值：1

最大值：99999999999999999

product_id

否

Integer

归属产品ID，product_template_id和product_id二选一

最小值：1

最大值：99999999999999999

created_user_name

否

String

创建用户名

最小长度：2

最大长度：64

created_date_start

否

Long

创建时间起始，格式timestamp(ms)，使用UTC时区

最小值：1

最大值：99999999999999999

created_date_end

否

Long

创建时间截止，格式timestamp(ms)。使用UTC时区

最小值：1

最大值：99999999999999999

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0

最小值：0

最大值：999999

缺省值：0

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值：1

最大值：99999999999999999

size

Integer

本次返回数量

最小值：1

最大值：999

items

Array of Service objects

服务列表
表4 Service

参数

参数类型

描述

product_template_id

Integer

服务归属的产品模板ID

最小值：1

最大值：99999999999999999

product_id

Integer

服务归属的产品ID

最小值：1

最大值：99999999999999999

service_id

Integer

服务ID

最小值：1

最大值：99999999999999999

service_name

String

服务名称，支持中文,英文大小写，数字，下划线和中划线,长度2-64

最小长度：2

最大长度：64

description

String

服务描述，长度0-200

最小长度：0

最大长度：200

status

Integer

服务状态 0-启用 1-停用

最小值：0

最大值：10

created_user

CreatedUser object

创建时的用户

last_updated_user

LastUpdatedUser object

最后更新时的用户

created_datetime

Long

创建时间止，格式timestamp(ms)，使用UTC时区

最小值：1

最大值：99999999999999999

last_updated_datetime

Long

最后修改时间止，格式timestamp(ms)，使用UTC时区

最小值：1

最大值：99999999999999999
表5 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度：0

最大长度：64

user_name

String

用户名

最小长度：0

最大长度：64
表6 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度：0

最大长度：64

user_name

String

用户名

最小长度：0

最大长度：64

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

请求示例

GET /{project_id}/link/instances/{instance_id}/services

响应示例

状态码： 200

OK

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "product_template_id" : null,
    "product_id" : 122893,
    "service_id" : 10190,
    "service_name" : "s1",
    "description" : null,
    "status" : 0,
    "created_user" : {
      "user_id" : null,
      "user_name" : "user"
    },
    "last_updated_user" : {
      "user_id" : null,
      "user_name" : "user"
    },
    "created_datetime" : 1607502702474,
    "last_updated_datetime" : 1607572282845
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-services.queryService]. Parameter is [X-Auth-Token]. Processor is [header].",
  "requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码： 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found"
}

状态码： 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 服务管理