All Products
Search

This Product

    MaxCompute:GetMmsDataSource

    Document Center

    MaxCompute:GetMmsDataSource

    Last Updated:Sep 30, 2025

    Retrieves the details of a specific MaxCompute Migration Assist (MMA) data source.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    odps:GetMmsDataSource

    get

    *Project

    acs:odps:{#regionId}:{#accountId}:mmsdatasource/{#sourceId}

    		 None None

    Request syntax

    GET /api/v1/mms/datasources/{sourceId} HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    sourceId

    integer

    Yes

    The data source ID.

    2000015
    withConfig

    boolean

    No

    Specifies whether to obtain the specific configuration items of the data source.

    true
    lang

    string

    No

    The language of the description for the configuration items.

    en_US

    Response elements

    Element

    Type

    Description

    Example

    object

    ApiRes

    requestId

    string

    The request ID.

    98EC8C47-3D6D-560C-808B-84E494220A32
    data

    object

    The data returned.

    id

    integer

    The data source ID.

    2000015
    region

    string

    The region ID.

    cn-shanghai
    name

    string

    The name of the data source.

    demo
    dstProject

    string

    mms_test
    dstProjects

    array

    string

    mms_test1
    type

    string

    The type of the data source.

    Valid values:

    • HIVE :

      HIVE

    • BIGQUERY :

      BIGQUERY

    • MAXCOMPUTE :

      MAXCOMPUTE

    BIGQUERY
    lastUpdateTime

    string

    The time when the metadata was last synchronized.

    2024-12-17 15:44:17
    dbNum

    integer

    The number of databases in the data source.

    3
    tableNum

    integer

    The number of tables in the data source.

    1000
    partitionNum

    integer

    The number of partitions in the data source.

    10000000
    createTime

    string

    The time when the data source was created.

    2024-12-17 09:29:58
    status

    string

    The status of the data source.

    Valid values:

    • STARTING :

      STARTING

    • STOPPED :

      STOPPED

    • STARTED :

      STARTED

    • START_FAILED :

      START_FAILED

    • STOPPING :

      STOPPING

    • STOP_FAILED :

      STOP_FAILED

    STARTED
    errMsg

    string

    The reason the data source instance failed to start or shut down. This parameter is returned if the status is START_FAILED or STOP_FAILED.

    unexpected exception
    config

    array<object>

    The configurations of the data source.

    object

    The configurations of the data source.

    name

    string

    The name of the configuration item.

    范围分区表迁移方式
    key

    string

    The key of the configuration item.

    bigquery.range.partition.migrate.type
    desc

    string

    The description of the configuration item.

    范围分区表迁移方式
    placeHolder

    string

    The placeholder for the value of the configuration item.

    Cluster or Partition
    type

    string

    The type of the configuration item. Valid values include boolean, int, map, string, password, and file.

    Valid values:

    • password :

      password

    • file :

      file

    • string :

      string

    • map :

      map

    • booelan :

      boolean

    • int :

      int

    string
    subType

    string

    If type is set to file, subType specifies the file type, such as .keytab.

    .keytab
    value

    any

    The value of the configuration item.

    Partition

    enums

    array

    The enumerated values of the configuration item.

    string

    The enumerated values of the configuration item.

    Cluster or Partition
    required

    boolean

    Specifies whether the configuration item is required.

    true
    group

    string

    The group of the configuration item.

    basic_group
    agentIsOnline

    boolean

    Indicates whether the data source instance or its associated agent is started.

    true
    tablesDoingNum

    integer

    The number of tables being migrated.

    19
    tablesDoneNum

    integer

    The number of tables that are migrated.

    16
    tablesPartDoneNum

    integer

    The number of tables that are partially migrated.

    123
    tablesFailedNum

    integer

    The number of tables that failed to migrate.

    2
    partitionsDoingNum

    integer

    The number of partitions being migrated.

    23322
    partitionsDoneNum

    integer

    The number of partitions that are migrated.

    11113
    partitionsFailedNum

    integer

    The number of partitions that failed to migrate.

    32
    scanId

    integer

    The ID of the metadata synchronization task.

    1000253

    Examples

    Success response

    JSON format

    {
  "requestId": "98EC8C47-3D6D-560C-808B-84E494220A32",
  "data": {
    "id": 2000015,
    "region": "cn-shanghai",
    "name": "demo",
    "dstProject": "mms_test",
    "dstProjects": [
      "mms_test1"
    ],
    "type": "BIGQUERY",
    "networklink": "vpc-2zebqp6uojhdla46677tl:cn-shanghai",
    "lastUpdateTime": "2024-12-17 15:44:17",
    "dbNum": 3,
    "tableNum": 1000,
    "partitionNum": 10000000,
    "createTime": "2024-12-17 09:29:58",
    "status": "STARTED",
    "errMsg": "unexpected exception",
    "config": [
      {
        "name": "范围分区表迁移方式",
        "key": "bigquery.range.partition.migrate.type",
        "desc": "范围分区表迁移方式",
        "placeHolder": "Cluster or Partition",
        "type": "string",
        "subType": ".keytab",
        "value": "Partition\n",
        "enums": [
          "Cluster or Partition"
        ],
        "required": true,
        "group": "basic_group"
      }
    ],
    "agentIsOnline": true,
    "tablesDoingNum": 19,
    "tablesDoneNum": 16,
    "tablesPartDoneNum": 123,
    "tablesFailedNum": 2,
    "partitionsDoingNum": 23322,
    "partitionsDoneNum": 11113,
    "partitionsFailedNum": 32,
    "scanId": 1000253
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.