Domain name for API request: gse.tencentcloudapi.com.
This API is used to get the credentials required for instance login.
A maximum of 20 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 parameter. The value used for this API: GetInstanceAccess. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-11-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| FleetId | Yes | String | Server fleet ID |
| InstanceId | Yes | String | Instance ID |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceAccess | InstanceAccess | Credentials required for instance login |
| 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 get the credentials required for instance login.
https://gse.tencentcloudapi.com/?Action=GetInstanceAccess
&FleetId=fleet-qp3g3caa-iectl8nb
&InstanceId=ins-gi2lxw
&<common request parameters>
{
"Response": {
"InstanceAccess": {
"Credentials": {
"Secret": "w4bksrwe3gdbqwernmlvjioqeniovmlni3289t0123n42lfn892sjdfqwionv823bnvh2ljkvs",
"UserName": "root"
},
"FleetId": "fleet-qp3g3caa-iectl8nb",
"InstanceId": "ins-gi2lxw",
"IpAddress": "9.12.5.87",
"OperatingSystem": "centos6.7"
},
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}
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 | Operation failed. |
| InternalError | An internal error occurred. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Missing parameter. |
| ResourceInUse | The resource is in use. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnauthorizedOperation.ServiceNotOpened | The service is not activated. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?