Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to set the attributes of the default login key pair of an instance.
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: ModifyInstancesLoginKeyPairAttribute. |
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. |
InstanceIds.N | Yes | Array of String | Instance ID list. Each request can contain up to 100 instances at a time. |
PermitLogin | No | String | Whether to allow login with the default key pair. Valid values: YES: yes; NO: no. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://lighthouse.tencentcloudapi.com/?Action=ModifyInstancesLoginKeyPairAttribute
&InstanceIds.0=lhins-ruy9d2tw
&PermitLogin=NO
&<Common request parameters>
{
"Response": {
"RequestId": "fb3c565c-1ce9-43de-9b4e-58855716b16d"
}
}
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. |
InvalidParameterValue.Duplicated | Invalid parameter value: duplicate values are not allowed. |
InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
InvalidParameterValue.InvalidInstanceLoginKeyPairPermitLogin | The value of setting whether to use the default key pair for login is incorrect. |
InvalidParameterValue.LimitExceeded | Invalid parametric value: the number of parameter values exceeds the upper limit. |
ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
ResourceNotFound.InstanceNotFound | The instance does not exist. |
UnauthorizedOperation.NoPermission | No permission |
UnsupportedOperation.InvalidInstanceState | Unsupported operation: the instance status is invalid. |
UnsupportedOperation.LatestOperationUnfinished | Unsupported operation: the last operation of the instance has not been completed. |
UnsupportedOperation.OperationOffline |
Was this page helpful?