GetInstanceAccess

Last updated: 2020-07-03 09:29:03

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 Service deployment ID
InstanceId Yes String Instance ID

3. Output Parameters

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.

4. Example

Example1 Getting credentials required for instance login

This example shows you how to get the credentials required for instance login.

Input Example

https://gse.tencentcloudapi.com/?Action=GetInstanceAccess
&FleetId=xxx
&InstanceId=xxx
&<Common request parameters>

Output Example

{
  "InstanceAccess": {
    "Credentials": {
      "Secret": "xxxxx",
      "UserName": "xxxxx"
    },
    "FleetId": "xxxx",
    "InstanceId": "xxxx",
    "IpAddress": "xxxxx",
    "OperatingSystem": "xxxxx",
    "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The 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 Unauthorized operation.
UnsupportedOperation Unsupported operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help