summaryrefslogtreecommitdiff
path: root/data/zh_cn/datahub
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/datahub
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/datahub')
-rw-r--r--data/zh_cn/datahub/2019-11-20/api-docs.php265
-rw-r--r--data/zh_cn/datahub/2024-06-20/api-docs.php3798
2 files changed, 1757 insertions, 2306 deletions
diff --git a/data/zh_cn/datahub/2019-11-20/api-docs.php b/data/zh_cn/datahub/2019-11-20/api-docs.php
index 32da240..c5cc152 100644
--- a/data/zh_cn/datahub/2019-11-20/api-docs.php
+++ b/data/zh_cn/datahub/2019-11-20/api-docs.php
@@ -1,19 +1,12 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'datahub',
- 'version' => '2019-11-20',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'datahub', 'version' => '2019-11-20'],
'directories' => [
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'OpenDataHubService',
- 'ListProjects',
- ],
+ 'children' => ['OpenDataHubService', 'ListProjects'],
],
],
'components' => [
@@ -22,14 +15,8 @@
'apis' => [
'OpenDataHubService' => [
'summary' => '开通Datahub服务',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -50,9 +37,7 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
],
'parameters' => [],
'responses' => [
@@ -60,12 +45,8 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'OrderId' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'OrderId' => ['type' => 'string'],
],
],
],
@@ -75,13 +56,8 @@
],
'ListProjects' => [
'summary' => '查询project列表信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -93,55 +69,28 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '每页的大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '每页的大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'description' => '查询的关键字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'search_key',
- ],
+ 'schema' => ['description' => '查询的关键字', 'type' => 'string', 'required' => false, 'example' => 'search_key'],
],
],
'responses' => [
@@ -149,31 +98,11 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '查询结果总数',
- 'type' => 'string',
- 'example' => '50',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '20250401102332e68e3d0b04ab4904',
- ],
- 'PageSize' => [
- 'description' => '每页的大小',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'PageCount' => [
- 'description' => '总页数',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageNumber' => [
- 'description' => '当前页码',
- 'type' => 'string',
- 'example' => '84',
- ],
+ 'TotalCount' => ['description' => '查询结果总数', 'type' => 'string', 'example' => '50'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '20250401102332e68e3d0b04ab4904'],
+ 'PageSize' => ['description' => '每页的大小', 'type' => 'string', 'example' => '10'],
+ 'PageCount' => ['description' => '总页数', 'type' => 'string', 'example' => '1'],
+ 'PageNumber' => ['description' => '当前页码', 'type' => 'string', 'example' => '84'],
'List' => [
'type' => 'object',
'itemNode' => true,
@@ -185,87 +114,36 @@
'description' => '项目信息。',
'type' => 'object',
'properties' => [
- 'UpdateTime' => [
- 'description' => '更新时间'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1708171905000',
- ],
- 'Comment' => [
- 'description' => '字段的文本注释',
- 'type' => 'string',
- 'example' => '测试专用',
- ],
- 'CreateTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1708171905000',
- ],
- 'ProjectName' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'example' => 'poc_test',
- ],
- 'Creator' => [
- 'description' => '创建者id',
- 'type' => 'string',
- 'example' => '1048133943212399',
- ],
- 'CreatorName' => [
- 'description' => '创建者名称',
- 'type' => 'string',
- 'example' => 'user_name',
- ],
+ 'UpdateTime' => ['description' => '更新时间'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000'],
+ 'Comment' => ['description' => '字段的文本注释', 'type' => 'string', 'example' => '测试专用'],
+ 'CreateTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000'],
+ 'ProjectName' => ['description' => '项目名称', 'type' => 'string', 'example' => 'poc_test'],
+ 'Creator' => ['description' => '创建者id', 'type' => 'string', 'example' => '1048133943212399'],
+ 'CreatorName' => ['description' => '创建者名称', 'type' => 'string', 'example' => 'user_name'],
],
],
],
],
],
- 'Success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => '%s',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => '%s',
- ],
- [
- 'errorCode' => 'ResourceAlreadyExist',
- 'errorMessage' => '%s',
- ],
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => '%s',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s'],
+ ['errorCode' => 'NoPermission', 'errorMessage' => '%s'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => '%s'],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s'],
],
500 => [
- [
- 'errorCode' => 'OdpsServiceError',
- 'errorMessage' => '%s',
- ],
+ ['errorCode' => 'OdpsServiceError', 'errorMessage' => '%s'],
],
502 => [
- [
- 'errorCode' => 'ApiProxyServiceError',
- 'errorMessage' => '%s',
- ],
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => '%s',
- ],
+ ['errorCode' => 'ApiProxyServiceError', 'errorMessage' => '%s'],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => '%s'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"50\\",\\n \\"RequestId\\": \\"20250401102332e68e3d0b04ab4904\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageCount\\": \\"1\\",\\n \\"PageNumber\\": \\"84\\",\\n \\"List\\": {\\n \\"Project\\": [\\n {\\n \\"UpdateTime\\": 1708171905000,\\n \\"Comment\\": \\"测试专用\\",\\n \\"CreateTime\\": 1708171905000,\\n \\"ProjectName\\": \\"poc_test\\",\\n \\"Creator\\": \\"1048133943212399\\",\\n \\"CreatorName\\": \\"user_name\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
@@ -273,65 +151,20 @@
],
],
'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',
- ],
+ ['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'],
],
];
diff --git a/data/zh_cn/datahub/2024-06-20/api-docs.php b/data/zh_cn/datahub/2024-06-20/api-docs.php
index 6ce7153..4681b6d 100644
--- a/data/zh_cn/datahub/2024-06-20/api-docs.php
+++ b/data/zh_cn/datahub/2024-06-20/api-docs.php
@@ -1,87 +1,58 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'datahub',
- 'version' => '2024-06-20',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'datahub', 'version' => '2024-06-20'],
'directories' => [
[
- 'id' => 377654,
- 'title' => '数据读写',
+ 'children' => ['GetRecords', 'PutRecords'],
'type' => 'directory',
- 'children' => [
- 'GetRecords',
- 'PutRecords',
- ],
+ 'title' => '数据读写',
+ 'id' => 424978,
],
[
- 'id' => 377657,
- 'title' => '同步任务管理',
+ 'children' => ['ListConnectors', 'GetConnector'],
'type' => 'directory',
- 'children' => [
- 'ListConnectors',
- 'GetConnector',
- ],
+ 'title' => '同步任务管理',
+ 'id' => 424979,
],
[
- 'id' => 377658,
- 'title' => '订阅管理',
+ 'children' => ['CreateSubscription', 'GetSubscription', 'ListSubscriptions', 'DeleteSubscription', 'GetGroup', 'ListGroups'],
'type' => 'directory',
- 'children' => [
- 'GetGroup',
- 'ListGroups',
- 'ListSubscriptions',
- 'GetSubscription',
- ],
+ 'title' => '订阅管理',
+ 'id' => 424980,
],
[
- 'id' => 377659,
- 'title' => 'Topic 管理',
+ 'children' => ['CreateTopic', 'UpdateTopic', 'DeleteTopic', 'GetTopic', 'ListTopics', 'GetSchema', 'ListSchemas'],
'type' => 'directory',
- 'children' => [
- 'GetTopic',
- 'ListTopics',
- 'GetSchema',
- 'ListSchemas',
- ],
+ 'title' => 'Topic 管理',
+ 'id' => 424981,
],
[
- 'id' => 377660,
- 'title' => 'Project 管理',
+ 'children' => ['CreateProject', 'ListProjects', 'GetProject', 'UpdateProject', 'DeleteProject'],
'type' => 'directory',
- 'children' => [
- 'GetProject',
- 'ListProjects',
- ],
+ 'title' => 'Project 管理',
+ 'id' => 424985,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetRecords' => [
- 'summary' => '读取指定topic的数据，主要是调试使用，大流量的读取请参考官方文档的SDK介绍。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateProject' => [
+ 'summary' => '创建project空间',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -89,47 +60,102 @@
[
'name' => 'ProjectName',
'in' => 'query',
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project'],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作空间的描述信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_comment'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '2025112610124322c53d0b028e7fa9'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
+ 'ProjectName' => ['description' => '项目名称', 'type' => 'string', 'example' => 'test_project'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => '资源已存在'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建项目',
+ 'description' => '创建project',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2025112610124322c53d0b028e7fa9\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\"\\n}","type":"json"}]',
+ ],
+ 'CreateSubscription' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20412',
+ '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',
- ],
+ 'schema' => ['description' => 'topic名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic'],
],
[
- 'name' => 'ShardId',
+ 'name' => 'SubscriptionId',
'in' => 'query',
- 'schema' => [
- 'description' => '读取数据的shardId。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '7',
- ],
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => '手动设置订阅ID(不指定则由服务端创建）'."\n"
+ ."\n"
+ .'1. 只能包含小写字母，数字和下划线(_)'."\n"
+ ."\n"
+ .'1. 必须以小写字母开头'."\n"
+ ."\n"
+ .'1. 名称长度限制在4-40个字符之间', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1764122860063VIIZ2'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Application',
'in' => 'query',
- 'schema' => [
- 'description' => '读取数据的开始时间，默认从当前时刻的5分钟前开始读取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '1769065251123',
- ],
+ 'schema' => ['description' => '新建的应用描述，最多支持256个字符', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_application'],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => ['description' => '订阅信息描述', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_abc'],
],
],
'responses' => [
@@ -137,103 +163,43 @@
'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',
- ],
- ],
- ],
- ],
+ 'SubscriptionId' => ['description' => '订阅ID', 'type' => 'string', 'example' => '1764123368886L0S9H'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '2025092710234722c53d0b08e811d8'],
+ 'Success' => ['description' => '是否成功', 'type' => 'string', 'example' => 'True'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => '资源已存在'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- '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' => '本接口主要是供用户调试使用，请勿使用该接口读取大量数据。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建订阅',
+ 'summary' => '创建订阅信息',
+ 'description' => '创建订阅信息',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubscriptionId\\": \\"1764123368886L0S9H\\",\\n \\"RequestId\\": \\"2025092710234722c53d0b08e811d8\\",\\n \\"Success\\": \\"True\\"\\n}","type":"json"}]',
],
- 'PutRecords' => [
- 'summary' => '向指定的topic写入数据，主要是调试使用，大流量的写入请参考官方文档的SDK介绍。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateTopic' => [
+ 'summary' => 'Topic是 DataHub 订阅和发布的最小单位，用户可以用Topic来表示一类或者一种流数据',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -242,12 +208,10 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -255,169 +219,173 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xiaowutest'],
],
[
'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => 'topic名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_topic',
- ],
+ 'schema' => ['description' => 'topic名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'adsb_cat021'],
],
[
- 'name' => 'ShardId',
+ 'name' => 'ShardCount',
'in' => 'query',
- 'schema' => [
- 'description' => '待写入的shardId，如果不指定，则随机写入某一个Shard。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '7',
- ],
+ 'schema' => ['description' => 'shard数量'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
- 'name' => 'Records',
+ 'name' => 'Lifecycle',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => 'Topic生命周期，单位为天'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'RecordType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Topic类型，目前支持Tuple与Blob两种类型：'."\n"
+ ."\n"
+ .'1. Blob类型Topic支持写入一块二进制数据作为一个Record。'."\n"
+ ."\n"
+ .'1. Tuple类型的Topic支持类似于数据库的记录的数据，每条记录包含多个列，需要指定RecordSchema，因为网络传输中，数据都是以字符串的形式发送，需要schema来转换成对应的类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TUPLE'],
+ ],
+ [
+ 'name' => 'RecordSchema',
+ 'in' => 'query',
+ 'schema' => ['description' => 'schema表结构', 'type' => 'string', 'required' => false, 'example' => '"{\\"fields\\":[{\\"name\\":\\"field_init\\",\\"type\\":\\"STRING\\",\\"notnull\\":\\"false\\"}]}"'],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Topic描述信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test'],
+ ],
+ [
+ 'name' => 'ExpandMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Topic扩展模式，开启扩展模式后，shard支持水平扩展，不再支持“合并”和“分裂”，以后shard数量只能增加，不可减少。此模式开启后可以使用kafka方式来消费当前Topic。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'EnableSchemaRegistry',
+ 'in' => 'query',
+ 'schema' => ['description' => '开启多version的schema，topic可以同时拥有多个schema，可以选择其中一个schema写入，消费端会根据每条数据标记的version自适应完成解析（如对应的version的schema被删除则解析失败）'."\n"
+ ."\n\n"
+ .'> 开启多version后会有以下影响 '."\n"
+ .'1.用户无法再使用appendFields接口、'."\n"
+ .' 2.可以对schema进行增删改查、'."\n"
+ .' 3.创建Connector使用最新version的schema'."\n"
+ ."\n\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'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,
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '2026020210000022c53d0b06900170'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
+ 'TopicName' => ['description' => 'topic名称', 'type' => 'string', 'example' => 'test01'],
],
- 'required' => true,
- 'docRequired' => true,
- 'maxItems' => 100,
- 'minItems' => 1,
+ 'description' => '',
],
],
],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => '资源已存在'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建topic',
+ 'description' => '创建Topic资源',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2026020210000022c53d0b06900170\\",\\n \\"Success\\": true,\\n \\"TopicName\\": \\"test01\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteProject' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'query',
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'jr_techout'],
+ ],
+ ],
'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',
- ],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '20260128101840d2a3770b05d299b3'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ShardId\\": \\"7\\"\\n}","type":"json"}]',
- 'title' => '发布数据',
- 'description' => '本接口主要是供用户调试使用，请勿使用该接口写入大量数据。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除项目',
+ 'summary' => '删除project，删除前需要删除project下的所有资源(Topic、同步任务、订阅任务)',
+ 'description' => '删除Project',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20260128101840d2a3770b05d299b3\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'ListConnectors' => [
- 'summary' => '获取同步任务列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteSubscription' => [
+ 'summary' => '删除订阅任务',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahub86JVYW'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -425,91 +393,84 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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',
- ],
+ 'schema' => ['description' => 'topic 名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic'],
],
[
- 'name' => 'Skip',
+ 'name' => 'SubscriptionId',
'in' => 'query',
+ 'schema' => ['description' => '订阅ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1713853462590KA0YP'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '分页查询时跳过的记录数'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '1',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '2026031915480122c53d0b00c2d347'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => '资源已存在'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
[
- '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',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除订阅',
+ 'description' => '删除订阅任务',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2026031915480122c53d0b00c2d347\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteTopic' => [
+ 'summary' => '删除topic资源，删除topic资源前需要删除对应topic下的所有订阅和同步任务',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '9892074a2a89600ae4b0d5a34fb99a3f',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'Keyword',
+ 'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时的过滤关键词',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'dh',
- ],
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'feeding'],
],
[
- 'name' => 'Pure',
+ 'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => '是否仅返回主键信息',
- 'type' => 'boolean',
- 'required' => false,
- 'docRequired' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '需要删除的topic名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'liuywdb01_hh1'],
],
],
'responses' => [
@@ -517,181 +478,40 @@
'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',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '20250623101207d2a3770b026dd321'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- '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' => '查询同步任务列表信息。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除topic',
+ 'description' => '删除topic资源',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20250623101207d2a3770b026dd321\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetConnector' => [
'summary' => '查询同步任务信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -703,9 +523,7 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -713,35 +531,17 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '同步任务id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c5e07a96-5069-4486-87c3-0d281951f772'],
],
],
'responses' => [
@@ -749,136 +549,69 @@
'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',
- ],
+ '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'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- '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"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询同步任务信息',
'description' => '查询同步任务信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Connector', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}/connector/{#connectorId}'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
],
'GetGroup' => [
- 'summary' => '查询消费组信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -890,9 +623,7 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -900,22 +631,12 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_project',
- ],
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'example' => 'test_project'],
],
[
'name' => 'GroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '消费组名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_group',
- ],
+ 'schema' => ['description' => '消费组名称', 'type' => 'string', 'required' => true, 'example' => 'test_group'],
],
],
'responses' => [
@@ -923,116 +644,66 @@
'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',
- ],
+ '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\'}]',
- ],
+ 'items' => ['description' => '消费组所绑定的topic列表', 'type' => 'string', 'example' => '[{\'topic\': \'pub/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'pub\', \'permission\': \'W\'}, {\'topic\': \'sub/nologin/uuid/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'sub-uuid\', \'permission\': \'R\'}]'],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'ResourceAlreadyExist',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => '资源已存在'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- '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"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询消费组信息',
+ 'summary' => '查询消费组信息。',
'description' => '查询消费组信息。',
- ],
- 'ListGroups' => [
- 'summary' => '获取消费组列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Group', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#projectName}/group/{#groupName}'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'GetProject' => [
+ 'summary' => '查询Project信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1041,12 +712,10 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1054,73 +723,102 @@
[
'name' => 'ProjectName',
'in' => 'query',
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_project',
+ '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'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
[
- 'name' => 'Skip',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时跳过的记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '1',
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询项目信息',
+ 'description' => '查询Project信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetProject',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}'],
+ ],
],
],
+ ],
+ '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"}]',
+ ],
+ 'GetRecords' => [
+ 'summary' => '读取指定topic的数据，主要是调试使用，大流量的读取请参考官方文档的SDK介绍。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'MaxResults',
+ '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' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '1000',
- 'minimum' => '0',
- 'exclusiveMinimum' => true,
- 'example' => '5',
- 'default' => '5',
- ],
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '9892074a2a89600ae4b0d5a34fb99a3f',
- ],
+ 'schema' => ['description' => 'topic名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic'],
],
[
- 'name' => 'Keyword',
+ 'name' => 'ShardId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时的过滤关键词',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'dh',
- ],
+ 'schema' => ['description' => '读取数据的shardId。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7'],
],
[
- 'name' => 'Pure',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '是否仅返回主键信息',
- 'type' => 'boolean',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '读取数据的开始时间，默认从当前时刻的5分钟前开始读取。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1769065251123'],
],
],
'responses' => [
@@ -1128,142 +826,73 @@
'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' => '消费组列表',
+ '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' => '消费组列表',
+ 'description' => '单个 Record 的内容。',
'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列表',
+ 'Data' => [
+ 'description' => 'Record 的数据内容。',
'type' => 'array',
- 'items' => [
- 'description' => 'topic名称',
- 'type' => 'string',
- 'example' => '["topic1","topic2"]',
- ],
- ],
- 'Creator' => [
- 'description' => '消费组创建者',
- 'type' => 'string',
- 'example' => '276887103073464052',
- ],
- 'CreateTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1708171905000',
+ 'items' => ['description' => '记录的具体DNS信息。不同类型记录包含不同的信息。', 'type' => 'string', 'example' => '10'],
],
- 'UpdateTime' => [
- 'description' => '最后更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1708171905000',
+ 'Attributes' => [
+ 'description' => 'Record 的额外信息，如没有额外信息则为空。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'Record 的额外信息。', 'example' => 'key:val'],
],
+ 'SystemTime' => ['description' => 'Record的写入时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1769065251123'],
],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '订阅数据',
+ 'description' => '本接口主要是供用户调试使用，请勿使用该接口读取大量数据。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dhs:GetRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}'],
+ ],
+ ],
+ ],
],
- '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' => '查询消费组列表信息。',
+ '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"}]',
],
- 'ListSubscriptions' => [
- 'summary' => '获取订阅列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetSchema' => [
+ 'summary' => '查询Schema信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1272,12 +901,10 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahub86JVYW',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1285,74 +912,18 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '主题名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'VersionId',
'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',
- ],
+ 'schema' => ['description' => 'schema版本号'."\n"
+ ."\n", 'type' => 'string', 'required' => true, 'example' => '0'],
],
],
'responses' => [
@@ -1360,158 +931,60 @@
'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',
- ],
- ],
- ],
- ],
- ],
- ],
+ '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'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => '资源已存在'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询Shema信息',
+ 'description' => '查询Scema信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetSchema',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Schema', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}/schema/{#versionId}'],
+ ],
+ ],
+ ],
],
- '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' => '查询订阅列表信息。',
+ '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"}]',
],
'GetSubscription' => [
- 'summary' => '查询订阅信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1523,9 +996,7 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahub86JVYW',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahub86JVYW'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1533,35 +1004,17 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '订阅Id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1764122860063VIIZ2'],
],
],
'responses' => [
@@ -1569,128 +1022,68 @@
'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',
- ],
+ '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'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- '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"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询订阅信息',
+ 'summary' => '查询订阅信息。',
'description' => '查询订阅信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetSubscription',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Subscription', 'arn' => 'acs:datahub:{#regionId}:{#accountId}:project/{#ProjectName}topic/{#TopicName}/subscription/{#SubscriptionId}'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
],
'GetTopic' => [
'summary' => '查询Topic信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1702,9 +1095,7 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1712,24 +1103,12 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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",
- ],
+ 'schema' => ['description' => 'topic名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic'."\n"],
],
],
'responses' => [
@@ -1737,141 +1116,68 @@
'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',
- ],
+ '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'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- '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"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询Topic信息',
'description' => '查询Topic信息。',
- ],
- 'ListTopics' => [
- 'summary' => '获取Topic列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'ListConnectors' => [
+ 'summary' => '获取同步任务列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1883,9 +1189,7 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1893,73 +1197,44 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '分页查询时跳过的记录数'."\n"
+ ."\n", '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',
- ],
+ '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',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '分页查询时的过滤关键词', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dh'],
],
[
'name' => 'Pure',
'in' => 'query',
'schema' => [
- 'description' => '是否仅返回主键信息'."\n"
- ."\n",
+ 'description' => '是否仅返回主键信息',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'false',
],
],
@@ -1969,173 +1244,94 @@
'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',
- ],
+ '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列表',
+ 'Connector' => [
+ 'description' => '同步任务列表',
'type' => 'array',
'items' => [
- 'description' => 'topic列表',
+ 'description' => '同步任务列表',
'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描述信息',
+ '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',
- 'example' => '这是一个描述信息',
+ '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',
],
- 'Creator' => [
- 'description' => 'topic创建者',
+ 'State' => [
+ 'description' => '同步任务状态',
'type' => 'string',
- 'example' => '276887103073464052',
- ],
- 'CreateTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1753346106000',
- ],
- 'UpdateTime' => [
- 'description' => '最后更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1753346106000',
+ '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'],
],
],
],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取同步任务列表',
+ 'description' => '查询同步任务列表信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListConnectors',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Connector', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}/*'],
+ ],
+ ],
+ ],
],
- '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列表信息。',
+ '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"}]',
],
- 'GetSchema' => [
- 'summary' => '查询Schema信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListGroups' => [
+ 'summary' => '获取消费组列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2144,12 +1340,10 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -2157,34 +1351,154 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ 'schema' => ['description' => '项目名称', 'type' => 'string', 'required' => true, 'example' => 'test_project'],
],
[
- 'name' => 'TopicName',
+ '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' => [
- 'description' => '主题名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_topic',
+ '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'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
[
- 'name' => 'VersionId',
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取消费组列表',
+ 'description' => '查询消费组列表信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListGroups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Group', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#projectName}/*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ ],
+ 'ListProjects' => [
+ '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' => 'schema版本号'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '0',
+ 'description' => '是否仅返回主键信息',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'example' => 'false',
],
],
],
@@ -2193,108 +1507,77 @@
'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',
+ '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'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'ResourceAlreadyExist',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取项目列表',
+ 'summary' => '获取项目列表。',
+ 'description' => '查询Project列表信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListProjects',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:*'],
+ ],
+ ],
+ ],
],
- '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信息。',
+ '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"}]',
],
'ListSchemas' => [
- 'summary' => '获取Schema列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2306,9 +1589,7 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -2316,63 +1597,27 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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",
- ],
+ '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',
- ],
+ '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',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '分页查询的令牌（Token）。取值：如果NextToken为空表示从头开始查询。 否则从令牌所对应上一次查询末尾开始查询。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9892074a2a89600ae4b0d5a34fb99a3f'],
],
],
'responses' => [
@@ -2380,34 +1625,12 @@
'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',
- ],
+ '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',
@@ -2415,99 +1638,61 @@
'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',
- ],
+ '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'],
],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'ResourceAlreadyExist',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => '资源已存在'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- '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"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取Schema列表',
+ 'summary' => '获取Schema列表。',
'description' => '查询schema列表信息。',
- ],
- 'GetProject' => [
- 'summary' => '查询Project信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:ListSchemas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Schema', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}/*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'ListSubscriptions' => [
+ 'summary' => '获取订阅列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2516,12 +1701,10 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahub86JVYW'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -2529,13 +1712,32 @@
[
'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test_project',
- ],
+ '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' => [
@@ -2543,106 +1745,84 @@
'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',
+ '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'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取订阅列表',
+ 'description' => '查询订阅列表信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListSubscriptions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Subscription', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}topic/{#TopicName}/*'],
+ ],
+ ],
+ ],
],
- '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信息。',
+ '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"}]',
],
- 'ListProjects' => [
- 'summary' => '获取项目列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListTopics' => [
+ 'summary' => '获取Topic列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2654,77 +1834,41 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdatahubB2GCPA',
- ],
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ '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',
- ],
+ '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',
- ],
+ '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',
- ],
+ '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',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '是否仅返回主键信息'."\n"
+ ."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false'],
],
],
'responses' => [
@@ -2732,182 +1876,656 @@
'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',
- ],
+ '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' => '项目列表',
+ 'Topic' => [
+ 'description' => 'topic列表',
'type' => 'array',
'items' => [
- 'description' => '项目列表',
+ 'description' => 'topic列表',
'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',
- ],
+ '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'],
],
],
],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Error:%s.',
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取Topic列表',
+ 'description' => '查询Topic列表信息。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListTopics',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ ],
+ '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,
],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'Error:%s.',
+ ],
+ ],
+ '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'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'Error:%s.',
- ],
- [
- 'errorCode' => 'OperationDenied',
- 'errorMessage' => 'Error:%s.',
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '发布数据',
+ 'description' => '本接口主要是供用户调试使用，请勿使用该接口写入大量数据。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dhs:PutRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ShardId\\": \\"7\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateProject' => [
+ 'summary' => '更新Project描述信息',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'Error:%s.',
+ 'name' => 'ProjectName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'project名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project'],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => ['description' => 'project 描述信息', 'type' => 'string', 'required' => false, 'example' => 'ec800m-y数据总线，康复中心'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '20250923101459e68e3d0b0869e5e4'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'Error:%s.',
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新项目信息',
+ 'description' => '更新Project描述信息',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20250923101459e68e3d0b0869e5e4\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'UpdateTopic' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ '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, 'example' => 'test_topic'."\n"],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '20260319152525d2a3770b00c232d4'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
+ ],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => '输入的参数不合法'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => '缺少必须参数'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => '您无权执行此操作。'],
+ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => '操作被拒绝'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => '资源不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ],
],
- '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列表信息。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新Topic信息',
+ 'summary' => '更新Topic描述信息',
+ 'description' => '更新Topic描述信息',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20260319152525d2a3770b00c232d4\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
],
'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' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.cn-shenzhen.aliyuncs.com', 'endpoint' => 'datahub.cn-shenzhen.aliyuncs.com', 'vpc' => 'datahub-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'datahub.cn-wulanchabu.aliyuncs.com', 'vpc' => 'datahub-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.cn-beijing.aliyuncs.com', 'endpoint' => 'datahub.cn-beijing.aliyuncs.com', 'vpc' => 'datahub-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.cn-shanghai.aliyuncs.com', 'endpoint' => 'datahub.cn-shanghai.aliyuncs.com', 'vpc' => 'datahub-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.cn-hongkong.aliyuncs.com', 'endpoint' => 'datahub.cn-hongkong.aliyuncs.com', 'vpc' => 'datahub-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.ap-southeast-1.aliyuncs.com', 'endpoint' => 'datahub.ap-southeast-1.aliyuncs.com', 'vpc' => 'datahub-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.ap-southeast-3.aliyuncs.com', 'endpoint' => 'datahub.ap-southeast-3.aliyuncs.com', 'vpc' => 'datahub-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.ap-southeast-5.aliyuncs.com', 'endpoint' => 'datahub.ap-southeast-5.aliyuncs.com', 'vpc' => 'datahub-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'datahub.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'datahub-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'datahub.cn-hangzhou.aliyuncs.com', 'endpoint' => 'datahub.cn-hangzhou.aliyuncs.com', 'vpc' => 'datahub-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'datahub.eu-central-1.aliyuncs.com', 'endpoint' => 'datahub.eu-central-1.aliyuncs.com', 'vpc' => 'datahub-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'datahub.aliyuncs.com', 'endpoint' => 'datahub.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'datahub.aliyuncs.com', 'endpoint' => 'datahub.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-central-1', 'regionName' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'datahub.me-central-1.aliyuncs.com', 'endpoint' => 'datahub.me-central-1.aliyuncs.com', 'vpc' => 'datahub-vpc.me-central-1.aliyuncs.com'],
+ ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'datahub.aliyuncs.com', 'endpoint' => 'datahub.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'ApiProxyServiceError', 'message' => 'Error:%s.', 'http_code' => 500, 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ['code' => 'InternalServerError', 'message' => '%s.', 'http_code' => 500, 'description' => '系统内部错误'],
+ ['code' => 'InternalServerError', 'message' => 'Error:%s.', 'http_code' => 500, 'description' => '服务端错误，服务端不可用或发生了预期外的错误'],
+ ['code' => 'InvalidParameter', 'message' => 'The input parameter is invalid.', 'http_code' => 400, 'description' => '输入参数不合法'],
+ ['code' => 'InvalidParameter', 'message' => 'Error:%s.', 'http_code' => 400, 'description' => '输入的参数不合法'],
+ ['code' => 'MissingParameter', 'message' => '%s.', 'http_code' => 400, 'description' => '缺少必须参数'],
+ ['code' => 'MissingParameter', 'message' => 'Error:%s.', 'http_code' => 400, 'description' => '缺少必须参数'],
+ ['code' => 'NoPermission', 'message' => 'Error:%s.', 'http_code' => 403, 'description' => '您无权执行此操作。'],
+ ['code' => 'OperationDenied', 'message' => '%s.', 'http_code' => 403, 'description' => '操作被拒绝'],
+ ['code' => 'OperationDenied', 'message' => 'Error:%s.', 'http_code' => 403, 'description' => '操作被拒绝'],
+ ['code' => 'ResourceAlreadyExist', 'message' => 'Collect space already exists.', 'http_code' => 400, 'description' => '采集空间已存在'],
+ ['code' => 'ResourceAlreadyExist', 'message' => 'Error:%s.', 'http_code' => 400, 'description' => '资源已存在'],
+ ['code' => 'ResourceNotFound', 'message' => 'Resource not found.', 'http_code' => 404, 'description' => '采集空间不存在'],
+ ['code' => 'ResourceNotFound', 'message' => '%s.', 'http_code' => 404, 'description' => '资源不存在'],
+ ['code' => 'ResourceNotFound', 'message' => 'Error:%s.', 'http_code' => 404, 'description' => '资源不存在'],
+ ['code' => 'VPCServiceError', 'message' => 'get vpc info failed.', 'http_code' => 400, 'description' => '获取vpc信息失败'],
+ ],
+ 'changeSet' => [],
+ 'ram' => [
+ 'productCode' => 'DataHub',
+ 'productName' => '数据总线 DataHub',
+ 'ramCodes' => ['dhs'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DeleteTopic',
+ 'description' => '删除topic',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dhs:DeleteTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetConnector',
+ 'description' => '查询同步任务信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Connector', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/connectors/{#ConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSchema',
+ 'description' => '查询Shema信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetSchema',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Schema', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/schemas/{#versionId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSchemas',
+ 'description' => '获取Schema列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:ListSchemas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Schema', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/schemas/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateTopic',
+ 'description' => '更新Topic信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dhs:UpdateTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRecords',
+ 'description' => '订阅数据',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dhs:GetRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTopics',
+ 'description' => '获取Topic列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListTopics',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PutRecords',
+ 'description' => '发布数据',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dhs:PutRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListGroups',
+ 'description' => '获取消费组列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListGroups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Group', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#projectName}/groups/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetProject',
+ 'description' => '查询项目信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetProject',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSubscription',
+ 'description' => '查询订阅信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetSubscription',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Subscription', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/subscriptions/{#SubscriptionId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProject',
+ 'description' => '更新项目信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dhs:UpdateProject',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSubscriptions',
+ 'description' => '获取订阅列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListSubscriptions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Subscription', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/subscriptions/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProject',
+ 'description' => '创建项目',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dhs:CreateProject',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTopic',
+ 'description' => '创建topic',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dhs:CreateTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListConnectors',
+ 'description' => '获取同步任务列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListConnectors',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Connector', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/connectors/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListProjects',
+ 'description' => '获取项目列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dhs:ListProjects',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetGroup',
+ 'description' => '查询消费组信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Group', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#projectName}/groups/{#groupName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTopic',
+ 'description' => '查询Topic信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dhs:GetTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteProject',
+ 'description' => '删除项目',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dhs:DeleteProject',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'],
+ ],
+ ],
+ ],
],
- [
- 'regionId' => 'me-central-1',
- 'endpoint' => 'datahub.me-central-1.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ['validationType' => 'always', 'resourceType' => 'Connector', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/connectors/{#ConnectorId}'],
+ ['validationType' => 'always', 'resourceType' => 'Schema', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/schemas/{#versionId}'],
+ ['validationType' => 'always', 'resourceType' => 'Schema', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/schemas/*'],
+ ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}'],
+ ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/*'],
+ ['validationType' => 'always', 'resourceType' => 'Group', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#projectName}/groups/*'],
+ ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'],
+ ['validationType' => 'always', 'resourceType' => 'Subscription', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/subscriptions/{#SubscriptionId}'],
+ ['validationType' => 'always', 'resourceType' => 'Subscription', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/subscriptions/*'],
+ ['validationType' => 'always', 'resourceType' => 'Connector', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/connectors/*'],
+ ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/*'],
+ ['validationType' => 'always', 'resourceType' => 'Group', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#projectName}/groups/{#groupName}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:38:31 +0000