'1.0',
'info' => [
'style' => 'RPC',
'product' => 'dataworks-public',
'version' => '2018-06-01',
],
'directories' => [
[
'id' => 60061,
'title' => '流程',
'type' => 'directory',
'children' => [
'CreateManualDag',
'DeleteFile',
'SearchManualDagNodeInstance',
],
],
[
'id' => 60066,
'title' => 'HIVE',
'type' => 'directory',
'children' => [
'DescribeEmrHiveTable',
'ListEmrHiveAuditLogs',
'ListEmrHiveDatabases',
'ListEmrHiveTables',
'ListHiveTableLineages',
'ListHiveColumnLineages',
'ListTablePartitions',
],
],
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
'children' => [
'OpenDataWorksStandardService',
'SendTaskMetaCallback',
'SetSwitchValue',
'GetDataServiceApiContext',
'GetDataServiceContextUpdateEvent',
'GetDataServiceConnection',
'GetDataServiceApiAuthMapContext',
'GetDataServiceFunction',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateManualDag' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '78125',
'abilityTreeNodes' => [
'FEATUREdideVFMENL',
],
],
'parameters' => [
[
'name' => 'ProjectName',
'in' => 'query',
'schema' => [
'description' => '项目名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test_project',
],
],
[
'name' => 'FlowName',
'in' => 'query',
'schema' => [
'description' => '手动业务流程名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test_flow',
],
],
[
'name' => 'DagPara',
'in' => 'query',
'schema' => [
'description' => '业务流程参数。',
'type' => 'string',
'required' => false,
'example' => 'param_k1=param_v1 param_k2=param_v2',
],
],
[
'name' => 'NodePara',
'in' => 'query',
'schema' => [
'description' => '节点参数,节点ID到节点参数的map。如果节点有多个参数,在节点参数值中用空格分隔。',
'type' => 'string',
'required' => false,
'example' => '{"103180025": "test=$[yyyy-mm-dd]"}',
],
],
[
'name' => 'Bizdate',
'in' => 'query',
'schema' => [
'description' => '业务日期。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-12-12 00:00:00',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ReturnCode' => [
'description' => '响应代码编号,0标识成功。',
'type' => 'string',
'example' => '0',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2d9ce-38ef-4923-baf6-391a7e656',
],
'ReturnValue' => [
'description' => '返回值,此处返回手动业务流程的运行实例ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1244311235',
],
'ReturnErrorSolution' => [
'description' => '如果异常,会显示异常的解决方案信息。',
'type' => 'string',
'example' => 'test',
],
'ReturnMessage' => [
'description' => '异常信息。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ReturnCode\\": \\"0\\",\\n \\"RequestId\\": \\"2d9ce-38ef-4923-baf6-391a7e656\\",\\n \\"ReturnValue\\": 1244311235,\\n \\"ReturnErrorSolution\\": \\"test\\",\\n \\"ReturnMessage\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nD394A-96-4C7-96E-FCDEB0AB3\\r\\n\\t0\\r\\n\\t\\r\\n\\t\\r\\n\\t13245685\\r\\n","errorExample":""}]',
'title' => '触发手动业务流程执行',
'summary' => '触发手动业务流程执行。',
'description' => 'CreateManualDag不支持开发环境调用,仅支持生产环境调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteFile' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '78128',
'abilityTreeNodes' => [
'FEATUREdide8FM783',
],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'type' => 'integer',
'format' => 'int32',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'ErrorCode' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'Forbidden.Access',
'errorMessage' => 'Access is forbidden. Activate DataWorks first.',
],
[
'errorCode' => 'ResourceNotAuthorized.Api',
'errorMessage' => 'You are not authorized to access the resources.',
],
],
429 => [
[
'errorCode' => 'Throttling.Api',
'errorMessage' => 'The request for this resource has exceeded your available limit.',
],
[
'errorCode' => 'Throttling.System',
'errorMessage' => 'The DataWorks system is busy. Try again later.',
],
[
'errorCode' => 'Throttling.User',
'errorMessage' => 'Your request is too frequent. Try again later.',
],
],
500 => [
[
'errorCode' => 'InternalError.System',
'errorMessage' => 'An internal system error occurred. Try again later.',
],
[
'errorCode' => 'InternalError.UserId.Missing',
'errorMessage' => 'An internal system error occurred. Try again later.',
],
],
],
'responseDemo' => '',
],
'SearchManualDagNodeInstance' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '78147',
'abilityTreeNodes' => [
'FEATUREdide7WF1GB',
],
],
'parameters' => [
[
'name' => 'ProjectName',
'in' => 'query',
'schema' => [
'description' => '项目名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test_odps_project',
],
],
[
'name' => 'DagId',
'in' => 'query',
'schema' => [
'description' => '手动业务流程运行实例ID,**createManualDag**接口返回的值。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '123434234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2d9ced66-38ef-4923-baf6-391dd3a7e656',
],
'ErrMsg' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'test',
],
'ErrCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NodeInsInfo' => [
'description' => '返回的手动业务流程内部运行任务的列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态:'."\n"
."\n"
.'- 未运行:上游实例未全部成功。例如,NOT_RUN(1, "未运行")。'."\n"
."\n"
.'- 等待定时时间(dueTime/cycleTime)到来。例如,WAIT_TIME(2, "等待时间")。'."\n"
."\n"
.'- 已经下发到执行引擎,在等待排队调度执行。例如,WAIT_RESOURCE(3, "等待资源")。'."\n"
."\n"
.'- 执行中。例如,RUNNING(4, "运行中")。'."\n"
."\n"
.'- 执行完毕,已经下发进行数据校验。例如,CHECKING(7, "校验中")。'."\n"
."\n"
.'- 执行完毕,正在进行分支条件校验。例如,CHECKING_CONDITION(8, "条件检测中")。'."\n"
."\n"
.'- 执行失败。例如,FAILURE(5, "运行失败")。'."\n"
."\n"
.'- 执行成功。例如,SUCCESS(6, "运行成功")。',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'BeginRunningTime' => [
'description' => '开始运行时间。',
'type' => 'string',
'example' => '2018-12-12 00:00:00',
],
'FinishTime' => [
'description' => '任务结束时间。',
'type' => 'string',
'example' => '2018-12-12 00:00:00',
],
'ParaValue' => [
'description' => '任务参数信息。',
'type' => 'string',
'example' => 'param_k1=param_v1',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2018-12-12 00:00:00',
],
'DagId' => [
'description' => '业务流程运行实例ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12434232423',
],
'InstanceId' => [
'description' => '任务实例ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12322434112',
],
'BeginWaitResTime' => [
'description' => '开始等待资源的时间点。',
'type' => 'string',
'example' => '2018-12-12 00:00:00',
],
'DagType' => [
'description' => '业务流程类型,5标识手动业务流程。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'NodeName' => [
'description' => '任务节点名称。',
'type' => 'string',
'example' => 'test_node',
],
'Bizdate' => [
'description' => '业务日期。',
'type' => 'string',
'example' => '2018-12-12 00:00:00',
],
'BeginWaitTimeTime' => [
'description' => '开始等待时间的时间点。',
'type' => 'string',
'example' => '2018-12-12 00:00:00',
],
'ModifyTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2018-12-12 00:00:00',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2d9ced66-38ef-4923-baf6-391dd3a7e656\\",\\n \\"ErrMsg\\": \\"test\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NodeInsInfo\\": [\\n {\\n \\"Status\\": 6,\\n \\"BeginRunningTime\\": \\"2018-12-12 00:00:00\\",\\n \\"FinishTime\\": \\"2018-12-12 00:00:00\\",\\n \\"ParaValue\\": \\"param_k1=param_v1\\",\\n \\"CreateTime\\": \\"2018-12-12 00:00:00\\",\\n \\"DagId\\": 12434232423,\\n \\"InstanceId\\": 12322434112,\\n \\"BeginWaitResTime\\": \\"2018-12-12 00:00:00\\",\\n \\"DagType\\": 5,\\n \\"NodeName\\": \\"test_node\\",\\n \\"Bizdate\\": \\"2018-12-12 00:00:00\\",\\n \\"BeginWaitTimeTime\\": \\"2018-12-12 00:00:00\\",\\n \\"ModifyTime\\": \\"2018-12-12 00:00:00\\"\\n }\\n ]\\n }\\n}","errorExample":" {}"},{"type":"xml","example":"\\r\\n \\r\\n\\t\\t1564019679966\\r\\n\\t\\t1564019679966\\r\\n\\t\\t1564019679506\\r\\n\\t\\t1559318400000\\r\\n\\t\\t1564019679464\\r\\n\\t\\t332455685\\r\\n\\t\\t5\\r\\n\\t\\t1564019679966\\r\\n\\t\\t2427622331\\r\\n\\t\\t1564019679966\\r\\n\\t\\tvi\\r\\n\\t\\t6\\r\\n\\t\\r\\n\\t0\\r\\n\\t\\r\\n\\tE1729535-8C06-43F6-B1EA-6236F60A68E9\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => '查询已触发的手动业务流程信息',
'summary' => '状态和名称等信息,包括运行中和运行完成的实例。',
'description' => '**endpoint**:dataworks.[RegionId].aliyuncs.com '."\n"
.'> [RegionId] 指具体的某个Region,例如cn-shanghai、cn-beijing。'."\n"
."\n"
.'**product**:dataworks-public'."\n"
."\n"
.'SearchManualDagNodeInstance不支持开发环境调用,仅支持生产环境调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeEmrHiveTable' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'EMR集群的ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'C-D033DD5FB82436A6',
],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => [
'description' => 'EMR Hive数据库的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'default',
],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => [
'description' => 'EMR Hive表的名称。',
'type' => 'string',
'required' => false,
'example' => 'pt_table_090901_emr',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'test',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E6F0DBDD-5AD8-4870-A6A0',
],
'ErrorCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'TableParameters' => [
'description' => 'HIVE表的参数JSON串。',
'type' => 'string',
'example' => '{\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}',
],
'Owner' => [
'description' => '所有者。',
'type' => 'string',
'example' => 'root',
],
'TableName' => [
'description' => 'EMR Hive表的名称。',
'type' => 'string',
'example' => 'pt_table_090901_emr',
],
'TableDesc' => [
'description' => '表的描述信息。',
'type' => 'string',
'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA',
],
'IsCompressed' => [
'description' => '是否压缩。',
'type' => 'boolean',
'example' => 'false',
],
'GmtModified' => [
'description' => '修改时间,指元数据信息。',
'type' => 'string',
'example' => '2019-09-09 20:41:28',
],
'SerializationLib' => [
'description' => '序列化反序列化设置。',
'type' => 'string',
'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe',
],
'OwnerId' => [
'description' => '所有者的Aliyun UID。',
'type' => 'string',
'example' => '1861276710322536',
],
'TableSize' => [
'description' => '以字节为单位的表的物理大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '552',
],
'LastAccessTime' => [
'description' => '最后的访问时间。',
'type' => 'string',
'example' => '1970-01-01 08:00:00',
],
'TableComment' => [
'description' => '表的注释信息。',
'type' => 'string',
'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA',
],
'LastModifyTime' => [
'description' => '最后的修改时间。',
'type' => 'string',
'example' => '2019-09-09 20:23:47',
],
'DatabaseName' => [
'description' => 'Hive数据库的名称。',
'type' => 'string',
'example' => 'default',
],
'IsTemporary' => [
'description' => '是否为临时表。',
'type' => 'boolean',
'example' => 'false',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-09-09 20:41:28',
],
'OutputFormat' => [
'description' => 'Hive表的输出格式。',
'type' => 'string',
'example' => 'org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat',
],
'TableType' => [
'description' => '表的类型。',
'type' => 'string',
'example' => 'MANAGED_TABLE',
],
'OwnerType' => [
'description' => 'Owner类型。',
'type' => 'string',
'example' => 'USER',
],
'PartitionKeys' => [
'description' => '分区字段的名称列表。',
'type' => 'string',
'example' => 'DS,HR,REGION',
],
'ClusterBizId' => [
'description' => 'EMR集群的ID。',
'type' => 'string',
'example' => 'C-D033DD5FB82436A6',
],
'Location' => [
'description' => 'HDFS或OSS等存放路径。',
'type' => 'string',
'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr',
],
'ClusterBizName' => [
'description' => 'EMR集群的名称。',
'type' => 'string',
'example' => 'EHMC测试',
],
'InputFormat' => [
'description' => 'Hive表的输入格式。',
'type' => 'string',
'example' => 'org.apache.hadoop.mapred.TextInputFormat',
],
'Columns' => [
'description' => '字段列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ColumnName' => [
'description' => '字段的名称。',
'type' => 'string',
'example' => 'double',
],
'ColumnComment' => [
'description' => '字段的注释。',
'type' => 'string',
'example' => 'BALANCE FIELD',
],
'Comment' => [
'description' => '字段的注释。',
'type' => 'string',
'example' => 'BALANCE FIELD',
],
'ColumnType' => [
'description' => '字段的数据类型。',
'type' => 'string',
'example' => 'double',
],
'GmtCreate' => [
'description' => '创建时间,指元数据信息。',
'type' => 'string',
'example' => '2019-09-09 20:23:47',
],
'GmtModified' => [
'description' => '修改时间,指元数据信息。',
'type' => 'string',
'example' => '2019-09-09 20:23:47',
],
'ColumnPosition' => [
'description' => '字段的位置。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"TableParameters\\": \\"{\\\\\\\\\\\\\\"transient_lastDdlTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1568031823\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bucketing_version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\\\\\\\\\\\\\"}\\",\\n \\"Owner\\": \\"root\\",\\n \\"TableName\\": \\"pt_table_090901_emr\\",\\n \\"TableDesc\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"IsCompressed\\": false,\\n \\"GmtModified\\": \\"2019-09-09 20:41:28\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"OwnerId\\": \\"1861276710322536\\",\\n \\"TableSize\\": 552,\\n \\"LastAccessTime\\": \\"1970-01-01 08:00:00\\",\\n \\"TableComment\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"LastModifyTime\\": \\"2019-09-09 20:23:47\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"IsTemporary\\": false,\\n \\"GmtCreate\\": \\"2019-09-09 20:41:28\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": \\"DS,HR,REGION\\",\\n \\"ClusterBizId\\": \\"C-D033DD5FB82436A6\\",\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr\\",\\n \\"ClusterBizName\\": \\"EHMC测试\\",\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.TextInputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"double\\",\\n \\"ColumnComment\\": \\"BALANCE FIELD\\",\\n \\"Comment\\": \\"BALANCE FIELD\\",\\n \\"ColumnType\\": \\"double\\",\\n \\"GmtCreate\\": \\"2019-09-09 20:23:47\\",\\n \\"GmtModified\\": \\"2019-09-09 20:23:47\\",\\n \\"ColumnPosition\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0\\nsuccess\\n6212847D-86BE-4E5D-A147-FF5****\\n\\n C-D033DD5FB8****\\n pt_table_090901_emr\\n MANAGED_TABLE\\n 552\\n root\\n \\n false\\n org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\n org.apache.hadoop.mapred.TextInputFormat\\n org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\\n hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr\\n 1970-01-01 08:00:00\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\n {\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}\\n DS,HR,REGION\\n false\\n EHMC测试****\\n default\\n 1861276****\\n RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\n 2019-09-09 20:23:47\\n \\n 4\\n gender\\n boolean\\n GENDER FIELD\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n GENDER FIELD\\n \\n \\n 3\\n balance\\n double\\n BALANCE FIELD\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n BALANCE FIELD\\n \\n \\n 2\\n age\\n bigint\\n AGE FIELD\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n AGE FIELD\\n \\n \\n 2\\n REGION\\n string\\n PARTITIONED BY REGION\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n PARTITIONED BY REGION\\n \\n \\n 1\\n tag\\n string\\n TAG FIELD\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n TAG FIELD\\n \\n \\n 1\\n HR\\n string\\n PARTITIONED BY SINGLE DAY HOUR\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n PARTITIONED BY SINGLE DAY HOUR\\n \\n \\n 0\\n name\\n string\\n NAME FIELD\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n NAME FIELD\\n \\n \\n 0\\n DS\\n string\\n PARTITIONED BY SINGLE DAY\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n PARTITIONED BY SINGLE DAY\\n \\n \\n 5\\n birthday\\n string\\n BIRTHDAY FIELD\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n BIRTHDAY FIELD\\n \\n","errorExample":""}]',
'title' => '获取EMR HIVE表元数据详情信息',
'summary' => '获取EMR HIVE表元数据的详情信息,包括Column列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListEmrHiveAuditLogs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'EMR集群的标识。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'C-D033DD5FB82436A6',
],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => [
'description' => '数据库的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'default',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '2',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页宽(每页记录数量)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '2',
],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => [
'description' => '表的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test_table',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '表示开始时间(10位时间戳),EndTime-StartTime需要满足小于等于86400。'."\n"
.'两个输入值可以同时为空,返回(current-86400, current)时间段内的审计日志。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1586509407',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '表示结束时间(10位时间戳),EndTime-StartTime需要满足小于等于86400。'."\n"
.'两个输入值可以同时为空,返回(current-86400, current)时间段内的审计日志。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1586509710',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求标识。',
'type' => 'string',
'example' => '58D5334A-B013-430E',
],
'ErrorCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PageSize' => [
'description' => '页宽(每页记录数量)。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总记录量。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'PagedData' => [
'description' => '分页获取的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Operation' => [
'description' => '操作。',
'type' => 'string',
'example' => 'CREATE_TABLE',
],
'User' => [
'description' => '用户。',
'type' => 'string',
'example' => 'root',
],
'EventTime' => [
'description' => '事件的发生时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1564019679506',
],
'Table' => [
'description' => '数据表。',
'type' => 'string',
'example' => 'test_table',
],
'Database' => [
'description' => '数据库。',
'type' => 'string',
'example' => 'default',
],
'Groups' => [
'type' => 'array',
'items' => [
'description' => '用户组。',
'type' => 'string',
'example' => 'root',
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 5,\\n \\"PagedData\\": [\\n {\\n \\"Operation\\": \\"CREATE_TABLE\\",\\n \\"User\\": \\"root\\",\\n \\"EventTime\\": 1564019679506,\\n \\"Table\\": \\"test_table\\",\\n \\"Database\\": \\"default\\",\\n \\"Groups\\": [\\n \\"root\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0\\nsuccess\\nE6F0DBDD-5AD8-4870-A6A0-B8FD5B****\\n\\n 2\\n 2\\n 5\\n \\n wj_db_01\\n root\\n CREATE_TABLE\\n \\n root\\n \\n","errorExample":""}]',
'title' => '查看Hive元数据的审计日志',
'summary' => '查看Hive元数据的审计日志。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListEmrHiveDatabases' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'EMR集群的ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'C-D033DD5FB82436A6',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'test',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D9A61DC0-B922-421B-B706',
],
'ErrorCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '数据库的类型。',
'type' => 'string',
'example' => 'HIVE',
],
'Status' => [
'description' => '数据库的状态。',
'type' => 'string',
'example' => '-',
],
'Owner' => [
'description' => '数据库的所有者。',
'type' => 'string',
'example' => 'public',
],
'Comment' => [
'description' => 'Hive数据库的注释。',
'type' => 'string',
'example' => 'Default Hive database',
],
'GmtModified' => [
'description' => '修改时间戳,指元数据信息。',
'type' => 'integer',
'format' => 'int64',
'example' => '1568010630000',
],
'OwnerId' => [
'description' => '数据库所有者的Aliyun Uid。',
'type' => 'string',
'example' => '18612767',
],
'Parameters' => [
'description' => 'Hive数据库参数JSON串。',
'type' => 'string',
'example' => '{}',
],
'Region' => [
'description' => 'Hive数据库所属集群的所在地域。',
'type' => 'string',
'example' => 'cn-shanghai',
],
'GmtCreate' => [
'description' => '创建时间戳,指元数据信息。',
'type' => 'integer',
'format' => 'int64',
'example' => '1568010630000',
],
'OwnerType' => [
'description' => '所有者的类型。',
'type' => 'string',
'example' => 'ROLE',
],
'Name' => [
'description' => 'Hive数据库的名称。',
'type' => 'string',
'example' => 'default',
],
'Location' => [
'description' => 'Hive数据库的存储位置。',
'type' => 'string',
'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"D9A61DC0-B922-421B-B706\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": [\\n {\\n \\"Type\\": \\"HIVE\\",\\n \\"Status\\": \\"-\\",\\n \\"Owner\\": \\"public\\",\\n \\"Comment\\": \\"Default Hive database\\",\\n \\"GmtModified\\": 1568010630000,\\n \\"OwnerId\\": \\"18612767\\",\\n \\"Parameters\\": \\"{}\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"GmtCreate\\": 1568010630000,\\n \\"OwnerType\\": \\"ROLE\\",\\n \\"Name\\": \\"default\\",\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0\\nsuccess\\nD9A61DC0-B922-421B-B706-B2****\\n\\n default\\n HIVE\\n public\\n 18612767****\\n Default Hive database\\n hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse\\n \\n {}\\n 1568010630000\\n 1568010630000\\n ROLE\\n cn-shanghai\\n\\n\\n house_db_0909\\n HIVE\\n root\\n 18612767103****\\n ?????0909\\n hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/house_db_0909.db\\n \\n {}\\n 1568010341000\\n 1568010341000\\n USER\\n cn-shanghai\\n\\n\\n twitter_db\\n HIVE\\n admin\\n 1861276710****\\n hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/twitter_db.db\\n \\n {}\\n 1568178228000\\n 1568178228000\\n USER\\n cn-shanghai\\n","errorExample":""}]',
'title' => '获取EMR集群下Hive数据库列表',
'summary' => '获取EMR集群下的Hive数据库列表(不分页)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListEmrHiveTables' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'EMR集群的ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'C-D033DD5FB82436A6',
],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => [
'description' => 'EMR Hive数据库的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'default',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '2',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页宽(每页记录数量)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'test',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E6F0DBDD-5AD8-4870-A6A0',
],
'ErrorCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PageSize' => [
'description' => '页宽(每页记录数量)。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总记录量。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'PagedData' => [
'description' => '分页获取的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TableParameters' => [
'description' => 'Hive表参数JSON串。',
'type' => 'string',
'example' => '{\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}',
],
'Owner' => [
'description' => '所有者。',
'type' => 'string',
'example' => 'root',
],
'TableName' => [
'description' => '表的名称。',
'type' => 'string',
'example' => 'pt_table_090901_emr_orc',
],
'TableDesc' => [
'description' => '表的描述信息。',
'type' => 'string',
'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA',
],
'IsCompressed' => [
'description' => '是否启用了压缩。',
'type' => 'boolean',
'example' => 'false',
],
'GmtModified' => [
'description' => '编辑时间,指元数据。',
'type' => 'string',
'example' => '2019-09-09 20:23:47',
],
'SerializationLib' => [
'description' => 'Hive表的序列化、反序列化设置。',
'type' => 'string',
'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe',
],
'OwnerId' => [
'description' => '所有者的Aliyun Uid。',
'type' => 'string',
'example' => '18612767103****',
],
'LastAccessTime' => [
'description' => '最后访问的时间。',
'type' => 'string',
'example' => '1970-01-01 08:00:00',
],
'TableComment' => [
'description' => '表注释,同表在Hive库中的Comment。',
'type' => 'string',
'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA',
],
'LastModifyTime' => [
'description' => '最后修改的时间。',
'type' => 'string',
'example' => '2019-09-09 20:23:47',
],
'DatabaseName' => [
'description' => '表所在数据库的名称。',
'type' => 'string',
'example' => 'default',
],
'IsTemporary' => [
'description' => '是否为临时表。',
'type' => 'boolean',
'example' => 'false',
],
'GmtCreate' => [
'description' => '创建时间,指元数据。',
'type' => 'string',
'example' => '2019-09-09 20:23:47',
],
'OutputFormat' => [
'description' => '表的输出格式。',
'type' => 'string',
'example' => 'org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat',
],
'TableType' => [
'description' => '表的类型。',
'type' => 'string',
'example' => 'MANAGED_TABLE',
],
'OwnerType' => [
'description' => '所有者的类型。',
'type' => 'string',
'example' => 'ROLE',
],
'PartitionKeys' => [
'description' => '分区字段列表(仅限分区表)。',
'type' => 'string',
'example' => 'DS,HR,REGION',
],
'ClusterBizId' => [
'description' => 'EMR集群的标识。',
'type' => 'string',
'example' => 'C-D033DD5FB82436A6',
],
'Location' => [
'description' => '表的存储路径。',
'type' => 'string',
'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr',
],
'ClusterBizName' => [
'description' => 'EMR集群的名称。',
'type' => 'string',
'example' => 'EHMC测试',
],
'InputFormat' => [
'description' => '表的输入格式。',
'type' => 'string',
'example' => 'org.apache.hadoop.hive.ql.io.orc.OrcInputFormat',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 5,\\n \\"PagedData\\": [\\n {\\n \\"TableParameters\\": \\"{\\\\\\\\\\\\\\"transient_lastDdlTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1568031823\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bucketing_version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\\\\\\\\\\\\\"}\\",\\n \\"Owner\\": \\"root\\",\\n \\"TableName\\": \\"pt_table_090901_emr_orc\\",\\n \\"TableDesc\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"IsCompressed\\": false,\\n \\"GmtModified\\": \\"2019-09-09 20:23:47\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"OwnerId\\": \\"18612767103****\\",\\n \\"LastAccessTime\\": \\"1970-01-01 08:00:00\\",\\n \\"TableComment\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"LastModifyTime\\": \\"2019-09-09 20:23:47\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"IsTemporary\\": false,\\n \\"GmtCreate\\": \\"2019-09-09 20:23:47\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"OwnerType\\": \\"ROLE\\",\\n \\"PartitionKeys\\": \\"DS,HR,REGION\\",\\n \\"ClusterBizId\\": \\"C-D033DD5FB82436A6\\",\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr\\",\\n \\"ClusterBizName\\": \\"EHMC测试\\",\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.orc.OrcInputFormat\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0\\nsuccess\\nE6F0DBDD-5AD8-4870-A6A0-B8FD5B****\\n\\n 2\\n 2\\n 5\\n \\n C-D033DD5FB****\\n pt_table_090901_emr_orc\\n MANAGED_TABLE\\n root\\n \\n false\\n org.apache.hadoop.hive.ql.io.orc.OrcSerde\\n org.apache.hadoop.hive.ql.io.orc.OrcInputFormat\\n org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat\\n hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_orc\\n 1970-01-01 08:00:00\\n 2019-09-09 20:41:28\\n 2019-09-09 20:41:28\\n RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\n {\\"orc.compress\\":\\"ZLIB\\",\\"transient_lastDdlTime\\":\\"1568032884\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}\\n DS,HR,REGION\\n false\\n EHMC测试****\\n default\\n 18612767****\\n 2019-09-09 20:41:28\\n RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\n \\n \\n C-D033DD5FB8****\\n pt_table_090901_emr\\n MANAGED_TABLE\\n root\\n \\n false\\n org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\n org.apache.hadoop.mapred.TextInputFormat\\n org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\\n hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr\\n 1970-01-01 08:00:00\\n 2019-09-09 20:23:47\\n 2019-09-09 20:23:47\\n RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\n {\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}\\n DS,HR,REGION\\n false\\n EHMC测试****\\n default\\n 1861276710322536\\n 2019-09-09 20:23:47\\n RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\n \\n","errorExample":""}]',
'title' => '获取集群指定库下的Hive表列表',
'summary' => '获取集群指定库下的Hive表列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListHiveTableLineages' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'EMR集群的ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'C-D033DD5FB82436A6',
],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => [
'description' => 'EMR HIVE数据库的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'default',
],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => [
'description' => 'EMR HIVE表的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pt_table_090901_emr',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'test',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '691CA452-D37A-4ED0-9441',
],
'ErrorCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'UpstreamNumber' => [
'description' => '上游血缘的数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DownstreamNumber' => [
'description' => '下游血缘的数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'UpstreamLineages' => [
'description' => '上游血缘列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TableName' => [
'description' => '表的名称。',
'type' => 'string',
'example' => 'pt_table_090901_emr_orc',
],
'ModifiedTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-01-09 18:16:37',
],
'QueryText' => [
'description' => '任务对应的语句。',
'type' => 'string',
'example' => 'create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr',
],
'JobId' => [
'description' => '任务的ID。',
'type' => 'string',
'example' => 'job_1234567055_0006',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-01-09 18:16:15',
],
'DatabaseName' => [
'description' => '数据库的名称。',
'type' => 'string',
'example' => 'default',
],
'Engine' => [
'description' => '引擎信息。',
'type' => 'string',
'example' => 'mr',
],
'Source' => [
'description' => '血缘来源,例如HIVE。',
'type' => 'string',
'example' => 'HIVE',
],
'ClusterId' => [
'description' => 'EMR集群的标识。',
'type' => 'string',
'example' => 'C-D033DD5FB82436A6',
],
],
],
],
'DownstreamLineages' => [
'description' => '下游血缘列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TableName' => [
'description' => '表的名称。',
'type' => 'string',
'example' => 'pt_table_090901_emr_orc',
],
'ModifiedTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-01-09 18:16:37',
],
'QueryText' => [
'description' => '任务对应的语句。',
'type' => 'string',
'example' => 'create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr',
],
'JobId' => [
'description' => '任务的ID。',
'type' => 'string',
'example' => 'job_1234567055_0006',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-01-09 18:16:15',
],
'DatabaseName' => [
'description' => '数据库的名称。',
'type' => 'string',
'example' => 'default',
],
'Engine' => [
'description' => '引擎信息。',
'type' => 'string',
'example' => 'mr',
],
'Source' => [
'description' => '血缘来源,例如HIVE。',
'type' => 'string',
'example' => 'HIVE',
],
'ClusterId' => [
'description' => 'EMR集群的标识。',
'type' => 'string',
'example' => 'C-D033DD5FB82436A6',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"UpstreamNumber\\": 0,\\n \\"DownstreamNumber\\": 3,\\n \\"UpstreamLineages\\": [\\n {\\n \\"TableName\\": \\"pt_table_090901_emr_orc\\",\\n \\"ModifiedTime\\": \\"2020-01-09 18:16:37\\",\\n \\"QueryText\\": \\"create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr\\",\\n \\"JobId\\": \\"job_1234567055_0006\\",\\n \\"CreateTime\\": \\"2020-01-09 18:16:15\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"Engine\\": \\"mr\\",\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ],\\n \\"DownstreamLineages\\": [\\n {\\n \\"TableName\\": \\"pt_table_090901_emr_orc\\",\\n \\"ModifiedTime\\": \\"2020-01-09 18:16:37\\",\\n \\"QueryText\\": \\"create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr\\",\\n \\"JobId\\": \\"job_1234567055_0006\\",\\n \\"CreateTime\\": \\"2020-01-09 18:16:15\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"Engine\\": \\"mr\\",\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0\\nsuccess\\n691CA452-D37A-4ED0-9441-16F57****\\n\\n 0\\n 3\\n \\n 2019-11-10 11:33:52\\n create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr\\n default\\n mr\\n job_1234567055_0006\\n 2019-11-10 11:33:52\\n C-D033DD5FB****\\n HIVE\\n pt_table_090901_emr_child\\n \\n \\n 2020-01-09 18:16:15\\n insert OVERWRITE table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr\\n default\\n mr\\n job_1234567055_0006\\n 2020-01-09 18:16:15\\n C-D033DD5****\\n HIVE\\n pt_table_090901_emr_orc\\n \\n \\n 2020-01-09 18:16:37\\n create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr\\n default\\n mr\\n job_1234567055_0006\\n 2020-01-09 18:16:37\\n C-D033DD5FB8****\\n HIVE\\n pt_table_0909_emr_orc\\n \\n","errorExample":""}]',
'title' => '获取Hive表的血缘信息',
'summary' => '获取Hive表的血缘信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListHiveColumnLineages' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'EMR集群的标识。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'C-D033DD5FB82436A6',
],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => [
'description' => '数据库的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'default',
],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => [
'description' => '表的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test_table',
],
],
[
'name' => 'ColumnName',
'in' => 'query',
'schema' => [
'description' => '字段的名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'balance',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求标识。',
'type' => 'string',
'example' => '58D5334A-B013-430E',
],
'ErrorCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'UpstreamNumber' => [
'description' => '上游血缘数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DownstreamNumber' => [
'description' => '下游血缘的数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'UpstreamLineages' => [
'description' => '上游血缘。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ColumnName' => [
'description' => '字段的名称。',
'type' => 'string',
'example' => 'balance',
],
'DirectUpperTableNumber' => [
'description' => '直接上游的表数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TableName' => [
'description' => '表的名称。',
'type' => 'string',
'example' => 'pt_table_090901_emr_child',
],
'ModifiedTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2019-11-10 11:33:51',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-11-10 11:33:51',
],
'DirectDownTableNumber' => [
'description' => '直接下游的表数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DatabaseName' => [
'description' => '数据库的名称。',
'type' => 'string',
'example' => 'default',
],
'DirectDownColumnNumber' => [
'description' => '直接下游的字段数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DirectUpperColumnNumber' => [
'description' => '直接上游的字段数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Source' => [
'description' => '血缘来源,例如HIVE。',
'type' => 'string',
'example' => 'HIVE',
],
'ClusterId' => [
'description' => 'EMR集群的标识。',
'type' => 'string',
'example' => 'C-D033DD5FB82436A6',
],
],
],
],
'DownstreamLineages' => [
'description' => '下游血缘。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ColumnName' => [
'description' => '字段的名称。',
'type' => 'string',
'example' => 'balance',
],
'DirectUpperTableNumber' => [
'description' => '直接上游的表数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TableName' => [
'description' => '表的名称。',
'type' => 'string',
'example' => 'pt_table_090901_emr_child',
],
'ModifiedTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-11-10 11:33:52',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-11-10 11:33:52',
],
'DirectDownTableNumber' => [
'description' => '直接下游的表数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DatabaseName' => [
'description' => '数据库的名称。',
'type' => 'string',
'example' => 'default',
],
'DirectDownColumnNumber' => [
'description' => '直接下游的字段数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DirectUpperColumnNumber' => [
'description' => '直接上游的字段数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Source' => [
'description' => '血缘来源,例如HIVE。',
'type' => 'string',
'example' => 'HIVE',
],
'ClusterId' => [
'description' => 'EMR集群的标识。',
'type' => 'string',
'example' => 'C-D033DD5FB82436A6',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"UpstreamNumber\\": 0,\\n \\"DownstreamNumber\\": 3,\\n \\"UpstreamLineages\\": [\\n {\\n \\"ColumnName\\": \\"balance\\",\\n \\"DirectUpperTableNumber\\": 1,\\n \\"TableName\\": \\"pt_table_090901_emr_child\\",\\n \\"ModifiedTime\\": \\"2019-11-10 11:33:51\\",\\n \\"CreateTime\\": \\"2019-11-10 11:33:51\\",\\n \\"DirectDownTableNumber\\": 0,\\n \\"DatabaseName\\": \\"default\\",\\n \\"DirectDownColumnNumber\\": 1,\\n \\"DirectUpperColumnNumber\\": 2,\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ],\\n \\"DownstreamLineages\\": [\\n {\\n \\"ColumnName\\": \\"balance\\",\\n \\"DirectUpperTableNumber\\": 1,\\n \\"TableName\\": \\"pt_table_090901_emr_child\\",\\n \\"ModifiedTime\\": \\"2019-11-10 11:33:52\\",\\n \\"CreateTime\\": \\"2019-11-10 11:33:52\\",\\n \\"DirectDownTableNumber\\": 0,\\n \\"DatabaseName\\": \\"default\\",\\n \\"DirectDownColumnNumber\\": 0,\\n \\"DirectUpperColumnNumber\\": 1,\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0\\nsuccess\\n58D5334A-B013-430E-AF34-CD21****\\n\\n 0\\n 3\\n \\n 2019-11-10 11:33:51\\n 1\\n C-D033DD5F****\\n HIVE\\n pt_table_090901_emr_child\\n 1\\n 2\\n 2019-11-10 11:33:51\\n 2\\n balance\\n \\n \\n 2019-11-10 11:33:52\\n 0\\n C-D033DD5F****\\n HIVE\\n pt_table_090901_emr_orc\\n 0\\n 1\\n 2019-11-10 11:33:52\\n 1\\n balance\\n \\n \\n 2019-11-10 11:33:52\\n 0\\n C-D033DD5F****\\n HIVE\\n pt_table_0909_emr_orc\\n 0\\n 1\\n 2019-11-10 11:33:52\\n 1\\n balance\\n \\n","errorExample":""}]',
'title' => '获取指定字段的上下游血缘信息',
'summary' => '获取指定字段的上下游血缘信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTablePartitions' => [
'summary' => '获取EMR HIVE表的分区列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdideE9OA4H',
],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群标识。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'C-2A51D3826C701234',
],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => [
'description' => '数据库名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'default',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页宽。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => [
'description' => '表名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test_table',
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => '升降序。升序为ASC,降序为DESC。',
'type' => 'string',
'required' => false,
'example' => 'ASC/DESC',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求标识。',
'type' => 'string',
'example' => 'UUID',
],
'ErrorCode' => [
'description' => '错误码。',
'type' => 'string',
'example' => '0',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'PageSize' => [
'description' => '页宽。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PagedData' => [
'description' => '分页数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PartitionPath' => [
'description' => '分区的路径,例如HDFS路径。',
'type' => 'string',
'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai',
],
'PartitionComment' => [
'description' => '分区的描述信息。',
'type' => 'string',
'example' => 'test',
],
'PartitionName' => [
'description' => '分区的名称。',
'type' => 'string',
'example' => 'ds=20190909/hr=20/region=shanghai',
],
'GmtCreate' => [
'description' => '分区的创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1568032253000',
],
'PartitionType' => [
'description' => '分区的类型。',
'type' => 'string',
'example' => 'HIVE',
],
'GmtModified' => [
'description' => '分区的修改时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1568032253000',
],
'Location' => [
'description' => '分区的存储位置。',
'type' => 'string',
'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 3,\\n \\"PageSize\\": 10,\\n \\"PagedData\\": [\\n {\\n \\"PartitionPath\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai\\",\\n \\"PartitionComment\\": \\"test\\",\\n \\"PartitionName\\": \\"ds=20190909/hr=20/region=shanghai\\",\\n \\"GmtCreate\\": 1568032253000,\\n \\"PartitionType\\": \\"HIVE\\",\\n \\"GmtModified\\": 1568032253000,\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0\\nsuccess\\n2B31A7F4-68C8-499C-AF2B-3C906B56809F\\n\\n 2\\n 4\\n \\n 1574304364000\\n 1574304364000\\n hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190724/hr=02/region=test-2\\n ds=20190724/hr=02/region=test-2\\n hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190724/hr=02/region=test-2\\n HIVE\\n \\n \\n \\n 1574304355000\\n 1574304355000\\n hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190721/hr=05/region=test-5\\n ds=20190721/hr=05/region=test-5\\n hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190721/hr=05/region=test-5\\n HIVE\\n \\n \\n","errorExample":""}]',
'title' => '获取EMR HIVE表的分区列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'OpenDataWorksStandardService' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [],
],
'SendTaskMetaCallback' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '78150',
'abilityTreeNodes' => [
'FEATUREdideSYOMAV',
],
],
'parameters' => [
[
'name' => 'TenantId',
'in' => 'formData',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '9223372036854775807',
'minimum' => '1',
'isFileTransferUrl' => false,
],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '9223372036854775807',
'minimum' => '1',
'isFileTransferUrl' => false,
],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '9223372036854775807',
'minimum' => '1',
'isFileTransferUrl' => false,
],
],
[
'name' => 'User',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'Code',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'ConnectionInfo',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'TaskEnvParam',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'SubType',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'Resources',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'maxItems' => 10,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'ErrMsg' => [
'type' => 'string',
],
'ErrorCode' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError.Meta.Unknown',
'errorMessage' => 'An unknown error occurred while processing your request.',
],
],
],
],
'SetSwitchValue' => [
'summary' => '设置Switch的值',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SwitchName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SwitchValue',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'type' => 'string',
],
'Data' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
],
'GetDataServiceApiContext' => [
'summary' => '获取数据服务ApiContext信息',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '180496',
'abilityTreeNodes' => [
'FEATUREdideWDSR97',
],
],
'parameters' => [
[
'name' => 'ApiId',
'in' => 'query',
'schema' => [
'title' => 'api逐渐',
'description' => 'apiId',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '0',
'exclusiveMinimum' => true,
'example' => '12345',
],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => [
'title' => '是否详情',
'description' => '是否详情',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'CacheKey',
'in' => 'query',
'schema' => [
'description' => 'ApiContext缓存键值',
'type' => 'string',
'required' => false,
'example' => 'abc-124',
],
],
[
'name' => 'ForPrivateResGroup',
'in' => 'query',
'schema' => [
'description' => '是否绑定独享数据服务资源组',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ApiStatus',
'in' => 'query',
'schema' => [
'description' => 'Api状态,已发布、草稿态等',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ApiContext',
'description' => 'ApiContext',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'ApiContext信息',
'type' => 'string',
'example' => '{"apiId":123}',
],
'ErrMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => 'success',
],
'ErrCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '0',
],
'RequestId' => [
'description' => '请求Id',
'type' => 'string',
'example' => '1AFAE64E-D1BE-432B-A9****',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError.System',
'errorMessage' => 'An internal system error occurred. Try again later.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\\\"apiId\\\\\\":123}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]',
'title' => '获取数据服务ApiContext信息',
'description' => '获取数据服务ApiContext信息',
],
'GetDataServiceContextUpdateEvent' => [
'summary' => '查询APIcontext变更事件。',
'methods' => [
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '191385',
'abilityTreeNodes' => [
'FEATUREdideZZ63WZ',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID',
'type' => 'string',
'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75',
],
'Data' => [
'title' => 'Id of the request',
'description' => '返回内容',
'type' => 'string',
'example' => '{\'TotalCount\': 0, \'CalcEngines\': []}',
],
'ErrMsg' => [
'title' => 'Id of the request',
'description' => '错误信息',
'type' => 'string',
'example' => 'success',
],
'ErrCode' => [
'title' => 'Id of the request',
'description' => '错误码',
'type' => 'string',
'example' => '0',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError.System',
'errorMessage' => 'An internal system error occurred. Try again later.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Data\\": \\"{\'TotalCount\': 0, \'CalcEngines\': []}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\"\\n}","type":"json"}]',
'title' => 'GetDataServiceContextUpdateEvent',
],
'GetDataServiceConnection' => [
'summary' => '新server独享资源组获取数据源信息。',
'methods' => [
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '259634',
'abilityTreeNodes' => [
'FEATUREdideWDSR97',
],
],
'parameters' => [
[
'name' => 'ConnectionId',
'in' => 'query',
'schema' => [
'description' => '数据源id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'DataSourceType',
'in' => 'query',
'schema' => [
'description' => '数据源类型',
'type' => 'string',
'required' => false,
'example' => 'normal',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '123-abc',
],
'Data' => [
'description' => '数据源信息',
'type' => 'string',
'example' => '{}',
],
'ErrMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => 'success',
],
'ErrCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '0',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123-abc\\",\\n \\"Data\\": \\"{}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\"\\n}","type":"json"}]',
'title' => '查询数据源信息',
],
'GetDataServiceApiAuthMapContext' => [
'summary' => '新server独享资源组获取api context。',
'methods' => [
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '259344',
'abilityTreeNodes' => [
'FEATUREdideWDSR97',
],
],
'parameters' => [
[
'name' => 'ApiId',
'in' => 'query',
'schema' => [
'description' => 'API ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => [
'description' => '是否查询详细信息',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'description' => 'DataWorks项目空间id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'ApiPath',
'in' => 'query',
'schema' => [
'description' => 'API 路径',
'type' => 'string',
'required' => false,
'example' => '/apiPath',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'API 信息',
'type' => 'string',
'example' => '{}',
],
'ErrMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => 'success',
],
'ErrCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '0',
],
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '123-abc',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"RequestId\\": \\"123-abc\\"\\n}","type":"json"}]',
'title' => '查询API内容信息',
],
'GetDataServiceFunction' => [
'summary' => '查询函数信息。',
'methods' => [
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '260794',
'abilityTreeNodes' => [
'FEATUREdideSYX560',
],
],
'parameters' => [
[
'name' => 'FunctionId',
'in' => 'query',
'schema' => [
'description' => '函数ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Data' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '{}',
],
'ErrMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => 'success',
],
'ErrCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '0',
],
'RequestId' => [
'description' => 'RequestId',
'type' => 'string',
'example' => 'abc-123',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"RequestId\\": \\"abc-123\\"\\n}","type":"json"}]',
'title' => '查询函数信息',
],
],
'endpoints' => [
[
'regionId' => 'cn-wulanchabu',
'endpoint' => 'dataworks.cn-wulanchabu.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'dataworks.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'dataworks.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'dataworks.cn-hongkong.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'dataworks.cn-zhangjiakou.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'dataworks.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'dataworks.ap-northeast-1.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'dataworks.cn-chengdu.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'dataworks.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'dataworks.ap-southeast-3.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'dataworks.ap-southeast-5.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'dataworks.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'dataworks.us-east-1.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'dataworks.eu-west-1.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'dataworks.us-west-1.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'dataworks.eu-central-1.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'dataworks.me-east-1.aliyuncs.com',
],
[
'regionId' => 'me-central-1',
'endpoint' => 'dataworks.me-central-1.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'dataworks.cn-shenzhen-finance-1.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'dataworks.cn-shanghai-finance-1.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'dataworks.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2',
'endpoint' => 'dataworks.ap-northeast-2.aliyuncs.com',
],
],
];