This API is used to query instances that a parameter template can be applied to.
This API supports the following instance types:
GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
config_id |
Yes |
String |
Parameter template ID. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
offset |
No |
Integer |
Index offset. If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data. The value must be a non-negative number. |
limit |
No |
Integer |
Maximum records to be queried.
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
instances |
Array of ApplicableInstanceRsp objects |
All instances. |
count |
Integer |
Maximum number of instances that parameters can be applied to. |
GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/9e80bf6bbd7142f49761c07e9c32dd04pr06/applicable-instances?offset=0&limit=10
Status code: 200
Successful response
{
"instances" : [ {
"id" : "f38e203908bd4fae82714e88f12600f6in06",
"name" : "test"
} ],
"count" : 1000
}
See Status Codes.
See Error Codes.