data/zh_cn/ecs-workbench/2025-11-11/api-docs.php


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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'ecs-workbench',
        'version' => '2025-11-11',
    ],
    'directories' => [
        [
            'id' => 357414,
            'title' => '系统配置',
            'type' => 'directory',
            'children' => [
                'DescribeTerminalSettings',
                'ModifyTerminalSettings',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'DescribeTerminalSettings' => [
            'summary' => '本接口用于查询Workbench终端配置，包括免密功能开关等配置。',
            'description' => '查询Workbench终端配置',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'none',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '232258',
                'abilityTreeNodes' => [
                    'FEATUREecs3YSCYT',
                ],
            ],
            'parameters' => [],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => '请求ID',
                                'description' => '请求ID',
                                'type' => 'string',
                                'example' => '47348885-C929-489A-93D7-B2E99D50D77B',
                            ],
                            'PasswordlessLoginConfig' => [
                                'description' => '免密登录配置',
                                'type' => 'object',
                                'properties' => [
                                    'Enabled' => [
                                        'description' => '是否启用免密登录功能，取值范围：'."\n"
                                            ."\n"
                                            .'- true：启用。'."\n"
                                            ."\n"
                                            .'- false：不启用。',
                                        'type' => 'boolean',
                                        'enumValueTitles' => [
                                            'true/false' => 'true/false',
                                        ],
                                        'example' => 'true',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                403 => [
                    [
                        'errorCode' => 'Forbidden.Unauthorized',
                        'errorMessage' => 'You are not authorized to perform this operation.',
                    ],
                ],
                500 => [
                    [
                        'errorCode' => 'InternalError',
                        'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"47348885-C929-489A-93D7-B2E99D50D77B\\",\\n  \\"PasswordlessLoginConfig\\": {\\n    \\"Enabled\\": true\\n  }\\n}","type":"json"}]',
            'title' => '查询终端配置',
        ],
        'ModifyTerminalSettings' => [
            'summary' => '本接口用于修改Workbench终端配置，支持修改免密功能开关等配置。',
            'description' => '修改Workbench终端配置',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '232258',
                'abilityTreeNodes' => [
                    'FEATUREecs3YSCYT',
                ],
                'autoTest' => true,
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'PasswordlessLoginConfig',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '免密登录配置',
                        'description' => '免密登录配置',
                        'type' => 'object',
                        'properties' => [
                            'Enabled' => [
                                'title' => '免密功能开关',
                                'description' => '是否启用免密登录功能，取值范围：'."\n"
                                    ."\n"
                                    .'- true：启用。'."\n"
                                    ."\n"
                                    .'- false：不启用。',
                                'type' => 'boolean',
                                'required' => false,
                                'example' => 'true',
                            ],
                        ],
                        'required' => true,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => '请求ID',
                                'description' => '请求ID',
                                'type' => 'string',
                                'example' => '47348885-C929-489A-93D7-B2E99D50D77B',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    [
                        'errorCode' => 'MissingParameter.PasswordlessLoginConfig',
                        'errorMessage' => 'The parameter PasswordlessLoginConfig is missing.',
                    ],
                    [
                        'errorCode' => 'MissingParameter.PasswordlessLoginConfig.Enabled',
                        'errorMessage' => 'The parameter PasswordlessLoginConfig.Enabled is missing.',
                    ],
                ],
                403 => [
                    [
                        'errorCode' => 'Forbidden.Unauthorized',
                        'errorMessage' => 'You are not authorized to perform this operation.',
                    ],
                ],
                500 => [
                    [
                        'errorCode' => 'InternalError',
                        'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"47348885-C929-489A-93D7-B2E99D50D77B\\"\\n}","type":"json"}]',
            'title' => '修改终端配置',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-hangzhou',
            'endpoint' => 'ecs-workbench.cn-hangzhou.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-beijing',
            'endpoint' => 'ecs-workbench.cn-beijing.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-southeast-1',
            'endpoint' => 'ecs-workbench.ap-southeast-1.aliyuncs.com',
        ],
    ],
];