summaryrefslogtreecommitdiff
path: root/data/en_us/eflo-controller/2026-06-12/api-docs.php
blob: bf3dee02ac0e261ebf67f3faefa1baca2d24f3bd (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'eflo-controller', 'version' => '2026-06-12'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['ListImages'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'ListImages' => [
            'summary' => '查询用户可用的镜像列表',
            'methods' => ['get', 'post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'operationType' => 'read',
            'systemTags' => [
                'operationType' => 'list',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '189004',
                'abilityTreeNodes' => ['FEATUREbcclusterSIOTA6'],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'Name',
                    'in' => 'query',
                    'schema' => ['title' => '镜像名', 'description' => '镜像名模糊匹配', 'type' => 'string'],
                ],
                [
                    'name' => 'Labels',
                    'in' => 'query',
                    'schema' => ['title' => '标签过滤', 'description' => '形如 Key=Value 的标签过滤,多 Label 间 AND', 'type' => 'string'],
                ],
                [
                    'name' => 'Query',
                    'in' => 'query',
                    'schema' => ['title' => '全文搜索', 'description' => '全文模糊匹配,命中 Name / Description 等任一即返', 'type' => 'string'],
                ],
                [
                    'name' => 'PageNumber',
                    'in' => 'query',
                    'schema' => ['title' => '页码', 'description' => '页码,默认1', 'type' => 'integer', 'format' => 'int32'],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['title' => '每页条数', 'description' => '每页条数,默认20,上限100', 'type' => 'integer', 'format' => 'int32'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string'],
                            'TotalCount' => ['title' => '总数', 'description' => '满足过滤条件的镜像总数', 'type' => 'integer', 'format' => 'int32'],
                            'Images' => [
                                'title' => '镜像列表',
                                'description' => '镜像列表',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'ImageId' => ['title' => '镜像ID', 'description' => '镜像唯一ID', 'type' => 'string'],
                                        'Name' => ['title' => '镜像名', 'description' => '镜像名称', 'type' => 'string'],
                                        'Description' => ['title' => '描述', 'description' => '镜像描述', 'type' => 'string'],
                                        'ImageUri' => ['title' => '镜像地址', 'description' => '完整镜像地址,可直接作为 CreateTrainJob 的 Image 参数', 'type' => 'string'],
                                        'Accessibility' => ['title' => '可见性', 'description' => '镜像可见性,取值 PUBLIC / PRIVATE', 'type' => 'string'],
                                        'WorkspaceId' => ['title' => '工作空间ID', 'description' => '所属工作空间ID,官方镜像为空', 'type' => 'string'],
                                        'UserId' => ['title' => '创建者', 'description' => '镜像创建者', 'type' => 'string'],
                                        'SourceType' => ['title' => '来源类型', 'description' => '镜像来源类型,取值 OFFICIAL / USER_BUILD / USER_IMPORT', 'type' => 'string'],
                                        'Size' => ['title' => '镜像大小', 'description' => '镜像大小,单位为字节', 'type' => 'integer', 'format' => 'int64'],
                                        'Labels' => [
                                            'title' => '标签列表',
                                            'description' => '镜像标签列表',
                                            'type' => 'array',
                                            'items' => [
                                                'type' => 'object',
                                                'properties' => [
                                                    'Key' => ['title' => '标签键', 'description' => '标签Key', 'type' => 'string'],
                                                    'Value' => ['title' => '标签值', 'description' => '标签Value', 'type' => 'string'],
                                                ],
                                            ],
                                        ],
                                        'GmtCreateTime' => ['title' => '创建时间', 'description' => '镜像创建时间,ISO-8601格式', 'type' => 'string', 'format' => 'iso8601'],
                                        'GmtModifiedTime' => ['title' => '修改时间', 'description' => '镜像修改时间,ISO-8601格式', 'type' => 'string', 'format' => 'iso8601'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-beijing', 'endpoint' => 'eflo-controller.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'eflo-controller.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'cn-huhehaote', 'endpoint' => 'eflo-controller.cn-huhehaote.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu', 'endpoint' => 'eflo-controller.cn-wulanchabu.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'eflo-controller.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'eflo-controller.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'eflo-controller.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-heyuan', 'endpoint' => 'eflo-controller.cn-heyuan.aliyuncs.com'],
        ['regionId' => 'cn-guangzhou', 'endpoint' => 'eflo-controller.cn-guangzhou.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'eflo-controller.cn-hongkong.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'eflo-controller.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'eflo-controller.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'eflo-controller.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'eflo-controller.eu-central-1.aliyuncs.com'],
        ['regionId' => 'me-east-1', 'endpoint' => 'eflo-controller.me-east-1.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'eflo-controller.cn-shanghai-finance-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-7', 'endpoint' => 'eflo-controller.ap-southeast-7.aliyuncs.com'],
        ['regionId' => 'ap-southeast-8', 'endpoint' => 'eflo-controller.ap-sourtheast-8.aliyuncs.com'],
    ],
];