Querying Instances That a Parameter Template Can Be Applied To
Function
This API is used to query the instances that the current parameter template can be applied to. Before calling this API:
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/configurations/{config_id}/applicable-instances
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A |
config_id |
Yes |
String |
Definition Parameter template ID. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A |
offset |
No |
Integer |
Definition Index offset. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th data records are displayed. Constraints N/A Range [0,2^31-1] Default Value 0: The query starts from the first data record. |
limit |
No |
Integer |
Definition Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed. Constraints N/A Range [1, 100] Default Value 100 |
Request Parameters
None
Response Parameters
Parameter |
Type |
Description |
---|---|---|
instances |
Array of objects |
Definition Parameter template information. For details, see Table 3. |
total_count |
Integer |
Definition Total number of records. Range N/A |
Example Request
Querying instances that the current parameter template can be applied to
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/applicable-instances
Example Response
Instances that the current parameter template can be applied to queried.
{ "instances": [ { "instance_id": "1995a67680474481b3e42ac1474e32e0in14", "instance_name": "gauss-a283" }, { "instance_id": "8303819fd8744ef69f34595e9710a33din14", "instance_name": "gauss-2423-lt-master" } ], "total_count": 2 }
Status Codes
- Normal
- Abnormal
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot