Obtaining the DB Instances to Which a Parameter Template Applies

Function

This API is used to obtain the DB instances to which a specified parameter template applies.

URI

  • URI format

    PATH: /v1.0/{project_id}/configurations/{id}/instances

    Method: GET

  • Parameter description

    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    id

    Yes

    Specifies the parameter template ID.

  • Restrictions

    Currently, the DB engines MySQL and PostgreSQL support obtaining DB instances to which the specified parameter template applies.

Request

None

Normal Response

  • Parameter description

    Table 2 Parameter description

    Name

    Type

    Description

    instances

    List data structure. For details, see Table 3.

    Indicates the DB instance list information.

    Table 3 instances field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the DB instance ID.

    name

    String

    Indicates the DB instance name.

  • Response example

    {
      "instances": [
        {
          "id": "53754eff-3f95-4da8-a908-a88e6ea2f65a",
          "name": "instances_test_1"
    },
    {
          "id": "53754eff-3f95-4da8-a908-a88e6ea2f65b",
          "name": "instances_test_2"
        }
      ]
    }
    

Abnormal Response

For details, see Abnormal Request Results.