1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (DescribeLaunchConfigurations) is used to query the information about launch configurations.
- You can query the launch configuration details based on information such as the launch configuration ID and name. For more information about the supported filters, see
Filters. - If the filtering parameters are empty, a certain number (specified by
Limitand 20 by default) of launch configurations that belong to the current user will be returned.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-31 17:06:10.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeLaunchConfigurations |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-04-19 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LaunchConfigurationIds | No | No | Array of String | ID of one or more launch configurations to query, such as asc-ouy1ax38. You can specify a maximum of 100 scaling activity IDs in each request. LaunchConfigurationIds and Filters cannot be specified at the same time.Example: ["asc-fa28v4in"] |
| Filters | No | No | Array of Filter | Filter conditions.Filters per request is 10. The upper limit for Filter.Values is 5. LaunchConfigurationIds and Filters cannot be specified at the same time.Example:View |
| Limit | No | No | Uint64 | Number of returned items. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in API Introduction.Example: 20 |
| Offset | No | No | Uint64 | Offset. Default value: 0. For more information on Offset, see the relevant section in API Introduction.Example: 0 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Uint64 | Number of launch configurations that meet the specified conditions. Example: 1 |
| LaunchConfigurationSet | Array of LaunchConfiguration | Information about the launch configurations that meet the specified conditions. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidLaunchConfigurationId | Invalid launch configuration ID. |
| InvalidPermission | The account is not authorized to perform this operation. |
| InvalidParameter.Conflict | Multiple parameters specified conflict and cannot co-exist. |
| InvalidFilter | Invalid filter. |
| InvalidLaunchConfiguration | Invalid launch configuration. |