diff options
Diffstat (limited to 'data/zh_cn/es-serverless/2023-06-27')
| -rw-r--r-- | data/zh_cn/es-serverless/2023-06-27/api-docs.php | 5301 |
1 files changed, 2231 insertions, 3070 deletions
diff --git a/data/zh_cn/es-serverless/2023-06-27/api-docs.php b/data/zh_cn/es-serverless/2023-06-27/api-docs.php index c678957..b63e8cb 100644 --- a/data/zh_cn/es-serverless/2023-06-27/api-docs.php +++ b/data/zh_cn/es-serverless/2023-06-27/api-docs.php @@ -1,105 +1,132 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'es-serverless', - 'version' => '2023-06-27', - ], + 'info' => ['style' => 'ROA', 'product' => 'es-serverless', 'version' => '2023-06-27'], 'directories' => [ [ - 'id' => 364874, - 'title' => '应用', + 'children' => ['UpdateApp', 'GetApp', 'ListApps', 'DeleteApp', 'GetAppQuota', 'GetMonitorData'], 'type' => 'directory', - 'children' => [ - 'CreateApp', - 'UpdateApp', - 'GetApp', - 'ListApps', - 'DeleteApp', - 'GetAppQuota', - 'GetMonitorData', - 'ListIndices', - ], + 'title' => '应用', + 'id' => 99495, ], [ - 'id' => 364883, - 'title' => '数据备份', + 'children' => ['UpdateSnapshotSetting', 'ListSnapshots', 'ListSnapshotRepositories', 'GetSnapshotSetting'], 'type' => 'directory', - 'children' => [ - 'CreateSnapshot', - 'UpdateSnapshotSetting', - 'ListSnapshots', - 'ListSnapshotRepositories', - 'GetSnapshotSetting', - 'DeleteSnapshot', - ], + 'title' => '数据备份', + 'id' => 99480, ], [ - 'id' => 364890, - 'title' => '词典', + 'children' => ['UpdateDict', 'ListDicts', 'DeleteDict'], 'type' => 'directory', - 'children' => [ - 'UpdateDict', - 'ListDicts', - 'DeleteDict', - ], + 'title' => '词典', + 'id' => 99491, ], [ - 'id' => 364894, - 'title' => '终端节点', + 'children' => ['CreateEndpoint', 'UpdateEndpoint', 'ListEndpoints', 'DeleteEndpoint'], 'type' => 'directory', - 'children' => [ - 'CreateEndpoint', - 'UpdateEndpoint', - 'ListEndpoints', - 'DeleteEndpoint', - ], + 'title' => '终端节点', + 'id' => 99474, ], [ - 'id' => 364899, + 'children' => ['ListSpecReviewTasks', 'GetSpecReviewTask', 'CancelSpecReviewTask'], + 'type' => 'directory', 'title' => '规格审批任务', + 'id' => 99487, + ], + [ + 'children' => ['UpdatePrivateNetwrok', 'UpdateNetwork'], 'type' => 'directory', - 'children' => [ - 'ListSpecReviewTasks', - 'GetSpecReviewTask', - 'CancelSpecReviewTask', - ], + 'title' => '其 他', + 'id' => 344253, ], [ - 'id' => 364903, + 'children' => ['CreateApp', 'CreateSnapshot', 'DeleteSnapshot', 'ListIndices'], 'title' => '其他', 'type' => 'directory', - 'children' => [ - 'UpdatePrivateNetwrok', - 'UpdateNetwork', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ + 'CancelSpecReviewTask' => [ + 'summary' => '调用CancelSpecReviewTask接口，撤销ES Serverless应用规格审批工单。', + 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks/{taskId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '207770', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], + ], + 'parameters' => [ + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '339'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD'], + 'result' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '撤销审批工单', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSpecReviewTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:CancelSpecReviewTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], 'CreateApp' => [ 'summary' => '调用CreateApp接口，创建Elasticsearch Serverless应用。', 'path' => '/openapi/es-serverless/instances', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ @@ -107,9 +134,7 @@ 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '185142', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchGXQH1U', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchGXQH1U'], ], 'parameters' => [ [ @@ -121,20 +146,8 @@ 'description' => 'Body参数。', 'type' => 'object', 'properties' => [ - 'appName' => [ - 'title' => '应用名', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'description' => [ - 'title' => '应用备注', - 'description' => '应用备注。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'appName' => ['title' => '应用名', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'description' => ['title' => '应用备注', 'description' => '应用备注。', 'type' => 'string', 'required' => false, 'example' => 'test'], 'network' => [ 'description' => '公网信息。', 'type' => 'array', @@ -142,33 +155,12 @@ 'description' => '公网信息具体结构。', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型：'."\n" - .'- PUBLIC_ES：Elasticsearch公网访问白名单'."\n" - .'- PUBLIC_KIBANA：Kibana公网访问白名单', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC_ES', - ], - 'enabled' => [ - 'description' => '是否开启公网访问。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com', - ], - 'port' => [ - 'description' => '端口号。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], + 'type' => ['description' => 'IP白名单的类型：'."\n" + .'- PUBLIC_ES：Elasticsearch公网访问白名单'."\n" + .'- PUBLIC_KIBANA：Kibana公网访问白名单', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC_ES'], + 'enabled' => ['description' => '是否开启公网访问。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'domain' => ['description' => '域名信息。', 'type' => 'string', 'required' => false, 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'], + 'port' => ['description' => '端口号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200'], 'whiteIpGroup' => [ 'description' => '白名单列表。', 'type' => 'array', @@ -176,21 +168,11 @@ 'description' => '白名单具体结构。', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'groupName' => ['description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'default'], 'ips' => [ 'description' => '白名单组中的IP地址列表。', 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], 'required' => false, ], ], @@ -214,18 +196,8 @@ 'description' => '基础信息。', 'type' => 'object', 'properties' => [ - 'username' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-123', - ], - 'password' => [ - 'description' => '密码。', - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], + 'username' => ['description' => '用户名。（暂不支持设置，系统会默认将应用ID设置为用户名）', 'type' => 'string', 'required' => false, 'example' => 'test-123'], + 'password' => ['description' => '密码。', 'type' => 'string', 'required' => false, 'example' => '******'], ], 'required' => false, ], @@ -234,51 +206,24 @@ ], 'required' => true, ], - 'regionId' => [ - 'description' => '应用所在的地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'version' => [ - 'description' => '应用版本，默认7.10版本。', - 'type' => 'string', - 'required' => false, - 'example' => '7.10', - ], - 'chargeType' => [ - 'description' => '付费类型。当前仅支持按量付费：POSTPAY。', - 'type' => 'string', - 'required' => true, - 'example' => 'POSTPAY', - ], + 'regionId' => ['description' => '应用所在的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'version' => ['description' => '应用版本，目前仅支持ES 8.17版本的创建。', 'type' => 'string', 'required' => false, 'example' => '8.17'], + 'chargeType' => ['description' => '付费类型。当前仅支持按量付费：POSTPAY。', 'type' => 'string', 'required' => true, 'example' => 'POSTPAY'], 'quotaInfo' => [ 'description' => '配额信息。', 'type' => 'object', 'properties' => [ - 'cu' => [ - 'description' => '单个应用的弹性计算资源上限。单位：CU。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], - 'storage' => [ - 'description' => '单个应用的索引最大存储量。单位：GB。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - ], - 'appType' => [ - 'description' => '应用类型：'."\n" - ."\n" - .'- STANDARD：企业版，'."\n" - .'- TRIAL：入门版', - 'type' => 'string', - 'required' => false, - 'example' => 'STANDARD', - ], + 'cu' => ['description' => '（该字段已经废弃）单个应用的弹性计算资源上限。单位：CU。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'], + 'storage' => ['description' => '单个应用的索引最大存储量。单位：GB。（创建应用时不需要设置该值，系统会根据cu自动设置）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'], + 'appType' => ['description' => '应用类型：'."\n" + ."\n" + .'- STANDARD：企业版。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'], + 'minCu' => ['title' => '计算资源下限，单位CU。'."\n" + .'检索增强型可填值：2，4，6，8，16'."\n", 'description' => '计算资源下限，单位CU。'."\n" + .'检索增强型可填值：2，4，6，8，16', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + 'elastic' => ['title' => '是否开启弹性功能(改值仅针对检索增强型应用设置)，开启：true 关闭: false ', 'description' => '是否开启弹性功能。'."\n" + .'开启：true'."\n" + .'关闭: false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, ], @@ -289,21 +234,11 @@ 'description' => '私网信息具体结构。', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型：'."\n" - ."\n" - .'- PRIVATE_KIBANA：Kibana私网访问白名单'."\n" - .'- PRIVATE_ES：Elasticsearch私网访问白名单', - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE_ES', - ], - 'enabled' => [ - 'description' => '是否开启私网访问。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'type' => ['description' => 'IP白名单的类型：'."\n" + ."\n" + .'- PRIVATE_KIBANA：Kibana私网访问白名单'."\n" + .'- PRIVATE_ES：Elasticsearch私网访问白名单', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE_ES'], + 'enabled' => ['description' => '是否开启私网访问。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'whiteIpGroup' => [ 'description' => '白名单列表。', 'type' => 'array', @@ -311,21 +246,11 @@ 'description' => '白名单具体结构。', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'groupName' => ['description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'default'], 'ips' => [ 'description' => '白名单组中的IP地址列表。', 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], 'required' => false, ], ], @@ -333,48 +258,28 @@ ], 'required' => false, ], - 'vpcId' => [ - 'description' => '终端节点所在VPC的ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1jy348ibzulk6hn****', - ], - 'pvlEndpointId' => [ - 'description' => '终端节点ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ep-bp1id41dd116e52e****', - ], + 'vpcId' => ['description' => '终端节点所在VPC的ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1jy348ibzulk6hn****'], + 'pvlEndpointId' => ['description' => '终端节点ID。', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id41dd116e52e****'], ], 'required' => false, ], 'required' => false, ], - 'scenario' => [ - 'description' => '应用使用场景 ：'."\n" - .'- SEARCH：检索场景'."\n" - .'- LOG：时序日志场景', - 'type' => 'string', - 'required' => false, - 'example' => 'SEARCH', - ], + 'scenario' => ['description' => '应用使用场景 ：'."\n" + .'- GENERAL：检索增强型', 'type' => 'string', 'required' => false, 'example' => 'GENERAL'], 'tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'key' => [ - 'type' => 'string', - 'required' => false, - ], - 'value' => [ - 'type' => 'string', - 'required' => false, - ], + 'key' => ['type' => 'string', 'required' => false, 'description' => ''], + 'value' => ['type' => 'string', 'required' => false, 'description' => ''], ], 'required' => false, + 'description' => '', ], 'required' => false, + 'description' => '', ], ], 'required' => false, @@ -383,24 +288,16 @@ [ 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => '是否校验入参数据合法性并创建应用，默认false。'."\n" - ."\n" - .'- **true**：只校验参数合法性。'."\n" - ."\n" - .'- **false**：校验参数合法性，并创建应用。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '是否校验入参数据合法性并创建应用，默认false。'."\n" + ."\n" + .'- **true**：只校验参数合法性。'."\n" + ."\n" + .'- **false**：校验参数合法性，并创建应用。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -410,24 +307,13 @@ 'description' => '响应体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'instaneId' => [ - 'description' => '应用对应的实例id。', - 'type' => 'string', - 'example' => 'es-serverless-cn-xxx', - ], - 'appId' => [ - 'type' => 'string', - ], + 'instaneId' => ['description' => '应用对应的实例id。', 'type' => 'string', 'example' => 'es-serverless-cn-xxx'], + 'appId' => ['type' => 'string', 'description' => ''], ], ], ], @@ -436,965 +322,733 @@ ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"instaneId\\": \\"es-serverless-cn-xxx\\",\\n \\"appId\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '创建应用', - ], - 'UpdateApp' => [ - 'summary' => '调用UpdateApp接口，更新Elasticsearch Serverless应用相关信息，包括备注、网络开关、IP白名单组、账号密码等。', - 'path' => '/openapi/es-serverless/instances/{appName}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'http', - 'https', + 'requestParamsDescription' => '创建应用的完整请求体示例如下：'."\n" + .'```'."\n" + .'{'."\n" + .' "appName": "esserverlesstest",'."\n" + .' "description": "test",'."\n" + .' "network": ['."\n" + .' {'."\n" + .' "type": "PUBLIC_ES",'."\n" + .' "enabled": true,'."\n" + .' "whiteIpGroup": ['."\n" + .' {'."\n" + .' "groupName": "test",'."\n" + .' "ips": ['."\n" + .' "127.0.0.1"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .' "authentication": {'."\n" + .' "basicAuth": ['."\n" + .' {'."\n" + .' "password": "Admin113"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "version": "8.17",'."\n" + .' "chargeType": "POSTPAY",'."\n" + .' "quotaInfo": {'."\n" + .' "appType": "STANDARD",'."\n" + .' "minCu": 2,'."\n" + .' "elastic": true'."\n" + .' },'."\n" + .' "scenario": "GENERAL"'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 86400, 'regionId' => '*', 'api' => 'CreateApp'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateEndpoint' => [ + 'summary' => '调用CreateEndpoint接口，创建ES Serverless应用的私网终端节点，目前限制用户每个区域最多创建50个。目前仅支持创建VPC类型的端点，用来打通用户VPC网络和ES Serverless服务的网络。调用该接口会默认帮助用户创建AliyunServiceRoleForESServerless角色。', + 'path' => '/openapi/es-serverless/endpoints', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '185144', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '206201', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], ], 'parameters' => [ [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => '应用名称。调用[ListApps](~~2539816~~)获取应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => 'body参数', - 'description' => 'body参数。', + 'description' => 'body参数', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '应用备注', - 'description' => '应用备注。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'network' => [ - 'description' => '公网信息。', - 'type' => 'array', - 'items' => [ - 'description' => '公网信息具体结构。', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型：'."\n" - .'- PUBLIC_ES：Elasticsearch公网访问白名单'."\n" - .'- PUBLIC_KIBANA：Kibana公网访问白名单', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC_ES', - ], - 'enabled' => [ - 'description' => '是否开启公网访问。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名信息。（暂不支持修改）', - 'type' => 'string', - 'required' => false, - 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com', - ], - 'port' => [ - 'description' => '端口号。（暂不支持修改）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], - 'whiteIpGroup' => [ - 'description' => '白名单列表。', - 'type' => 'array', - 'items' => [ - 'description' => '白名单具体结构。', - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'ips' => [ - 'description' => '白名单组中的IP地址列表。', - 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'authentication' => [ - 'description' => '认证信息。', - 'type' => 'object', - 'properties' => [ - 'basicAuth' => [ - 'description' => 'BasicAuth信息。', - 'type' => 'array', - 'items' => [ - 'description' => '基础信息。', - 'type' => 'object', - 'properties' => [ - 'username' => [ - 'description' => '用户名。（目前默认为应用ID， 暂时不支持修改）', - 'type' => 'string', - 'required' => false, - 'example' => 'test-123', - ], - 'password' => [ - 'description' => '密码。', - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'privateNetwork' => [ - 'description' => '私网信息。', + 'endpointZones' => [ + 'description' => '可用区信息列表。', 'type' => 'array', 'items' => [ - 'description' => '私网信息具体结构。', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型，可选值：'."\n" - ."\n" - .'- PRIVATE_KIBANA：Kibana私网访问白名单'."\n" - .'- PRIVATE_ES：Elasticsearch私网访问白名单', - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE_ES', - ], - 'enabled' => [ - 'description' => '是否开启私网访问。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'vpcId' => [ - 'description' => '终端节点VPC的ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1jy348ibzulk6hn****', - ], - 'pvlEndpointId' => [ - 'description' => '终端节点ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ep-bp1id41dd116e52e****', - ], - 'whiteIpGroup' => [ - 'description' => '白名单列表。', - 'type' => 'array', - 'items' => [ - 'description' => '白名单具体结构。', - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'ips' => [ - 'description' => '白名单组中的IP地址列表。', - 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'zoneId' => ['description' => '可用区ID。目前支持的地域和可用区如下：'."\n" + .'- 杭州区域：cn-hangzhou-h, cn-hangzhou-g, cn-hangzhou-i'."\n" + .'- 北京区域：cn-beijing-g, cn-beijing-h, cn-beijing-i'."\n" + .'- 深圳区域：cn-shenzhen-d, cn-shenzhen-e, cn-shenzhen-f'."\n" + .'- 上海区域：cn-shanghai-b, cn-shanghai-f, cn-shanghai-g', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], + 'vswitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6qmfkqdcw*****'], ], 'required' => false, + 'description' => '', ], - 'required' => false, - ], - 'limiterInfo' => [ - 'description' => '系统限制信息。'."\n" - ."\n" - .'> 推荐通过控制台修改，提交修改后会生成规格审批工单。', - 'type' => 'object', - 'properties' => [ - 'limiters' => [ - 'description' => '限制列表。', - 'type' => 'array', - 'items' => [ - 'description' => '限制。', - 'type' => 'object', - 'properties' => [ - 'maxValue' => [ - 'description' => '最大阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'minValue' => [ - 'description' => '最小阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'type' => [ - 'description' => '系统限制类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'MAX_CU_PER_SHARD', - ], - 'values' => [ - 'description' => '限制取值列表。', - 'type' => 'array', - 'items' => [ - 'description' => '限制取值。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'applyReason' => [ - 'description' => '申请理由。', - 'type' => 'string', - 'required' => false, - 'example' => '申请系统限制。', - ], - 'contactInfo' => [ - 'description' => '联系方式，电话或邮箱', - 'type' => 'string', - 'required' => false, - 'example' => '1370247****', + 'required' => true, ], + 'vpcId' => ['description' => '专有网络实例ID', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf664nyle5khp5***'], + 'name' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'testendpoint'], ], 'required' => false, ], ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => '端点类型，默认值VPC。', 'type' => 'string', 'required' => false, 'example' => 'VPC'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6B297235-FC5B-590D-8218-8A5ED90AAE99', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => '应用对应的实例ID。', - 'type' => 'string', - 'example' => 'es-serverless-cn-8tr6u27483859****', - ], + 'endpointId' => ['description' => '端点ID。', 'type' => 'string', 'example' => 'essep-abd***dks'], ], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6B297235-FC5B-590D-8218-8A5ED90AAE99\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"es-serverless-cn-8tr6u27483859****\\"\\n }\\n}","type":"json"}]', - 'title' => '更新应用', - ], - 'GetApp' => [ - 'summary' => '调用GetApp接口，获取Elasticsearch Serverless应用的详情信息。', - 'path' => '/openapi/es-serverless/instances/{appName}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"essep-abd***dks\\"\\n }\\n}","type":"json"}]', + 'title' => '创建终端节点', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEndpoint'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateSnapshot' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories/{repository}/snapshots', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '185146', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchGXQH1U', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '213584', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ - 'name' => 'appName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '应用名称。调用[ListApps](~~2539816~~)获取应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'title' => 'body参数', + 'description' => 'body参数。', + 'type' => 'object', + 'properties' => [ + 'snapshot' => ['description' => '快照名称。', 'type' => 'string', 'required' => true, 'example' => 'qingning'], + 'indices' => ['description' => '索引名称，多个索引逗号分隔。', 'type' => 'string', 'required' => true, 'example' => 'product_info'], + ], + 'required' => false, ], ], [ - 'name' => 'detailed', + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'dryRun', 'in' => 'query', + 'schema' => ['description' => '是否校验入参数据合法性，默认false。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **true**：只校验参数合法性。'."\n" + ."\n" + .'- **false**：校验参数合法性，创建快照。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'repository', + 'in' => 'path', + 'schema' => ['description' => '快照仓库名称。目前默认aliyun_auto_snapshot。', 'type' => 'string', 'required' => true, 'example' => 'aliyun_auto_snapshot'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否获取详细信息。取值如下：'."\n" - .'- **false**（默认）：不获取'."\n" - .'- **true**：获取', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => 'Schema of Response', + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '03761BE5-D12F-55B4-9C93-0255C11DE44A'], + 'result' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建快照', + 'summary' => '调用CreateSnapshot，创建ES Serverless应用的快照。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSnapshot'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"03761BE5-D12F-55B4-9C93-0255C11DE44A\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'DeleteApp' => [ + 'summary' => '调用DeleteApp接口，删除Elasticsearch Serverless应用。', + 'path' => '/openapi/es-serverless/instances/{appName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '185145', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], + ], + 'parameters' => [ + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => '待删除的应用名称。调用[ListApps](~~2539816~~)获取应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数。', + 'description' => '响应体结构。', 'type' => 'object', 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'appName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'es-severless-test-app', - ], - 'ownerId' => [ - 'description' => '应用所属的阿里云主账号UID。', - 'type' => 'string', - 'example' => '*******7595', - ], - 'regionId' => [ - 'description' => '应用所在地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'status' => [ - 'description' => '应用状态：'."\n" - ."\n" - .'- **ACTIVE**：正常'."\n" - .'- **INIT**：创建中'."\n" - .'- **INACTIVE**：冻结', - 'type' => 'string', - 'example' => 'ACTIVE', - ], - 'createTime' => [ - 'description' => '应用创建时间。', - 'type' => 'string', - 'example' => '2022-08-15T11:20:52.370Z', - ], - 'modifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2022-08-15T11:21:50.000Z', - ], - 'description' => [ - 'description' => '应用备注。', - 'type' => 'string', - 'example' => '这是一个demo应用', - ], - 'appId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'test-app-abc', - ], - 'version' => [ - 'description' => '产品版本。', - 'type' => 'string', - 'example' => '7.10', - ], - 'instanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'es-serverless-***17位id**', - ], - 'network' => [ - 'description' => '公网信息。', - 'type' => 'array', - 'items' => [ - 'description' => '公网信息具体结构。', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型'."\n" - ."\n" - .'- PUBLIC_ES：Elasticsearch公网访问白名单'."\n" - .'- PUBLIC_KIBANA：Kibana公网访问白名单', - 'type' => 'string', - 'example' => 'PUBLIC_ES', - ], - 'enabled' => [ - 'description' => '是否开启公网访问。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名信息。', - 'type' => 'string', - 'example' => 'test-123.public.cn-hangzhou.es-serverless.aliyuncs.com', - ], - 'port' => [ - 'description' => '端口号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'whiteIpGroup' => [ - 'description' => '白名单列表', - 'type' => 'array', - 'items' => [ - 'description' => '白名单具体结构', - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。', - 'type' => 'string', - 'example' => 'test', - ], - 'ips' => [ - 'description' => '白名单组中的IP地址列表。', - 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - ], - ], - ], - ], - ], - ], - ], - 'privateNetwork' => [ - 'description' => '私网信息。', - 'type' => 'array', - 'items' => [ - 'description' => '私网信息具体结构。', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型'."\n" - ."\n" - .'- PRIVATE_KIBANA：Kibana私网访问白名单'."\n" - .'- PRIVATE_ES：Elasticsearch私网访问白名单', - 'type' => 'string', - 'example' => 'PRIVATE_ES', - ], - 'enabled' => [ - 'description' => '是否开启私网访问。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名信息。', - 'type' => 'string', - 'example' => 'test-123.private.cn-hangzhou.es-serverless.aliyuncs.com', - ], - 'port' => [ - 'description' => '端口号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'vpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp16ul4pwsg1mjni***', - ], - 'pvlEndpointId' => [ - 'description' => '终端节点信息。', - 'type' => 'string', - 'example' => 'ep-aaaddd**', - ], - 'whiteIpGroup' => [ - 'description' => '白名单列表', - 'type' => 'array', - 'items' => [ - 'description' => '白名单具体结构', - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。', - 'type' => 'string', - 'example' => 'test', - ], - 'ips' => [ - 'description' => '白名单组中的IP地址列表。', - 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - ], - ], - ], - ], - ], - ], - ], - 'appType' => [ - 'type' => 'string', - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - ], - ], - ], - 'scenario' => [ - 'type' => 'string', - ], - 'chargeType' => [ - 'type' => 'string', - ], + 'instanceId' => ['description' => '已删除应用对应的实例ID。', 'type' => 'string', 'example' => 'Es-serverless-***17-digit-id**'], ], ], - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"appName\\": \\"es-severless-test-app\\",\\n \\"ownerId\\": \\"*******7595\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"ACTIVE\\",\\n \\"createTime\\": \\"2022-08-15T11:20:52.370Z\\",\\n \\"modifiedTime\\": \\"2022-08-15T11:21:50.000Z\\",\\n \\"description\\": \\"这是一个demo应用\\",\\n \\"appId\\": \\"test-app-abc\\",\\n \\"version\\": \\"7.10\\",\\n \\"instanceId\\": \\"es-serverless-***17位id**\\",\\n \\"network\\": [\\n {\\n \\"type\\": \\"PUBLIC_ES\\",\\n \\"enabled\\": true,\\n \\"domain\\": \\"test-123.public.cn-hangzhou.es-serverless.aliyuncs.com\\",\\n \\"port\\": 9200,\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"test\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"privateNetwork\\": [\\n {\\n \\"type\\": \\"PRIVATE_ES\\",\\n \\"enabled\\": true,\\n \\"domain\\": \\"test-123.private.cn-hangzhou.es-serverless.aliyuncs.com\\",\\n \\"port\\": 9200,\\n \\"vpcId\\": \\"vpc-bp16ul4pwsg1mjni***\\",\\n \\"pvlEndpointId\\": \\"ep-aaaddd**\\",\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"test\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"appType\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"scenario\\": \\"\\",\\n \\"chargeType\\": \\"\\"\\n },\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\"\\n}","type":"json"}]', - 'title' => '获取应用详情', - ], - 'ListApps' => [ - 'summary' => '调用ListApps接口，查看Elasticsearch Serverless应用的列表。', - 'path' => '/openapi/es-serverless/instances', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"Es-serverless-***17-digit-id**\\"\\n }\\n}","type":"json"}]', + 'title' => '删除应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteDict' => [ + 'summary' => '调用DeleteDict接口，删除ES Serverless应用的词典。', + 'path' => '/openapi/es-serverless/instances/{appName}/dicts/actions/remove', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '185147', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchGXQH1U', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '213564', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ - 'name' => 'appName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', + 'title' => 'body参数', + 'description' => 'body参数', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '词典文件名称。', 'type' => 'string', 'required' => true, 'example' => 'a.dic'], + 'type' => ['description' => '词典类型：'."\n" + ."\n" + .'- MAIN：IK主分词词库'."\n" + .'- STOP：IK停用词库', 'type' => 'string', 'required' => true, 'example' => 'MAIN'], + ], 'required' => false, - 'example' => 'es-severless-test-app'."\n", ], ], [ - 'name' => 'description', - 'in' => 'query', + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '应用描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'metrics-logs-online', + 'title' => 'Schema of Response', + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2BF6B57E-5AAD-5389-80CD-E200BBF91FF9'], + 'result' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除词典', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDict'], + ], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时设置的页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2BF6B57E-5AAD-5389-80CD-E200BBF91FF9\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'DeleteEndpoint' => [ + 'summary' => '调用DeleteEndpoint接口，删除在ES Serverless平台创建的终端节点。', + 'path' => '/openapi/es-serverless/endpoints/{endpointId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '206262', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], + ], + 'parameters' => [ [ - 'name' => 'createTime', - 'in' => 'query', + 'name' => 'endpointId', + 'in' => 'path', + 'schema' => ['description' => '终端节点ID。', 'type' => 'string', 'required' => true, 'example' => 'essep-2f46b743f60****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '应用创建时间。过滤出大于等于输入值的应用，时间格式为YYYY-MM-DDThh:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-08-29T02:37:22Z', + 'title' => 'Schema of Response', + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1305A3E0-A291-54BA-A3B2-7D1C12EC4112'], + 'result' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除终端节点', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEndpoint'], + ], + ], + 'ramActions' => [ [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'description' => '应用状态：'."\n" - ."\n" - .'- **ACTIVE**：正常'."\n" - .'- **INIT**：创建中'."\n" - .'- **INACTIVE**：冻结', - 'type' => 'string', - 'required' => false, - 'example' => 'ACTIVE', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1305A3E0-A291-54BA-A3B2-7D1C12EC4112\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'DeleteSnapshot' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories/{repository}/snapshots/{snapshot}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'orderType', - 'in' => 'query', - 'schema' => [ - 'description' => '按照应用创建时间的排序方式。默认desc。'."\n" - ."\n" - .'- **asc**：升序'."\n" - .'- **desc**：降序', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '213582', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], + ], + 'parameters' => [ [ - 'name' => 'tags', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'repository', + 'in' => 'path', + 'schema' => ['description' => '备份仓库名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun_auto_snapshot'], + ], + [ + 'name' => 'snapshot', + 'in' => 'path', + 'schema' => ['description' => '快照名称。', 'type' => 'string', 'required' => true, 'example' => 'qingning'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'title' => '总记录数。', - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '0', - 'example' => '4', - 'default' => '0', - ], - 'result' => [ - 'title' => '数组，返回示例目录。', - 'description' => '数组，返回示例目录。', - 'type' => 'array', - 'items' => [ - 'title' => 'AppItemType', - 'description' => 'AppItemType', - 'type' => 'object', - 'properties' => [ - 'appName' => [ - 'title' => '资源名称', - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'es-severless-test-app'."\n", - ], - 'ownerId' => [ - 'title' => 'OwnerID', - 'description' => '应用所属的阿里云主账号UID。', - 'type' => 'string', - 'example' => '*********7595', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => '地域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'status' => [ - 'title' => '资源状态', - 'description' => '应用状态。', - 'type' => 'string', - 'example' => 'ACTIVE', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-12-27T07:09:11.000Z', - ], - 'modifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2022-12-27T07:09:11.000Z'."\n", - ], - 'description' => [ - 'title' => '应用备注', - 'description' => '应用备注。', - 'type' => 'string', - 'example' => '这是一个demo应用', - ], - 'appId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'test-abc', - ], - 'instanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'es-serverless-***17位id**', - ], - 'version' => [ - 'description' => '产品版本。', - 'type' => 'string', - 'example' => '7.10', - ], - 'appType' => [ - 'type' => 'string', - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '16484F36-A2A3-5A05-B242-0BF2BF6AA326'], + 'result' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 4,\\n \\"result\\": [\\n {\\n \\"appName\\": \\"es-severless-test-app\\\\n\\",\\n \\"ownerId\\": \\"*********7595\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"ACTIVE\\",\\n \\"createTime\\": \\"2022-12-27T07:09:11.000Z\\",\\n \\"modifiedTime\\": \\"2022-12-27T07:09:11.000Z\\\\n\\",\\n \\"description\\": \\"这是一个demo应用\\",\\n \\"appId\\": \\"test-abc\\",\\n \\"instanceId\\": \\"es-serverless-***17位id**\\",\\n \\"version\\": \\"7.10\\",\\n \\"appType\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\"\\n}","type":"json"}]', - 'title' => '应用列表', - ], - 'DeleteApp' => [ - 'summary' => '调用DeleteApp接口，删除Elasticsearch Serverless应用。', - 'path' => '/openapi/es-serverless/instances/{appName}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除快照', + 'summary' => '调用DeleteSnapshot接口，删除ES Serverless应用快照。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSnapshot'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"16484F36-A2A3-5A05-B242-0BF2BF6AA326\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'GetApp' => [ + 'summary' => '调用GetApp接口，获取Elasticsearch Serverless应用的详情信息。', + 'path' => '/openapi/es-serverless/instances/{appName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '185145', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185146', + 'abilityTreeNodes' => ['FEATUREelasticsearchGXQH1U'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '待删除的应用名称。调用[ListApps](~~2539816~~)获取应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '应用名称。调用[ListApps](~~2539816~~)获取应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'detailed', + 'in' => 'query', + 'schema' => ['description' => '是否获取详细信息。取值如下：'."\n" + .'- **false**（默认）：不获取'."\n" + .'- **true**：获取', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构。', + 'description' => '返回参数。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], 'result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => '已删除应用对应的实例ID。', - 'type' => 'string', - 'example' => 'es-serverless-***17位id**', + 'appName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'es-severless-test-app'], + 'ownerId' => ['description' => '应用所属的阿里云主账号UID。', 'type' => 'string', 'example' => '*******7595'], + 'regionId' => ['description' => '应用所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'status' => ['description' => '应用状态：'."\n" + ."\n" + .'- **ACTIVE**：正常'."\n" + .'- **INIT**：创建中'."\n" + .'- **INACTIVE**：冻结', 'type' => 'string', 'example' => 'ACTIVE'], + 'createTime' => ['description' => '应用创建时间。', 'type' => 'string', 'example' => '2022-08-15T11:20:52.370Z'], + 'modifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2022-08-15T11:21:50.000Z'], + 'description' => ['description' => '应用备注。', 'type' => 'string', 'example' => 'This is a demo application.'], + 'appId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'test-app-abc'], + 'version' => ['description' => '产品版本。', 'type' => 'string', 'example' => '7.10'], + 'instanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'Es-serverless-***17-digit-id**'], + 'network' => [ + 'description' => '公网信息。', + 'type' => 'array', + 'items' => [ + 'description' => '公网信息具体结构。', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'IP白名单的类型'."\n" + ."\n" + .'- PUBLIC_ES：Elasticsearch公网访问白名单'."\n" + .'- PUBLIC_KIBANA：Kibana公网访问白名单', 'type' => 'string', 'example' => 'PUBLIC_ES'], + 'enabled' => ['description' => '是否开启公网访问。', 'type' => 'boolean', 'example' => 'true'], + 'domain' => ['description' => '域名信息。', 'type' => 'string', 'example' => 'test-123.public.cn-hangzhou.es-serverless.aliyuncs.com'], + 'port' => ['description' => '端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => '9200'], + 'whiteIpGroup' => [ + 'description' => '白名单列表', + 'type' => 'array', + 'items' => [ + 'description' => '白名单具体结构', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => '白名单组的组名。', 'type' => 'string', 'example' => 'test'], + 'ips' => [ + 'description' => '白名单组中的IP地址列表。', + 'type' => 'array', + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'example' => '127.0.0.1'], + ], + ], + ], + ], + ], + ], + ], + 'privateNetwork' => [ + 'description' => '私网信息。', + 'type' => 'array', + 'items' => [ + 'description' => '私网信息具体结构。', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'IP白名单的类型'."\n" + ."\n" + .'- PRIVATE_KIBANA：Kibana私网访问白名单'."\n" + .'- PRIVATE_ES：Elasticsearch私网访问白名单', 'type' => 'string', 'example' => 'PRIVATE_ES'], + 'enabled' => ['description' => '是否开启私网访问。', 'type' => 'boolean', 'example' => 'true'], + 'domain' => ['description' => '域名信息。', 'type' => 'string', 'example' => 'test-123.private.cn-hangzhou.es-serverless.aliyuncs.com'], + 'port' => ['description' => '端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '9200'], + 'vpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp16ul4pwsg1mjni***'], + 'pvlEndpointId' => ['description' => '终端节点信息。', 'type' => 'string', 'example' => 'ep-aaaddd**'], + 'whiteIpGroup' => [ + 'description' => '白名单列表', + 'type' => 'array', + 'items' => [ + 'description' => '白名单具体结构', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => '白名单组的组名。', 'type' => 'string', 'example' => 'test'], + 'ips' => [ + 'description' => '白名单组中的IP地址列表。', + 'type' => 'array', + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'example' => '127.0.0.1'], + ], + ], + ], + ], + ], + ], ], + 'appType' => ['type' => 'string', 'description' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string', 'description' => ''], + 'value' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], + 'scenario' => ['type' => 'string', 'description' => ''], + 'chargeType' => ['type' => 'string', 'description' => ''], ], ], + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"appName\\": \\"es-severless-test-app\\",\\n \\"ownerId\\": \\"*******7595\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"ACTIVE\\",\\n \\"createTime\\": \\"2022-08-15T11:20:52.370Z\\",\\n \\"modifiedTime\\": \\"2022-08-15T11:21:50.000Z\\",\\n \\"description\\": \\"This is a demo application.\\",\\n \\"appId\\": \\"test-app-abc\\",\\n \\"version\\": \\"7.10\\",\\n \\"instanceId\\": \\"Es-serverless-***17-digit-id**\\",\\n \\"network\\": [\\n {\\n \\"type\\": \\"PUBLIC_ES\\",\\n \\"enabled\\": true,\\n \\"domain\\": \\"test-123.public.cn-hangzhou.es-serverless.aliyuncs.com\\",\\n \\"port\\": 9200,\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"test\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"privateNetwork\\": [\\n {\\n \\"type\\": \\"PRIVATE_ES\\",\\n \\"enabled\\": true,\\n \\"domain\\": \\"test-123.private.cn-hangzhou.es-serverless.aliyuncs.com\\",\\n \\"port\\": 9200,\\n \\"vpcId\\": \\"vpc-bp16ul4pwsg1mjni***\\",\\n \\"pvlEndpointId\\": \\"ep-aaaddd**\\",\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"test\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"appType\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"scenario\\": \\"\\",\\n \\"chargeType\\": \\"\\"\\n },\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\"\\n}","type":"json"}]', + 'title' => '获取应用详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApp'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"es-serverless-***17位id**\\"\\n }\\n}","type":"json"}]', - 'title' => '删除应用', ], 'GetAppQuota' => [ 'summary' => '调用GetAppQuota接口，获取Elasticsearch Serverless应用的配额信息。', 'path' => '/openapi/es-serverless/instances/{appName}/quota', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '190715', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。调用[ListApps](~~2539816~~)获取应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '应用名称。调用[ListApps](~~2539816~~)获取应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -1404,20 +1058,12 @@ 'description' => '响应体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'quotaInfo' => [ - 'description' => '配额信息。', - 'type' => 'object', - ], + 'quotaInfo' => ['description' => '配额信息。', 'type' => 'object'], 'limiterInfo' => [ 'description' => '系统限制信息。', 'type' => 'object', @@ -1428,28 +1074,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '系统限制类型。', - 'type' => 'string', - 'example' => 'INDEX_NUMBER_OF_SHARDS', - ], - 'immutable' => [ - 'description' => '是否为不可变的限制。暂时不支持修改系统限制。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'minValue' => [ - 'description' => '最小阈值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'maxValue' => [ - 'description' => '最大阈值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'type' => ['description' => '系统限制类型。', 'type' => 'string', 'example' => 'INDEX_NUMBER_OF_SHARDS'], + 'immutable' => ['description' => '是否为不可变的限制。暂时不支持修改系统限制。', 'type' => 'boolean', 'example' => 'true'], + 'minValue' => ['description' => '最小阈值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'maxValue' => ['description' => '最大阈值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], ], ], @@ -1461,53 +1089,52 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看应用配额', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppQuota'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetAppQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"quotaInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"limiterInfo\\": {\\n \\"limiters\\": [\\n {\\n \\"type\\": \\"INDEX_NUMBER_OF_SHARDS\\",\\n \\"immutable\\": true,\\n \\"minValue\\": 1,\\n \\"maxValue\\": 10\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => '查看应用配额', ], 'GetMonitorData' => [ - 'summary' => '调用GetMonitorData接口，获取Elasticsearch Serverless应用监控的指标数据。', 'path' => '/openapi/es-serverless/emon/metrics/query', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '187769', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchDSZGTG', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchDSZGTG'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求体信息。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{"start":1689245180581,"end":1689246950582,"queries":[{"metric":"aliyunes.elasticsearch.index.docs.count","aggregator":"sum","downsample":"avg","tags":{"resource":"{appName}"},"filters":[],"granularity":"auto"}]}', - ], + 'schema' => ['description' => '请求体信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"start":1689245180581,"end":1689246950582,"queries":[{"metric":"aliyunes.elasticsearch.index.docs.count","aggregator":"sum","downsample":"avg","tags":{"resource":"{appName}"},"filters":[],"granularity":"auto"}]}'], ], ], 'responses' => [ @@ -1515,69 +1142,26 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InternalServerError', - ], - 'message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'internal server error', - ], - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], - 'success' => [ - 'description' => '调用结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InternalServerError'], + 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'internal server error'], + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], + 'success' => ['description' => '调用结果。', 'type' => 'boolean', 'example' => 'true'], 'result' => [ 'description' => '返回结果。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'integrity' => [ - 'description' => '数据完整性。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'summary' => [ - 'description' => '返回值中的一个属性，暂无含义。', - 'type' => 'number', - 'format' => 'float', - 'example' => '172455913.18935508', - ], - 'messageWatermark' => [ - 'description' => '请求到达服务端的时间戳，用于排查问题。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689566839447', - ], - 'dps' => [ - 'description' => '指标实时监控数据。格式为`{时间戳:数据}`。', - 'type' => 'object', - 'example' => '{'."\n" - .' "1689480600":28676235.104761902'."\n" - .'}', - ], - 'tags' => [ - 'description' => '标签。', - 'type' => 'object', - 'example' => '{'."\n" - .' "indexName":"test"'."\n" - .' }', - ], - 'metric' => [ - 'description' => '指标名称。', - 'type' => 'string', - 'example' => 'elasticsearch-server.logic_cpu.cpu', - ], + 'integrity' => ['description' => '数据完整性。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'summary' => ['description' => '返回值中的一个属性，暂无含义。', 'type' => 'number', 'format' => 'float', 'example' => '172455913.18935508'], + 'messageWatermark' => ['description' => '请求到达服务端的时间戳，用于排查问题。', 'type' => 'integer', 'format' => 'int64', 'example' => '1689566839447'], + 'dps' => ['description' => '指标实时监控数据。格式为`{时间戳:数据}`。', 'type' => 'object', 'example' => '{'."\n" + .' "1689480600":28676235.104761902'."\n" + .'}'], + 'tags' => ['description' => '标签。', 'type' => 'object', 'example' => '{'."\n" + .' "indexName":"test"'."\n" + .' }'], + 'metric' => ['description' => '指标名称。', 'type' => 'string', 'example' => 'elasticsearch-server.logic_cpu.cpu'], ], ], ], @@ -1588,400 +1172,414 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"InternalServerError\\",\\n \\"message\\": \\"internal server error\\",\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"integrity\\": 1,\\n \\"summary\\": 172455913.18935508,\\n \\"messageWatermark\\": 1689566839447,\\n \\"dps\\": {\\n \\"1689480600\\": 28676235.104761902\\n },\\n \\"tags\\": {\\n \\"indexName\\": \\"test\\"\\n },\\n \\"metric\\": \\"elasticsearch-server.logic_cpu.cpu\\"\\n }\\n ]\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取应用监控数据', - ], - 'ListIndices' => [ - 'summary' => '调用ListIndices接口，查看ES Serverless应用的索引列表。', - 'path' => '/openapi/es-serverless/instances/{appName}/indices', - 'methods' => [ - 'get', + 'summary' => '调用GetMonitorData接口，获取Elasticsearch Serverless应用监控的指标数据。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonitorData'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"InternalServerError\\",\\n \\"message\\": \\"internal server error\\",\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"success\\": true,\\n \\"result\\": [\\n {\\n \\"integrity\\": 1,\\n \\"summary\\": 172455913.18935508,\\n \\"messageWatermark\\": 1689566839447,\\n \\"dps\\": {\\n \\"1689480600\\": 28676235.104761902\\n },\\n \\"tags\\": {\\n \\"indexName\\": \\"test\\"\\n },\\n \\"metric\\": \\"elasticsearch-server.logic_cpu.cpu\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetSnapshotSetting' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/auto-snapshot-setting', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '213585', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '213569', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'text', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8C85CCB3-C0C9-521C-B599-F903E14A8793', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC'], 'result' => [ 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '返回结果详情。', - 'type' => 'any', - 'example' => '{"index" : ".aliyun-limiter-config"}', + 'type' => 'object', + 'properties' => [ + 'quartzRegex' => ['description' => '自动备份执行策略。', 'type' => 'string', 'example' => '0 0 01 ? * * *'], + 'enable' => ['description' => '是否开启自动备份。'."\n" + ."\n" + .'- true：开启'."\n" + .'- false：不开启', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8C85CCB3-C0C9-521C-B599-F903E14A8793\\",\\n \\"result\\": [\\n \\"{\\\\\\"index\\\\\\" : \\\\\\".aliyun-limiter-config\\\\\\"}\\"\\n ]\\n}","type":"json"}]', - 'title' => '查看索引列表', - ], - 'CreateSnapshot' => [ - 'summary' => '调用CreateSnapshot，创建ES Serverless应用的快照。', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories/{repository}/snapshots', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取自动备份配置', + 'summary' => '调用GetSnapshotSetting接口，获取ES Serverless应用的自动备份配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSnapshotSetting'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC\\",\\n \\"result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","type":"json"}]', + ], + 'GetSpecReviewTask' => [ + 'summary' => '调用GetSpecReviewTask接口，查看ES Serverless应用的规格审批工单详情。', + 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks/{taskId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '213584', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '207276', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数。', - 'type' => 'object', - 'properties' => [ - 'snapshot' => [ - 'description' => '快照名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'qingning', - ], - 'indices' => [ - 'description' => '索引名称，多个索引逗号分隔。', - 'type' => 'string', - 'required' => true, - 'example' => 'product_info', - ], - ], - 'required' => false, - ], - ], - [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => '是否校验入参数据合法性，默认false。'."\n" - ."\n" - .'取值：'."\n" - ."\n" - .'- **true**：只校验参数合法性。'."\n" - ."\n" - .'- **false**：校验参数合法性，创建快照。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'repository', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => '快照仓库名称。目前默认aliyun_auto_snapshot。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun_auto_snapshot', - ], + 'schema' => ['description' => '工单ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '339'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03761BE5-D12F-55B4-9C93-0255C11DE44A', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E310AC54-957A-5FD5-B85B-E972B2BDA8DE'], 'result' => [ - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'appName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test'], + 'type' => ['description' => '申请修改工单的规格类型。取值包括：'."\n" + ."\n" + .'- QUOTA：配额'."\n" + .'- LIMITER：系统限制', 'type' => 'string', 'example' => 'QUOTA'], + 'source' => ['description' => '工单来源：'."\n" + .'- USER：用户申请'."\n" + .'- DEVOPS：ES Serverless运维人员', 'type' => 'string', 'example' => 'USER'], + 'status' => ['description' => '工单审批状态：'."\n" + .'- Pending：待处理'."\n" + .'- Approved：通过'."\n" + .'- Rejected：拒绝'."\n" + .'- Canceled：撤销', 'type' => 'string', 'example' => 'Pending'], + 'applyReason' => ['description' => '申请理由。', 'type' => 'string', 'example' => 'Business requirement.'], + 'gmtCreate' => ['description' => '创建时间的UTC时间。', 'type' => 'string', 'example' => '2024-05-30T06:28:07.000Z'], + 'gmtModified' => ['description' => '最后修改的UTC时间。', 'type' => 'string', 'example' => '2024-05-30T06:28:07.000Z'], + 'oldQuota' => ['description' => '原始配额信息。', 'type' => 'object', 'example' => '{'."\n" + .' "appType": "TRIAL",'."\n" + .' "cu": 2,'."\n" + .' "storage": 1'."\n" + .' }'], + 'applyQuota' => ['description' => '申请的配额信息。', 'type' => 'object', 'example' => '{'."\n" + .' "appType": "TRIAL",'."\n" + .' "cu": 4,'."\n" + .' "storage": 100'."\n" + .' }'], + 'effectiveQuota' => ['description' => '生效的配额信息。', 'type' => 'object', 'example' => '{'."\n" + .' "appType": "TRIAL",'."\n" + .' "cu": 4,'."\n" + .' "storage": 100'."\n" + .' }'], + 'oldLimiter' => ['description' => '原始的系统限制。', 'type' => 'object', 'example' => '{'."\n" + .' "limiters": ['."\n" + .' {'."\n" + .' "type": "INDEX_QUOTA",'."\n" + .' "maxValue": 500,'."\n" + .' "immutable": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }'], + 'applyLimiter' => ['description' => '申请的系统限制。', 'type' => 'object', 'example' => '{'."\n" + .' "limiters": ['."\n" + .' {'."\n" + .' "type": "INDEX_QUOTA",'."\n" + .' "maxValue": 500,'."\n" + .' "immutable": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }'], + 'effectiveLimiter' => ['description' => '生效的系统限制。', 'type' => 'object', 'example' => '{'."\n" + .' "limiters": ['."\n" + .' {'."\n" + .' "type": "INDEX_QUOTA",'."\n" + .' "maxValue": 500,'."\n" + .' "immutable": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }'], + 'Id' => ['title' => '资源一级ID', 'description' => '工单ID。', 'type' => 'string', 'deprecated' => false, 'example' => '339', 'pattern' => '', 'default' => ''], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"03761BE5-D12F-55B4-9C93-0255C11DE44A\\",\\n \\"result\\": true\\n}","type":"json"}]', - 'title' => '创建快照', - ], - 'UpdateSnapshotSetting' => [ - 'summary' => '调用UpdateSnapshotSetting接口，修改ES Serverless应用自动备份快照的配置。', - 'path' => '/openapi/es-serverless/instances/{appName}/auto-snapshot-setting', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E310AC54-957A-5FD5-B85B-E972B2BDA8DE\\",\\n \\"result\\": {\\n \\"appName\\": \\"test\\",\\n \\"type\\": \\"QUOTA\\",\\n \\"source\\": \\"USER\\",\\n \\"status\\": \\"Pending\\",\\n \\"applyReason\\": \\"Business requirement.\\",\\n \\"gmtCreate\\": \\"2024-05-30T06:28:07.000Z\\",\\n \\"gmtModified\\": \\"2024-05-30T06:28:07.000Z\\",\\n \\"oldQuota\\": {\\n \\"appType\\": \\"TRIAL\\",\\n \\"cu\\": 2,\\n \\"storage\\": 1\\n },\\n \\"applyQuota\\": {\\n \\"appType\\": \\"TRIAL\\",\\n \\"cu\\": 4,\\n \\"storage\\": 100\\n },\\n \\"effectiveQuota\\": {\\n \\"appType\\": \\"TRIAL\\",\\n \\"cu\\": 4,\\n \\"storage\\": 100\\n },\\n \\"oldLimiter\\": {\\n \\"limiters\\": [\\n {\\n \\"type\\": \\"INDEX_QUOTA\\",\\n \\"maxValue\\": 500,\\n \\"immutable\\": false\\n }\\n ]\\n },\\n \\"applyLimiter\\": {\\n \\"limiters\\": [\\n {\\n \\"type\\": \\"INDEX_QUOTA\\",\\n \\"maxValue\\": 500,\\n \\"immutable\\": false\\n }\\n ]\\n },\\n \\"effectiveLimiter\\": {\\n \\"limiters\\": [\\n {\\n \\"type\\": \\"INDEX_QUOTA\\",\\n \\"maxValue\\": 500,\\n \\"immutable\\": false\\n }\\n ]\\n },\\n \\"Id\\": \\"339\\"\\n }\\n}","type":"json"}]', + 'title' => '查看规格审批工单详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSpecReviewTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetSpecReviewTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListApps' => [ + 'summary' => '调用ListApps接口，查看Elasticsearch Serverless应用的列表。', + 'path' => '/openapi/es-serverless/instances', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '213565', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185147', + 'abilityTreeNodes' => ['FEATUREelasticsearchGXQH1U'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数。', - 'type' => 'object', - 'properties' => [ - 'quartzRegex' => [ - 'description' => '自动备份时间配置，采用Quartz Cron表达式。', - 'type' => 'string', - 'required' => true, - 'example' => '0 0 01 ? * * *', - ], - 'enable' => [ - 'description' => '是否开启自动备份。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - 'required' => false, - ], + 'name' => 'appName', + 'in' => 'query', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'es-severless-test-app'."\n"], ], [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => '应用描述信息。', 'type' => 'string', 'required' => false, 'example' => 'metrics-logs-online'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页查询时设置的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'createTime', + 'in' => 'query', + 'schema' => ['description' => '应用创建时间。过滤出大于等于输入值的应用，时间格式为YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2023-08-29T02:37:22Z'], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['description' => '应用状态：'."\n" + ."\n" + .'- **ACTIVE**：正常'."\n" + .'- **INIT**：创建中'."\n" + .'- **INACTIVE**：冻结', 'type' => 'string', 'required' => false, 'example' => 'ACTIVE'], + ], + [ + 'name' => 'orderType', + 'in' => 'query', + 'schema' => ['description' => '按照应用创建时间的排序方式。默认desc。'."\n" + ."\n" + .'- **asc**：升序'."\n" + .'- **desc**：降序', 'type' => 'string', 'required' => false, 'example' => 'desc'], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => '响应体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7B03723-AA73-5A5F-B71C-270792614DD8', - ], + 'totalCount' => ['title' => '总记录数。', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '0', 'example' => '4', 'default' => '0'], 'result' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'example' => '{'."\n" - .' "quartzRegex": "0 0 01 ? * * *",'."\n" - .' "enable": true'."\n" - .' }', + 'title' => '数组，返回示例目录。', + 'description' => '数组，返回示例目录。', + 'type' => 'array', + 'items' => [ + 'title' => 'AppItemType', + 'description' => 'AppItemType', + 'type' => 'object', + 'properties' => [ + 'appName' => ['title' => '资源名称', 'description' => '应用名称。', 'type' => 'string', 'example' => 'es-severless-test-app'."\n"], + 'ownerId' => ['title' => 'OwnerID', 'description' => '应用所属的阿里云主账号UID。', 'type' => 'string', 'example' => '*********7595'], + 'regionId' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'status' => ['title' => '资源状态', 'description' => '应用状态。', 'type' => 'string', 'example' => 'ACTIVE'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2022-12-27T07:09:11.000Z'], + 'modifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2022-12-27T07:09:11.000Z'."\n"], + 'description' => ['title' => '应用备注', 'description' => '应用备注。', 'type' => 'string', 'example' => 'This is a demo application.'], + 'appId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'test-abc'], + 'instanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'Es-serverless-***17-digit-id**'], + 'version' => ['description' => '产品版本。', 'type' => 'string', 'example' => '7.10'], + 'appType' => ['type' => 'string', 'description' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string', 'description' => ''], + 'value' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], + ], + ], ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7B03723-AA73-5A5F-B71C-270792614DD8\\",\\n \\"result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","type":"json"}]', - 'title' => '修改自动备份配置', - ], - 'ListSnapshots' => [ - 'summary' => '调用ListSnapshots接口，获取ES Serverless应用的快照列表。', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshots', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 4,\\n \\"result\\": [\\n {\\n \\"appName\\": \\"es-severless-test-app\\\\n\\",\\n \\"ownerId\\": \\"*********7595\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"ACTIVE\\",\\n \\"createTime\\": \\"2022-12-27T07:09:11.000Z\\",\\n \\"modifiedTime\\": \\"2022-12-27T07:09:11.000Z\\\\n\\",\\n \\"description\\": \\"This is a demo application.\\",\\n \\"appId\\": \\"test-abc\\",\\n \\"instanceId\\": \\"Es-serverless-***17-digit-id**\\",\\n \\"version\\": \\"7.10\\",\\n \\"appType\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\"\\n}","type":"json"}]', + 'title' => '应用列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDicts' => [ + 'summary' => '调用ListDicts接口，获取ES Serverless应用的词典列表。', + 'path' => '/openapi/es-serverless/instances/{appName}/dicts', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '213581', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'abilityTreeCode' => '213559', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'repository', - 'in' => 'query', - 'schema' => [ - 'description' => '快照仓库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun_auto_snapshot', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'snapshot', - 'in' => 'query', - 'schema' => [ - 'description' => '快照备份名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'qingning', - ], + 'schema' => ['description' => '每页返回的结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -1991,287 +1589,275 @@ 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '22E9EE78-F567-550A-8F7C-20E9CD3DE489', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3'], + 'totalCount' => ['description' => '字典总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'result' => [ 'description' => '返回结果。', 'type' => 'array', 'items' => [ - 'description' => '单项返回结果。', + 'description' => '返回结果', 'type' => 'object', - 'example' => '{'."\n" - .' "snapshot": "qingning",'."\n" - .' "uuid": "_ULkbfoHREaJ0Gdcza****",'."\n" - .' "version_id": 7100099,'."\n" - .' "version": "7.10.0",'."\n" - .' "indices": ['."\n" - .' "product_info"'."\n" - .' ],'."\n" - .' "data_streams": [],'."\n" - .' "include_global_state": false,'."\n" - .' "state": "SUCCESS",'."\n" - .' "start_time": "2024-05-30T07:51:58.973Z",'."\n" - .' "start_time_in_millis": 1717055518973,'."\n" - .' "end_time": "2024-05-30T07:51:59.373Z",'."\n" - .' "end_time_in_millis": 1717055519373,'."\n" - .' "duration_in_millis": 400,'."\n" - .' "failures": [],'."\n" - .' "shards": {'."\n" - .' "total": 6,'."\n" - .' "failed": 0,'."\n" - .' "successful": 6'."\n" - .' },'."\n" - .' "repository": "aliyun_auto_snapshot"'."\n" - .' }', + 'properties' => [ + 'name' => ['description' => '词典名称。', 'type' => 'string', 'example' => 'a.dic'], + 'type' => ['description' => '词典类型：'."\n" + ."\n" + .'- MAIN：IK主分词词库'."\n" + .'- STOP：IK停用词库'."\n" + .'- SYNONYMS：同义词词库', 'type' => 'string', 'example' => 'MAIN'], + 'downloadUrl' => ['description' => '文件下载地址。', 'type' => 'string', 'example' => 'http://es-serverless-****.oss-cn-hangzhou.aliyuncs.com/app/es7**190/0/config/analysis-ik/stopword.dic?Expires=1705923089&OSSAccessKeyId=STS.NV18q****UkVp6LNj&Signat'], + 'sourceType' => ['description' => '词典文件来源类型，可选值：OSS（使用OSS开放存储）。', 'type' => 'string', 'example' => 'OSS'], + ], ], ], - 'nextToken' => [ - 'description' => '分页token。（暂时没有启用）', - 'type' => 'string', - 'example' => 'ODgyObrnP3', - ], - 'totalCount' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"22E9EE78-F567-550A-8F7C-20E9CD3DE489\\",\\n \\"result\\": [\\n {\\n \\"snapshot\\": \\"qingning\\",\\n \\"uuid\\": \\"_ULkbfoHREaJ0Gdcza****\\",\\n \\"version_id\\": 7100099,\\n \\"version\\": \\"7.10.0\\",\\n \\"indices\\": [\\n \\"product_info\\"\\n ],\\n \\"data_streams\\": [],\\n \\"include_global_state\\": false,\\n \\"state\\": \\"SUCCESS\\",\\n \\"start_time\\": \\"2024-05-30T07:51:58.973Z\\",\\n \\"start_time_in_millis\\": 1717055518973,\\n \\"end_time\\": \\"2024-05-30T07:51:59.373Z\\",\\n \\"end_time_in_millis\\": 1717055519373,\\n \\"duration_in_millis\\": 400,\\n \\"failures\\": [],\\n \\"shards\\": {\\n \\"total\\": 6,\\n \\"failed\\": 0,\\n \\"successful\\": 6\\n },\\n \\"repository\\": \\"aliyun_auto_snapshot\\"\\n }\\n ],\\n \\"nextToken\\": \\"ODgyObrnP3\\",\\n \\"totalCount\\": 1\\n}","type":"json"}]', - 'title' => '获取快照列表', - ], - 'ListSnapshotRepositories' => [ - 'summary' => '调用ListSnapshotRepositories接口，获取ES Serverless应用快照的备份仓库列表。', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取词典列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDicts'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListDicts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3\\",\\n \\"totalCount\\": 1,\\n \\"result\\": [\\n {\\n \\"name\\": \\"a.dic\\",\\n \\"type\\": \\"MAIN\\",\\n \\"downloadUrl\\": \\"http://es-serverless-****.oss-cn-hangzhou.aliyuncs.com/app/es7**190/0/config/analysis-ik/stopword.dic?Expires=1705923089&OSSAccessKeyId=STS.NV18q****UkVp6LNj&Signat\\",\\n \\"sourceType\\": \\"OSS\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEndpoints' => [ + 'summary' => '调用ListEndpoints接口，获取在ES Serverless平台创建的VPC终端节点列表。', + 'path' => '/openapi/es-serverless/endpoints', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '213572', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'abilityTreeCode' => '206264', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], ], 'parameters' => [ [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => '节点类型， 默认VPC。', 'type' => 'string', 'required' => true, 'example' => 'VPC'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'vpcId', + 'in' => 'query', + 'schema' => ['description' => 'VPC网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1212sb7cj2j4e6x****'], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => ['description' => '资源ID，VPC类型资源ID对应为privatelink实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id41dd116e52e****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => '响应体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '56E0591D-7D62-56A2-993E-952FB2026C69', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5'], 'result' => [ 'description' => '返回结果。', 'type' => 'array', 'items' => [ - 'description' => '返回结果对象', + 'description' => '返回结果。', 'type' => 'object', - 'example' => '{'."\n" - .' "type": "oss",'."\n" - .' "name": "aliyun_auto_snapshot",'."\n" - .' "snapshotAmount": 5'."\n" - .' }', + 'properties' => [ + 'endpointId' => ['description' => '端点ID。', 'type' => 'string', 'example' => 'essep-2f46b743f60****'], + 'resourceId' => ['description' => '资源ID，VPC类型资源ID对应为PrivateLink实例ID。', 'type' => 'string', 'example' => 'ep-bp1id41dd116e52e****'."\n"], + 'vpcId' => ['description' => 'VPC网络ID。', 'type' => 'string', 'example' => 'vpc-uf6gykvwcirp886ef****'], + 'status' => ['description' => '终端节点状态：'."\n" + ."\n" + .'- Creating：创建中。'."\n" + .'- Active：可用。'."\n" + .'- Pending：修改中。'."\n" + .'- Deleting：删除中。', 'type' => 'string', 'example' => 'Active'], + 'connectionStatus' => ['description' => '终端节点连接状态：'."\n" + ."\n" + .'- Pending：修改中。'."\n" + .'- Connecting：连接中。'."\n" + .'- Connected：已连接。'."\n" + .'- Disconnecting：断开连接中。'."\n" + .'- Disconnected：未连接。'."\n" + .'- Deleting：删除中。'."\n" + .'- ServiceDeleted：终端节点对应的服务已删除。', 'type' => 'string', 'example' => 'Pending'], + 'type' => ['description' => '节点类型， 默认VPC。', 'type' => 'string', 'example' => 'VPC'], + 'created' => ['description' => '创建时间戳（秒级时间戳）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1701259721'], + 'updated' => ['description' => '更新时间戳（秒级时间戳）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1701259721'], + 'name' => ['description' => '终端节点名称。', 'type' => 'string', 'example' => 'test'], + 'endpointZones' => [ + 'description' => '可用区信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区信息。', + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-k'], + 'vSwitchId' => ['description' => '虚拟专有交换机，其所在可用区必须与Serverless应用一致。', 'type' => 'string', 'example' => 'vsw-bp194pz9iez****'], + ], + ], + ], + 'securityGroupIds' => [ + 'description' => '安全组ID列表。', + 'type' => 'array', + 'items' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-bp1278950t9ykn2s****'], + ], + 'domain' => ['description' => '终端节点域名。', 'type' => 'string', 'example' => 'ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com'], + ], ], ], + 'totalCount' => ['description' => '记录总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"56E0591D-7D62-56A2-993E-952FB2026C69\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"oss\\",\\n \\"name\\": \\"aliyun_auto_snapshot\\",\\n \\"snapshotAmount\\": 5\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取快照备份仓库列表', - ], - 'GetSnapshotSetting' => [ - 'summary' => '调用GetSnapshotSetting接口，获取ES Serverless应用的自动备份配置。', - 'path' => '/openapi/es-serverless/instances/{appName}/auto-snapshot-setting', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取终端节点列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEndpoints'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5\\",\\n \\"result\\": [\\n {\\n \\"endpointId\\": \\"essep-2f46b743f60****\\",\\n \\"resourceId\\": \\"ep-bp1id41dd116e52e****\\\\n\\",\\n \\"vpcId\\": \\"vpc-uf6gykvwcirp886ef****\\",\\n \\"status\\": \\"Active\\",\\n \\"connectionStatus\\": \\"Pending\\",\\n \\"type\\": \\"VPC\\",\\n \\"created\\": 1701259721,\\n \\"updated\\": 1701259721,\\n \\"name\\": \\"test\\",\\n \\"endpointZones\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-k\\",\\n \\"vSwitchId\\": \\"vsw-bp194pz9iez****\\"\\n }\\n ],\\n \\"securityGroupIds\\": [\\n \\"sg-bp1278950t9ykn2s****\\"\\n ],\\n \\"domain\\": \\"ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com\\"\\n }\\n ],\\n \\"totalCount\\": 10\\n}","type":"json"}]', + ], + 'ListIndices' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/indices', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '213569', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '213585', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'text'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8C85CCB3-C0C9-521C-B599-F903E14A8793'], 'result' => [ 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'quartzRegex' => [ - 'description' => '自动备份执行策略。', - 'type' => 'string', - 'example' => '0 0 01 ? * * *', - ], - 'enable' => [ - 'description' => '是否开启自动备份。'."\n" - ."\n" - .'- true：开启'."\n" - .'- false：不开启', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'type' => 'array', + 'items' => ['description' => '返回结果详情。', 'type' => 'any', 'example' => '{"index" : ".aliyun-limiter-config"}'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC\\",\\n \\"result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","type":"json"}]', - 'title' => '获取自动备份配置', - ], - 'DeleteSnapshot' => [ - 'summary' => '调用DeleteSnapshot接口，删除ES Serverless应用快照。', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories/{repository}/snapshots/{snapshot}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看索引列表', + 'summary' => '调用ListIndices接口，查看ES Serverless应用的索引列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIndices'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8C85CCB3-C0C9-521C-B599-F903E14A8793\\",\\n \\"result\\": [\\n \\"{\\\\\\"index\\\\\\" : \\\\\\".aliyun-limiter-config\\\\\\"}\\"\\n ]\\n}","type":"json"}]', + ], + 'ListSnapshotRepositories' => [ + 'summary' => '调用ListSnapshotRepositories接口，获取ES Serverless应用快照的备份仓库列表。', + 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '213582', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '213572', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'repository', - 'in' => 'path', - 'schema' => [ - 'description' => '备份仓库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun_auto_snapshot', - ], - ], - [ - 'name' => 'snapshot', - 'in' => 'path', - 'schema' => [ - 'description' => '快照名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'qingning', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -2281,159 +1867,86 @@ 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '16484F36-A2A3-5A05-B242-0BF2BF6AA326', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '56E0591D-7D62-56A2-993E-952FB2026C69'], 'result' => [ 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', + 'type' => 'array', + 'items' => ['description' => '返回结果对象', 'type' => 'object', 'example' => '{'."\n" + .' "type": "oss",'."\n" + .' "name": "aliyun_auto_snapshot",'."\n" + .' "snapshotAmount": 5'."\n" + .' }'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"16484F36-A2A3-5A05-B242-0BF2BF6AA326\\",\\n \\"result\\": true\\n}","type":"json"}]', - 'title' => '删除快照', - ], - 'UpdateDict' => [ - 'summary' => '调用UpdateDict接口，创建或修改ES Serverless应用词典。目前仅支持通过OSS地址上传。', - 'path' => '/openapi/es-serverless/instances/{appName}/dicts', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取快照备份仓库列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshotRepositories'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSnapshotRepositories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"56E0591D-7D62-56A2-993E-952FB2026C69\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"oss\\",\\n \\"name\\": \\"aliyun_auto_snapshot\\",\\n \\"snapshotAmount\\": 5\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSnapshots' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/snapshots', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '213563', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '213581', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数', - 'type' => 'object', - 'properties' => [ - 'files' => [ - 'description' => '文件信息。', - 'type' => 'array', - 'items' => [ - 'description' => '文件信息。', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '上传的词典文件名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dic_0.dic', - ], - 'ossObject' => [ - 'description' => 'OSS存储配置详情。', - 'type' => 'object', - 'properties' => [ - 'bucketName' => [ - 'description' => 'OSS Bucket名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'bucket1', - ], - 'key' => [ - 'description' => '词典文件在OSS Bucket中的存储路径。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss/dic_0.dic', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'type' => [ - 'description' => '要更新的词典类型：'."\n" - ."\n" - .'- MAIN：IK主分词词库'."\n" - .'- STOP：IK停用词库', - 'type' => 'string', - 'required' => false, - 'example' => 'MAIN', - ], - 'sourceType' => [ - 'description' => '词典文件来源类型。目前仅支持OSS（使用OSS开放存储）。', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - ], - 'required' => false, - ], - ], - [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ - 'name' => 'dryRun', + 'name' => 'repository', 'in' => 'query', - 'schema' => [ - 'description' => '是否校验入参数据合法性并创建或修改词典信息，默认false。'."\n" - ."\n" - .'- **true**：只校验参数合法性。'."\n" - ."\n" - .'- **false**：校验参数合法性，并创建或修改词典信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '快照仓库名称。', 'type' => 'string', 'required' => false, 'example' => 'aliyun_auto_snapshot'], ], [ - 'name' => 'allowCover', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '是否允许覆盖同名的词典，默认false。'."\n" - ."\n" - .'- false：不允许覆盖同名词典，若存在同名的词典会报错。'."\n" - .'- true：允许覆盖同名的词典。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '页码，默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'snapshot', + 'in' => 'query', + 'schema' => ['description' => '快照备份名称。', 'type' => 'string', 'required' => false, 'example' => 'qingning'], ], ], 'responses' => [ @@ -2443,283 +1956,416 @@ 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '12797BCC-E0B5-5A47-B4B9-A14DDF0B0200', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '22E9EE78-F567-550A-8F7C-20E9CD3DE489'], 'result' => [ 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'type' => 'array', + 'items' => ['description' => '单项返回结果。', 'type' => 'object', 'example' => '{'."\n" + .' "snapshot": "qingning",'."\n" + .' "uuid": "_ULkbfoHREaJ0Gdcza****",'."\n" + .' "version_id": 7100099,'."\n" + .' "version": "7.10.0",'."\n" + .' "indices": ['."\n" + .' "product_info"'."\n" + .' ],'."\n" + .' "data_streams": [],'."\n" + .' "include_global_state": false,'."\n" + .' "state": "SUCCESS",'."\n" + .' "start_time": "2024-05-30T07:51:58.973Z",'."\n" + .' "start_time_in_millis": 1717055518973,'."\n" + .' "end_time": "2024-05-30T07:51:59.373Z",'."\n" + .' "end_time_in_millis": 1717055519373,'."\n" + .' "duration_in_millis": 400,'."\n" + .' "failures": [],'."\n" + .' "shards": {'."\n" + .' "total": 6,'."\n" + .' "failed": 0,'."\n" + .' "successful": 6'."\n" + .' },'."\n" + .' "repository": "aliyun_auto_snapshot"'."\n" + .' }'], + ], + 'nextToken' => ['description' => '分页token。（暂时没有启用）', 'type' => 'string', 'example' => 'ODgyObrnP3'], + 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"12797BCC-E0B5-5A47-B4B9-A14DDF0B0200\\",\\n \\"result\\": true\\n}","type":"json"}]', - 'title' => '创建或修改词典', - 'description' => '系统将自动创建服务关联角色，允许访问OSS等其他云产品服务。'."\n" - .'OSS地址要求：目录名称需包含es-serverless，或为OSS Bucket添加es-serverless:es-serverless标签。', - ], - 'ListDicts' => [ - 'summary' => '调用ListDicts接口，获取ES Serverless应用的词典列表。', - 'path' => '/openapi/es-serverless/instances/{appName}/dicts', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取快照列表', + 'summary' => '调用ListSnapshots接口，获取ES Serverless应用的快照列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshots'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSnapshots', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"22E9EE78-F567-550A-8F7C-20E9CD3DE489\\",\\n \\"result\\": [\\n {\\n \\"snapshot\\": \\"qingning\\",\\n \\"uuid\\": \\"_ULkbfoHREaJ0Gdcza****\\",\\n \\"version_id\\": 7100099,\\n \\"version\\": \\"7.10.0\\",\\n \\"indices\\": [\\n \\"product_info\\"\\n ],\\n \\"data_streams\\": [],\\n \\"include_global_state\\": false,\\n \\"state\\": \\"SUCCESS\\",\\n \\"start_time\\": \\"2024-05-30T07:51:58.973Z\\",\\n \\"start_time_in_millis\\": 1717055518973,\\n \\"end_time\\": \\"2024-05-30T07:51:59.373Z\\",\\n \\"end_time_in_millis\\": 1717055519373,\\n \\"duration_in_millis\\": 400,\\n \\"failures\\": [],\\n \\"shards\\": {\\n \\"total\\": 6,\\n \\"failed\\": 0,\\n \\"successful\\": 6\\n },\\n \\"repository\\": \\"aliyun_auto_snapshot\\"\\n }\\n ],\\n \\"nextToken\\": \\"ODgyObrnP3\\",\\n \\"totalCount\\": 1\\n}","type":"json"}]', + ], + 'ListSpecReviewTasks' => [ + 'summary' => '调用ListSpecReviewTasks，查看ES Serverless应用中申请修改规格的审批工单列表。', + 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '213559', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207292', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => '该字段已废弃。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '该字段已废弃。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => '申请修改工单的规格类型。取值包括：'."\n" + .'- QUOTA：配额。'."\n" + .'- LIMITER：系统限制。', 'type' => 'string', 'required' => false, 'example' => 'QUOTA'], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '页码。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页返回的结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页查询时设置的每页条数。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['description' => '工单审批状态。取值如下：'."\n" + .'- Pending：待处理。'."\n" + .'- Approved：通过。'."\n" + .'- Rejected：拒绝。'."\n" + .'- Canceled：撤销。', 'type' => 'string', 'required' => false, 'example' => 'Pending'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3', - ], - 'totalCount' => [ - 'description' => '字典总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '55F7B3FE-05D8-5F0F-BD55-A18967D447DC'], 'result' => [ 'description' => '返回结果。', 'type' => 'array', 'items' => [ - 'description' => '返回结果', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '词典名称。', - 'type' => 'string', - 'example' => 'a.dic', - ], - 'type' => [ - 'description' => '词典类型：'."\n" - ."\n" - .'- MAIN：IK主分词词库'."\n" - .'- STOP：IK停用词库'."\n" - .'- SYNONYMS：同义词词库', - 'type' => 'string', - 'example' => 'MAIN', - ], - 'downloadUrl' => [ - 'description' => '文件下载地址。', - 'type' => 'string', - 'example' => 'http://es-serverless-****.oss-cn-hangzhou.aliyuncs.com/app/es7**190/0/config/analysis-ik/stopword.dic?Expires=1705923089&OSSAccessKeyId=STS.NV18q****UkVp6LNj&Signat', - ], - 'sourceType' => [ - 'description' => '词典文件来源类型，可选值：OSS（使用OSS开放存储）。', - 'type' => 'string', - 'example' => 'OSS', - ], + 'appName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test'], + 'type' => ['description' => '规格类型。', 'type' => 'string', 'example' => 'QUOTA'], + 'source' => ['description' => '工单来源：'."\n" + .'- USER：用户申请。'."\n" + .'- DEVOPS：ES Serverless运维人员。', 'type' => 'string', 'example' => 'USER'], + 'status' => ['description' => '工单审批状态：'."\n" + .'- Pending：待处理。'."\n" + .'- Approved：通过。'."\n" + .'- Rejected：拒绝。'."\n" + .'- Canceled：撤销。', 'type' => 'string', 'example' => 'Pending'], + 'applyReason' => ['description' => '申请理由。', 'type' => 'string', 'example' => 'Business requirement.'], + 'gmtCreate' => ['description' => '创建时间的UTC时间。', 'type' => 'string', 'example' => '2024-05-27T10:13:22.000Z'], + 'Id' => ['title' => '资源一级ID', 'description' => '工单ID。', 'type' => 'string', 'deprecated' => false, 'example' => '339', 'pattern' => '', 'default' => ''], ], ], ], + 'totalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3\\",\\n \\"totalCount\\": 1,\\n \\"result\\": [\\n {\\n \\"name\\": \\"a.dic\\",\\n \\"type\\": \\"MAIN\\",\\n \\"downloadUrl\\": \\"http://es-serverless-****.oss-cn-hangzhou.aliyuncs.com/app/es7**190/0/config/analysis-ik/stopword.dic?Expires=1705923089&OSSAccessKeyId=STS.NV18q****UkVp6LNj&Signat\\",\\n \\"sourceType\\": \\"OSS\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取词典列表', - ], - 'DeleteDict' => [ - 'summary' => '调用DeleteDict接口，删除ES Serverless应用的词典。', - 'path' => '/openapi/es-serverless/instances/{appName}/dicts/actions/remove', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"55F7B3FE-05D8-5F0F-BD55-A18967D447DC\\",\\n \\"result\\": [\\n {\\n \\"appName\\": \\"test\\",\\n \\"type\\": \\"QUOTA\\",\\n \\"source\\": \\"USER\\",\\n \\"status\\": \\"Pending\\",\\n \\"applyReason\\": \\"Business requirement.\\",\\n \\"gmtCreate\\": \\"2024-05-27T10:13:22.000Z\\",\\n \\"Id\\": \\"339\\"\\n }\\n ],\\n \\"totalCount\\": 1\\n}","type":"json"}]', + 'title' => '查看规格审批工单列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSpecReviewTasks'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSpecReviewTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateApp' => [ + 'summary' => '调用UpdateApp接口，更新Elasticsearch Serverless应用相关信息，包括备注、网络开关、IP白名单组、账号密码等。', + 'path' => '/openapi/es-serverless/instances/{appName}', + 'methods' => ['patch'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '213564', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '185144', + 'abilityTreeNodes' => ['FEATUREelasticsearchGXQH1U'], ], 'parameters' => [ [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['title' => '实例 ID。', 'description' => '应用名称。调用[ListApps](~~2539816~~)获取应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => 'body参数', - 'description' => 'body参数', + 'description' => 'body参数。', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '词典文件名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'a.dic', + 'description' => ['title' => '应用备注', 'description' => '应用备注。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'network' => [ + 'description' => '公网信息。', + 'type' => 'array', + 'items' => [ + 'description' => '公网信息具体结构。', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'IP白名单的类型：'."\n" + .'- PUBLIC_ES：Elasticsearch公网访问白名单'."\n" + .'- PUBLIC_KIBANA：Kibana公网访问白名单', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC_ES'], + 'enabled' => ['description' => '是否开启公网访问。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'domain' => ['description' => '域名信息。（暂不支持修改）', 'type' => 'string', 'required' => false, 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'], + 'port' => ['description' => '端口号。（暂不支持修改）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200'], + 'whiteIpGroup' => [ + 'description' => '白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单具体结构。', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'ips' => [ + 'description' => '白名单组中的IP地址列表。', + 'type' => 'array', + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'authentication' => [ + 'description' => '认证信息。', + 'type' => 'object', + 'properties' => [ + 'basicAuth' => [ + 'description' => 'BasicAuth信息。', + 'type' => 'array', + 'items' => [ + 'description' => '基础信息。', + 'type' => 'object', + 'properties' => [ + 'username' => ['description' => '用户名。（目前默认为应用ID， 暂时不支持修改）', 'type' => 'string', 'required' => false, 'example' => 'test-123'], + 'password' => ['description' => '密码。', 'type' => 'string', 'required' => false, 'example' => '******'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, ], - 'type' => [ - 'description' => '词典类型：'."\n" + 'privateNetwork' => [ + 'description' => '私网信息。', + 'type' => 'array', + 'items' => [ + 'description' => '私网信息具体结构。', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'IP白名单的类型，可选值：'."\n" + ."\n" + .'- PRIVATE_KIBANA：Kibana私网访问白名单'."\n" + .'- PRIVATE_ES：Elasticsearch私网访问白名单', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE_ES'], + 'enabled' => ['description' => '是否开启私网访问。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'vpcId' => ['description' => '终端节点VPC的ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1jy348ibzulk6hn****'], + 'pvlEndpointId' => ['description' => '终端节点ID。', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id41dd116e52e****'], + 'whiteIpGroup' => [ + 'description' => '白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单具体结构。', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'ips' => [ + 'description' => '白名单组中的IP地址列表。', + 'type' => 'array', + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'limiterInfo' => [ + 'description' => '系统限制信息。'."\n" ."\n" - .'- MAIN：IK主分词词库'."\n" - .'- STOP：IK停用词库', - 'type' => 'string', - 'required' => true, - 'example' => 'MAIN', + .'> 推荐通过控制台修改，提交修改后会生成规格审批工单。', + 'type' => 'object', + 'properties' => [ + 'limiters' => [ + 'description' => '限制列表。', + 'type' => 'array', + 'items' => [ + 'description' => '限制。', + 'type' => 'object', + 'properties' => [ + 'maxValue' => ['description' => '最大阈值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'minValue' => ['description' => '最小阈值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'type' => ['description' => '系统限制类型。', 'type' => 'string', 'required' => false, 'example' => 'MAX_CU_PER_SHARD'], + 'values' => [ + 'description' => '限制取值列表。', + 'type' => 'array', + 'items' => ['description' => '限制取值。', 'type' => 'string', 'required' => false, 'example' => 'true'], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, ], + 'applyReason' => ['description' => '申请理由。', 'type' => 'string', 'required' => false, 'example' => 'Apply for system limits.'], + 'contactInfo' => ['description' => '联系方式，电话或邮箱', 'type' => 'string', 'required' => false, 'example' => '1370247****'], ], 'required' => false, ], ], - [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => '响应体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2BF6B57E-5AAD-5389-80CD-E200BBF91FF9', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6B297235-FC5B-590D-8218-8A5ED90AAE99'], 'result' => [ 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => '应用对应的实例ID。', 'type' => 'string', 'example' => 'es-serverless-cn-8tr6u27483859****'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2BF6B57E-5AAD-5389-80CD-E200BBF91FF9\\",\\n \\"result\\": true\\n}","type":"json"}]', - 'title' => '删除词典', - ], - 'CreateEndpoint' => [ - 'summary' => '调用CreateEndpoint接口，创建ES Serverless应用的私网终端节点。目前仅支持创建VPC类型的端点，用来打通用户VPC网络和ES Serverless服务的网络。调用该接口会默认帮助用户创建AliyunServiceRoleForESServerless角色。', - 'path' => '/openapi/es-serverless/endpoints', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6B297235-FC5B-590D-8218-8A5ED90AAE99\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"es-serverless-cn-8tr6u27483859****\\"\\n }\\n}","type":"json"}]', + 'title' => '更新应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApp'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateDict' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/dicts', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '206201', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '213563', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ @@ -2731,58 +2377,58 @@ 'description' => 'body参数', 'type' => 'object', 'properties' => [ - 'endpointZones' => [ - 'description' => '可用区信息列表。', + 'files' => [ + 'description' => '文件信息。', 'type' => 'array', 'items' => [ + 'description' => '文件信息。', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'description' => '可用区ID。目前支持的地域和可用区如下：'."\n" - .'- 杭州区域：cn-hangzhou-h, cn-hangzhou-g, cn-hangzhou-i'."\n" - .'- 北京区域：cn-beijing-g, cn-beijing-h, cn-beijing-i'."\n" - .'- 深圳区域：cn-shenzhen-d, cn-shenzhen-e, cn-shenzhen-f'."\n" - .'- 上海区域：cn-shanghai-b, cn-shanghai-f, cn-shanghai-g', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], - 'vswitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', + 'name' => ['description' => '上传的词典文件名称。', 'type' => 'string', 'required' => false, 'example' => 'dic_0.dic'], + 'ossObject' => [ + 'description' => 'OSS存储配置详情。', + 'type' => 'object', + 'properties' => [ + 'bucketName' => ['description' => 'OSS Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'bucket1'], + 'key' => ['description' => '词典文件在OSS Bucket中的存储路径。', 'type' => 'string', 'required' => false, 'example' => 'oss/dic_0.dic'], + ], 'required' => false, - 'example' => 'vsw-uf6qmfkqdcw*****', ], ], 'required' => false, ], 'required' => true, ], - 'vpcId' => [ - 'description' => '专有网络实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-uf664nyle5khp5***', - ], - 'name' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testendpoint', - ], + 'type' => ['description' => '要更新的词典类型：'."\n" + ."\n" + .'- MAIN：IK主分词词库'."\n" + .'- STOP：IK停用词库', 'type' => 'string', 'required' => false, 'example' => 'MAIN'], + 'sourceType' => ['description' => '词典文件来源类型。目前仅支持OSS（使用OSS开放存储）。', 'type' => 'string', 'required' => false, 'example' => 'OSS'], ], 'required' => false, ], ], [ - 'name' => 'type', + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => '端点类型，默认值VPC。', - 'type' => 'string', - 'required' => false, - 'example' => 'VPC', - ], + 'schema' => ['description' => '是否校验入参数据合法性并创建或修改词典信息，默认false。'."\n" + ."\n" + .'- **true**：只校验参数合法性。'."\n" + ."\n" + .'- **false**：校验参数合法性，并创建或修改词典信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'allowCover', + 'in' => 'query', + 'schema' => ['description' => '是否允许覆盖同名的词典，默认false。'."\n" + ."\n" + .'- false：不允许覆盖同名词典，若存在同名的词典会报错。'."\n" + .'- true：允许覆盖同名的词典。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -2792,62 +2438,55 @@ 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], - 'result' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'endpointId' => [ - 'description' => '端点ID。', - 'type' => 'string', - 'example' => 'essep-abd***dks', - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '12797BCC-E0B5-5A47-B4B9-A14DDF0B0200'], + 'result' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建或修改词典', + 'summary' => '调用UpdateDict接口，创建或修改ES Serverless应用词典。目前仅支持通过OSS地址上传。', + 'description' => '系统将自动创建服务关联角色，允许访问OSS等其他云产品服务。'."\n" + .'OSS地址要求：目录名称需包含es-serverless，或为OSS Bucket添加es-serverless:es-serverless标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDict'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"essep-abd***dks\\"\\n }\\n}","type":"json"}]', - 'title' => '创建终端节点', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"12797BCC-E0B5-5A47-B4B9-A14DDF0B0200\\",\\n \\"result\\": true\\n}","type":"json"}]', ], 'UpdateEndpoint' => [ - 'summary' => '调用UpdateEndpoint接口，修改ES Serverless平台中创建的终端节点。', 'path' => '/openapi/es-serverless/endpoints/{endpointId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '206245', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], ], 'parameters' => [ [ @@ -2866,29 +2505,14 @@ 'description' => '可用区。', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'description' => '终端节点所在的可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], - 'vSwitchId' => [ - 'description' => '终端节点所在的交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp18r8uwnukv3rvi9****', - ], + 'zoneId' => ['description' => '终端节点所在的可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], + 'vSwitchId' => ['description' => '终端节点所在的交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp18r8uwnukv3rvi9****'], ], 'required' => false, ], 'required' => true, ], - 'name' => [ - 'description' => '修改后的终端节点名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => ['description' => '修改后的终端节点名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], 'required' => false, ], @@ -2896,12 +2520,7 @@ [ 'name' => 'endpointId', 'in' => 'path', - 'schema' => [ - 'description' => '终端节点ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ep-bp1i98bcbb1540d0****', - ], + 'schema' => ['description' => '终端节点ID。', 'type' => 'string', 'required' => true, 'example' => 'ep-bp1i98bcbb1540d0****'], ], ], 'responses' => [ @@ -2911,431 +2530,116 @@ 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FBAD8493-87FA-583E-8A4C-D487F2DE90FC', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FBAD8493-87FA-583E-8A4C-D487F2DE90FC'], 'result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'endpointId' => [ - 'description' => '终端节点ID。', - 'type' => 'string', - 'example' => 'ep-bp1i98bcbb1540d0****'."\n", - ], + 'endpointId' => ['description' => '终端节点ID。', 'type' => 'string', 'example' => 'ep-bp1i98bcbb1540d0****'."\n"], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FBAD8493-87FA-583E-8A4C-D487F2DE90FC\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"ep-bp1i98bcbb1540d0****\\\\n\\"\\n }\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改终端节点信息', - ], - 'ListEndpoints' => [ - 'summary' => '调用ListEndpoints接口，获取在ES Serverless平台创建的VPC终端节点列表。', - 'path' => '/openapi/es-serverless/endpoints', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '206264', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], - ], - 'parameters' => [ - [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'description' => '节点类型， 默认VPC。', - 'type' => 'string', - 'required' => true, - 'example' => 'VPC', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'vpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'VPC网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1212sb7cj2j4e6x****', - ], - ], - [ - 'name' => 'resourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源ID，VPC类型资源ID对应为privatelink实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ep-bp1id41dd116e52e****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应体结构。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5', - ], - 'result' => [ - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'endpointId' => [ - 'description' => '端点ID。', - 'type' => 'string', - 'example' => 'essep-2f46b743f60****', - ], - 'resourceId' => [ - 'description' => '资源ID，VPC类型资源ID对应为PrivateLink实例ID。', - 'type' => 'string', - 'example' => 'ep-bp1id41dd116e52e****'."\n", - ], - 'vpcId' => [ - 'description' => 'VPC网络ID。', - 'type' => 'string', - 'example' => 'vpc-uf6gykvwcirp886ef****', - ], - 'status' => [ - 'description' => '终端节点状态：'."\n" - ."\n" - .'- Creating：创建中。'."\n" - .'- Active：可用。'."\n" - .'- Pending：修改中。'."\n" - .'- Deleting：删除中。', - 'type' => 'string', - 'example' => 'Active', - ], - 'connectionStatus' => [ - 'description' => '终端节点连接状态：'."\n" - ."\n" - .'- Pending：修改中。'."\n" - .'- Connecting：连接中。'."\n" - .'- Connected：已连接。'."\n" - .'- Disconnecting：断开连接中。'."\n" - .'- Disconnected：未连接。'."\n" - .'- Deleting：删除中。'."\n" - .'- ServiceDeleted：终端节点对应的服务已删除。', - 'type' => 'string', - 'example' => 'Pending', - ], - 'type' => [ - 'description' => '节点类型， 默认VPC。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'created' => [ - 'description' => '创建时间戳（秒级时间戳）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1701259721', - ], - 'updated' => [ - 'description' => '更新时间戳（秒级时间戳）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1701259721', - ], - 'name' => [ - 'description' => '终端节点名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'endpointZones' => [ - 'description' => '可用区信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '可用区信息。', - 'type' => 'object', - 'properties' => [ - 'zoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - 'vSwitchId' => [ - 'description' => '虚拟专有交换机，其所在可用区必须与Serverless应用一致。', - 'type' => 'string', - 'example' => 'vsw-bp194pz9iez****', - ], - ], - ], - ], - 'securityGroupIds' => [ - 'description' => '安全组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-bp1278950t9ykn2s****', - ], - ], - 'domain' => [ - 'description' => '终端节点域名。', - 'type' => 'string', - 'example' => 'ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com', - ], - ], - ], - ], - 'totalCount' => [ - 'description' => '记录总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5\\",\\n \\"result\\": [\\n {\\n \\"endpointId\\": \\"essep-2f46b743f60****\\",\\n \\"resourceId\\": \\"ep-bp1id41dd116e52e****\\\\n\\",\\n \\"vpcId\\": \\"vpc-uf6gykvwcirp886ef****\\",\\n \\"status\\": \\"Active\\",\\n \\"connectionStatus\\": \\"Pending\\",\\n \\"type\\": \\"VPC\\",\\n \\"created\\": 1701259721,\\n \\"updated\\": 1701259721,\\n \\"name\\": \\"test\\",\\n \\"endpointZones\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-k\\",\\n \\"vSwitchId\\": \\"vsw-bp194pz9iez****\\"\\n }\\n ],\\n \\"securityGroupIds\\": [\\n \\"sg-bp1278950t9ykn2s****\\"\\n ],\\n \\"domain\\": \\"ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com\\"\\n }\\n ],\\n \\"totalCount\\": 10\\n}","type":"json"}]', - 'title' => '获取终端节点列表', - ], - 'DeleteEndpoint' => [ - 'summary' => '调用DeleteEndpoint接口，删除在ES Serverless平台创建的终端节点。', - 'path' => '/openapi/es-serverless/endpoints/{endpointId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '206262', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', + 'summary' => '调用UpdateEndpoint接口，修改ES Serverless平台中创建的终端节点。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEndpoint'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'endpointId', - 'in' => 'path', - 'schema' => [ - 'description' => '终端节点ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'essep-2f46b743f60****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '请求结果。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1305A3E0-A291-54BA-A3B2-7D1C12EC4112', - ], - 'result' => [ - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1305A3E0-A291-54BA-A3B2-7D1C12EC4112\\",\\n \\"result\\": true\\n}","type":"json"}]', - 'title' => '删除终端节点', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FBAD8493-87FA-583E-8A4C-D487F2DE90FC\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"ep-bp1i98bcbb1540d0****\\\\n\\"\\n }\\n}","type":"json"}]', ], - 'ListSpecReviewTasks' => [ - 'summary' => '调用ListSpecReviewTasks，查看ES Serverless应用中申请修改规格的审批工单列表。', - 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateNetwork' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/networks', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '207292', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '230419', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '该字段已废弃。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => '该字段已废弃。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'description' => '申请修改工单的规格类型。取值包括：'."\n" - .'- QUOTA：配额。'."\n" - .'- LIMITER：系统限制。', - 'type' => 'string', - 'required' => false, - 'example' => 'QUOTA', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时设置的每页条数。默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '实例 ID。', 'description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'autotest-8k8a8'], ], [ - 'name' => 'status', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工单审批状态。取值如下：'."\n" - .'- Pending：待处理。'."\n" - .'- Approved：通过。'."\n" - .'- Rejected：拒绝。'."\n" - .'- Canceled：撤销。', - 'type' => 'string', + 'title' => 'body参数', + 'description' => 'body参数。', + 'type' => 'array', + 'items' => [ + 'description' => '请求体结构。', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'IP白名单的类型：'."\n" + ."\n" + .'PUBLIC_ES：Elasticsearch公网访问白名单'."\n" + .'PUBLIC_KIBANA：Kibana公网访问白名单', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC_ES'], + 'enabled' => ['description' => '是否开启公网访问。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'domain' => ['description' => '域名信息。（暂不支持修改）', 'type' => 'string', 'required' => false, 'example' => 'autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n"], + 'port' => ['description' => '端口号。（暂不支持修改）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200'], + 'whiteIpGroup' => [ + 'description' => '白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单具体结构。', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'ips' => [ + 'description' => '白名单组中的IP地址列表。', + 'type' => 'array', + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'."\n"], + 'required' => false, + ], + 'modifyMode' => ['description' => '修改方式，可选值：'."\n" + ."\n" + .'- Cover（默认）：使用ips参数的值覆盖原白名单的IP地址。'."\n" + ."\n" + .'- Append：在原白名单的IP地址中增加ips参数中输入的IP地址。'."\n" + ."\n" + .'- Delete：在原白名单的IP地址中删除ips参数中输入的IP地址，至少需要保留一个IP地址。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'Cover'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'Pending', ], ], ], @@ -3343,407 +2647,90 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '55F7B3FE-05D8-5F0F-BD55-A18967D447DC', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ 'description' => '返回结果。', 'type' => 'array', 'items' => [ - 'description' => '返回结果。', + 'description' => '返回结构。', 'type' => 'object', 'properties' => [ - 'appName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'type' => [ - 'description' => '规格类型。', - 'type' => 'string', - 'example' => 'QUOTA', - ], - 'source' => [ - 'description' => '工单来源：'."\n" - .'- USER：用户申请。'."\n" - .'- DEVOPS：ES Serverless运维人员。', - 'type' => 'string', - 'example' => 'USER', - ], - 'status' => [ - 'description' => '工单审批状态：'."\n" - .'- Pending：待处理。'."\n" - .'- Approved：通过。'."\n" - .'- Rejected：拒绝。'."\n" - .'- Canceled：撤销。', - 'type' => 'string', - 'example' => 'Pending', - ], - 'applyReason' => [ - 'description' => '申请理由。', - 'type' => 'string', - 'example' => '业务需要。', - ], - 'gmtCreate' => [ - 'description' => '创建时间的UTC时间。', - 'type' => 'string', - 'example' => '2024-05-27T10:13:22.000Z', - ], - 'Id' => [ - 'title' => '资源一级ID', - 'description' => '工单ID。', - 'type' => 'string', - 'deprecated' => false, - 'example' => '339', - 'pattern' => '', - 'default' => '', + 'type' => ['description' => 'IP白名单的类型。', 'type' => 'string', 'example' => 'PUBLIC_ES'], + 'enabled' => ['description' => '是否开启私网访问。', 'type' => 'string', 'example' => 'true'], + 'domain' => ['description' => '域名。', 'type' => 'string', 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n"], + 'port' => ['description' => '端口号。', 'type' => 'string', 'example' => '9200'], + 'whiteIpGroup' => [ + 'description' => '白名单信息。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单具体结构。', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => '白名单组的组名。', 'type' => 'string', 'example' => 'default'], + 'ips' => [ + 'description' => '白名单组中的IP地址列表。', + 'type' => 'array', + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'example' => '127.0.0.1'], + ], + ], + ], ], ], ], ], - 'totalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"55F7B3FE-05D8-5F0F-BD55-A18967D447DC\\",\\n \\"result\\": [\\n {\\n \\"appName\\": \\"test\\",\\n \\"type\\": \\"QUOTA\\",\\n \\"source\\": \\"USER\\",\\n \\"status\\": \\"Pending\\",\\n \\"applyReason\\": \\"业务需要。\\",\\n \\"gmtCreate\\": \\"2024-05-27T10:13:22.000Z\\",\\n \\"Id\\": \\"339\\"\\n }\\n ],\\n \\"totalCount\\": 1\\n}","type":"json"}]', - 'title' => '查看规格审批工单列表', - ], - 'GetSpecReviewTask' => [ - 'summary' => '调用GetSpecReviewTask接口，查看ES Serverless应用的规格审批工单详情。', - 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks/{taskId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '207276', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], - ], - 'parameters' => [ - [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '339', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E310AC54-957A-5FD5-B85B-E972B2BDA8DE', - ], - 'result' => [ - 'description' => '查询结果。', - 'type' => 'object', - 'properties' => [ - 'appName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'type' => [ - 'description' => '申请修改工单的规格类型。取值包括：'."\n" - ."\n" - .'- QUOTA：配额'."\n" - .'- LIMITER：系统限制', - 'type' => 'string', - 'example' => 'QUOTA', - ], - 'source' => [ - 'description' => '工单来源：'."\n" - .'- USER：用户申请'."\n" - .'- DEVOPS：ES Serverless运维人员', - 'type' => 'string', - 'example' => 'USER', - ], - 'status' => [ - 'description' => '工单审批状态：'."\n" - .'- Pending：待处理'."\n" - .'- Approved：通过'."\n" - .'- Rejected：拒绝'."\n" - .'- Canceled：撤销', - 'type' => 'string', - 'example' => 'Pending', - ], - 'applyReason' => [ - 'description' => '申请理由。', - 'type' => 'string', - 'example' => '业务需要。', - ], - 'gmtCreate' => [ - 'description' => '创建时间的UTC时间。', - 'type' => 'string', - 'example' => '2024-05-30T06:28:07.000Z', - ], - 'gmtModified' => [ - 'description' => '最后修改的UTC时间。', - 'type' => 'string', - 'example' => '2024-05-30T06:28:07.000Z', - ], - 'oldQuota' => [ - 'description' => '原始配额信息。', - 'type' => 'object', - 'example' => '{'."\n" - .' "appType": "TRIAL",'."\n" - .' "cu": 2,'."\n" - .' "storage": 1'."\n" - .' }', - ], - 'applyQuota' => [ - 'description' => '申请的配额信息。', - 'type' => 'object', - 'example' => '{'."\n" - .' "appType": "TRIAL",'."\n" - .' "cu": 4,'."\n" - .' "storage": 100'."\n" - .' }', - ], - 'effectiveQuota' => [ - 'description' => '生效的配额信息。', - 'type' => 'object', - 'example' => '{'."\n" - .' "appType": "TRIAL",'."\n" - .' "cu": 4,'."\n" - .' "storage": 100'."\n" - .' }', - ], - 'oldLimiter' => [ - 'description' => '原始的系统限制。', - 'type' => 'object', - 'example' => '{'."\n" - .' "limiters": ['."\n" - .' {'."\n" - .' "type": "INDEX_QUOTA",'."\n" - .' "maxValue": 500,'."\n" - .' "immutable": false'."\n" - .' }'."\n" - .' ]'."\n" - .' }', - ], - 'applyLimiter' => [ - 'description' => '申请的系统限制。', - 'type' => 'object', - 'example' => '{'."\n" - .' "limiters": ['."\n" - .' {'."\n" - .' "type": "INDEX_QUOTA",'."\n" - .' "maxValue": 500,'."\n" - .' "immutable": false'."\n" - .' }'."\n" - .' ]'."\n" - .' }', - ], - 'effectiveLimiter' => [ - 'description' => '生效的系统限制。', - 'type' => 'object', - 'example' => '{'."\n" - .' "limiters": ['."\n" - .' {'."\n" - .' "type": "INDEX_QUOTA",'."\n" - .' "maxValue": 500,'."\n" - .' "immutable": false'."\n" - .' }'."\n" - .' ]'."\n" - .' }', - ], - 'Id' => [ - 'title' => '资源一级ID', - 'description' => '工单ID。', - 'type' => 'string', - 'deprecated' => false, - 'example' => '339', - 'pattern' => '', - 'default' => '', - ], - ], - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E310AC54-957A-5FD5-B85B-E972B2BDA8DE\\",\\n \\"result\\": {\\n \\"appName\\": \\"test\\",\\n \\"type\\": \\"QUOTA\\",\\n \\"source\\": \\"USER\\",\\n \\"status\\": \\"Pending\\",\\n \\"applyReason\\": \\"业务需要。\\",\\n \\"gmtCreate\\": \\"2024-05-30T06:28:07.000Z\\",\\n \\"gmtModified\\": \\"2024-05-30T06:28:07.000Z\\",\\n \\"oldQuota\\": {\\n \\"appType\\": \\"TRIAL\\",\\n \\"cu\\": 2,\\n \\"storage\\": 1\\n },\\n \\"applyQuota\\": {\\n \\"appType\\": \\"TRIAL\\",\\n \\"cu\\": 4,\\n \\"storage\\": 100\\n },\\n \\"effectiveQuota\\": {\\n \\"appType\\": \\"TRIAL\\",\\n \\"cu\\": 4,\\n \\"storage\\": 100\\n },\\n \\"oldLimiter\\": {\\n \\"limiters\\": [\\n {\\n \\"type\\": \\"INDEX_QUOTA\\",\\n \\"maxValue\\": 500,\\n \\"immutable\\": false\\n }\\n ]\\n },\\n \\"applyLimiter\\": {\\n \\"limiters\\": [\\n {\\n \\"type\\": \\"INDEX_QUOTA\\",\\n \\"maxValue\\": 500,\\n \\"immutable\\": false\\n }\\n ]\\n },\\n \\"effectiveLimiter\\": {\\n \\"limiters\\": [\\n {\\n \\"type\\": \\"INDEX_QUOTA\\",\\n \\"maxValue\\": 500,\\n \\"immutable\\": false\\n }\\n ]\\n },\\n \\"Id\\": \\"339\\"\\n }\\n}","type":"json"}]', - 'title' => '查看规格审批工单详情', - ], - 'CancelSpecReviewTask' => [ - 'summary' => '调用CancelSpecReviewTask接口，撤销ES Serverless应用规格审批工单。', - 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks/{taskId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '207770', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], - ], - 'parameters' => [ - [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '339', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '请求结果。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD', - ], - 'result' => [ - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新应用公网配置', + 'summary' => '修改应用公网配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD\\",\\n \\"result\\": true\\n}","type":"json"}]', - 'title' => '撤销审批工单', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"PUBLIC_ES\\",\\n \\"enabled\\": \\"true\\",\\n \\"domain\\": \\"test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com\\\\n\\",\\n \\"port\\": \\"9200\\",\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"default\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'UpdatePrivateNetwrok' => [ 'summary' => '修改应用私网信息。', 'path' => '/openapi/es-serverless/instances/{appName}/private-networks', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '230430', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => '实例 ID。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ 'name' => 'body', @@ -3757,34 +2744,13 @@ 'description' => 'body参数。', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型：'."\n" - ."\n" - .'PRIVATE_ES：Elasticsearch私网访问白名单'."\n" - .'PRIVATE_KIBANA：Kibana私网访问白名单', - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE_ES', - ], - 'enabled' => [ - 'description' => '是否开启私网访问。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名信息。（暂不支持修改）', - 'type' => 'string', - 'required' => false, - 'example' => 'autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n", - ], - 'port' => [ - 'description' => '端口号。（暂不支持修改）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], + 'type' => ['description' => 'IP白名单的类型：'."\n" + ."\n" + .'PRIVATE_ES：Elasticsearch私网访问白名单'."\n" + .'PRIVATE_KIBANA：Kibana私网访问白名单', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE_ES'], + 'enabled' => ['description' => '是否开启私网访问。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'domain' => ['description' => '域名信息。（暂不支持修改）', 'type' => 'string', 'required' => false, 'example' => 'autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n"], + 'port' => ['description' => '端口号。（暂不支持修改）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200'], 'whiteIpGroup' => [ 'description' => '白名单具体结构。', 'type' => 'array', @@ -3792,53 +2758,28 @@ 'description' => '白名单具体结构。', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'groupName' => ['description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'default'], 'ips' => [ 'description' => '具体IP或IP段。', 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1'."\n", - ], - 'required' => false, - ], - 'modifyMode' => [ - 'description' => '修改方式，可选值：'."\n" - ."\n" - .'- Cover（默认）：使用ips参数的值覆盖原白名单的IP地址。'."\n" - ."\n" - .'- Append：在原白名单的IP地址中增加ips参数中输入的IP地址。'."\n" - ."\n" - .'- Delete：在原白名单的IP地址中删除ips参数中输入的IP地址，至少需要保留一个IP地址。'."\n" - ."\n", - 'type' => 'string', + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'."\n"], 'required' => false, - 'example' => 'Cover', ], + 'modifyMode' => ['description' => '修改方式，可选值：'."\n" + ."\n" + .'- Cover（默认）：使用ips参数的值覆盖原白名单的IP地址。'."\n" + ."\n" + .'- Append：在原白名单的IP地址中增加ips参数中输入的IP地址。'."\n" + ."\n" + .'- Delete：在原白名单的IP地址中删除ips参数中输入的IP地址，至少需要保留一个IP地址。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'Cover'], ], 'required' => false, ], 'required' => false, ], - 'vpcId' => [ - 'description' => '专有网络实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-uf664nyle5khp5***', - ], - 'pvlEndpointId' => [ - 'description' => '终端节点ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ep-bp1id6dc2568****', - ], + 'vpcId' => ['description' => '专有网络实例ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf664nyle5khp5***'], + 'pvlEndpointId' => ['description' => '终端节点ID。', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id6dc2568****'], ], 'required' => false, ], @@ -3853,12 +2794,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ 'description' => '返回结果', 'type' => 'array', @@ -3866,26 +2802,10 @@ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型。', - 'type' => 'string', - 'example' => 'PRIVATE_ES', - ], - 'enabled' => [ - 'description' => '是否开启私网访问。', - 'type' => 'string', - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'test-**.private.cn-hangzhou.es-serverless.aliyuncs.com', - ], - 'port' => [ - 'description' => '端口号。', - 'type' => 'string', - 'example' => '9200', - ], + 'type' => ['description' => 'IP白名单的类型。', 'type' => 'string', 'example' => 'PRIVATE_ES'], + 'enabled' => ['description' => '是否开启私网访问。', 'type' => 'string', 'example' => 'true'], + 'domain' => ['description' => '域名。', 'type' => 'string', 'example' => 'test-**.private.cn-hangzhou.es-serverless.aliyuncs.com'], + 'port' => ['description' => '端口号。', 'type' => 'string', 'example' => '9200'], 'whiteIpGroup' => [ 'description' => '白名单具体结构。', 'type' => 'array', @@ -3893,33 +2813,17 @@ 'description' => '白名单具体结构。', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。', - 'type' => 'string', - 'example' => 'default', - ], + 'groupName' => ['description' => '白名单组的组名。', 'type' => 'string', 'example' => 'default'], 'ips' => [ 'description' => '具体IP或IP段。', 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'example' => '127.0.0.1', - ], + 'items' => ['description' => '具体IP或IP段。', 'type' => 'string', 'example' => '127.0.0.1'], ], ], ], ], - 'vpcId' => [ - 'description' => 'VPC网络ID。', - 'type' => 'string', - 'example' => 'vpc-uf6gykvwcirp886ef****', - ], - 'pvlEndpointId' => [ - 'description' => '终端节点ID。', - 'type' => 'string', - 'example' => 'ep-bp1id6dc2568****', - ], + 'vpcId' => ['description' => 'VPC网络ID。', 'type' => 'string', 'example' => 'vpc-uf6gykvwcirp886ef****'], + 'pvlEndpointId' => ['description' => '终端节点ID。', 'type' => 'string', 'example' => 'ep-bp1id6dc2568****'], ], ], ], @@ -3927,238 +2831,495 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"PRIVATE_ES\\",\\n \\"enabled\\": \\"true\\",\\n \\"domain\\": \\"test-**.private.cn-hangzhou.es-serverless.aliyuncs.com\\",\\n \\"port\\": \\"9200\\",\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"default\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ],\\n \\"vpcId\\": \\"vpc-uf6gykvwcirp886ef****\\",\\n \\"pvlEndpointId\\": \\"ep-bp1id6dc2568****\\"\\n }\\n ]\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '更新应用私网配置', 'description' => '系统将自动创建服务关联角色，允许访问OSS等其他云产品服务。'."\n" .'OSS地址要求：目录名称需包含es-serverless，或为OSS Bucket添加es-serverless:es-serverless标签。', - ], - 'UpdateNetwork' => [ - 'summary' => '修改应用公网配置。', - 'path' => '/openapi/es-serverless/instances/{appName}/networks', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdatePrivateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"PRIVATE_ES\\",\\n \\"enabled\\": \\"true\\",\\n \\"domain\\": \\"test-**.private.cn-hangzhou.es-serverless.aliyuncs.com\\",\\n \\"port\\": \\"9200\\",\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"default\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ],\\n \\"vpcId\\": \\"vpc-uf6gykvwcirp886ef****\\",\\n \\"pvlEndpointId\\": \\"ep-bp1id6dc2568****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdateSnapshotSetting' => [ + 'summary' => '调用UpdateSnapshotSetting接口，修改ES Serverless应用自动备份快照的配置。', + 'path' => '/openapi/es-serverless/instances/{appName}/auto-snapshot-setting', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '230419', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'abilityTreeCode' => '213565', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => '实例 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'autotest-8k8a8', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => 'body参数', 'description' => 'body参数。', - 'type' => 'array', - 'items' => [ - 'description' => '请求体结构。', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型：'."\n" - ."\n" - .'PUBLIC_ES：Elasticsearch公网访问白名单'."\n" - .'PUBLIC_KIBANA：Kibana公网访问白名单', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC_ES', - ], - 'enabled' => [ - 'description' => '是否开启公网访问。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名信息。（暂不支持修改）', - 'type' => 'string', - 'required' => false, - 'example' => 'autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n", - ], - 'port' => [ - 'description' => '端口号。（暂不支持修改）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], - 'whiteIpGroup' => [ - 'description' => '白名单列表。', - 'type' => 'array', - 'items' => [ - 'description' => '白名单具体结构。', - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'ips' => [ - 'description' => '白名单组中的IP地址列表。', - 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1'."\n", - ], - 'required' => false, - ], - 'modifyMode' => [ - 'description' => '修改方式，可选值：'."\n" - ."\n" - .'- Cover（默认）：使用ips参数的值覆盖原白名单的IP地址。'."\n" - ."\n" - .'- Append：在原白名单的IP地址中增加ips参数中输入的IP地址。'."\n" - ."\n" - .'- Delete：在原白名单的IP地址中删除ips参数中输入的IP地址，至少需要保留一个IP地址。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'quartzRegex' => ['description' => '自动备份时间配置，采用Quartz Cron表达式。', 'type' => 'string', 'required' => true, 'example' => '0 0 01 ? * * *'], + 'enable' => ['description' => '是否开启自动备份。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], 'required' => false, ], ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], - 'result' => [ - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '返回结构。', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'IP白名单的类型。', - 'type' => 'string', - 'example' => 'PUBLIC_ES', - ], - 'enabled' => [ - 'description' => '是否开启私网访问。', - 'type' => 'string', - 'example' => 'true', - ], - 'domain' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n", - ], - 'port' => [ - 'description' => '端口号。', - 'type' => 'string', - 'example' => '9200', - ], - 'whiteIpGroup' => [ - 'description' => '白名单信息。', - 'type' => 'array', - 'items' => [ - 'description' => '白名单具体结构。', - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => '白名单组的组名。', - 'type' => 'string', - 'example' => 'default', - ], - 'ips' => [ - 'description' => '白名单组中的IP地址列表。', - 'type' => 'array', - 'items' => [ - 'description' => '具体IP或IP段。', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A7B03723-AA73-5A5F-B71C-270792614DD8'], + 'result' => ['description' => '返回结果。', 'type' => 'object', 'example' => '{'."\n" + .' "quartzRegex": "0 0 01 ? * * *",'."\n" + .' "enable": true'."\n" + .' }'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改自动备份配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSnapshotSetting'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"PUBLIC_ES\\",\\n \\"enabled\\": \\"true\\",\\n \\"domain\\": \\"test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com\\\\n\\",\\n \\"port\\": \\"9200\\",\\n \\"whiteIpGroup\\": [\\n {\\n \\"groupName\\": \\"default\\",\\n \\"ips\\": [\\n \\"127.0.0.1\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '更新应用公网配置', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7B03723-AA73-5A5F-B71C-270792614DD8\\",\\n \\"result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","type":"json"}]', ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'es-serverless.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'es-serverless.cn-shanghai.aliyuncs.com', + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'es-serverless.cn-shenzhen.aliyuncs.com', 'endpoint' => 'es-serverless.cn-shenzhen.aliyuncs.com', 'vpc' => 'es-serverless-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'es-serverless.cn-beijing.aliyuncs.com', 'endpoint' => 'es-serverless.cn-beijing.aliyuncs.com', 'vpc' => 'es-serverless-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'es-serverless.cn-shanghai.aliyuncs.com', 'endpoint' => 'es-serverless.cn-shanghai.aliyuncs.com', 'vpc' => 'es-serverless-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'es-serverless.cn-hangzhou.aliyuncs.com', 'endpoint' => 'es-serverless.cn-hangzhou.aliyuncs.com', 'vpc' => 'es-serverless-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSpecReviewTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDicts'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApp'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSnapshotSetting'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshots'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSpecReviewTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSpecReviewTasks'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSnapshot'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEndpoint'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIndices'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonitorData'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEndpoints'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEndpoint'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppQuota'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshotRepositories'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDict'], + ['threshold' => '100', 'countWindow' => 86400, 'regionId' => '*', 'api' => 'CreateApp'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDict'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEndpoint'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApp'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSnapshot'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSnapshotSetting'], ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'es-serverless.cn-beijing.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'ElasticsearchServerless', + 'productName' => '检索分析服务 Elasticsearch版', + 'ramCodes' => ['es-serverless'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ListSnapshotRepositories', + 'description' => '获取快照备份仓库列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSnapshotRepositories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateApp', + 'description' => '创建应用', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateEndpoint', + 'description' => '修改终端节点信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateEndpoint', + 'description' => '创建终端节点', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelSpecReviewTask', + 'description' => '撤销审批工单', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:CancelSpecReviewTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSnapshotSetting', + 'description' => '获取自动备份配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDict', + 'description' => '创建或修改词典', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListApps', + 'description' => '应用列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSpecReviewTasks', + 'description' => '查看规格审批工单列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSpecReviewTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSnapshot', + 'description' => '创建快照', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDict', + 'description' => '删除词典', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListIndices', + 'description' => '查看索引列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateApp', + 'description' => '更新应用', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateNetwork', + 'description' => '更新应用公网配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateSnapshotSetting', + 'description' => '修改自动备份配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteApp', + 'description' => '删除应用', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAppQuota', + 'description' => '查看应用配额', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetAppQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetApp', + 'description' => '获取应用详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListEndpoints', + 'description' => '获取终端节点列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMonitorData', + 'description' => '获取应用监控数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdatePrivateNetwrok', + 'description' => '更新应用私网配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdatePrivateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSnapshot', + 'description' => '删除快照', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDicts', + 'description' => '获取词典列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListDicts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSnapshots', + 'description' => '获取快照列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSnapshots', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteEndpoint', + 'description' => '删除终端节点', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSpecReviewTask', + 'description' => '查看规格审批工单详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetSpecReviewTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'es-serverless.cn-shenzhen.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'SpecReviewTask', 'arn' => 'acs:es-serverless:{#regionId}:{#accountId}:*'], + ['validationType' => 'always', 'resourceType' => 'Endpoint', 'arn' => 'acs:es-serverless:{#regionId}:{#accountId}:*'], ], ], ]; |