diff options
Diffstat (limited to 'data/en_us/datahub')
| -rw-r--r-- | data/en_us/datahub/2019-11-20/api-docs.php | 265 | ||||
| -rw-r--r-- | data/en_us/datahub/2024-06-20/api-docs.php | 3887 |
2 files changed, 1912 insertions, 2240 deletions
diff --git a/data/en_us/datahub/2019-11-20/api-docs.php b/data/en_us/datahub/2019-11-20/api-docs.php index a6b12c7..4d7477a 100644 --- a/data/en_us/datahub/2019-11-20/api-docs.php +++ b/data/en_us/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' => 'Query project list information', - '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' => 'Current page number', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'Search keyword', - 'type' => 'string', - 'required' => false, - 'example' => 'search_key', - ], + 'schema' => ['description' => 'Search keyword', 'type' => 'string', 'required' => false, 'example' => 'search_key'], ], ], 'responses' => [ @@ -149,31 +98,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'Total number of query results', - 'type' => 'string', - 'example' => '50', - ], - 'RequestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '20250401102332e68e3d0b04ab4904', - ], - 'PageSize' => [ - 'description' => 'Page size', - 'type' => 'string', - 'example' => '10', - ], - 'PageCount' => [ - 'description' => 'Total number of pages', - 'type' => 'string', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'Current page number', - 'type' => 'string', - 'example' => '84', - ], + 'TotalCount' => ['description' => 'Total number of query results', 'type' => 'string', 'example' => '50'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '20250401102332e68e3d0b04ab4904'], + 'PageSize' => ['description' => 'Page size', 'type' => 'string', 'example' => '10'], + 'PageCount' => ['description' => 'Total number of pages', 'type' => 'string', 'example' => '1'], + 'PageNumber' => ['description' => 'Current page number', 'type' => 'string', 'example' => '84'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -185,87 +114,36 @@ 'description' => 'Project information.', 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'description' => 'Update time'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708171905000', - ], - 'Comment' => [ - 'description' => 'Text comment for the field', - 'type' => 'string', - 'example' => '测试专用', - ], - 'CreateTime' => [ - 'description' => 'Creation time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708171905000', - ], - 'ProjectName' => [ - 'description' => 'Project name', - 'type' => 'string', - 'example' => 'poc_test', - ], - 'Creator' => [ - 'description' => 'Creator ID', - 'type' => 'string', - 'example' => '1048133943212399', - ], - 'CreatorName' => [ - 'description' => 'Creator\'s name', - 'type' => 'string', - 'example' => 'user_name', - ], + 'UpdateTime' => ['description' => 'Update time'."\n" + ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000'], + 'Comment' => ['description' => 'Text comment for the field', 'type' => 'string', 'example' => '测试专用'], + 'CreateTime' => ['description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000'], + 'ProjectName' => ['description' => 'Project name', 'type' => 'string', 'example' => 'poc_test'], + 'Creator' => ['description' => 'Creator ID', 'type' => 'string', 'example' => '1048133943212399'], + 'CreatorName' => ['description' => 'Creator\'s name', 'type' => 'string', 'example' => 'user_name'], ], ], ], ], ], - 'Success' => [ - 'description' => 'Whether the operation was successful', - 'type' => 'boolean', - 'example' => 'True', - ], + 'Success' => ['description' => 'Whether the operation was successful', '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"}]', @@ -274,65 +152,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/en_us/datahub/2024-06-20/api-docs.php b/data/en_us/datahub/2024-06-20/api-docs.php index 40112ec..e7c13cc 100644 --- a/data/en_us/datahub/2024-06-20/api-docs.php +++ b/data/en_us/datahub/2024-06-20/api-docs.php @@ -1,87 +1,53 @@ <?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' => null, + 'children' => ['GetRecords', 'PutRecords'], 'type' => 'directory', - 'children' => [ - 'GetRecords', - 'PutRecords', - ], + 'title' => 'Data read and write', ], [ - 'id' => 377657, - 'title' => null, + 'children' => ['ListConnectors', 'GetConnector'], 'type' => 'directory', - 'children' => [ - 'ListConnectors', - 'GetConnector', - ], + 'title' => 'Synchronization task management', ], [ - 'id' => 377658, - 'title' => null, + 'children' => ['CreateSubscription', 'GetSubscription', 'ListSubscriptions', 'DeleteSubscription', 'GetGroup', 'ListGroups'], 'type' => 'directory', - 'children' => [ - 'GetGroup', - 'ListGroups', - 'ListSubscriptions', - 'GetSubscription', - ], + 'title' => 'Subscription management', ], [ - 'id' => 377659, - 'title' => null, + 'children' => ['CreateTopic', 'UpdateTopic', 'DeleteTopic', 'GetTopic', 'ListTopics', 'GetSchema', 'ListSchemas'], 'type' => 'directory', - 'children' => [ - 'GetTopic', - 'ListTopics', - 'GetSchema', - 'ListSchemas', - ], + 'title' => 'Topic management', ], [ - 'id' => 377660, - 'title' => null, + 'children' => ['CreateProject', 'ListProjects', 'GetProject', 'UpdateProject', 'DeleteProject'], 'type' => 'directory', - 'children' => [ - 'GetProject', - 'ListProjects', - ], + 'title' => 'Project management', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'GetRecords' => [ - 'summary' => '读取Topic数据', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateProject' => [ + 'summary' => 'Creates a 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 +55,116 @@ [ 'name' => 'ProjectName', 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The description of the workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_comment', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2025112610124322c53d0b028e7fa9', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => 'Resource already exists'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a project', + 'description' => 'Creates a project.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dhs:CreateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'], + ], + ], + ], + ], + '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' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], [ 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic', - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], ], [ - 'name' => 'ShardId', + 'name' => 'SubscriptionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '7', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The subscription ID that you manually specify. If you do not specify this parameter, the server automatically generates one.'."\n" + ."\n" + .'1. The ID can contain only lowercase letters, digits, and underscores (_).'."\n" + ."\n" + .'1. The ID must start with a lowercase letter.'."\n" + ."\n" + .'1. The ID must be 4 to 40 characters in length.', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => '1764122860063VIIZ2', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Application', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1769065251123', - ], + 'schema' => ['description' => 'The description of the new application. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_application', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The description of the subscription.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_abc', 'title' => ''], ], ], 'responses' => [ @@ -137,101 +172,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Records' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - ], - 'Attributes' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'key:val', - ], - ], - 'SystemTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1769065251123', - ], - ], - ], - ], + 'SubscriptionId' => ['description' => 'The subscription ID.', 'type' => 'string', 'example' => '1764123368886L0S9H', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2025092710234722c53d0b08e811d8', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'True', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => 'Resource already exists'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], ], ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a subscription', + 'summary' => 'Creates subscription information.', + 'description' => 'Creates subscription information.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubscriptionId\\": \\"1764123368886L0S9H\\",\\n \\"RequestId\\": \\"2025092710234722c53d0b08e811d8\\",\\n \\"Success\\": \\"True\\"\\n}","type":"json"}]', ], - 'PutRecords' => [ - 'summary' => '写入数据', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateTopic' => [ + 'summary' => 'A topic is the smallest unit for DataHub subscription and publishing. You can use a topic to represent a type or category of streaming data.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -240,12 +219,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -253,79 +230,56 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xiaowutest', 'title' => ''], ], [ 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic', - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'adsb_cat021', 'title' => ''], ], [ - 'name' => 'ShardId', + 'name' => 'ShardCount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '7', - ], + 'schema' => ['description' => 'The number of shards.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Records', + 'name' => 'Lifecycle', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aa', - ], - 'required' => true, - 'example' => '["aa", "bb", "12", "12.34"]', - 'maxItems' => 100, - ], - 'Attributes' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'key:val', - 'description' => '', - ], - 'example' => '{"key1":"val1","key2":"val2"}', - ], - ], - 'required' => false, - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 100, - 'minItems' => 1, - ], + 'schema' => ['description' => 'The lifecycle of the topic. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'RecordType', + 'in' => 'query', + 'schema' => ['description' => 'The topic type. Valid values:'."\n" + ."\n" + .'1. Blob: supports writing a block of binary data as a single record.'."\n" + ."\n" + .'1. Tuple: supports database-like records where each record contains multiple columns. You must specify RecordSchema because data is transmitted over the network as strings and requires a schema to convert the data into the corresponding types.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TUPLE', 'title' => ''], + ], + [ + 'name' => 'RecordSchema', + 'in' => 'query', + 'schema' => ['description' => 'The schema table structure.', 'type' => 'string', 'required' => false, 'example' => '"{\\"fields\\":[{\\"name\\":\\"field_init\\",\\"type\\":\\"STRING\\",\\"notnull\\":\\"false\\"}]}"', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The description of the topic.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test', 'title' => ''], + ], + [ + 'name' => 'ExpandMode', + 'in' => 'query', + 'schema' => ['description' => 'The expansion mode of the topic. After the expansion mode is enabled, shards support horizontal scaling and no longer support merge or split operations. The number of shards can only increase and cannot decrease. After this mode is enabled, you can consume the current topic by using Kafka.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'EnableSchemaRegistry', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable multi-version schema. After this feature is enabled, a topic can have multiple schemas. You can select one of the schemas for writing. The consumer automatically parses each record based on the version tag. If the schema for the corresponding version has been deleted, parsing fails.'."\n" + ."\n" + .'> Enabling multi-version schema has the following impacts:'."\n" + .'1. You can no longer use the appendFields operation.'."\n" + .' 2. You can create, delete, modify, and query schemas.'."\n" + .' 3. Connectors are created by using the schema of the latest version.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -333,87 +287,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ShardId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2026020210000022c53d0b06900170', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test01', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => 'Resource already exists'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a topic', + 'description' => 'Creates a topic resource.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ShardId\\": \\"7\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2026020210000022c53d0b06900170\\",\\n \\"Success\\": true,\\n \\"TopicName\\": \\"test01\\"\\n}","type":"json"}]', ], - 'ListConnectors' => [ - 'summary' => '查询Connector列表信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteProject' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -421,89 +355,162 @@ [ 'name' => 'ProjectName', 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'jr_techout', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20260128101840d2a3770b05d299b3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], [ - 'name' => 'TopicName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a project', + 'summary' => 'Deletes a project. Before deleting a project, delete all resources under the project, including topics, synchronization tasks, and subscription tasks.', + 'description' => 'Deletes a project.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dhs:DeleteProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20260128101840d2a3770b05d299b3\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteSubscription' => [ + 'summary' => 'Deletes a subscription task.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Skip', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdatahub86JVYW'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '5', - 'default' => '5', - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'SubscriptionId', 'in' => 'query', + 'schema' => ['description' => 'The subscription ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1713853462590KA0YP', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2026031915480122c53d0b00c2d347', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => 'Resource already exists'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], [ - 'name' => 'Keyword', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a subscription', + 'description' => 'Deletes a subscription task.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2026031915480122c53d0b00c2d347\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteTopic' => [ + 'summary' => 'Deletes a topic resource. Before deleting a topic resource, delete all subscriptions and sync tasks under the topic.', + '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' => false, - 'docRequired' => false, - 'example' => 'dh', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'feeding', 'title' => ''], ], [ - 'name' => 'Pure', + 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The name of the topic to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'liuywdb01_hh1', 'title' => ''], ], ], 'responses' => [ @@ -511,179 +518,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'test_topic', - ], - 'ConnectorId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fa44384c-0ac5-4d3e-8acd-76e18636ab10', - ], - 'SubscriptionId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2025-12-04 16:45:00', - ], - 'ColumnFields' => [ - 'description' => '', - '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' => 'The request ID.', 'type' => 'string', 'example' => '20250623101207d2a3770b026dd321', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a topic', + 'description' => 'Deletes a topic resource.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - '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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20250623101207d2a3770b026dd321\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetConnector' => [ - 'summary' => '查询Connector信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the information about a synchronization task.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -695,9 +577,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -705,35 +585,17 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], ], [ 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic', - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], ], [ 'name' => 'ConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c5e07a96-5069-4486-87c3-0d281951f772', - ], + 'schema' => ['description' => 'The synchronization task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c5e07a96-5069-4486-87c3-0d281951f772', 'title' => ''], ], ], 'responses' => [ @@ -741,128 +603,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ConnectorId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c5e07a96-5069-4486-87c3-0d281951f772', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SINK_ODPS', - ], - 'State' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ColumnFields' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[\\"field1\\",\\"field2\\"]', - ], - 'Config' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2025-06-06 15:45:00', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '270523390948438349', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1724041098000', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1724041098000', - ], - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_project', - ], - 'TopicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_topic', - ], - 'SubscriptionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1764123132492KO88A', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ConnectorId' => ['description' => 'The synchronization task ID.', 'type' => 'string', 'example' => 'c5e07a96-5069-4486-87c3-0d281951f772', 'title' => ''], + 'Type' => ['description' => 'The type of the synchronization task.', 'type' => 'string', 'example' => 'SINK_ODPS', 'title' => ''], + 'State' => ['description' => 'The status of the synchronization task.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'ColumnFields' => ['description' => 'The list of fields for the synchronization task.', 'type' => 'string', 'example' => '[\\"field1\\",\\"field2\\"]', 'title' => ''], + 'Config' => ['description' => 'The configuration information of the synchronization task.', '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\\"}', 'title' => ''], + 'DoneTime' => ['description' => 'The time when the synchronization task is marked as done. This parameter takes effect only for ODPS synchronization (SINK_ODPS) tasks.', 'type' => 'string', 'example' => '2025-06-06 15:45:00', 'title' => ''], + 'Creator' => ['description' => 'The creator of the synchronization task.', 'type' => 'string', 'example' => '270523390948438349', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1724041098000', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.', 'type' => 'string', 'example' => '1724041098000', 'title' => ''], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test_topic', 'title' => ''], + 'SubscriptionId' => ['description' => 'The subscription ID.', 'type' => 'string', 'example' => '1764123132492KO88A', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query synchronization task information', + 'description' => 'Queries the information about a synchronization task.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - '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"}]', ], 'GetGroup' => [ - 'summary' => '查询Group信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -874,9 +673,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -884,22 +681,12 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'test_project', 'title' => ''], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_group', - ], + 'schema' => ['description' => 'The consumer group name.', 'type' => 'string', 'required' => true, 'example' => 'test_group', 'title' => ''], ], ], 'responses' => [ @@ -907,113 +694,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', - ], - 'Success' => [ - 'description' => '', - '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' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'GroupName' => ['description' => 'The consumer group name.', 'type' => 'string', 'example' => 'consumer_group1', 'title' => ''], + 'Comment' => ['description' => 'The description of the consumer group.', 'type' => 'string', 'example' => 'test_comment', 'title' => ''], + 'Creator' => ['description' => 'The creator of the consumer group.', 'type' => 'string', 'example' => '270523390948438349', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the consumer group was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724041098000', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the consumer group was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724041098000', 'title' => ''], 'TopicList' => [ - 'description' => '', + 'description' => 'The list of topics associated with the consumer group.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\'topic\': \'pub/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'pub\', \'permission\': \'W\'}, {\'topic\': \'sub/nologin/uuid/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'sub-uuid\', \'permission\': \'R\'}]', - ], + 'items' => ['description' => 'The list of topics associated with the consumer group.', 'type' => 'string', 'example' => '[{\'topic\': \'pub/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'pub\', \'permission\': \'W\'}, {\'topic\': \'sub/nologin/uuid/4A4AD3BC0A436B44092F9BDDD1B3ACE4\', \'type\': \'sub-uuid\', \'permission\': \'R\'}]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'ResourceAlreadyExist', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => 'Resource already exists'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query consumer group information', + 'summary' => 'Queries the information about a consumer group.', + 'description' => 'Queries the information about a consumer group.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - '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"}]', ], - 'ListGroups' => [ - 'summary' => '查询Group列表信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetProject' => [ + 'summary' => 'Queries project information.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1022,12 +765,10 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1035,73 +776,104 @@ [ 'name' => 'ProjectName', 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'Comment' => ['description' => 'The project description.', 'type' => 'string', 'example' => 'test_comment', 'title' => ''], + 'VpcWhitelist' => ['description' => 'The VPC whitelist of the project.', 'type' => 'string', 'example' => '[\\"11.22.33.44\\"]', 'title' => ''], + 'Storage' => ['description' => 'The total storage capacity of the project.', 'type' => 'integer', 'format' => 'int64', 'example' => '12252454', 'title' => ''], + 'Creator' => ['description' => 'The creator of the project.', 'type' => 'string', 'example' => '1559031978056215', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the project was created.', 'type' => 'string', 'example' => '1724041098000', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the project was last updated.', 'type' => 'string', 'example' => '1724041098000', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], [ - 'name' => 'Skip', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query project information', + 'description' => 'Queries project information.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dhs:GetProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#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' => 'Reads data from a specified topic. This operation is primarily used for debugging. For high-volume data reading, refer to the SDK documentation.', + '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' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'ShardId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dh', - ], + 'schema' => ['description' => 'The shard ID from which to read data.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7', 'title' => ''], ], [ - 'name' => 'Pure', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The start time for reading data. By default, data is read starting from 5 minutes before the current time.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => false, 'example' => '1769065251123', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -1109,140 +881,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], - 'List' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Records' => [ + 'description' => 'The records that were read.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The content of a single 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' => '', + 'Data' => [ + 'description' => 'The data content of the record.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["topic1","topic2"]', - ], - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '276887103073464052', + 'items' => ['description' => 'The specific DNS information of the record. Different record types contain different information.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708171905000', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708171905000', + 'Attributes' => [ + 'description' => 'The additional information of the record. This value is empty if no additional information exists.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Record 的额外信息。', 'type' => 'string', 'example' => 'key:val', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'SystemTime' => ['description' => 'The write time of the record.', 'type' => 'integer', 'format' => 'int64', 'example' => '1769065251123', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Subscribe to data', + 'description' => 'This operation is intended for debugging purposes. Do not use this operation to read large amounts of data.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": [\\n {\\n \\"ProjectName\\": \\"test_project\\",\\n \\"GroupName\\": \\"test_group\\",\\n \\"Comment\\": \\"test_comment\\",\\n \\"TopicList\\": [\\n \\"[\\\\\\"topic1\\\\\\",\\\\\\"topic2\\\\\\"]\\"\\n ],\\n \\"Creator\\": \\"276887103073464052\\",\\n \\"CreateTime\\": 1708171905000,\\n \\"UpdateTime\\": 1708171905000\\n }\\n ]\\n}","type":"json"}]', + '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' => '查询Subscription列表信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetSchema' => [ + 'summary' => 'Queries schema information.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1251,12 +968,10 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahub86JVYW', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1264,74 +979,17 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], ], [ 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic', - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], ], [ - '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' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], - ], - [ - 'name' => 'Keyword', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dh', - ], + 'schema' => ['description' => 'The schema version number.', 'type' => 'string', 'required' => true, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -1339,154 +997,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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' => '20', - ], - 'NextToken' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'test_topic', - ], - 'SubscriptionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1745824636429WZ2EE', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USER', - ], - 'State' => [ - 'description' => '', - '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', - 'example' => '1708171905000', - 'format' => 'int64', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'example' => '1708171905000', - 'format' => 'int64', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test_topic'."\n", 'title' => ''], + 'VersionId' => ['description' => 'The schema version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RecordSchema' => ['description' => 'The schema data corresponding to the specified VersionId.', 'type' => 'string', 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"context\\"}]', 'title' => ''], + 'Creator' => ['description' => 'The creator of the schema.', 'type' => 'string', 'example' => '1559031978056215', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724041098000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => 'Resource already exists'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query schema information', + 'description' => 'Queries schema information.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": {\\n \\"Subscription\\": [\\n {\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\",\\n \\"SubscriptionId\\": \\"1745824636429WZ2EE\\",\\n \\"Type\\": \\"USER\\",\\n \\"State\\": 1,\\n \\"Comment\\": \\"test_comment\\",\\n \\"Application\\": \\"test_application_name\\",\\n \\"Creator\\": \\"1048133943212399\\",\\n \\"CreateTime\\": 1708171905000,\\n \\"UpdateTime\\": 1708171905000\\n }\\n ]\\n }\\n}","type":"json"}]', + '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' => '查询Subscription信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1498,9 +1062,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahub86JVYW', - ], + 'abilityTreeNodes' => ['FEATUREdatahub86JVYW'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1508,35 +1070,17 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], ], [ 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic', - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], ], [ 'name' => 'SubscriptionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1764122860063VIIZ2', - ], + 'schema' => ['description' => 'The subscription ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1764122860063VIIZ2', 'title' => ''], ], ], 'responses' => [ @@ -1544,121 +1088,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_project', - ], - 'TopicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_topic'."\n", - ], - 'SubscriptionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1741072334529RFEF7', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USER', - ], - 'State' => [ - 'description' => '', - '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' => '1559031978056215', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'example' => '1724041098000', - 'format' => 'int64', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'example' => '1724041098000', - 'format' => 'int64', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test_topic'."\n", 'title' => ''], + 'SubscriptionId' => ['description' => 'The subscription ID.', 'type' => 'string', 'example' => '1741072334529RFEF7', 'title' => ''], + 'Type' => ['description' => 'The type of the subscription. Valid values:'."\n" + .'- USER: created by a user.'."\n" + .'- SYSTEM: created by the system.', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'State' => ['description' => 'The status of the subscription. Valid values:'."\n" + .'- 0: offline.'."\n" + .'- 1: online.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Comment' => ['description' => 'The description of the subscription.', 'type' => 'string', 'example' => 'test_comment', 'title' => ''], + 'Application' => ['description' => 'The name of the application to which the subscription belongs.', 'type' => 'string', 'example' => 'test_application_name', 'title' => ''], + 'Creator' => ['description' => 'The creator of the subscription.', 'type' => 'string', 'example' => '1559031978056215', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724041098000', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724041098000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query subscription information', + 'summary' => 'Queries subscription information.', + 'description' => 'Queries subscription information.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - '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"}]', ], 'GetTopic' => [ - 'summary' => '查询Topic信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries topic information.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1670,9 +1162,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1680,24 +1170,12 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], ], [ 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic'."\n", - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic'."\n", 'title' => ''], ], ], 'responses' => [ @@ -1705,136 +1183,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_project', - ], - 'TopicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_topic'."\n", - ], - 'RecordType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TUPLE', - ], - 'Lifecycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ShardCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Storage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12252454', - ], - 'ExpandMode' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableSchemaRegistry' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RecordSchema' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"str\\"},{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"dt\\"}]', - ], - 'Comment' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_comment', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1397493986831962', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1724041098000', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1724041098000', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test_topic'."\n", 'title' => ''], + 'RecordType' => ['description' => 'The topic type.', 'type' => 'string', 'example' => 'TUPLE', 'title' => ''], + 'Lifecycle' => ['description' => 'The lifecycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ShardCount' => ['description' => 'The number of shards.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Storage' => ['description' => 'The total storage of the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '12252454', 'title' => ''], + 'ExpandMode' => ['description' => 'Indicates whether the extended mode is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableSchemaRegistry' => ['description' => 'Indicates whether multiple versions are supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'RecordSchema' => ['description' => 'The data schema for the TUPLE type.', 'type' => 'string', 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"str\\"},{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"dt\\"}]', 'title' => ''], + 'Comment' => ['description' => 'The topic description.', 'type' => 'string', 'example' => 'test_comment', 'title' => ''], + 'Creator' => ['description' => 'The topic creator.', 'type' => 'string', 'example' => '1397493986831962', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1724041098000', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.', 'type' => 'string', 'example' => '1724041098000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query topic information', + 'description' => 'Queries topic information.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], ], - '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"}]', ], - 'ListTopics' => [ - 'summary' => '查询Topic列表信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListConnectors' => [ + 'summary' => 'Retrieves a list of synchronization tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1846,9 +1255,7 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1856,73 +1263,47 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of records to skip in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '5', - 'default' => '5', + 'description' => 'The maximum number of records to return in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5', 'default' => '5', + 'title' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], + 'schema' => ['description' => 'The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from the end of the previous query indicated by the token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dh', - ], + 'schema' => ['description' => 'The filter keyword for the paged query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dh', 'title' => ''], ], [ 'name' => 'Pure', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Specifies whether to return only primary key information.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', + 'title' => '', ], ], ], @@ -1931,171 +1312,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of records returned in this query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NextToken' => ['description' => 'The pagination token for the next query. If NextToken is empty, no more results are available. If NextToken has a value, it indicates the token from which the next query starts.', 'type' => 'string', 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], 'List' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Topic' => [ - 'description' => '', + 'Connector' => [ + 'description' => 'The list of synchronization tasks.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of synchronization tasks.', 'type' => 'object', 'properties' => [ - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'poc_test', - ], - 'TopicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ods_bio_safety_env_disinfection', - ], - 'RecordType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TUPLE', - ], - 'Lifecycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ShardCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Storage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ExpandMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'EnableSchemaRegistry' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'RecordSchema' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"str\\"},{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"dt\\"}]', - ], - 'Comment' => [ - 'description' => '', + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test_topic', 'title' => ''], + 'ConnectorId' => ['description' => 'The synchronization task ID.', 'type' => 'string', 'example' => 'fa44384c-0ac5-4d3e-8acd-76e18636ab10', 'title' => ''], + 'SubscriptionId' => ['description' => 'The subscription ID.', 'type' => 'string', 'example' => '1745824636429WZ2EE', 'title' => ''], + 'Type' => [ + 'description' => 'The synchronization task type.', + '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'], 'type' => 'string', - 'example' => '', + 'example' => 'SINK_ODPS', + 'title' => '', ], - 'Creator' => [ - 'description' => '', + 'State' => [ + 'description' => 'The synchronization task status.', + 'enumValueTitles' => ['PAUSED' => 'PAUSED', 'CREATED' => 'CREATED', 'RUNNING' => 'RUNNING', 'STOPPED' => 'STOPPED'], 'type' => 'string', - 'example' => '276887103073464052', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1753346106000', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1753346106000', + 'example' => 'RUNNING', + 'title' => '', ], + 'DoneTime' => ['description' => 'The time when the synchronization task is marked as Done. This parameter takes effect only for ODPS synchronization (SINK_ODPS) tasks.', 'type' => 'string', 'example' => '2025-12-04 16:45:00', 'title' => ''], + 'ColumnFields' => ['description' => 'The list of fields for the synchronization task.', 'type' => 'string', 'example' => '[\\"field1\\",\\"field2\\"]', 'title' => ''], + 'Config' => ['description' => 'The configuration information of the synchronization task.', 'type' => 'string', 'example' => '{\\"Table\\":\\"r3\\",\\"Endpoint\\":\\"https://Device-data.cn-beijing.ots-internal.aliyuncs.com\\",\\"Instance\\":\\"Device-data\\",\\"WriteMode\\":\\"PUT\\",\\"AuthMode\\":\\"STS\\"}', 'title' => ''], + 'Creator' => ['description' => 'The creator of the synchronization task.', 'type' => 'string', 'example' => '1696648921408952', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1724041098000', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.', 'type' => 'string', 'example' => '1708171905000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List synchronization tasks', + 'description' => 'Queries the list of synchronization tasks.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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/*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 50,\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"9892074a2a89600ae4b0d5a34fb99a3f\\",\\n \\"List\\": {\\n \\"Topic\\": [\\n {\\n \\"ProjectName\\": \\"poc_test\\",\\n \\"TopicName\\": \\"ods_bio_safety_env_disinfection\\",\\n \\"RecordType\\": \\"TUPLE\\",\\n \\"Lifecycle\\": 3,\\n \\"ShardCount\\": 1,\\n \\"Storage\\": 10000,\\n \\"ExpandMode\\": \\"true\\",\\n \\"EnableSchemaRegistry\\": \\"false\\",\\n \\"RecordSchema\\": \\"[{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"dt\\\\\\\\\\\\\\"}]\\",\\n \\"Comment\\": \\"这是一个描述信息\\",\\n \\"Creator\\": \\"276887103073464052\\",\\n \\"CreateTime\\": 1753346106000,\\n \\"UpdateTime\\": 1753346106000\\n }\\n ]\\n }\\n}","type":"json"}]', + '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' => 'Retrieves a list of consumer groups.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2104,12 +1418,10 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -2117,33 +1429,169 @@ [ 'name' => 'ProjectName', 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => ['description' => 'The number of records to skip in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', + 'description' => 'The maximum number of records to return in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5', 'default' => '5', + 'title' => '', ], ], [ - 'name' => 'TopicName', + 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => 'The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from the end of the previous query indicated by the token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The filter keyword for a paged query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dh', 'title' => ''], + ], + [ + 'name' => 'Pure', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only primary key information.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of records returned in this query.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5', 'default' => '5', 'title' => ''], + 'NextToken' => ['description' => 'The pagination token for the next query. If NextToken is empty, no more results are available. If NextToken has a value, it indicates the token from which the next query starts.', 'type' => 'string', 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], + 'List' => [ + 'description' => 'The list of consumer groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of consumer groups.', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'GroupName' => ['description' => 'The consumer group name.', 'type' => 'string', 'example' => 'test_group', 'title' => ''], + 'Comment' => ['description' => 'The description of the consumer group.', 'type' => 'string', 'example' => 'test_comment', 'title' => ''], + 'TopicList' => [ + 'description' => 'The list of topics bound to the consumer group.', + 'type' => 'array', + 'items' => ['description' => 'The topic name.', 'type' => 'string', 'example' => '["topic1","topic2"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Creator' => ['description' => 'The creator of the consumer group.', 'type' => 'string', 'example' => '276887103073464052', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], [ - 'name' => 'VersionId', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List consumer groups', + 'description' => 'Queries the list of consumer groups.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dhs:ListGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Group', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#projectName}/groups/*'], + ], + ], + ], + ], + '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' => 'The number of records to skip in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0', + 'description' => 'The maximum number of records to return in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5', 'default' => '5', + 'title' => '', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from where the previous query ended based on the token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The filter keyword for a paged query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dh', 'title' => ''], + ], + [ + 'name' => 'Pure', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return only primary key information.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], ], @@ -2152,104 +1600,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_project', - ], - 'TopicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_topic'."\n", - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RecordSchema' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"context\\"}]', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1559031978056215', - ], - 'CreateTime' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of records returned in this query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NextToken' => ['description' => 'The pagination token for the next query. If NextToken is empty, no more results are available. If NextToken has a value, it indicates the token from which the next query starts.', 'type' => 'string', 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Project' => [ + 'description' => 'The list of projects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of projects.', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'Comment' => ['description' => 'The project description.', 'type' => 'string', 'example' => 'test_comment', 'title' => ''], + 'Creator' => ['description' => 'The project creator.', 'type' => 'string', 'example' => '1048133943212399', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724041098000', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'ResourceAlreadyExist', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve project list', + 'summary' => 'Retrieves a list of projects.', + 'description' => 'Queries the list of projects.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dhs:ListProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"TopicName\\": \\"test_topic\\\\n\\",\\n \\"VersionId\\": 0,\\n \\"RecordSchema\\": \\"[{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowNull\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"context\\\\\\\\\\\\\\"}]\\",\\n \\"Creator\\": \\"1559031978056215\\",\\n \\"CreateTime\\": 1724041098000\\n}","type":"json"}]', + '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' => [], @@ -2261,9 +1690,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -2271,63 +1698,30 @@ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], ], [ 'name' => 'TopicName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_topic'."\n", - ], + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic'."\n", 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of records to skip in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '5', - 'default' => '5', + 'description' => 'The maximum number of records to return in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5', 'default' => '5', + 'title' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], + 'schema' => ['description' => 'The pagination token. If NextToken is empty, the query starts from the beginning. Otherwise, the query starts from where the previous query left off based on the token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], ], ], 'responses' => [ @@ -2335,131 +1729,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20250401102332e68e3d0b04ab4904', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of records returned in this query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'NextToken' => ['description' => 'The pagination token for the next query. If NextToken is empty, no more results are available. If NextToken has a value, the value indicates the token for the next query.'."\n" + ."\n", 'type' => 'string', 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list of schemas.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of schemas.', 'type' => 'object', 'properties' => [ - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_project', - ], - 'TopicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_topic', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RecordSchema' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"context\\"}]', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1048133943212399', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708171905000', - ], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test_topic', 'title' => ''], + 'VersionId' => ['description' => 'The schema version ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RecordSchema' => ['description' => 'The schema data corresponding to the version ID.', 'type' => 'string', 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"context\\"}]', 'title' => ''], + 'Creator' => ['description' => 'The creator of the schema.', 'type' => 'string', 'example' => '1048133943212399', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'ResourceAlreadyExist', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ['errorCode' => 'ResourceAlreadyExist', 'errorMessage' => 'Error:%s.', 'description' => 'Resource already exists'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List Schemas', + 'summary' => 'Lists schemas.', + 'description' => 'Queries schema list information.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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/*'], + ], ], ], ], - '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"}]', ], - 'GetProject' => [ - 'summary' => '查询Project资源详细信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListSubscriptions' => [ + 'summary' => 'Retrieves a list of subscriptions.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2468,12 +1811,10 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahub86JVYW'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -2481,118 +1822,130 @@ [ 'name' => 'ProjectName', 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => ['description' => 'The number of records to skip in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_project', + 'description' => 'The maximum number of records to return for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5', 'default' => '5', + 'title' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from the end of the previous query indicated by the token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword used to filter results in a paged query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dh', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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', - ], - 'VpcWhitelist' => [ - 'description' => '', - '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' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of records returned in this query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'NextToken' => ['description' => 'The pagination token for the next query. If NextToken is empty, no more results are available. If NextToken has a value, it indicates the token for the next query.', 'type' => 'string', 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Subscription' => [ + 'description' => 'The subscription list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subscription list.', + 'type' => 'object', + 'properties' => [ + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test_topic', 'title' => ''], + 'SubscriptionId' => ['description' => 'The subscription ID.', 'type' => 'string', 'example' => '1745824636429WZ2EE', 'title' => ''], + 'Type' => ['description' => 'The type of the subscription. Valid values:'."\n" + .'- USER: created by a user.'."\n" + .'- SYSTEM: created by the system.', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'State' => ['description' => 'The status of the subscription. Valid values:'."\n" + .'- 0: offline.'."\n" + .'- 1: online.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Comment' => ['description' => 'The description of the subscription.', 'type' => 'string', 'example' => 'test_comment', 'title' => ''], + 'Application' => ['description' => 'The name of the application to which the subscription belongs.', 'type' => 'string', 'example' => 'test_application_name', 'title' => ''], + 'Creator' => ['description' => 'The creator of the subscription.', 'type' => 'string', 'example' => '1048133943212399', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the subscription was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the subscription was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => '1724041098000', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve subscription list', + 'description' => 'Queries subscription list information.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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/*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"Comment\\": \\"test_comment\\",\\n \\"VpcWhitelist\\": \\"[\\\\\\\\\\\\\\"11.22.33.44\\\\\\\\\\\\\\"]\\",\\n \\"Storage\\": 12252454,\\n \\"Creator\\": \\"1559031978056215\\",\\n \\"CreateTime\\": \\"1724041098000\\",\\n \\"UpdateTime\\": \\"1724041098000\\"\\n}","type":"json"}]', + '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' => '查询Project列表信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListTopics' => [ + 'summary' => 'Retrieves a list of topics.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2604,77 +1957,43 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdatahubB2GCPA', - ], + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], + [ 'name' => 'Skip', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of records to skip in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '5', - 'default' => '5', + 'description' => 'The maximum number of records to return in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5', 'default' => '5', + 'title' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], + 'schema' => ['description' => 'The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from the position where the previous query ended.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dh', - ], + 'schema' => ['description' => 'The filter keyword for a paged query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dh', 'title' => ''], ], [ 'name' => 'Pure', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to return only primary key information.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -2682,180 +2001,700 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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' => '1', - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of records returned in this query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NextToken' => ['description' => 'The pagination token for the next query. If NextToken is empty, no more results are available. If NextToken is returned, the value indicates the token for the next query.', 'type' => 'string', 'example' => '9892074a2a89600ae4b0d5a34fb99a3f', 'title' => ''], 'List' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Project' => [ - 'description' => '', + 'Topic' => [ + 'description' => 'The list of topics.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of topics.', 'type' => 'object', 'properties' => [ - 'ProjectName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'poc_test', - ], - 'Comment' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1048133943212399', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708171905000', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708171905000', - ], + 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'poc_test', 'title' => ''], + 'TopicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'ods_bio_safety_env_disinfection', 'title' => ''], + 'RecordType' => ['description' => 'The topic type.', 'type' => 'string', 'example' => 'TUPLE', 'title' => ''], + 'Lifecycle' => ['description' => 'The lifecycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ShardCount' => ['description' => 'The number of shards.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Storage' => ['description' => 'The total storage of the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'ExpandMode' => ['description' => 'Indicates whether the extended mode is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'EnableSchemaRegistry' => ['description' => 'Indicates whether multiple versions are supported.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'RecordSchema' => ['description' => 'The data schema for the TUPLE type.', 'type' => 'string', 'example' => '[{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"str\\"},{\\"Type\\":\\"STRING\\",\\"AllowNull\\":true,\\"Name\\":\\"dt\\"}]', 'title' => ''], + 'Comment' => ['description' => 'The topic description.', 'type' => 'string', 'example' => '这是一个描述信息', 'title' => ''], + 'Creator' => ['description' => 'The topic creator.', 'type' => 'string', 'example' => '276887103073464052', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1753346106000', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1753346106000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve topic list', + 'description' => 'Queries the list of topics.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dhs:ListTopics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Topic', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/*'], + ], + ], + ], + ], + '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' => 'Writes data to a specified topic. This operation is primarily intended for debugging. For high-volume data writes, refer to the SDK documentation.', + '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' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_topic', 'title' => ''], + ], + [ + 'name' => 'ShardId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the shard to which data is written. If this parameter is not specified, data is randomly written to a shard.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7', 'title' => ''], + ], + [ + 'name' => 'Records', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The data to be written.', + 'type' => 'array', + 'items' => [ + 'description' => 'The content of a single record.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data content of the record.', + 'type' => 'array', + 'items' => ['description' => 'The data must be consistent with the schema of the topic. Each column of data must be converted to a string. If the number of data columns is less than the number of columns in the topic schema, null values are appended.', 'type' => 'string', 'required' => false, 'example' => 'aa', 'title' => ''], + 'required' => true, + 'example' => '["aa", "bb", "12", "12.34"]', + 'maxItems' => 100, + 'title' => '', + ], + 'Attributes' => [ + 'description' => 'The additional information of the record. You can leave this parameter empty if no additional information is available.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Record的额外属性信息。', 'type' => 'string', 'example' => 'key:val', 'title' => ''], + 'example' => '{"key1":"val1","key2":"val2"}', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Error:%s.', + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A20A7093-8FE0-058C-BE0C-3C8057D5F1A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ShardId' => ['description' => 'The ID of the shard to which the data was written.', 'type' => 'string', 'example' => '7', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'Error:%s.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Publish data', + 'description' => 'This operation is primarily intended for debugging. Do not use this operation to write large amounts of data.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A20A7093-8FE0-058C-BE0C-3C8057D5F1A1\\",\\n \\"Success\\": true,\\n \\"ShardId\\": \\"7\\"\\n}","type":"json"}]', + ], + 'UpdateProject' => [ + 'summary' => 'Updates the description of a 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' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'Error:%s.', + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The description of the project.', 'type' => 'string', 'required' => false, 'example' => 'ec800m-y数据总线，康复中心', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20250923101459e68e3d0b0869e5e4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'Error:%s.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update project information', + 'description' => 'Updates the description of a project.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dhs:UpdateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataHub', 'resourceType' => 'Project', 'arn' => 'acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20250923101459e68e3d0b0869e5e4\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateTopic' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - '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"}]', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdatahubB2GCPA'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'TopicName', + 'in' => 'query', + 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'example' => 'test_topic'."\n", 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The comment.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20260319152525d2a3770b00c232d4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Error:%s.', 'description' => 'The parameter entered is illegal'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Error:%s.', 'description' => 'Missing required parameters'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'Error:%s.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'OperationDenied', 'errorMessage' => 'Error:%s.', 'description' => 'Operation denied'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'Error:%s.', 'description' => 'Resource does not exist'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'Error:%s.', 'description' => 'Server error, server unavailable or unexpected error occurred'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update topic information', + 'summary' => 'Updates the description of a topic.', + 'description' => 'Updates the description of a topic.', + 'changeSet' => [], + 'ramActions' => [ + [ + '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}'], + ], + ], + ], + ], + '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-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'datahub.cn-zhangjiakou.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'datahub.cn-wulanchabu.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.cn-shenzhen.aliyuncs.com', 'endpoint' => 'datahub.cn-shenzhen.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.cn-shanghai.aliyuncs.com', 'endpoint' => 'datahub.cn-shanghai.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.cn-hongkong.aliyuncs.com', 'endpoint' => 'datahub.cn-hongkong.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.cn-hangzhou.aliyuncs.com', 'endpoint' => 'datahub.cn-hangzhou.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.cn-beijing.aliyuncs.com', 'endpoint' => 'datahub.cn-beijing.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.ap-southeast-5.aliyuncs.com', 'endpoint' => 'datahub.ap-southeast-5.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.ap-southeast-3.aliyuncs.com', 'endpoint' => 'datahub.ap-southeast-3.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datahub.ap-southeast-1.aliyuncs.com', 'endpoint' => 'datahub.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'datahub.eu-central-1.aliyuncs.com', 'endpoint' => 'datahub.eu-central-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'datahub.aliyuncs.com', 'endpoint' => 'datahub.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'datahub.aliyuncs.com', 'endpoint' => 'datahub.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'datahub.aliyuncs.com', 'endpoint' => 'datahub.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'datahub.me-central-1.aliyuncs.com', 'endpoint' => 'datahub.me-central-1.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'ApiProxyServiceError', 'message' => 'Error:%s.', 'http_code' => 500, 'description' => 'Server error, server unavailable or unexpected error occurred'], + ['code' => 'InternalServerError', 'message' => '%s.', 'http_code' => 500, 'description' => 'System internal error'], + ['code' => 'InternalServerError', 'message' => 'Error:%s.', 'http_code' => 500, 'description' => 'Server error, server unavailable or unexpected error occurred'], + ['code' => 'InvalidParameter', 'message' => 'The input parameter is invalid.', 'http_code' => 400, 'description' => 'Illegal input parameters'], + ['code' => 'InvalidParameter', 'message' => 'Error:%s.', 'http_code' => 400, 'description' => 'The parameter entered is illegal'], + ['code' => 'MissingParameter', 'message' => '%s.', 'http_code' => 400, 'description' => 'Missing required parameters'], + ['code' => 'MissingParameter', 'message' => 'Error:%s.', 'http_code' => 400, 'description' => 'Missing required parameters'], + ['code' => 'NoPermission', 'message' => 'Error:%s.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'], + ['code' => 'OperationDenied', 'message' => '%s.', 'http_code' => 403, 'description' => 'Operation denied'], + ['code' => 'OperationDenied', 'message' => 'Error:%s.', 'http_code' => 403, 'description' => 'Operation denied'], + ['code' => 'ResourceAlreadyExist', 'message' => 'Collect space already exists.', 'http_code' => 400, 'description' => 'Acquisition space already exists'], + ['code' => 'ResourceAlreadyExist', 'message' => 'Error:%s.', 'http_code' => 400, 'description' => 'Resource already exists'], + ['code' => 'ResourceNotFound', 'message' => 'Resource not found.', 'http_code' => 404, 'description' => 'Collect space does not exist'], + ['code' => 'ResourceNotFound', 'message' => '%s.', 'http_code' => 404, 'description' => 'Resource does not exist'], + ['code' => 'ResourceNotFound', 'message' => 'Error:%s.', 'http_code' => 404, 'description' => 'Resource does not exist'], + ['code' => 'VPCServiceError', 'message' => 'get vpc info failed.', 'http_code' => 400, 'description' => 'Failed to obtain the vpc information.'], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'DataHub', + 'productName' => 'DataHub', + 'ramCodes' => ['dhs'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DeleteTopic', + 'description' => '', + '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' => '', + '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' => '', + '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' => '', + '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' => '', + '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' => '', + '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' => '', + '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}'], ], ], ]; |