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());
    }
}