path: root/data/en_us/datahub/2019-11-20/api-docs.php

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'datahub',
        'version' => '2019-11-20',
    ],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => [
                'OpenDataHubService',
                'ListProjects',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'OpenDataHubService' => [
            'summary' => '开通Datahub服务',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
                [
                    'APP' => [],
                ],
                [
                    'PrivateKey' => [],
                ],
                [
                    'BearerToken' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'none',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeNodes' => [
                    'FEATUREdatahubB2GCPA',
                ],
            ],
            'parameters' => [],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'type' => 'string',
                            ],
                            'OrderId' => [
                                'type' => 'string',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => null,
        ],
        'ListProjects' => [
            'summary' => 'Query project list information',
            'methods' => [
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'list',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeNodes' => [
                    'FEATUREdatahubB2GCPA',
                ],
            ],
            'parameters' => [
                [
                    'name' => 'PageNumber',
                    'in' => 'query',
                    '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',
                    ],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    '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',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    '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',
                            ],
                            'List' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'Project' => [
                                        'description' => 'Project name',
                                        'type' => 'array',
                                        'items' => [
                                            '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',
                                                ],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                            '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',
                    ],
                ],
                500 => [
                    [
                        'errorCode' => 'OdpsServiceError',
                        'errorMessage' => '%s',
                    ],
                ],
                502 => [
                    [
                        '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"}]',
            'title' => 'Get Project List',
            'translator' => 'machine',
        ],
    ],
    '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',
        ],
    ],
];