Querying Services

Function

Querying Services

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. The default value is default for compatibility with 20.0.Project ID. For details about how to get the project ID, see "Appendix" > "Obtaining a Project ID" in this document.
instance_id	Yes	String	Instance ID. The default value is default for compatibility with 20.0.

**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.
service_id	No	Integer	Service ID, which is the unique auto-increment unique identifier in the database. You can call the service query API GET /v2/{project_id}/link/instances/{instance_id}/services to obtain the value of service_id of the corresponding service in the response body.
service_name	No	String	Service name.
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.
product_id	No	Integer	ID of the product to which the service belongs. Either product_template_id or product_id must be set.
created_user_name	No	String	Name of the user who created the product template.
created_date_start	No	Long	Creation start time. The format is timestamp(ms) and the UTC time zone is used.
created_date_end	No	Long	Creation end time. The format is timestamp(ms) and the UTC time zone is used.
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total.
size	Integer	Number of records displayed on each page.
items	Array of Service objects	Service list.

**Table 5** Service
Parameter	Type	Description
product_template_id	Integer	ID of the product template to which a service belongs.
product_id	Integer	ID of the product to which a service belongs.
service_id	Integer	Service ID, which is the unique auto-increment unique identifier in the database. You can call the service query API GET /v2/{project_id}/link/instances/{instance_id}/services to obtain the value of service_id of the corresponding service in the response body.
service_name	String	Service name, which is a string of 2 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).
description	String	Service description, which contains a maximum of 200 characters.
status	Integer	Service status. The options are as follows: 0: enabled; 1: disabled.
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 time. The format is timestamp (ms) and the UTC time zone is used.
last_updated_datetime	Long	Last modification time. The format is timestamp (ms) and the UTC time zone is used.

**Table 6** CreatedUser
Parameter	Type	Description
user_id	String	User ID (reserved).
user_name	String	Username.

**Table 7** LastUpdatedUser
Parameter	Type	Description
user_id	String	User ID (reserved).
user_name	String	Username.

Status code: 400

**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.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 404

**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.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 500

**Table 10** 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.
error_msg	String	Error description.
request_id	String	Message ID.

Example Requests

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

Example Responses

Status code: 200

{
  "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" : "",
      "user_name" : "user"
    },
    "last_updated_user" : {
      "user_id" : "",
      "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].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

Status code: 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-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"
}