summaryrefslogtreecommitdiff
path: root/data/zh_cn/datahub/2019-11-20/api-docs.php
blob: c5cc1526896bfce59aca0a3bac5eae9983f7de8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<?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' => '',
        ],
        'ListProjects' => [
            'summary' => '查询project列表信息。',
            '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' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => ['description' => '地域id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['description' => '每页的大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
                ],
                [
                    'name' => 'Keyword',
                    'in' => 'query',
                    'schema' => ['description' => '查询的关键字', 'type' => 'string', 'required' => false, 'example' => 'search_key'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'TotalCount' => ['description' => '查询结果总数', 'type' => 'string', 'example' => '50'],
                            'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '20250401102332e68e3d0b04ab4904'],
                            'PageSize' => ['description' => '每页的大小', 'type' => 'string', 'example' => '10'],
                            'PageCount' => ['description' => '总页数', 'type' => 'string', 'example' => '1'],
                            'PageNumber' => ['description' => '当前页码', 'type' => 'string', 'example' => '84'],
                            'List' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'Project' => [
                                        'description' => '项目名称',
                                        'type' => 'array',
                                        'items' => [
                                            'description' => '项目信息。',
                                            'type' => 'object',
                                            'properties' => [
                                                'UpdateTime' => ['description' => '更新时间'."\n"
                                                    ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000'],
                                                'Comment' => ['description' => '字段的文本注释', 'type' => 'string', 'example' => '测试专用'],
                                                'CreateTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1708171905000'],
                                                'ProjectName' => ['description' => '项目名称', 'type' => 'string', 'example' => 'poc_test'],
                                                'Creator' => ['description' => '创建者id', 'type' => 'string', 'example' => '1048133943212399'],
                                                'CreatorName' => ['description' => '创建者名称', 'type' => 'string', 'example' => 'user_name'],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                            'Success' => ['description' => '是否成功', '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' => '获取项目列表',
        ],
    ],
    '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'],
    ],
];