製品情報
パブリックイメージの更新情報
OSの公式サポート終了計画
製品に関するお知らせ
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to associate key pairs with instances.
SSH configuration of the instance, users will be able to log in to the instance with the private key of the key pair.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: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| InstanceIds.N | Yes | Array of String | Instance ID(s). The maximum number of instances in each request is 100. You can obtain the available instance IDs in two ways: InstanceId in the response. |
| KeyIds.N | Yes | Array of String | Key ID(s). The maximum number of key pairs in each request is 100. The key pair ID is in the format of skey-3glfot13. You can obtain the available key pair IDs in two ways: KeyId in the response. |
| ForceStop | No | Boolean | Whether to force shut down a running instances. It is recommended to manually shut down a running instance before associating a key pair with it. Valid values: Default value: FALSE. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssociateInstancesKeyPairs
<Common request parameters>
{
"InstanceIds": [
"ins-1e4r6y8i",
"ins-3e56fg78"
],
"KeyIds": [
"skey-4e5ty7i8"
]
}{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}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 |
|---|---|
| InternalServerError | Internal error. |
| InvalidInstance.NotSupported | This instance is not supported. |
| InvalidInstanceId.Malformed | Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length. |
| InvalidInstanceId.NotFound | No instance found. |
| InvalidKeyPairId.Malformed | Invalid key pair ID. The specified key pair ID has an invalid format. For example, skey-1122 has an invalid ID length. |
| InvalidKeyPairId.NotFound | Invalid key pair ID. The specified key pair ID does not exist. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InstanceIdMalformed | Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number). |
| InvalidParameterValue.KeyPairNotSupported | The specified key does not support the operation. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| MissingParameter | Missing parameter. |
| MutexOperation.TaskRunning | An identical job is running. |
| OperationDenied.InstanceOperationInProgress | The instance has an operation in progress. Please try again later. |
| UnauthorizedOperation.MFAExpired | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid. |
| UnauthorizedOperation.MFANotFound | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists. |
| UnsupportedOperation.InstanceOsWindows | The instance ins-xxxxxx with the Xserver windows2012cndatacenterx86_64 operating system does not support this operation. |
| UnsupportedOperation.InstanceStateEnterServiceLiveMigrate | The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported. |
| UnsupportedOperation.InstanceStateExitRescueMode | Instances are exiting from the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateFreezing | The operation is not supported for the frozen instances. |
| UnsupportedOperation.InstanceStateIsolating | Unable to isolate: the instance is isolated |
| UnsupportedOperation.InstanceStatePending | The instances are being created, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRebooting | The instances are being restarted, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRescueMode | Instances in the rescue mode are not available for this operation. |
| UnsupportedOperation.InstanceStateRunning | Running instances do not support this operation. |
| UnsupportedOperation.InstanceStateShutdown | Isolated instances do not support this operation. |
| UnsupportedOperation.InstanceStateStarting | The instance is starting up, and this operation is not supported. |
| UnsupportedOperation.InstanceStateStopping | The instance is being shut down, and this operation is not supported. |
| UnsupportedOperation.InstanceStateTerminating | The instance is being terminated, and the operation is not supported. |
| UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
フィードバック