DescribeInstanceBootConfiguration API Overview - ENS

Operation description

Queries the boot configuration of a heterogeneous PC Farm bare metal instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeInstanceBootConfiguration

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	i-****
BootType	string	No	The startup type.	pxe
BootSet	string	No	The startup method.	legacy
DiskSet	string	No	Specifies whether the startup depends on the disk.	on

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	F3B261DD-3858-4D3C-877D-303ADF374600
Instances	object	Schema of Response
BootType	string	The startup type.	disk
DiskSet	string	Specifies whether the startup depends on the disk.	off
BootSet	string	The startup method.	legacy
InstanceId	string	The ID of the instance.	i-****

Examples

Success response

JSON format

{
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600",
  "Instances": {
    "BootType": "disk",
    "DiskSet": "off",
    "BootSet": "legacy",
    "InstanceId": "i-****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstanceNotFound	Instance not found, please check the InstanceId.	Instance not found, please check the instance ID
400	Parameter.Invalid	The parameter is invalid. Please check your parameters and try it again.	The parameter is invalid.
400	IncorrectInstanceStatus	The current status of the instance does not support this operation.	The instance is in a state that does not support the current operation.
400	InvalidInstanceType.NotSupported	The specified InstanceType is not Supported.	The specified instance type does not support the current operation.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.