MaxCompute：CatalogAPI SDK使用指南

方法定義

Table createTable(Table table)

請求參數

返回結果

返回建立好的 Table 對象。

使用樣本

// 構造表
Table table = new Table();
table.setProjectId("my_project");
table.setSchemaName("default");
table.setTableName("my_table");
table.setDescription("這是一個樣本表");
table.setType("TABLE");

// 設定表 Schema
TableFieldSchema field = new TableFieldSchema();
field.setFieldName("id");
field.setTypeCategory("BIGINT");
field.setMode("REQUIRED");

TableFieldSchema nameField = new TableFieldSchema();
nameField.setFieldName("name");
nameField.setTypeCategory("STRING");
nameField.setMode("NULLABLE");

TableFieldSchema schema = new TableFieldSchema();
schema.setFields(Arrays.asList(field, nameField));
table.setTableSchema(schema);

// 建立表
Table createdTable = client.createTable(table);
System.out.println("Created table: " + createdTable.getName());

方法定義

Table getTable(Table table)

請求參數

返回結果

返回 Table 對象。

使用樣本

Table query = new Table();
query.setProjectId("my_project");
query.setSchemaName("default");
query.setTableName("my_table");

Table result = client.getTable(query);
System.out.println("Table type: " + result.getType());
System.out.println("Description: " + result.getDescription());

方法定義

Table updateTable(Table table)

請求參數

返回結果

返回更新後的 Table 對象。

使用樣本

Table table = client.getTable(query);
table.setDescription("更新後的描述");

Table updated = client.updateTable(table);

方法定義

HttpResponse deleteTable(Table table)

請求參數

返回結果

成功時返回空的 HttpResponse。

使用樣本

HttpResponse response = client.deleteTable(table);
System.out.println("Status code: " + response.getStatusCode());

方法定義

ListTablesResponse listTables(String projectId, String schemaName, Integer pageSize, String pageToken)

請求參數

返回結果

{
  "tables": [Table],
  "nextPageToken": "string"
}

使用樣本

ListTablesResponse response = client.listTables("my_project", "default", 100, "");

// 遍曆所有頁
while (response.getTables() != null && !response.getTables().isEmpty()) {
    for (Table t : response.getTables()) {
        System.out.println(t.getTableName());
    }
    
    if (response.getNextPageToken() == null || response.getNextPageToken().isEmpty()) {
        break;
    }
    response = client.listTables("my_project", "default", 100, response.getNextPageToken());
}

方法定義

Policy setTablePolicy(Table table, SetPolicyRequest request)

請求參數

返回結果

返回更新後的 Policy 對象。

方法定義

Policy getTablePolicy(Table table)

請求參數

返回結果

返回表的 Policy 對象。

方法定義

DataToken getDataToken(Table table, Integer duration)

請求參數

返回結果

{
  "version": "string",
  "type": "string",
  "value": "string",
  "expiration": "string"
}

DataToken 欄位說明

方法定義

ListPartitionsResponse listPartitions(
    String projectId, 
    String schemaName, 
    String tableName, 
    Integer pageSize, 
    String pageToken,
    String query,
    String view
)

請求參數

返回結果

{
  "partitions": [Partition],
  "nextPageToken": "string"
}

方法定義

Connection createConnection(String namespace, Connection connection)

請求參數

返回結果

返回建立好的 Connection 對象。

使用樣本

// 構造 Connection
Connection conn = new Connection();
conn.setConnectionName("my_oss_connection");
conn.setDescription("訪問 OSS 的串連");
conn.setConnectionType("CLOUD_RESOURCE");

CloudResourceOptions options = new CloudResourceOptions();
options.setRamRoleArn("acs:ram::123456789:role/MaxComputeOSSRole");
conn.setCloudResource(options);

// 建立串連
Connection created = client.createConnection("123456789", conn);

方法定義

ListConnectionsResponse listConnections(String namespace, Integer pageSize, String pageToken)

請求參數

返回結果

{
  "connections": [Connection],
  "nextPageToken": "string"
}

方法定義

Connection getConnection(String namespace, String connectionName)

方法定義

Connection updateConnection(String namespace, String connectionName, Connection connection, String updateMask)

請求參數

返回結果

返回更新後的 Connection 對象。

使用樣本

Connection conn = new Connection();
conn.setConnectionName("my_oss_connection");
conn.setDescription("更新後的描述");

Connection updated = client.updateConnection("123456789", "my_oss_connection", conn, "description");

方法定義

HttpResponse deleteConnection(String namespace, String connectionName)

方法定義

Policy setConnectionPolicy(String namespace, String connectionName, SetPolicyRequest request)

方法定義

Policy getConnectionPolicy(String namespace, String connectionName)

方法定義

Role createRole(String namespace, Role role)

請求參數

返回結果

返回建立好的 Role 對象。

使用樣本

Role role = new Role();
role.setRoleName("my_custom_role");
role.setDescription("自訂角色");
role.setIncludedPermissions(Arrays.asList("odps:CreateTable", "odps:ListTable"));

Role created = client.createRole("123456789", role);

方法定義

ListRolesResponse listRoles(
    String namespace, 
    Integer pageSize, 
    String pageToken, 
    String view, 
    Boolean showDeleted
)

請求參數

返回結果

{
  "roles": [Role],
  "nextPageToken": "string"
}

方法定義

Role getRole(String namespace, String roleName)

請求參數

方法定義

Role updateRole(String namespace, String roleName, Role role, String updateMask)

請求參數

方法定義

HttpResponse deleteRole(String namespace, String roleName)

方法定義

Policy setRolePolicy(String namespace, String roleName, SetPolicyRequest request)

方法定義

Policy getRolePolicy(String namespace, String roleName)

方法定義

Taxonomy createTaxonomy(String namespace, Taxonomy taxonomy)

請求參數

返回結果

返回建立好的 Taxonomy 對象。

使用樣本

Taxonomy taxonomy = new Taxonomy();
taxonomy.setTaxonomyName("sensitive_data");
taxonomy.setDescription("敏感性資料分類");
taxonomy.setActivatedPolicyTypes(Arrays.asList("FINE_GRAINED_ACCESS_CONTROL"));

Taxonomy created = client.createTaxonomy("123456789", taxonomy);

方法定義

ListTaxonomiesResponse listTaxonomies(String namespace, Integer pageSize, String pageToken)

方法定義

Taxonomy getTaxonomy(String namespace, String taxonomyId)

方法定義

Taxonomy updateTaxonomy(String namespace, String taxonomyId, Taxonomy taxonomy, String updateMask)

請求參數

方法定義

HttpResponse deleteTaxonomy(String namespace, String taxonomyId)

方法定義

Policy setTaxonomyPolicy(String namespace, String taxonomyId, SetPolicyRequest request)

方法定義

Policy getTaxonomyPolicy(String namespace, String taxonomyId)

方法定義

PolicyTag createPolicyTag(String namespace, String taxonomyId, PolicyTag policyTag)

請求參數

返回結果

返回建立好的 PolicyTag 對象。

使用樣本

PolicyTag tag = new PolicyTag();
tag.setPolicyTagName("phone_number");
tag.setDescription("手機號碼脫敏標籤");

PolicyTag created = client.createPolicyTag("123456789", "taxonomy_id_123", tag);

方法定義

ListPolicyTagsResponse listPolicyTags(
    String namespace, 
    String taxonomyId, 
    Integer pageSize, 
    String pageToken
)

方法定義

PolicyTag getPolicyTag(String namespace, String taxonomyId, String policyTagId)

方法定義

PolicyTag updatePolicyTag(
    String namespace, 
    String taxonomyId, 
    String policyTagId, 
    PolicyTag policyTag, 
    String updateMask
)

請求參數

方法定義

HttpResponse deletePolicyTag(String namespace, String taxonomyId, String policyTagId)

方法定義

Policy setPolicyTagPolicy(String namespace, String taxonomyId, String policyTagId, SetPolicyRequest request)

方法定義

Policy getPolicyTagPolicy(String namespace, String taxonomyId, String policyTagId)

方法定義

DataPolicy createDataPolicy(String namespace, DataPolicy dataPolicy)

請求參數

返回結果

返回建立好的 DataPolicy 對象。

使用樣本

// 構造脫敏規則
DataMaskingPolicy maskingPolicy = new DataMaskingPolicy();
maskingPolicy.setPredefinedExpression("STRING_MASKED_BA");

DataPolicy policy = new DataPolicy();
policy.setDataPolicyName("phone_masking");
policy.setPolicyTag("namespaces/123456789/taxonomies/tid_123/policyTags/ptid_456");
policy.setDataPolicyType("DATA_MASKING_POLICY");
policy.setDataMaskingPolicy(maskingPolicy);

DataPolicy created = client.createDataPolicy("123456789", policy);

方法定義

ListDataPoliciesResponse listDataPolicies(String namespace, Integer pageSize, String pageToken)

方法定義

DataPolicy getDataPolicy(String namespace, String dataPolicyName)

方法定義

HttpResponse deleteDataPolicy(String namespace, String dataPolicyName)

方法定義

Policy setDataPolicyPolicy(String namespace, String dataPolicyName, SetPolicyRequest request)

方法定義

Policy getDataPolicyPolicy(String namespace, String dataPolicyName)

方法定義

DataScan createDataScan(String namespace, DataScan dataScan)

請求參數

返回結果

返回建立好的 DataScan 對象。

使用樣本

// 構造爬取任務
DataScanSource source = new DataScanSource();
source.setLocation("oss://my-bucket/my-path/");
source.setConnection("my_oss_connection");

DataScanTarget target = new DataScanTarget();
target.setProject("my_project");
target.setSchema("default");
target.setNamePrefix("auto_");

DataScanProperties properties = new DataScanProperties();
properties.setFormatFilter("AUTO");
properties.setScanMode("SAMPLE");
properties.setAutoCommit(true);

DataScan dataScan = new DataScan();
dataScan.setScanName("my_oss_scan");
dataScan.setType("TABLE_DISCOVERY");
dataScan.setDescription("爬取 OSS 中繼資料");
dataScan.setSource(source);
dataScan.setTarget(target);
dataScan.setProperties(properties);
dataScan.setSchedulerMode("MANUAL");

DataScan created = client.createDataScan("123456789", dataScan);

方法定義

ListDataScansResponse listDataScans(String namespace, Integer pageSize, String pageToken)

方法定義

DataScan getDataScan(String namespace, String dataScanName)

方法定義

DataScan updateDataScan(String namespace, DataScan dataScan, String updateMask)

方法定義

HttpResponse deleteDataScan(String namespace, String dataScanName)

方法定義

HttpResponse triggerDataScan(String namespace, String dataScanName)

使用樣本

HttpResponse response = client.triggerDataScan("123456789", "my_oss_scan");
System.out.println("Triggered: " + response.getStatusCode());

方法定義

ListDataScanJobsResponse listDataScanJobs(
    String namespace, 
    String dataScanName, 
    Integer pageSize, 
    String pageToken
)

返回結果

{
  "scanJobs": [ScanJob],
  "nextPageToken": "string"
}

ScanJob 模型

方法定義

Model createModel(String projectId, String schemaName, Model model)

請求參數

返回結果

返回建立好的 Model 對象。

使用樣本

Model model = new Model();
model.setModelName("my_llm_model");
model.setVersionName("v1");
model.setDefaultVersion("v1");
model.setDescription("我的大語言模型");
model.setSourceType("IMPORT");
model.setModelType("LLM");
model.setPath("oss://my-bucket/models/my_llm/");
model.setTasks(Arrays.asList("text-generation", "chat"));

Model created = client.createModel("my_project", "default", model);

方法定義

ListModelsResponse listModels(
    String projectId, 
    String schemaName, 
    Integer pageSize, 
    String pageToken
)

方法定義

Model getModel(String projectId, String schemaName, String modelName, String versionName)

請求參數

方法定義

Model updateModel(
    String projectId, 
    String schemaName, 
    String modelName, 
    Model model, 
    String updateMask, 
    String versionName
)

方法定義

HttpResponse deleteModel(String projectId, String schemaName, String modelName)

方法定義

Model createModelVersion(String projectId, String schemaName, String modelName, Model model)

使用樣本

Model version = new Model();
version.setModelName("my_llm_model");
version.setVersionName("v2");
version.setVersionDescription("更新後的模型版本");
version.setPath("oss://my-bucket/models/my_llm_v2/");
version.setTasks(Arrays.asList("text-generation", "chat"));

Model createdVersion = client.createModelVersion("my_project", "default", "my_llm_model", version);

方法定義

HttpResponse deleteModelVersion(
    String projectId, 
    String schemaName, 
    String modelName, 
    String versionName
)

方法定義

ListModelVersionsResponse listModelVersions(
    String projectId, 
    String schemaName, 
    String modelName, 
    Integer pageSize, 
    String pageToken
)

方法定義

Policy setModelPolicy(String projectId, String schemaName, String modelName, SetPolicyRequest request)

方法定義

Policy getModelPolicy(String projectId, String schemaName, String modelName)

方法定義

Project getProject(String projectId)

使用樣本

Project project = client.getProject("my_project");
System.out.println("Project owner: " + project.getOwner());
System.out.println("Schema enabled: " + project.getSchemaEnabled());
System.out.println("Region: " + project.getRegion());

方法定義

Schema createSchema(String projectId, Schema schema)

請求參數

返回結果

返回建立好的 Schema 對象。

使用樣本

Schema schema = new Schema();
schema.setSchemaName("my_schema");
schema.setDescription("我的自訂 Schema");

Schema created = client.createSchema("my_project", schema);

方法定義

ListSchemasResponse listSchemas(String projectId, Integer pageSize, String pageToken)

方法定義

Schema getSchema(String projectId, String schemaName)

方法定義

Schema updateSchema(String projectId, String schemaName, String updateMask, Schema schema)

請求參數

方法定義

HttpResponse deleteSchema(String projectId, String schemaName)

方法定義

Policy setSchemaPolicy(String projectId, String schemaName, SetPolicyRequest request)

方法定義

Policy getSchemaPolicy(String projectId, String schemaName)

方法定義

SearchResponse search(
    String namespaceId, 
    String query, 
    Integer pageSize, 
    String pageToken, 
    String orderBy
)

請求參數

查詢文法

• 查詢條件列表：

  查詢條件	說明
  name:foo	將 foo 作為子字串與實體名稱匹配
  description:bar	將 bar 作為子字串與實體描述匹配
  type=TABLE	必選。匹配特定類型的實體。當前支援 TABLE、RESOURCE、SCHEMA
  project=proj	僅搜尋指定單個 project 下的實體。要求調用方擁有該 project 的 SearchProject 許可權
  project=(proj1|proj2|proj3)	搜尋多個 project 下的實體（最多 512 個）。要求調用方同時擁有這些 projects 的 SearchProject 許可權
  region=region_id	搜尋指定 region 的 project 下的實體

  • project=proj 與 project=(proj1|proj2|proj3) 不能同時存在

  • region=region_id 不能與 project 查詢條件同時存在

排序方式（orderBy）

返回結果

{
  "entries": [SearchResultEntry],
  "nextPageToken": "string"
}

使用樣本

// 搜尋指定 project 下的所有表
SearchResponse response = client.search(
    "123456789",                            // namespaceId
    "type=TABLE,project=my_project",        // query
    50,                                     // pageSize
    "",                                     // pageToken
    "last_modified_time desc"               // orderBy
);

if (response.getEntries() != null) {
    for (SearchResultEntry entry : response.getEntries()) {
        System.out.println("Name: " + entry.getDisplayName());
        System.out.println("Type: " + entry.getType());
        System.out.println("Path: " + entry.getName());
    }
}