Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to bind a user-specified key pair to an instance.
RUNNING
status will be forcibly shut down before binding.RequestId
will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the DescribeInstances
API. If the latest operation status (LatestOperationState) of the instance is SUCCESS
, the operation is successful.A maximum of 10 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: AssociateInstancesKeyPairs. |
Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
KeyIds.N | Yes | Array of String | Key pair ID list. Each request can contain up to 100 key pairs. |
InstanceIds.N | Yes | Array of String | Instance ID list. Each request can contain up to 100 instances at a time. You can get an instance ID from the InstanceId returned by the DescribeInstances API. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to bind a key pair to an instance.
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssociateInstancesKeyPairs
<Common request parameters>
{
"InstanceIds": [
"lhins-ruy9d2tw"
],
"KeyIds": [
"lhkp-f7rjie1q"
]
}
{
"Response": {
"RequestId": "f192c1a9-580e-4653-9d54-ba42cd4353a3"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.DescribeInstanceStatus | An error occurred when querying the instance status. |
FailedOperation.InstanceOperationFailed | Failed to manipulate the instance. |
InternalError.DescribeInstanceStatus | Failed to query the instance status. Please try again later. |
InternalError.InvalidCommandNotFound | The command is not found. |
InvalidParameterValue.Duplicated | Invalid parameter value: duplicate values are not allowed. |
InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
InvalidParameterValue.KeyPairIdMalformed | Invalid parametric value: the key pair ID format is invalid. |
InvalidParameterValue.LimitExceeded | Invalid parametric value: the number of parameter values exceeds the upper limit. |
InvalidParameterValue.OutOfRange | Invalid parametric value: it is not within the valid range. |
OperationDenied.InstanceCreating | It is not allowed to manipulate this instance, as it is being created. |
OperationDenied.InstanceOperationInProgress | It is not allowed to manipulate this instance, as the last operation is still in progress. |
ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
ResourceNotFound.InstanceNotFound | The instance does not exist. |
ResourceNotFound.KeyIdNotFound | The key pair ID does not exist. |
UnauthorizedOperation.MFAExpired | MFA has expired. |
UnauthorizedOperation.MFANotFound | MFA does not exist. |
UnauthorizedOperation.NoPermission | No permission |
UnsupportedOperation.InvalidInstanceState | Unsupported operation: the instance status is invalid. |
UnsupportedOperation.KeyPairBindDuplicate | Unsupported operation: one key pair cannot be bound to the same instance repeatedly. |
UnsupportedOperation.LatestOperationUnfinished | Unsupported operation: the last operation of the instance has not been completed. |
UnsupportedOperation.WindowsNotAllowToAssociateKeyPair | Windows instances do not support binding key pairs. |
UnsupportedOperation.WindowsNotSupportKeyPair | SSH key pair is not available for Windows instances |
本页内容是否解决了您的问题?