Help Center> ROMA Connect> API Reference> Device Integration APIs> Service Management> Querying Services
View PDF

Querying Services

Function

This API is used to querying services.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

Minimum: 0

Maximum: 32

instance_id

Yes

String

Instance ID.

Minimum: 0

Maximum: 36
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of items displayed on each page. The maximum value is 999. If the value exceeds 999, only 999 items are returned.

Minimum: 0

Maximum: 999999

Default: 10

service_id

No

Integer

Service ID.

Minimum: 1

Maximum: 99999999999999999

service_name

No

String

Service name.

Minimum: 0

Maximum: 64

product_template_id

No

Integer

ID of the product template to which the service belongs. Either product_template_id or product_id must be set.

Minimum: 1

Maximum: 99999999999999999

product_id

No

Integer

ID of the product to which the service belongs. Either product_template_id or product_id must be set.

Minimum: 1

Maximum: 99999999999999999

created_user_name

No

String

Name of the user who created the product template.

Minimum: 2

Maximum: 64

created_date_start

No

Long

Creation start time. The format is timestamp(ms) and the UTC time zone is used.

Minimum: 1

Maximum: 99999999999999999

created_date_end

No

Long

Creation end time. The format is timestamp(ms) and the UTC time zone is used.

Minimum: 1

Maximum: 99999999999999999

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

Minimum: 0

Maximum: 999999

Default: 0

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total.

Minimum: 1

Maximum: 99999999999999999

size

Integer

Number of records displayed on each page.

Minimum: 1

Maximum: 999

items

Array of Service objects

Service list.
Table 4 Service

Parameter

Type

Description

product_template_id

Integer

ID of the product template to which a service belongs.

Minimum: 1

Maximum: 99999999999999999

product_id

Integer

ID of the product to which a service belongs.

Minimum: 1

Maximum: 99999999999999999

service_id

Integer

Service ID.

Minimum: 1

Maximum: 99999999999999999

service_name

String

Service name, which is a string of 2 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).

Minimum: 2

Maximum: 64

description

String

Service description, which contains a maximum of 200 characters.

Minimum: 0

Maximum: 200

status

Integer

Service status. The options are as follows: 0: enabled; 1: disabled.

Minimum: 0

Maximum: 10

created_user

CreatedUser object

Name of the user who created the attribute.

last_updated_user

LastUpdatedUser object

User who performed the last update.

created_datetime

Long

Creation end time (timestamp, in millisecond). The UTC time zone is used.

Minimum: 1

Maximum: 99999999999999999

last_updated_datetime

Long

Last modification time (timestamp, in millisecond). The UTC time zone is used.

Minimum: 1

Maximum: 99999999999999999
Table 5 CreatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

Minimum: 0

Maximum: 64

user_name

String

Username.

Minimum: 0

Maximum: 64
Table 6 LastUpdatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

Minimum: 0

Maximum: 64

user_name

String

Username.

Minimum: 0

Maximum: 64

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Example Requests

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

Example Responses

Status code: 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
  } ]
}

Status code: 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"
}

Status code: 404

Not Found

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

Status code: 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"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Service Management