summaryrefslogtreecommitdiff
path: root/data/zh_cn/fc-open/2020-03-10/api-docs.php
blob: 35189dd04e142650ee720abfb55d7493276b16fb (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'FC', 'product' => 'FC-Open', 'version' => '2020-03-10'],
    'directories' => ['OpenFcService'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'OpenFcService' => [
            'path' => '/service/open',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
                [
                    'APP' => [],
                ],
                [
                    'PrivateKey' => [],
                ],
                [
                    'BearerToken' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => '开通服务信息',
                        'type' => 'object',
                        'properties' => [
                            'Message' => ['description' => '返回信息', 'type' => 'string', 'example' => 'success'],
                            'RequestId' => ['description' => '本次请求的ID', 'type' => 'string', 'example' => '8229F379-64B9-5311-****-22B19C4F***'],
                            'ErrorCode' => ['description' => '错误码。  '."\n"
                                .'取值说明如下:  '."\n"
                                ."\n"
                                .'- 请求成功:不返回ErrorCode字段。                                 '."\n"
                                .'- 请求失败:返回ErrorCode字段。具体信息,请参见本文的错误码列表。', 'type' => 'string', 'example' => '400'],
                            'OrderId' => ['description' => '订单ID', 'type' => 'string', 'example' => '20662****362'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'ORDER.OPEND', 'errorMessage' => '已开通'],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"Message\\": \\"success\\",\\n  \\"RequestId\\": \\"8229F379-64B9-5311-****-22B19C4F***\\",\\n  \\"ErrorCode\\": \\"400\\",\\n  \\"OrderId\\": \\"20662****362\\"\\n}","type":"json"}]',
            'title' => '使用API开通FC服务',
            'summary' => '首次使用函数计算服务时,您可以使用有OpenFcService权限的身份凭证(如访问密钥、临时安全令牌)通过API开通函数计算。',
            'description' => '本接口用于第一次使用函数计算的场景。开通服务后,您才能使用函数计算。只要调用任意可用地域的接入点就可以开通全地域。'."\n"
                ."\n"
                .'>关于支持的地域,请参见[服务接入地址](~~2517902~~)。',
            'extraInfo' => '除了调用OpenService接口,您还可以通过函数计算控制台开通服务。具体操作,请参见[开通函数计算服务](~~2509023~~)。',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'ap-northeast-2', 'endpoint' => 'fc.ap-northeast-2.aliyuncs.com'],
        ['regionId' => 'cn-qingdao', 'endpoint' => 'fc.cn-qingdao.aliyuncs.com'],
        ['regionId' => 'cn-beijing', 'endpoint' => 'fc.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'fc.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'cn-huhehaote', 'endpoint' => 'fc.cn-huhehaote.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'fc.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'fc.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'fc.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'fc.cn-chengdu.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'fc.cn-hongkong.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'fc.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'fc.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-2', 'endpoint' => 'fc.ap-southeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'fc.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'ap-southeast-5', 'endpoint' => 'fc.ap-southeast-5.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'fc.us-east-1.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'fc.us-west-1.aliyuncs.com'],
        ['regionId' => 'eu-west-1', 'endpoint' => 'fc.eu-west-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'fc.eu-central-1.aliyuncs.com'],
        ['regionId' => 'ap-south-1', 'endpoint' => 'fc.ap-south-1.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'account-id.cn-hangzhou-finance.fc.aliyuncs.com'],
        ['regionId' => 'ap-southeast-7', 'endpoint' => 'fc.ap-southeast-7.aliyuncs.com'],
    ],
];