All Products
Search
Document Center

ENS:DescribeInstanceBootConfiguration

Last Updated:Dec 04, 2025

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

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeInstanceBootConfigurationget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

i-****
BootTypestringNo

The startup type.

pxe
BootSetstringNo

The startup method.

legacy
DiskSetstringNo

Specifies whether the startup depends on the disk.

on

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Id of the request

F3B261DD-3858-4D3C-877D-303ADF374600
Instancesobject

Schema of Response

BootTypestring

The startup type.

disk
DiskSetstring

Specifies whether the startup depends on the disk.

off
BootSetstring

The startup method.

legacy
InstanceIdstring

The ID of the instance.

i-****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InstanceNotFoundInstance not found, please check the InstanceId.Instance not found, please check the instance ID
400Parameter.InvalidThe parameter is invalid. Please check your parameters and try it again.The parameter is invalid.
400IncorrectInstanceStatusThe current status of the instance does not support this operation.The instance is in a state that does not support the current operation.
400InvalidInstanceType.NotSupportedThe specified InstanceType is not Supported.The specified instance type does not support the current operation.
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.