All Products
Search

This Product

    DataWorks:GetDataSource

    Document Center

    DataWorks:GetDataSource

    Last Updated:Dec 25, 2024

    Queries a data source by ID.

    Operation description

    1. This API operation is available for all DataWorks editions.
    2. You can call this operation only if you are assigned one of the following roles in DataWorks:
    • Tenant Owner, Workspace Administrator, Deployment, Development, Project Owner, and O&M

    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:
      • The required resource types are displayed in bold characters.
      • 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
    dataworks:GetDataSourceget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    IdlongYes

    The data source ID.

    		16035

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		9252F32F-D855-549E-8898-61CF5A733050
    DataSourceobject

    The information about the data source.

    Idlong

    The data source ID.

    		16738
    ProjectIdlong

    The ID of the workspace with which the data source is associated.

    		52660
    Namestring

    The name of the data source.

    		test
    Typestring

    The type of the data source.

    		hologres
    ConnectionPropertiesany

    The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:

    • Dev: development environment
    • Prod: production environment

    The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see Data source connection information (ConnectionProperties).

    		{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
    ConnectionPropertiesModestring

    The mode in which the data source is added. The mode varies based on the data source type. Valid values:

    • InstanceMode: instance mode
    • UrlMode: connection string mode
    • CdhMode: CDH cluster mode
    		UrlMode
    Descriptionstring

    The description of the data source.

    		test
    CreateTimelong

    The time when the data source was added. This value is a UNIX timestamp.

    		1698286929333
    CreateUserstring

    The ID of the user who adds the data source.

    		1107550004253538
    ModifyTimelong

    The time when the data source was last modified. This value is a UNIX timestamp.

    		1698286929333
    ModifyUserstring

    The ID of the user who modifies the data source.

    		1107550004253538
    QualifiedNamestring

    The unique business key of the data source. For example, the unique business key of a Hologres data source is in the ${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database} format.

    		1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "DataSource": {
    "Id": 16738,
    "ProjectId": 52660,
    "Name": "test",
    "Type": "hologres",
    "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
    "ConnectionPropertiesMode": "UrlMode",
    "Description": "test",
    "CreateTime": 1698286929333,
    "CreateUser": "1107550004253538",
    "ModifyTime": 1698286929333,
    "ModifyUser": "1107550004253538",
    "QualifiedName": "1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb"
  }
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history