查询多种类型的表信息
功能介绍
从信息架构中查询多种类型的表信息,包括逻辑实体、物理表、维度表、事实表、汇总表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/design/all-tables
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
按名称或编码模糊查询。 |
create_by |
否 |
String |
按创建者查询。 |
status |
否 |
String |
业务状态。 枚举值:
|
sync_status |
否 |
String |
同步状态枚举。 枚举值:
|
sync_key |
否 |
Array of strings |
同步任务类型枚举。 枚举值:
|
biz_catalog_id |
否 |
String |
所属的业务分层的ID。 |
begin_time |
否 |
String |
时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效。格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
end_time |
否 |
String |
时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效。格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
limit |
否 |
Integer |
每页查询条数,即查询Y条数据。默认值50,取值范围[1,100]。 |
offset |
否 |
Integer |
查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整,默认值0。 |
biz_catalog_id_list |
否 |
Array of strings |
所属主题的ID列表,ID字符串。 |
biz_type_list |
是 |
Array of strings |
查询的表类型,必填。 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 使用Token认证时必选。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
X-Project-Id |
否 |
String |
项目ID,获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求,则该字段必选。 |
Content-Type |
否 |
String |
默认值:application/json;charset=UTF-8 可选,有Body体的情况下必选,没有Body体则无需填写和校验。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
data,统一的返回结果的最外层数据结构。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
l1的ID,ID字符串。 |
name |
String |
l1名称。 |
tb_logic_guid |
String |
表发布后对应的逻辑实体guid。 |
quality_id |
String |
质量ID。 |
reversed |
Boolean |
是否是逆向的。 |
partition_conf |
String |
分区表达式。 |
dirty_out_switch |
Boolean |
异常数据输出开关。 |
dirty_out_database |
String |
异常数据输出库。 |
dirty_out_prefix |
String |
异常表前缀。 |
dirty_out_suffix |
String |
异常表后缀。 |
tb_guid |
String |
表发布后对应的物理表guid。 |
code |
String |
编码。 |
create_by |
String |
创建人。 |
tenant_id |
String |
租户ID。 |
description |
String |
描述。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
biz_type |
String |
业务实体类型。 枚举值:
|
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
db_name |
String |
数据库名。 |
dw_type |
String |
数据连接类型,只读。 |
queue_name |
String |
dli数据连接执行sql所需的队列,数据连接类型为DLI时必须。 |
schema |
String |
DWS类型需要。 |
l1 |
String |
主题域分组。 |
l2 |
String |
主题域。 |
l3 |
String |
业务对象。 |
l1_id |
String |
主题域分组ID,只读,ID字符串。 |
l2_id |
String |
主题域ID。 |
l3_id |
String |
业务对象ID,只读,ID字符串。 |
new_biz |
BizVersionManageVO object |
业务版本管理,只读。 |
physical_table |
String |
生产环境创建表状态 |
dev_physical_table |
String |
开发环境创建表状态 |
technical_asset |
String |
技术资产同步状态,只读。 |
business_asset |
String |
业务资产同步状态,只读。 |
meta_data_link |
String |
资产关联状态,只读。 |
data_quality |
String |
质量作业状态,只读。 |
dlf_task |
String |
数据开发作业状态,只读。 |
materialization |
String |
码表数值落库状态,只读。 |
publish_to_dlm |
String |
DLM API生成状态,只读。 |
summary_status |
String |
同步整体状态,只读。 |
standard_count |
String |
标准数量,只读,ID字符串。 |
alias |
String |
别名。 |
api_id |
String |
汇总表API ID。 |
workspace_id |
String |
工作空间ID。 |
workspace_name |
String |
工作空间名称。 |
dev_version |
String |
开发环境版本,只读,ID字符串。 |
prod_version |
String |
生产环境版本,只读,ID字符串。 |
dev_version_name |
String |
开发环境版本名称,只读。 |
prod_version_name |
String |
生产环境版本名称,只读。 |
env_type |
String |
开发生产环境类型。 枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
ID信息,ID字符串。 |
biz_type |
String |
业务实体类型。 枚举值:
|
biz_id |
String |
业务ID,ID字符串。 |
biz_info |
String |
业务对象信息。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
biz_version |
Integer |
业务版本,只读。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
请求示例
从信息架构中查询逻辑实体、物理表、维度表、事实表、汇总表的前十条数据。
GET https://{endpoint}/v2/{project_id}/design/all-tables?offset=1&limit=10&biz_type_list=TABLE_MODEL_LOGIC&biz_type_list=TABLE_MODEL&biz_type_list=DIMENSION_LOGIC_TABLE&biz_type_list=FACT_LOGIC_TABLE&biz_type_list=AGGREGATION_LOGIC_TABLE&advOnInitFlg=true
响应示例
状态码: 200
Success,返回data数据是AllTableVO列表。
{ "data" : { "value" : { "total" : 86, "records" : [ { "id" : "1229920251379118081", "name" : "test_czh_0416", "tb_logic_guid" : "", "quality_id" : "1230938508982857728", "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_czh_0416", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "OFFLINE", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-16T22:23:59+08:00", "update_time" : "2024-04-19T17:55:49+08:00", "db_name" : "bi", "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : "test_czh_catalog", "l2" : null, "l3" : null, "l1_id" : "1194966710038474752", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "CREATE_SUCCESS", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1229812609512062976", "name" : "test_czh_sl_003", "tb_logic_guid" : "86ddea4c-0dda-4a7e-8ca1-a3ddce64ad97", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_czh_sl_003", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-16T15:16:15+08:00", "update_time" : "2024-04-17T17:07:55+08:00", "db_name" : null, "dw_type" : "UNSPECIFIED", "queue_name" : null, "schema" : null, "l1" : "test_czh2", "l2" : null, "l3" : null, "l1_id" : "1170064724101115904", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "NO_NEED", "dev_physical_table" : "NO_NEED", "technical_asset" : "NO_NEED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "NO_NEED", "data_quality" : "CREATE_FAILED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_SUCCESS", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1229812231022243840", "name" : "test_czh_sl_002", "tb_logic_guid" : "bafa9927-9f2b-4197-b8fa-cc94338b707b", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_czh_sl_002", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-16T15:14:45+08:00", "update_time" : "2024-04-16T15:14:52+08:00", "db_name" : null, "dw_type" : "UNSPECIFIED", "queue_name" : null, "schema" : null, "l1" : "test_czh2", "l2" : null, "l3" : null, "l1_id" : "1170064724101115904", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "NO_NEED", "dev_physical_table" : "NO_NEED", "technical_asset" : "NO_NEED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "NO_NEED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_SUCCESS", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1229805021919621120", "name" : "test_czh_sl_001", "tb_logic_guid" : "cec6e323-ec00-457a-aaee-9ec931326bc7", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_czh_sl_001", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-16T14:46:06+08:00", "update_time" : "2024-04-16T14:50:34+08:00", "db_name" : null, "dw_type" : "UNSPECIFIED", "queue_name" : null, "schema" : null, "l1" : "test_czh_catalog", "l2" : null, "l3" : null, "l1_id" : "1194966710038474752", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "NO_NEED", "dev_physical_table" : "NO_NEED", "technical_asset" : "NO_NEED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "NO_NEED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_SUCCESS", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1226973789422813184", "name" : "test_0408_004", "tb_logic_guid" : "40322535-e903-44e1-a0c0-f79573fc09e6", "quality_id" : "1227637237613944833", "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_0408_004", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-08T19:15:47+08:00", "update_time" : "2024-04-10T15:12:17+08:00", "db_name" : null, "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : "测试主题", "l2" : null, "l3" : null, "l1_id" : "1170064658061799424", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "CREATE_SUCCESS", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1226973648695504896", "name" : "test_0408_003", "tb_logic_guid" : "d6b610a5-de9f-43f6-b3ef-aa4bc23ae766", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_0408_003", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-08T19:15:14+08:00", "update_time" : "2024-04-08T19:18:36+08:00", "db_name" : null, "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : "我的测试", "l2" : null, "l3" : null, "l1_id" : "1178033294286176256", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1226923543347003392", "name" : "test_0408_002", "tb_logic_guid" : "b11128db-ba65-40b6-99a5-6103106fac79", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_0408_002", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-08T15:56:08+08:00", "update_time" : "2024-04-08T19:14:09+08:00", "db_name" : null, "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : "test_czh2", "l2" : null, "l3" : null, "l1_id" : "1170064724101115904", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1226923406239399936", "name" : "test_0408", "tb_logic_guid" : "", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_0408", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "DRAFT", "biz_type" : "TABLE_MODEL", "create_time" : "2024-04-08T15:55:35+08:00", "update_time" : "2024-04-19T17:22:02+08:00", "db_name" : null, "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : "test_import", "l2" : null, "l3" : null, "l1_id" : "1193142949320474624", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1222930979413499904", "name" : "test_czh_0328", "tb_logic_guid" : "712edcdd-3bba-4077-b182-4a1f17e5bcd8", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "dim_test_czh_0328", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "DIMENSION_LOGIC_TABLE", "create_time" : "2024-03-28T15:31:06+08:00", "update_time" : "2024-03-28T15:31:10+08:00", "db_name" : "bi", "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : "test_czh_catalog", "l2" : null, "l3" : null, "l1_id" : "1194966710038474752", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : null, "alias" : "", "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" }, { "id" : "1222853173564289024", "name" : "test_czh_0328", "tb_logic_guid" : "", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_czh_0328", "create_by" : "test_uesr", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "OFFLINE", "biz_type" : "TABLE_MODEL", "create_time" : "2024-03-28T10:21:56+08:00", "update_time" : "2024-04-19T17:55:50+08:00", "db_name" : "bi", "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : "test_czh_catalog", "l2" : null, "l3" : null, "l1_id" : "1194966710038474752", "l2_id" : null, "l3_id" : null, "new_biz" : null, "physical_table" : "CREATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "CREATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : null, "alias" : null, "api_id" : "0", "workspace_id" : null, "workspace_name" : null, "dev_version" : null, "prod_version" : null, "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" } ] } } }
状态码: 400
{ "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." }
状态码: 401
{ "error_code" : "DS.60xx", "error_msg" : "User authentication failed." }
状态码: 403
{ "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListAllTablesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListAllTablesRequest request = new ListAllTablesRequest(); try { ListAllTablesResponse response = client.listAllTables(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAllTablesRequest() response = client.list_all_tables(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAllTablesRequest{} response, err := client.ListAllTables(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success,返回data数据是AllTableVO列表。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |