diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/datahub/2024-06-20 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/datahub/2024-06-20')
| -rw-r--r-- | data/zh_cn/datahub/2024-06-20/api-docs.php | 2913 |
1 files changed, 2913 insertions, 0 deletions
diff --git a/data/zh_cn/datahub/2024-06-20/api-docs.php b/data/zh_cn/datahub/2024-06-20/api-docs.php new file mode 100644 index 0000000..6ce7153 --- /dev/null +++ b/data/zh_cn/datahub/2024-06-20/api-docs.php @@ -0,0 +1,2913 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'datahub', + 'version' => '2024-06-20', + ], + 'directories' => [ + [ + 'id' => 377654, + 'title' => '数据读写', + 'type' => 'directory', + 'children' => [ + 'GetRecords', + 'PutRecords', + ], + ], + [ + 'id' => 377657, + 'title' => '同步任务管理', + 'type' => 'directory', + 'children' => [ + 'ListConnectors', + 'GetConnector', + ], + ], + [ + 'id' => 377658, + 'title' => '订阅管理', + 'type' => 'directory', + 'children' => [ + 'GetGroup', + 'ListGroups', + 'ListSubscriptions', + 'GetSubscription', + ], + ], + [ + 'id' => 377659, + 'title' => 'Topic 管理', + 'type' => 'directory', + 'children' => [ + 'GetTopic', + 'ListTopics', + 'GetSchema', + 'ListSchemas', + ], + ], + [ + 'id' => 377660, + 'title' => 'Project 管理', + 'type' => 'directory', + 'children' => [ + 'GetProject', + 'ListProjects', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetRecords' => [ + 'summary' => '读取指定topic的数据，主要是调试使用，大流量的读取请参考官方文档的SDK介绍。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic', + ], + ], + [ + 'name' => 'ShardId', + 'in' => 'query', + 'schema' => [ + 'description' => '读取数据的shardId。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '读取数据的开始时间，默认从当前时刻的5分钟前开始读取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1769065251123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否调用成功。true：调用成功。false：调用失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Records' => [ + 'description' => '读取的Record内容。', + 'type' => 'array', + 'items' => [ + 'description' => '单个 Record 的内容。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Record 的数据内容。', + 'type' => 'array', + 'items' => [ + 'description' => '记录的具体DNS信息。不同类型记录包含不同的信息。', + 'type' => 'string', + 'example' => '10', + ], + ], + 'Attributes' => [ + 'description' => 'Record 的额外信息，如没有额外信息则为空。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'Record 的额外信息。', + 'example' => 'key:val', + ], + ], + 'SystemTime' => [ + 'description' => 'Record的写入时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1769065251123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"Records\\": [\\n {\\n \\"Data\\": [\\n \\"10\\"\\n ],\\n \\"Attributes\\": {\\n \\"key\\": \\"key:val\\"\\n },\\n \\"SystemTime\\": 1769065251123\\n }\\n ]\\n}","type":"json"}]', + 'title' => '订阅数据', + 'description' => '本接口主要是供用户调试使用，请勿使用该接口读取大量数据。', + ], + 'PutRecords' => [ + 'summary' => '向指定的topic写入数据，主要是调试使用，大流量的写入请参考官方文档的SDK介绍。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic', + ], + ], + [ + 'name' => 'ShardId', + 'in' => 'query', + 'schema' => [ + 'description' => '待写入的shardId，如果不指定，则随机写入某一个Shard。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'Records', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要写入的数据。', + 'type' => 'array', + 'items' => [ + 'description' => '单个Record的内容。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Record的数据内容。', + 'type' => 'array', + 'items' => [ + 'description' => '数据需要和topic的schema保持一致，每一列数据都需要转为string，如果数据少于topic schema的列数，会补null。', + 'type' => 'string', + 'required' => false, + 'example' => 'aa', + ], + 'required' => true, + 'example' => '["aa", "bb", "12", "12.34"]', + 'maxItems' => 100, + ], + 'Attributes' => [ + 'description' => 'Record的额外信息，如没有额外信息可不填写。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'key:val', + 'description' => 'Record的额外属性信息。', + ], + 'example' => '{"key1":"val1","key2":"val2"}', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ShardId' => [ + 'description' => '数据被写入的ShardId。', + 'type' => 'string', + 'example' => '7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ShardId\\": \\"7\\"\\n}","type":"json"}]', + 'title' => '发布数据', + 'description' => '本接口主要是供用户调试使用，请勿使用该接口写入大量数据。', + ], + 'ListConnectors' => [ + 'summary' => '获取同步任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时跳过的记录数'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询返回的最大记录数'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的过滤关键词', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dh', + ], + ], + [ + 'name' => 'Pure', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅返回主键信息', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TotalCount' => [ + 'description' => '查询结果总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'MaxResults' => [ + 'description' => '本次查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。 如果NextToken有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Connector' => [ + 'description' => '同步任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '同步任务列表', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'TopicName' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => 'test_topic', + ], + 'ConnectorId' => [ + 'description' => '同步任务id', + 'type' => 'string', + 'example' => 'fa44384c-0ac5-4d3e-8acd-76e18636ab10', + ], + 'SubscriptionId' => [ + 'description' => '订阅id', + 'type' => 'string', + 'example' => '1745824636429WZ2EE', + ], + 'Type' => [ + 'description' => '同步任务类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'SOURCE_DTS' => 'SOURCE_DTS', + 'SINK_ODPS' => 'SINK_ODPS', + 'SINK_DATAHUB' => 'SINK_DATAHUB', + 'SINK_MYSQL' => 'SINK_MYSQL', + 'SINK_HOLOGRES' => 'SINK_HOLOGRES', + 'SINK_ADS' => 'SINK_ADS', + 'SINK_OSS' => 'SINK_OSS', + 'SINK_FC' => 'SINK_FC', + 'SINK_OTS' => 'SINK_OTS', + 'SINK_ES' => 'SINK_ES', + ], + 'example' => 'SINK_ODPS', + ], + 'State' => [ + 'description' => '同步任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'PAUSED' => 'PAUSED', + 'CREATED' => 'CREATED', + 'RUNNING' => 'RUNNING', + 'STOPPED' => 'STOPPED', + ], + 'example' => 'RUNNING', + ], + 'DoneTime' => [ + 'description' => '同步任务中的标Done时间。仅同步ODPS（SINK_ODPS）任务中生效。', + 'type' => 'string', + 'example' => '2025-12-04 16:45:00', + ], + 'ColumnFields' => [ + 'description' => '同步任务的field列表', + 'type' => 'string', + 'example' => '[\\"field1\\",\\"field2\\"]', + ], + 'Config' => [ + 'description' => '同步任务的配置信息', + 'type' => 'string', + 'example' => '{\\"Table\\":\\"r3\\",\\"Endpoint\\":\\"https://Device-data.cn-beijing.ots-internal.aliyuncs.com\\",\\"Instance\\":\\"Device-data\\",\\"WriteMode\\":\\"PUT\\",\\"AuthMode\\":\\"STS\\"}', + ], + 'Creator' => [ + 'description' => '同步任务创建者', + 'type' => 'string', + 'example' => '1696648921408952', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1724041098000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'string', + 'example' => '1708171905000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": {\\n \\"Connector\\": [\\n {\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\",\\n \\"ConnectorId\\": \\"fa44384c-0ac5-4d3e-8acd-76e18636ab10\\",\\n \\"SubscriptionId\\": \\"1745824636429WZ2EE\\",\\n \\"Type\\": \\"SINK_ODPS\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"DoneTime\\": \\"2025-12-04 16:45:00\\",\\n \\"ColumnFields\\": \\"[\\\\\\\\\\\\\\"field1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"field2\\\\\\\\\\\\\\"]\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"Table\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"r3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://Device-data.cn-beijing.ots-internal.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Instance\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Device-data\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"WriteMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PUT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STS\\\\\\\\\\\\\\"}\\",\\n \\"Creator\\": \\"1696648921408952\\",\\n \\"CreateTime\\": \\"1724041098000\\",\\n \\"UpdateTime\\": \\"1708171905000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取同步任务列表', + 'description' => '查询同步任务列表信息。', + ], + 'GetConnector' => [ + 'summary' => '查询同步任务信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic', + ], + ], + [ + 'name' => 'ConnectorId', + 'in' => 'query', + 'schema' => [ + 'description' => '同步任务id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c5e07a96-5069-4486-87c3-0d281951f772', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ConnectorId' => [ + 'description' => '同步任务id'."\n" + ."\n", + 'type' => 'string', + 'example' => 'c5e07a96-5069-4486-87c3-0d281951f772', + ], + 'Type' => [ + 'description' => ' '."\n" + .'同步任务类型'."\n" + ."\n", + 'type' => 'string', + 'example' => 'SINK_ODPS', + ], + 'State' => [ + 'description' => '同步任务状态'."\n" + ."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ColumnFields' => [ + 'description' => '同步任务的field列表', + 'type' => 'string', + 'example' => '[\\"field1\\",\\"field2\\"]', + ], + 'Config' => [ + 'description' => '同步任务的配置信息'."\n" + ."\n", + 'type' => 'string', + 'example' => '{\\"TimestampUnit\\":\\"MICROSECOND\\",\\"PartitionConfig\\":{\\"hh\\":\\"%H\\",\\"mm\\":\\"%M\\",\\"ds\\":\\"%Y%m%d\\"},\\"Project\\":\\"xxx\\",\\"TimeRange\\":15,\\"TimeZone\\":\\"Asia/Shanghai\\",\\"Table\\":\\"xxx\\",\\"OdpsEndpoint\\":\\"xxx\\",\\"AccessId\\":\\"xxx\\",\\"PartitionMode\\":\\"SYSTEM_TIME\\",\\"AuthMode\\":\\"ak\\"}', + ], + 'DoneTime' => [ + 'description' => '同步任务中的标Done时间。仅同步ODPS（SINK_ODPS）任务中生效。', + 'type' => 'string', + 'example' => '2025-06-06 15:45:00', + ], + 'Creator' => [ + 'description' => '同步任务创建者', + 'type' => 'string', + 'example' => '270523390948438349', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1724041098000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间'."\n" + ."\n", + 'type' => 'string', + 'example' => '1724041098000', + ], + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'TopicName' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => 'test_topic', + ], + 'SubscriptionId' => [ + 'description' => '订阅Id', + 'type' => 'string', + 'example' => '1764123132492KO88A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ConnectorId\\": \\"c5e07a96-5069-4486-87c3-0d281951f772\\",\\n \\"Type\\": \\"SINK_ODPS\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"ColumnFields\\": \\"[\\\\\\\\\\\\\\"field1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"field2\\\\\\\\\\\\\\"]\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"TimestampUnit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MICROSECOND\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PartitionConfig\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"hh\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"%H\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mm\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"%M\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ds\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"%Y%m%d\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Project\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TimeRange\\\\\\\\\\\\\\":15,\\\\\\\\\\\\\\"TimeZone\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Asia/Shanghai\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Table\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OdpsEndpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AccessId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PartitionMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SYSTEM_TIME\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ak\\\\\\\\\\\\\\"}\\",\\n \\"DoneTime\\": \\"2025-06-06 15:45:00\\",\\n \\"Creator\\": \\"270523390948438349\\",\\n \\"CreateTime\\": \\"1724041098000\\",\\n \\"UpdateTime\\": \\"1724041098000\\",\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\",\\n \\"SubscriptionId\\": \\"1764123132492KO88A\\"\\n}","type":"json"}]', + 'title' => '查询同步任务信息', + 'description' => '查询同步任务信息。', + ], + 'GetGroup' => [ + 'summary' => '查询消费组信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '消费组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'GroupName' => [ + 'description' => '消费组名称', + 'type' => 'string', + 'example' => 'consumer_group1', + ], + 'Comment' => [ + 'description' => '消费组描述信息', + 'type' => 'string', + 'example' => 'test_comment', + ], + 'Creator' => [ + 'description' => '消费组创建者', + 'type' => 'string', + 'example' => '270523390948438349', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724041098000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724041098000', + ], + 'TopicList' => [ + 'description' => '消费组所绑定的topic列表', + 'type' => 'array', + 'items' => [ + 'description' => '消费组所绑定的topic列表', + 'type' => 'string', + 'example' => '[{\'topic\': \'pub/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'pub\', \'permission\': \'W\'}, {\'topic\': \'sub/nologin/uuid/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'sub-uuid\', \'permission\': \'R\'}]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'ResourceAlreadyExist', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"GroupName\\": \\"consumer_group1\\",\\n \\"Comment\\": \\"test_comment\\",\\n \\"Creator\\": \\"270523390948438349\\",\\n \\"CreateTime\\": 1724041098000,\\n \\"UpdateTime\\": 1724041098000,\\n \\"TopicList\\": [\\n \\"[{\'topic\': \'pub/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'pub\', \'permission\': \'W\'}, {\'topic\': \'sub/nologin/uuid/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'sub-uuid\', \'permission\': \'R\'}]\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询消费组信息', + 'description' => '查询消费组信息。', + ], + 'ListGroups' => [ + 'summary' => '获取消费组列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时跳过的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的过滤关键词', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dh', + ], + ], + [ + 'name' => 'Pure', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅返回主键信息', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TotalCount' => [ + 'description' => '查询结果总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'MaxResults' => [ + 'description' => '本次查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1000', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5', + 'default' => '5', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。 如果NextToken有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + 'List' => [ + 'description' => '消费组列表', + 'type' => 'array', + 'items' => [ + 'description' => '消费组列表', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'GroupName' => [ + 'description' => '消费组名称', + 'type' => 'string', + 'example' => 'test_group', + ], + 'Comment' => [ + 'description' => '消费组描述信息', + 'type' => 'string', + 'example' => 'test_comment', + ], + 'TopicList' => [ + 'description' => '消费组所绑定的topic列表', + 'type' => 'array', + 'items' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => '["topic1","topic2"]', + ], + ], + 'Creator' => [ + 'description' => '消费组创建者', + 'type' => 'string', + 'example' => '276887103073464052', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708171905000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708171905000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": [\\n {\\n \\"ProjectName\\": \\"test_project\\",\\n \\"GroupName\\": \\"test_group\\",\\n \\"Comment\\": \\"test_comment\\",\\n \\"TopicList\\": [\\n \\"[\\\\\\"topic1\\\\\\",\\\\\\"topic2\\\\\\"]\\"\\n ],\\n \\"Creator\\": \\"276887103073464052\\",\\n \\"CreateTime\\": 1708171905000,\\n \\"UpdateTime\\": 1708171905000\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取消费组列表', + 'description' => '查询消费组列表信息。', + ], + 'ListSubscriptions' => [ + 'summary' => '获取订阅列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahub86JVYW', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时跳过的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的过滤关键词', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TotalCount' => [ + 'description' => '查询结果总数'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'MaxResults' => [ + 'description' => '本次查询返回的最大记录数'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。 如果NextToken有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Subscription' => [ + 'description' => '订阅列表', + 'type' => 'array', + 'items' => [ + 'description' => '订阅列表', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'TopicName' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => 'test_topic', + ], + 'SubscriptionId' => [ + 'description' => '订阅id', + 'type' => 'string', + 'example' => '1745824636429WZ2EE', + ], + 'Type' => [ + 'description' => '订阅的类型。USER表示用户创建，SYSTEM表示系统创建。', + 'type' => 'string', + 'example' => 'USER', + ], + 'State' => [ + 'description' => '订阅的状态。0表示已下线，1表示在线', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Comment' => [ + 'description' => '订阅描述信息', + 'type' => 'string', + 'example' => 'test_comment', + ], + 'Application' => [ + 'description' => '订阅所属的应用名', + 'type' => 'string', + 'example' => 'test_application_name', + ], + 'Creator' => [ + 'description' => '订阅创建者', + 'type' => 'string', + 'example' => '1048133943212399', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708171905000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708171905000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": {\\n \\"Subscription\\": [\\n {\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\",\\n \\"SubscriptionId\\": \\"1745824636429WZ2EE\\",\\n \\"Type\\": \\"USER\\",\\n \\"State\\": 1,\\n \\"Comment\\": \\"test_comment\\",\\n \\"Application\\": \\"test_application_name\\",\\n \\"Creator\\": \\"1048133943212399\\",\\n \\"CreateTime\\": 1708171905000,\\n \\"UpdateTime\\": 1708171905000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取订阅列表', + 'description' => '查询订阅列表信息。', + ], + 'GetSubscription' => [ + 'summary' => '查询订阅信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahub86JVYW', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic', + ], + ], + [ + 'name' => 'SubscriptionId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅Id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1764122860063VIIZ2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'TopicName' => [ + 'description' => '主题名称', + 'type' => 'string', + 'example' => 'test_topic'."\n", + ], + 'SubscriptionId' => [ + 'description' => '订阅Id', + 'type' => 'string', + 'example' => '1741072334529RFEF7', + ], + 'Type' => [ + 'description' => '订阅的类型。USER表示用户创建，SYSTEM表示系统创建。', + 'type' => 'string', + 'example' => 'USER', + ], + 'State' => [ + 'description' => '订阅的状态。0表示已下线，1表示在线', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Comment' => [ + 'description' => '订阅描述信息'."\n" + ."\n", + 'type' => 'string', + 'example' => 'test_comment', + ], + 'Application' => [ + 'description' => '订阅所属的应用名'."\n" + ."\n", + 'type' => 'string', + 'example' => 'test_application_name', + ], + 'Creator' => [ + 'description' => '订阅创建者'."\n" + ."\n", + 'type' => 'string', + 'example' => '1559031978056215', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724041098000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724041098000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\\\n\\",\\n \\"SubscriptionId\\": \\"1741072334529RFEF7\\",\\n \\"Type\\": \\"USER\\",\\n \\"State\\": 1,\\n \\"Comment\\": \\"test_comment\\",\\n \\"Application\\": \\"test_application_name\\",\\n \\"Creator\\": \\"1559031978056215\\",\\n \\"CreateTime\\": 1724041098000,\\n \\"UpdateTime\\": 1724041098000\\n}","type":"json"}]', + 'title' => '查询订阅信息', + 'description' => '查询订阅信息。', + ], + 'GetTopic' => [ + 'summary' => '查询Topic信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'TopicName' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => 'test_topic'."\n", + ], + 'RecordType' => [ + 'description' => 'topic类型'."\n" + ."\n", + 'type' => 'string', + 'example' => 'TUPLE', + ], + 'Lifecycle' => [ + 'description' => '生命周期'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ShardCount' => [ + 'description' => 'shard数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Storage' => [ + 'description' => 'topic总存储量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12252454', + ], + 'ExpandMode' => [ + 'description' => '是否扩展模式', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableSchemaRegistry' => [ + 'description' => '是否支持多version'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'RecordSchema' => [ + 'description' => 'TUPLE类型下的数据Schema', + 'type' => 'string', + 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"str\\"},{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"dt\\"}]', + ], + 'Comment' => [ + 'description' => 'topic描述信息', + 'type' => 'string', + 'example' => 'test_comment', + ], + 'Creator' => [ + 'description' => 'topic创建者', + 'type' => 'string', + 'example' => '1397493986831962', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1724041098000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'string', + 'example' => '1724041098000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\\\n\\",\\n \\"RecordType\\": \\"TUPLE\\",\\n \\"Lifecycle\\": 3,\\n \\"ShardCount\\": 3,\\n \\"Storage\\": 12252454,\\n \\"ExpandMode\\": true,\\n \\"EnableSchemaRegistry\\": false,\\n \\"RecordSchema\\": \\"[{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"dt\\\\\\\\\\\\\\"}]\\",\\n \\"Comment\\": \\"test_comment\\",\\n \\"Creator\\": \\"1397493986831962\\",\\n \\"CreateTime\\": \\"1724041098000\\",\\n \\"UpdateTime\\": \\"1724041098000\\"\\n}","type":"json"}]', + 'title' => '查询Topic信息', + 'description' => '查询Topic信息。', + ], + 'ListTopics' => [ + 'summary' => '获取Topic列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时跳过的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '500', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的过滤关键词。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dh', + ], + ], + [ + 'name' => 'Pure', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅返回主键信息'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TotalCount' => [ + 'description' => '查询结果总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'MaxResults' => [ + 'description' => '本次查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。 如果NextToken有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Topic' => [ + 'description' => 'topic列表', + 'type' => 'array', + 'items' => [ + 'description' => 'topic列表', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'poc_test', + ], + 'TopicName' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => 'ods_bio_safety_env_disinfection', + ], + 'RecordType' => [ + 'description' => 'topic类型', + 'type' => 'string', + 'example' => 'TUPLE', + ], + 'Lifecycle' => [ + 'description' => '生命周期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ShardCount' => [ + 'description' => 'shard数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Storage' => [ + 'description' => 'topic总存储量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ExpandMode' => [ + 'description' => '是否扩展模式', + 'type' => 'string', + 'example' => 'true', + ], + 'EnableSchemaRegistry' => [ + 'description' => '是否支持多version', + 'type' => 'string', + 'example' => 'false', + ], + 'RecordSchema' => [ + 'description' => 'TUPLE类型下的数据Schema', + 'type' => 'string', + 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"str\\"},{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"dt\\"}]', + ], + 'Comment' => [ + 'description' => 'topic描述信息', + 'type' => 'string', + 'example' => '这是一个描述信息', + ], + 'Creator' => [ + 'description' => 'topic创建者', + 'type' => 'string', + 'example' => '276887103073464052', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1753346106000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1753346106000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": {\\n \\"Topic\\": [\\n {\\n \\"ProjectName\\": \\"poc_test\\",\\n \\"TopicName\\": \\"ods_bio_safety_env_disinfection\\",\\n \\"RecordType\\": \\"TUPLE\\",\\n \\"Lifecycle\\": 3,\\n \\"ShardCount\\": 1,\\n \\"Storage\\": 10000,\\n \\"ExpandMode\\": \\"true\\",\\n \\"EnableSchemaRegistry\\": \\"false\\",\\n \\"RecordSchema\\": \\"[{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"dt\\\\\\\\\\\\\\"}]\\",\\n \\"Comment\\": \\"这是一个描述信息\\",\\n \\"Creator\\": \\"276887103073464052\\",\\n \\"CreateTime\\": 1753346106000,\\n \\"UpdateTime\\": 1753346106000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取Topic列表', + 'description' => '查询Topic列表信息。', + ], + 'GetSchema' => [ + 'summary' => '查询Schema信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => '主题名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'schema版本号'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'TopicName' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => 'test_topic'."\n", + ], + 'VersionId' => [ + 'description' => 'schema版本号'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RecordSchema' => [ + 'description' => 'versionId对应的的Schema数据', + 'type' => 'string', + 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"context\\"}]', + ], + 'Creator' => [ + 'description' => 'schema创建者'."\n" + ."\n", + 'type' => 'string', + 'example' => '1559031978056215', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724041098000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'ResourceAlreadyExist', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\\\n\\",\\n \\"VersionId\\": 0,\\n \\"RecordSchema\\": \\"[{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"context\\\\\\\\\\\\\\"}]\\",\\n \\"Creator\\": \\"1559031978056215\\",\\n \\"CreateTime\\": 1724041098000\\n}","type":"json"}]', + 'title' => '查询Shema信息', + 'description' => '查询Scema信息。', + ], + 'ListSchemas' => [ + 'summary' => '获取Schema列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_topic'."\n", + ], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时跳过的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '20250401102332e68e3d0b04ab4904', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TotalCount' => [ + 'description' => '查询总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'MaxResults' => [ + 'description' => '本次查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。 如果NextToken有返回值，该取值表示下一次查询开始的令牌。'."\n" + ."\n", + 'type' => 'string', + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + 'List' => [ + 'description' => 'schema列表', + 'type' => 'array', + 'items' => [ + 'description' => 'schema列表', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'TopicName' => [ + 'description' => 'topic名称', + 'type' => 'string', + 'example' => 'test_topic', + ], + 'VersionId' => [ + 'description' => 'schema版本号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RecordSchema' => [ + 'description' => 'versionId对应的的Schema数据', + 'type' => 'string', + 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"context\\"}]', + ], + 'Creator' => [ + 'description' => 'schema创建者', + 'type' => 'string', + 'example' => '1048133943212399', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708171905000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'ResourceAlreadyExist', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20250401102332e68e3d0b04ab4904\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": [\\n {\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\",\\n \\"VersionId\\": 0,\\n \\"RecordSchema\\": \\"[{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"context\\\\\\\\\\\\\\"}]\\",\\n \\"Creator\\": \\"1048133943212399\\",\\n \\"CreateTime\\": 1708171905000\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取Schema列表', + 'description' => '查询schema列表信息。', + ], + 'GetProject' => [ + 'summary' => '查询Project信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'Comment' => [ + 'description' => '项目描述信息', + 'type' => 'string', + 'example' => 'test_comment', + ], + 'VpcWhitelist' => [ + 'description' => '项目的vpc白名单列表信息', + 'type' => 'string', + 'example' => '[\\"11.22.33.44\\"]', + ], + 'Storage' => [ + 'description' => '项目总存储量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12252454', + ], + 'Creator' => [ + 'description' => '项目创建者', + 'type' => 'string', + 'example' => '1559031978056215', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1724041098000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'string', + 'example' => '1724041098000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"Comment\\": \\"test_comment\\",\\n \\"VpcWhitelist\\": \\"[\\\\\\\\\\\\\\"11.22.33.44\\\\\\\\\\\\\\"]\\",\\n \\"Storage\\": 12252454,\\n \\"Creator\\": \\"1559031978056215\\",\\n \\"CreateTime\\": \\"1724041098000\\",\\n \\"UpdateTime\\": \\"1724041098000\\"\\n}","type":"json"}]', + 'title' => '查询项目信息', + 'description' => '查询Project信息。', + ], + 'ListProjects' => [ + 'summary' => '获取项目列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdatahubB2GCPA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时跳过的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的过滤关键词', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dh', + ], + ], + [ + 'name' => 'Pure', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅返回主键信息', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TotalCount' => [ + 'description' => '查询结果总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'MaxResults' => [ + 'description' => '本次查询返回的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。 如果NextToken有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + ], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Project' => [ + 'description' => '项目列表', + 'type' => 'array', + 'items' => [ + 'description' => '项目列表', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'test_project', + ], + 'Comment' => [ + 'description' => '项目描述信息', + 'type' => 'string', + 'example' => 'test_comment', + ], + 'Creator' => [ + 'description' => '项目创建者', + 'type' => 'string', + 'example' => '1048133943212399', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708171905000', + ], + 'UpdateTime' => [ + 'description' => '最后更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708171905000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Error:%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'Error:%s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Error:%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'Error:%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'Error:%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": {\\n \\"Project\\": [\\n {\\n \\"ProjectName\\": \\"test_project\\",\\n \\"Comment\\": \\"test_comment\\",\\n \\"Creator\\": \\"1048133943212399\\",\\n \\"CreateTime\\": 1708171905000,\\n \\"UpdateTime\\": 1708171905000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取项目列表', + 'description' => '查询Project列表信息。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'datahub.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'datahub.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'datahub.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'datahub.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'datahub.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'datahub.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'datahub.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'datahub.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'datahub.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'datahub.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'datahub.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'datahub.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'datahub.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'datahub.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'datahub.me-central-1.aliyuncs.com', + ], + ], +]; |