path: root/data/zh_cn/ddi/2020-06-17/api-docs.php

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'Ddi',
        'version' => '2020-06-17',
    ],
    'directories' => [
        [
            'id' => 112438,
            'title' => '作业和工作流',
            'type' => 'directory',
            'children' => [
                [
                    'id' => 112443,
                    'title' => '工作流的增删改查',
                    'type' => 'directory',
                    'children' => [
                        'CreateFlow',
                    ],
                ],
            ],
        ],
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => [
                'DescribeFlowEntitySnapshot',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'CreateFlow' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'parameters' => [
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => [
                        'description' => '地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => 'cn-hangzhou',
                    ],
                ],
                [
                    'name' => 'ProjectId',
                    'in' => 'query',
                    'schema' => [
                        'description' => '项目ID。您可以调用ListFlowProject查看项目的ID。',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => 'FP-ED2F3E844FE3****',
                    ],
                ],
                [
                    'name' => 'Name',
                    'in' => 'query',
                    'schema' => [
                        'description' => '目录名称。您可以调用ListFlowProject查看',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => 'myFlow',
                    ],
                ],
                [
                    'name' => 'Description',
                    'in' => 'query',
                    'schema' => [
                        'description' => '项目描述。',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => '这是一个项目描述',
                    ],
                ],
                [
                    'name' => 'StartSchedule',
                    'in' => 'query',
                    'schema' => [
                        'description' => '开始调度时间，长整型时间戳.。例如：System.currentTimeMillis()。'."\n"
                            .'- 必须小于EndSchedule。'."\n"
                            .'- 当CronExpr不为空时，此项必填。',
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '1538017814000',
                    ],
                ],
                [
                    'name' => 'EndSchedule',
                    'in' => 'query',
                    'schema' => [
                        'description' => '调度失效时间，长整型时间戳，例如System.currentTimeMillis()。',
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '1538018814000',
                    ],
                ],
                [
                    'name' => 'CronExpression',
                    'in' => 'query',
                    'schema' => [
                        'description' => '时间周期调度的cron表达式。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '0 0 0-23/1 * * ?',
                    ],
                ],
                [
                    'name' => 'CreateCluster',
                    'in' => 'query',
                    'schema' => [
                        'description' => '是否通过集群模板创建集群，true表示通过集群模板创建集群，ClusterId应设置为集群模板 ID(CT-xxx)，否则为已有集群 ID（C-xxx）。',
                        'type' => 'boolean',
                        'required' => false,
                        'example' => 'false',
                    ],
                ],
                [
                    'name' => 'ClusterId',
                    'in' => 'query',
                    'schema' => [
                        'description' => '集群ID。您可以调用ListClusters查看集群的ID。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'C-A23BD131A862****',
                    ],
                ],
                [
                    'name' => 'HostName',
                    'in' => 'query',
                    'schema' => [
                        'description' => '节点实例运行所在主机的名称。您可以调用ListFlow或登录主机使用hostname命令查看。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'emr-header-1.cluster-123456',
                    ],
                ],
                [
                    'name' => 'Namespace',
                    'in' => 'query',
                    'schema' => [
                        'description' => '保留字段。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '无',
                    ],
                ],
                [
                    'name' => 'Application',
                    'in' => 'query',
                    'schema' => [
                        'description' => 'APP',
                        'type' => 'string',
                        'required' => false,
                        'example' => '无',
                    ],
                ],
                [
                    'name' => 'AlertConf',
                    'in' => 'query',
                    'schema' => [
                        'description' => '报警通知配置，eventId目前支持以下告警：'."\n"
                            .'- EMR-210401001（工作流失败报警）。'."\n"
                            .'- EMR-110401002（工作流成功通知）。'."\n"
                            .'- EMR-110401015（工作流节点失败报警）。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '{"items":[{"enable":true,"eventId":"EMR-210401001","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401015","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401002","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]}]}',
                    ],
                ],
                [
                    'name' => 'AlertUserGroupBizId',
                    'in' => 'query',
                    'schema' => [
                        'description' => '报警用户组信息。'."\n"
                            ."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => 'ADG-0a00d00abb7743ff9f812f1a997f3d87',
                    ],
                ],
                [
                    'name' => 'AlertDingDingGroupBizId',
                    'in' => 'query',
                    'schema' => [
                        'description' => '报警钉钉群信息。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '已过期',
                    ],
                ],
                [
                    'name' => 'ParentFlowList',
                    'in' => 'query',
                    'schema' => [
                        'description' => '依赖的上游工作流列表，以逗号分隔。您可以调用ListFlowInstance查看工作流ID。'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => 'F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89',
                    ],
                ],
                [
                    'name' => 'ParentCategory',
                    'in' => 'query',
                    'schema' => [
                        'description' => 'F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89',
                    ],
                ],
                [
                    'name' => 'ClientToken',
                    'in' => 'query',
                    'schema' => [
                        'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '123e4567-e89b-12d3-a456-42665544****',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Id' => [
                                'description' => '新创建的工作流ID。',
                                'type' => 'string',
                                'example' => 'F-7A39731FE719****',
                            ],
                            'RequestId' => [
                                'description' => '请求ID。',
                                'type' => 'string',
                                'example' => '243D5A48-96A5-4C0C-8966-93CBF65635ED',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"Id\\": \\"F-7A39731FE719****\\",\\n  \\"RequestId\\": \\"243D5A48-96A5-4C0C-8966-93CBF65635ED\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateFlowResponse>\\n    <Id>F-7A39731FE719****</Id>\\n    <RequestId>243D5A48-96A5-4C0C-8966-93CBF65635ED</RequestId>\\n</CreateFlowResponse>","errorExample":""}]',
            'title' => '创建工作流',
            'summary' => '创建一个工作流，对应于项目空间 -> 工作流设计页面 -> 新建工作流。',
        ],
        'DescribeFlowEntitySnapshot' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                    ],
                ],
                [
                    'name' => 'Limit',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'integer',
                        'format' => 'int32',
                        'required' => false,
                        'maximum' => '100',
                        'minimum' => '1',
                        'default' => '20',
                    ],
                ],
                [
                    'name' => 'PageNumber',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'integer',
                        'format' => 'int32',
                        'required' => false,
                        'maximum' => '100',
                        'minimum' => '1',
                        'default' => '1',
                    ],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'integer',
                        'format' => 'int32',
                        'required' => false,
                        'maximum' => '100',
                        'minimum' => '1',
                        'default' => '20',
                    ],
                ],
                [
                    'name' => 'CurrentSize',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'integer',
                        'format' => 'int32',
                        'required' => false,
                        'maximum' => '100',
                        'minimum' => '1',
                        'default' => '20',
                    ],
                ],
                [
                    'name' => 'PageCount',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'integer',
                        'format' => 'int32',
                        'required' => false,
                        'maximum' => '100',
                        'minimum' => '1',
                        'default' => '20',
                    ],
                ],
                [
                    'name' => 'OrderField',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'OrderMode',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'CommitterId',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'EntityType',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'EntityGroupId',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'EntityId',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'Revision',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Active' => [
                                'type' => 'boolean',
                            ],
                            'Data' => [
                                'type' => 'string',
                            ],
                            'RequestId' => [
                                'type' => 'string',
                            ],
                            'EntityId' => [
                                'type' => 'string',
                            ],
                            'EntityType' => [
                                'type' => 'string',
                            ],
                            'UserId' => [
                                'type' => 'string',
                            ],
                            'GmtCreate' => [
                                'type' => 'integer',
                                'format' => 'int64',
                            ],
                            'Message' => [
                                'type' => 'string',
                            ],
                            'EntityGroupId' => [
                                'type' => 'string',
                            ],
                            'CommitterId' => [
                                'type' => 'string',
                            ],
                            'Revision' => [
                                'type' => 'string',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-qingdao',
            'endpoint' => 'ddi.cn-qingdao.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-chengdu',
            'endpoint' => 'ddi.cn-chengdu.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-zhangjiakou',
            'endpoint' => 'ddi.cn-zhangjiakou.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-huhehaote',
            'endpoint' => 'ddi.cn-huhehaote.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hongkong',
            'endpoint' => 'ddi.cn-hongkong.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-southeast-2',
            'endpoint' => 'ddi.ap-southeast-2.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-southeast-3',
            'endpoint' => 'ddi.ap-southeast-3.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-southeast-5',
            'endpoint' => 'ddi.ap-southeast-5.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-northeast-1',
            'endpoint' => 'ddi.ap-northeast-1.aliyuncs.com',
        ],
        [
            'regionId' => 'eu-west-1',
            'endpoint' => 'ddi.eu-west-1.aliyuncs.com',
        ],
        [
            'regionId' => 'us-east-1',
            'endpoint' => 'ddi.us-east-1.aliyuncs.com',
        ],
        [
            'regionId' => 'eu-central-1',
            'endpoint' => 'ddi.eu-central-1.aliyuncs.com',
        ],
        [
            'regionId' => 'me-east-1',
            'endpoint' => 'ddi.me-east-1.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-south-1',
            'endpoint' => 'ddi.ap-south-1.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-beijing',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shenzhen',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-heyuan',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-southeast-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'us-west-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-northeast-2-pop',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-beijing-finance-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-beijing-finance-pop',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-beijing-gov-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-beijing-nu16-b01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-edge-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-fujian',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-haidian-cm12-c01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou-bj-b01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou-finance',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou-internal-prod-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou-internal-test-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou-internal-test-2',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou-internal-test-3',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou-test-306',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hongkong-finance-pop',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-huhehaote-nebula-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-north-2-gov-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-qingdao-nebula',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shanghai-et15-b01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shanghai-et2-b01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shanghai-finance-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shanghai-inner',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shanghai-internal-test-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shenzhen-finance-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shenzhen-inner',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shenzhen-st4-d01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-shenzhen-su18-b01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-wuhan',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-wulanchabu',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-yushanfang',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-zhangbei-na61-b01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-zhangjiakou-na62-a01',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-zhengzhou-nebula-1',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'eu-west-1-oxs',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
        [
            'regionId' => 'rus-west-1-pop',
            'endpoint' => 'ddi.aliyuncs.com',
        ],
    ],
];