Querying Attributes

Function

Querying Attributes

URI

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

**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
property_id	No	Integer	Attribute ID. Minimum: 1 Maximum: 99999999999999999
property_name	No	String	Attribute 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: 999999999999999
size	Integer	Number of records displayed on each page. Minimum: 1 Maximum: 999
items	Array of PropertyResponseBody objects	Attribute list.

**Table 5** PropertyResponseBody
Parameter	Type	Description
property_id	Integer	Attribute ID. Minimum: 1 Maximum: 99999999999999999
property_name	String	Attribute name, which is a string of 2 to 50 characters containing letters, digits, hyphens (-), and underscores (_). The value must start with a letter. Minimum: 2 Maximum: 50
description	String	Description, which contains a maximum of 200 characters. Minimum: 0 Maximum: 200
data_type	String	Property data type. Options: enumerated values of boolean (case sensitive); number (ranging from ±1.0 x 10^-28 to ±7.9228 x 10^28); string; integer; datetime (in yyyyMMddTHHmmss format); json; array Minimum: 0 Maximum: 10
required	Integer	Whether a field is mandatory. The options are as follows: 0: no; 1: yes. Minimum: 0 Maximum: 10
min	String	Minimum value. This parameter is available if data_type is set to integer or number. Default: 0 Minimum: 0 Maximum: 10
max	String	Maximum value. This parameter is valid when data_type is set to integer or number. Default: 65536 Minimum: 0 Maximum: 10
step	String	Step. This parameter is available if data_type is set to integer or number. Default: 1 Minimum: 0 Maximum: 10
max_length	Integer	Maximum length of a character string. This parameter is available if data_type is set to string, datetime, or json. Minimum: 1 Maximum: 99999999 Default: 10
unit	String	Attribute unit. Minimum: 0 Maximum: 10
enum_list	String	Array of enumerated values of the string type. The values are separated by commas (,). Minimum: 0 Maximum: 2000
enum_dict	Object	For the boolean data type, use the JSON format. Example: "enum_dict":{"0":"xxx","1":"xxx"}
method	String	Access mode (compatible with 20.0. The options are as follows: R: the attribute is readable; W: the attribute is writable; E: the attribute is executable.). Minimum: 1 Maximum: 3

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}/properties

Example Responses

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "property_id" : 3320,
    "property_name" : "p2",
    "description" : null,
    "data_type" : "datetime",
    "required" : 0,
    "min" : 0,
    "max" : 65536,
    "step" : 1,
    "max_length" : "10",
    "unit" : "yuan",
    "enum_list" : null
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-command.saveProperty]. 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"
}