summaryrefslogtreecommitdiff
path: root/data/zh_cn/sls/2018-06-13/api-docs.php
blob: 5022d729b94f8a9df7b8080cfedb25a24f6b47b6 (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'SLS', 'product' => 'Sls', 'version' => '2018-06-13'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['AnalyzeProductLog'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'AnalyzeProductLog' => [
            'summary' => '操作云产品日志服务资源',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'update',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '84924',
                'abilityTreeNodes' => ['FEATUREslsL870A3'],
            ],
            'parameters' => [
                [
                    'name' => 'Region',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'Project',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'Logstore',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'CloudProduct',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'Lang',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'TTL',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'ResourceQuota',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Overwrite',
                    'in' => 'query',
                    'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'true'],
                ],
                [
                    'name' => 'ClientIp',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'VariableMap',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => ['type' => 'object', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Code' => ['type' => 'string'],
                            'Message' => ['type' => 'string'],
                            'RequestId' => ['type' => 'string'],
                            'Success' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'CreateProjectFailed', 'errorMessage' => 'Failed to create the project: %s.'],
                    ['errorCode' => 'ParamsIsNull', 'errorMessage' => '%s.'],
                    ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The region is invalid.'],
                    ['errorCode' => 'ProjectExist', 'errorMessage' => '%s.'],
                    ['errorCode' => 'LogstoreError', 'errorMessage' => 'Failed to create or update the logstore: %s.'],
                    ['errorCode' => 'DashboardError', 'errorMessage' => 'Failed to create or update the dashboard: %s.'],
                    ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The parameter is invalid: %s.'],
                    ['errorCode' => 'ProjectRegionInvalid', 'errorMessage' => '%s.'],
                    ['errorCode' => 'UnRegisterProduct', 'errorMessage' => '%s.'],
                    ['errorCode' => 'GetProjectFailed', 'errorMessage' => 'Failed to get project: %s.'],
                    ['errorCode' => 'InvalidLang', 'errorMessage' => '%s.'],
                    ['errorCode' => 'SavedSearchError', 'errorMessage' => '%s.'],
                    ['errorCode' => 'IndexError', 'errorMessage' => 'Failed to create or update index: %s.'],
                    ['errorCode' => 'JobError', 'errorMessage' => 'Failed to create or update the job: %s.'],
                ],
                [
                    ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'responseDemo' => '',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-qingdao', 'endpoint' => 'cn-qingdao.log.aliyuncs.com'],
        ['regionId' => 'cn-beijing', 'endpoint' => 'cn-beijing.log.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com'],
        ['regionId' => 'cn-huhehaote', 'endpoint' => 'cn-huhehaote.log.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu', 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'cn-hangzhou.log.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'cn-shanghai.log.aliyuncs.com'],
        ['regionId' => 'cn-nanjing', 'endpoint' => 'cn-nanjing.log.aliyuncs.com'],
        ['regionId' => 'cn-fuzhou', 'endpoint' => 'cn-fuzhou.log.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'cn-shenzhen.log.aliyuncs.com'],
        ['regionId' => 'cn-heyuan', 'endpoint' => 'cn-heyuan.log.aliyuncs.com'],
        ['regionId' => 'cn-guangzhou', 'endpoint' => 'cn-guangzhou.log.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'cn-chengdu.log.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'cn-hongkong.log.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'ap-northeast-1.log.aliyuncs.com'],
        ['regionId' => 'ap-northeast-2', 'endpoint' => 'ap-northeast-2.log.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'ap-southeast-1.log.aliyuncs.com'],
        ['regionId' => 'ap-southeast-2', 'endpoint' => 'ap-southeast-2.log.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'ap-southeast-3.log.aliyuncs.com'],
        ['regionId' => 'ap-southeast-5', 'endpoint' => 'ap-southeast-5.log.aliyuncs.com'],
        ['regionId' => 'ap-southeast-6', 'endpoint' => 'ap-southeast-6.log.aliyuncs.com'],
        ['regionId' => 'ap-southeast-7', 'endpoint' => 'ap-southeast-7.log.aliyuncs.com'],
        ['regionId' => 'us-southeast-1', 'endpoint' => 'us-southeast-1.log.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'eu-central-1.log.aliyuncs.com'],
        ['regionId' => 'eu-west-1', 'endpoint' => 'eu-west-1.log.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'us-west-1.log.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'us-east-1.log.aliyuncs.com'],
        ['regionId' => 'me-central-1', 'endpoint' => 'me-central-1.log.aliyuncs.com'],
        ['regionId' => 'me-east-1', 'endpoint' => 'me-east-1.log.aliyuncs.com'],
        ['regionId' => 'ap-south-1', 'endpoint' => 'ap-south-1.log.aliyuncs.com'],
        ['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com'],
        ['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com'],
    ],
];