All Products
Search
Document Center

AnalyticDB:CheckHadoopNetConnection

Last Updated:Nov 05, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Checks the network connectivity of a Hadoop external data source.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:CheckHadoopNetConnectionnone
*DBInstance
acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

Region ID.

cn-hangzhou
DBInstanceIdstringYes

Instance ID.

gp-xxxxxxx
EmrInstanceIdstringNo

EMR instance ID.

c-xxx
DataSourceIdstringNo
  1. Either DataSourceId or EmrInstanceId must be specified as input, otherwise an error will occur.
  2. If both of the above parameters are specified, EmrInstanceId will be used preferentially.
  3. If the data source specified by DataSourceId is a self-built Hadoop cluster, an error will occur directly.
126

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
ConnectionStatusstring

Connection status:

  • Network connected: Success

  • Network not connected: Failed

Success
ConnectionMessagestring

Return message: Returns error information if the connection fails, otherwise returns an empty string ("").

connection timeout

Examples

Sample success responses

JSONformat

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "ConnectionStatus": "Success",
  "ConnectionMessage": "connection timeout"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-20The request parameters of the API has changedView Change Details