Querying Products

Function

This API is used to obtain product information.

URI

GET /v1/{project_id}/link/instances/{instance_id}/products

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
project_id	string	Yes	Project ID of each region of a tenant.
instance_id	string	Yes	ID of the ROMA Connect instance used by the tenant.

Request

Request parameters

None

Example request

https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/products

Response Message

Response parameters

**Table 2** Response parameter description
Parameter	Type	Description
total	integer	Total number of products.
products	Array<product>	Product information.

**Table 3** Parameter description of products
Parameter	Type	Description
password	string	Password.
product_id	integer	Product ID.
product_name	string	Product name.
product_serial	string	Equipment serial number.
remark	string	Product description, which contains a maximum of 200 characters.
user_name	string	Username.

Example response

{
    "total": 1,
    "products": [
    {
            "product_id": 250,
            "product_name": "product01",
            "product_serial": "wbgfcYR6p250",
            "remark": "this is a demo.",
            "password": "*************",
            "user_name": "8f9be623df1249429dcfead6c0d541d3"
    }
    ]
}

Parent topic: Product Management

Previous topic: Creating a Product

Next topic: Device Management