summaryrefslogtreecommitdiff
path: root/data/en_us/ossadmin/2019-04-22/api-docs.php
blob: efecd0a008bd6ffd459a61d2523caba21d2e1695 (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'OssAdmin', 'version' => '2019-04-22'],
    'directories' => ['OpenOssService'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'OpenOssService' => [
            'summary' => 'Activates Object Storage Service (OSS) for an Alibaba Cloud account.',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
                [
                    'APP' => [],
                ],
                [
                    'PrivateKey' => [],
                ],
                [
                    'BearerToken' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'update'],
            'parameters' => [],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => 'The response information.',
                        'type' => 'object',
                        'properties' => [
                            'OrderId' => ['description' => 'The order ID of the activation operation.', 'type' => 'string', 'example' => '2431*******529', 'title' => ''],
                            'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FBD670BB-7930-5350-A313-995C303E8EDB', 'title' => ''],
                        ],
                        'title' => '',
                        'example' => '',
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'ORDER.OPEND', 'errorMessage' => 'You have already open the service. Go to the console to start using it.', 'description' => ''],
                ],
                403 => [
                    ['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'You are not authorized to do this operation.', 'description' => ''],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"OrderId\\": \\"2431*******529\\",\\n  \\"RequestId\\": \\"FBD670BB-7930-5350-A313-995C303E8EDB\\"\\n}","type":"json"}]',
            'title' => 'Activate OSS',
            'changeSet' => [],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'public', 'regionName' => 'Public network', 'areaId' => 'other', 'areaName' => 'Other', 'public' => 'oss-admin.aliyuncs.com', 'endpoint' => 'oss-admin.aliyuncs.com', 'vpc' => ''],
    ],
    'errorCodes' => [],
    'changeSet' => [],
];