Querying Commands

Function

Querying Commands

URI

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

**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
service_id	Yes	String	Service ID. Minimum: 0 Maximum: 20

**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
command_id	No	Integer	Command ID. Minimum: 1 Maximum: 99999999999999999
command_name	No	String	Command name. Minimum: 0 Maximum: 64
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

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum: 1 Maximum: 100000

Response Parameters

Status code: 200

**Table 4** 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: 9999
items	Array of Command objects	Command list.

**Table 5** Command
Parameter	Type	Description
service_id	Integer	ID of the service to which the command belongs. Minimum: 0 Maximum: 99999999999999999
command_id	Integer	Command ID. Minimum: 0 Maximum: 99999999999999999
command_name	String	Command name. Minimum: 0 Maximum: 255
description	String	Command description. Minimum: 0 Maximum: 255

Status code: 400

**Table 6** 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 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: 500

**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

Example Requests

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

Example Responses

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "service_id" : 10190,
    "command_id" : 6398,
    "command_name" : "command",
    "description" : "command"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-services.queryCommandsInService]. Parameter is [service_id]. Processor is [path].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

Status code: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
  "request_id" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01"
}

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"
}