alibaba.airbi.cube.get.cube.info (alibaba.airbi.cube.get.cube.info)

获取数据集信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
rpc_context RpcContext 可选 基础参数
  • └ tenant_id
  • String
  • 可选
  • 1000
  • 租户ID
  • └ time_zone
  • String
  • 可选
  • Asia/Shanghai
  • 时区
  • └ app_access_key
  • String
  • 可选
  • app_access_key
  • 应用访问KEY
  • └ app_code
  • String
  • 可选
  • app_code
  • 应用code
  • └ locale
  • String
  • 可选
  • en
  • 语言
  • operator
  • UserInfo
  • 可选
  • 人员信息
  • 人员信息
  • └ work_no
  • String
  • 可选
  • 00001
  • 工号
  • └ auth_provider
  • String
  • 可选
  • mozi
  • 登陆态
  • └ corp_id
  • String
  • 可选
  • corp_id
  • 企业id
  • └ api_model
  • String
  • 可选
  • TOP
  • 接口模式
cube_code String 可选 cubeCode 数据集编码

响应参数

名称 类型 示例值 描述
result RpcResult result 返回结果
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ error_code
  • Number
  • 1000
  • 错误编码
  • └ error_msg
  • String
  • error_msg
  • 错误信息
  • content
  • CubeInfo
  • content
  • content
  • └ cube_code
  • String
  • cubeCode
  • 数据集编码
  • └ cube_name
  • String
  • cubeName
  • 数据集名称
  • └ is_sql_type
  • Boolean
  • false
  • 是否为手写sql
  • └ table_name
  • String
  • tableName
  • 物理表名
  • column_list
  • Column []
  • columnList
  • 数据列
  • └ column_code
  • String
  • columnCode
  • 字段编码
  • └ column_name
  • String
  • columnName
  • 物理列名
  • └ data_type
  • String
  • dataType
  • 字段类型
  • └ column_alias
  • String
  • columnAlias
  • 字段名称
  • └ select_sql
  • String
  • selectSql
  • 手写sql
  • └ is_accelerate
  • Boolean
  • false
  • 是否加速
  • └ namespace_code
  • String
  • namespaceCode
  • 所属空间编码
  • http_info
  • HttpInfo
  • http数据集配置
  • └ url
  • String
  • https://www.baidu.com
  • 请求url
  • └ header_param
  • String
  • {}
  • 请求header参数
  • └ cube_type
  • String
  • HTTP
  • 数据集类型
  • └ json_content
  • String
  • jsonStr
  • content的jsonStr

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAirbiCubeGetCubeInfoRequest req = new AlibabaAirbiCubeGetCubeInfoRequest();
AlibabaAirbiCubeGetCubeInfoRequest.RpcContext obj1 = new AlibabaAirbiCubeGetCubeInfoRequest.RpcContext();
obj1.setTenantId("1000");
obj1.setTimeZone("Asia/Shanghai");
obj1.setAppAccessKey("app_access_key");
obj1.setAppCode("app_code");
obj1.setLocale("en");
AlibabaAirbiCubeGetCubeInfoRequest.UserInfo obj2 = new AlibabaAirbiCubeGetCubeInfoRequest.UserInfo();
obj2.setWorkNo("00001");
obj2.setAuthProvider("mozi");
obj2.setCorpId("corp_id");
obj1.setOperator(obj2);
obj1.setApiModel("TOP");
req.setRpcContext(obj1);
req.setCubeCode("cubeCode");
AlibabaAirbiCubeGetCubeInfoResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_airbi_cube_get_cube_info_response>
    <result>
        <success>true</success>
        <error_code>1000</error_code>
        <error_msg>error_msg</error_msg>
        <content>
            <cube_code>cubeCode</cube_code>
            <cube_name>cubeName</cube_name>
            <is_sql_type>false</is_sql_type>
            <table_name>tableName</table_name>
            <column_list>
                <column>
                    <column_code>columnCode</column_code>
                    <column_name>columnName</column_name>
                    <data_type>dataType</data_type>
                    <column_alias>columnAlias</column_alias>
                </column>
            </column_list>
            <select_sql>selectSql</select_sql>
            <is_accelerate>false</is_accelerate>
            <namespace_code>namespaceCode</namespace_code>
            <http_info>
                <url>https://www.baidu.com</url>
                <header_param>{}</header_param>
            </http_info>
            <cube_type>HTTP</cube_type>
        </content>
        <json_content>jsonStr</json_content>
    </result>
</alibaba_airbi_cube_get_cube_info_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部