diff options
Diffstat (limited to 'data/en_us/es-serverless/2023-06-27')
| -rw-r--r-- | data/en_us/es-serverless/2023-06-27/api-docs.php | 5360 |
1 files changed, 2626 insertions, 2734 deletions
diff --git a/data/en_us/es-serverless/2023-06-27/api-docs.php b/data/en_us/es-serverless/2023-06-27/api-docs.php index 62a810b..0a765e0 100644 --- a/data/en_us/es-serverless/2023-06-27/api-docs.php +++ b/data/en_us/es-serverless/2023-06-27/api-docs.php @@ -1,105 +1,122 @@ <?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' => null, + 'children' => ['UpdateApp', 'GetApp', 'ListApps', 'DeleteApp', 'GetAppQuota'], 'type' => 'directory', - 'children' => [ - 'CreateApp', - 'UpdateApp', - 'GetApp', - 'ListApps', - 'DeleteApp', - 'GetAppQuota', - 'GetMonitorData', - 'ListIndices', - ], + 'title' => 'Application', ], [ - 'id' => 364883, - 'title' => null, + 'children' => ['UpdateSnapshotSetting', 'ListSnapshots', 'ListSnapshotRepositories', 'GetSnapshotSetting'], 'type' => 'directory', - 'children' => [ - 'CreateSnapshot', - 'UpdateSnapshotSetting', - 'ListSnapshots', - 'ListSnapshotRepositories', - 'GetSnapshotSetting', - 'DeleteSnapshot', - ], + 'title' => 'Data backup', ], [ - 'id' => 364890, - 'title' => null, + 'children' => ['UpdateDict', 'ListDicts', 'DeleteDict'], 'type' => 'directory', - 'children' => [ - 'UpdateDict', - 'ListDicts', - 'DeleteDict', - ], + 'title' => 'Dictionary', ], [ - 'id' => 364894, - 'title' => null, + 'children' => ['CreateEndpoint', 'UpdateEndpoint', 'ListEndpoints', 'DeleteEndpoint'], 'type' => 'directory', - 'children' => [ - 'CreateEndpoint', - 'UpdateEndpoint', - 'ListEndpoints', - 'DeleteEndpoint', - ], + 'title' => 'Endpoint', ], [ - 'id' => 364899, - 'title' => null, + 'children' => ['ListSpecReviewTasks', 'GetSpecReviewTask', 'CancelSpecReviewTask'], 'type' => 'directory', - 'children' => [ - 'ListSpecReviewTasks', - 'GetSpecReviewTask', - 'CancelSpecReviewTask', - ], + 'title' => 'Specification approval task', ], [ - 'id' => 364903, - 'title' => null, + 'children' => ['UpdatePrivateNetwrok', 'UpdateNetwork', 'CreateApp', 'CreateSnapshot', 'DeleteSnapshot', 'GetMonitorData', 'ListIndices'], 'type' => 'directory', - 'children' => [ - 'UpdatePrivateNetwrok', - 'UpdateNetwork', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateApp' => [ - 'summary' => '创建Serverless应用', - 'path' => '/openapi/es-serverless/instances', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CancelSpecReviewTask' => [ + 'summary' => 'Call the CancelSpecReviewTask operation to revoke an approval ticket for an Alibaba Cloud Elasticsearch Serverless application specification.', + 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks/{taskId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '207770', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => true, 'example' => '339', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The result of the request.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD'], + 'result' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Revoke approval ticket', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'CreateApp' => [ + 'summary' => 'To create an Elasticsearch Serverless application, call the CreateApp API.', + 'path' => '/openapi/es-serverless/instances', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ @@ -107,9 +124,7 @@ 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '185142', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchGXQH1U', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchGXQH1U'], ], 'parameters' => [ [ @@ -117,1115 +132,1116 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', + 'description' => 'The request body.', + 'title' => 'body parameters ', 'type' => 'object', 'properties' => [ - 'appName' => [ - 'title' => '应用名', - 'description' => '应用名', - 'type' => 'string', - 'required' => true, - ], - 'description' => [ - 'title' => '应用备注', - 'description' => '应用备注', - 'type' => 'string', - 'required' => false, - ], + 'appName' => ['title' => 'Application Name', 'description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'description' => ['title' => 'Application Remarks', 'description' => 'The application description.', 'type' => 'string', 'required' => false, 'example' => 'test'], 'network' => [ + 'description' => 'The public network settings.', 'type' => 'array', 'items' => [ + 'description' => 'The public network configuration.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'enabled' => [ - 'type' => 'boolean', - ], - 'domain' => [ - 'type' => 'string', - ], - 'port' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'type' => ['description' => 'The type of the IP whitelist. Valid values:'."\n" + ."\n" + .'- `PUBLIC_ES`: The IP whitelist for public access to Elasticsearch.'."\n" + ."\n" + .'- `PUBLIC_KIBANA`: The IP whitelist for public access to Kibana.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC_ES', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether to enable public access.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com', 'title' => ''], + 'port' => ['description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], 'whiteIpGroup' => [ + 'description' => 'The list of IP whitelist groups.', 'type' => 'array', 'items' => [ + 'description' => 'An IP whitelist group.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'type' => 'string', - ], + 'groupName' => ['description' => 'The name of the IP whitelist group. This parameter is required if you specify the `whiteIpGroup` parameter.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'ips' => [ + 'description' => 'The IP addresses in the whitelist group.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['description' => 'An IP address or a CIDR block.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'authentication' => [ + 'description' => 'The authentication settings.', 'type' => 'object', 'properties' => [ 'basicAuth' => [ + 'description' => 'The basic authentication settings.', 'type' => 'array', 'items' => [ + 'description' => 'The credentials for basic authentication.', 'type' => 'object', 'properties' => [ - 'username' => [ - 'type' => 'string', - ], - 'password' => [ - 'type' => 'string', - ], + 'username' => ['description' => 'The username. This parameter is not configurable. The system automatically uses the application ID as the username.', 'type' => 'string', 'required' => false, 'example' => 'test-123', 'title' => ''], + 'password' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], - 'regionId' => [ - 'type' => 'string', - ], - 'version' => [ - 'type' => 'string', - ], - 'chargeType' => [ - 'type' => 'string', - 'required' => true, - ], + 'regionId' => ['description' => 'The region where the application is deployed.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'version' => ['description' => 'The application version. Currently, you can create only Elasticsearch 8.17 applications.', 'type' => 'string', 'required' => false, 'example' => '8.17', 'title' => ''], + 'chargeType' => ['description' => 'The billing method. Only Pay-As-You-Go (`POSTPAY`) is supported.', 'type' => 'string', 'required' => true, 'example' => 'POSTPAY', 'title' => ''], 'quotaInfo' => [ + 'description' => 'The quota settings.', 'type' => 'object', 'properties' => [ - 'cu' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'storage' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'appType' => [ - 'type' => 'string', - ], + 'cu' => ['description' => '(Deprecated) The upper limit of Capacity Units (CUs) for a single application.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', 'title' => ''], + 'storage' => ['description' => 'The maximum index storage space for the application, in GB. This value is automatically determined by the `cu` parameter and does not need to be set.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24', 'title' => ''], + 'appType' => ['description' => 'The application type. Valid value:'."\n" + ."\n" + .'- `STANDARD`: Standard Edition.', 'type' => 'string', 'required' => false, 'example' => 'STANDARD', 'title' => ''], + 'minCu' => ['description' => 'The minimum number of CUs.'."\n" + .'For a Search-enhanced application, valid values are 2, 4, 6, 8, and 16.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'required' => false], + 'elastic' => ['description' => 'Specifies whether to enable autoscaling.'."\n" + .'`true`: Enable autoscaling.'."\n" + .'`false`: Disable autoscaling.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'privateNetwork' => [ + 'description' => 'The private network settings.', 'type' => 'array', 'items' => [ + 'description' => 'The private network configuration.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'enabled' => [ - 'type' => 'boolean', - ], + 'type' => ['description' => 'The type of the IP whitelist. Valid values:'."\n" + ."\n" + .'- `PRIVATE_KIBANA`: The IP whitelist for private access to Kibana.'."\n" + ."\n" + .'- `PRIVATE_ES`: The IP whitelist for private access to Elasticsearch.', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE_ES', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether to enable private access.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'whiteIpGroup' => [ + 'description' => 'The list of IP whitelist groups.', 'type' => 'array', 'items' => [ + 'description' => 'An IP whitelist group.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'type' => 'string', - ], + 'groupName' => ['description' => 'The name of the IP whitelist group. This parameter is required if you specify the `whiteIpGroup` parameter.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'ips' => [ + 'description' => 'The IP addresses in the whitelist group.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['description' => 'An IP address or a CIDR block.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'vpcId' => [ - 'type' => 'string', - ], - 'pvlEndpointId' => [ - 'type' => 'string', - ], + 'vpcId' => ['description' => 'The ID of the Virtual Private Cloud (VPC) to which the endpoint belongs.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1jy348ibzulk6hn****', 'title' => ''], + 'pvlEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id41dd116e52e****', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'scenario' => [ - 'type' => 'string', - ], + 'scenario' => ['description' => 'The application scenario. Valid value:'."\n" + ."\n" + .'- `GENERAL`: Search-enhanced.', 'type' => 'string', 'required' => false, 'example' => 'GENERAL', 'title' => ''], 'tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'key' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'description' => 'A tag.', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'description' => 'The tags to add to the application.', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'example' => '', ], ], [ 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run. The default value is false.'."\n" + ."\n" + .'- **true**: Validates the request without creating the application.'."\n" + ."\n" + .'- **false**: Validates the request and creates the application.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'A client token to ensure request idempotence. You must ensure that the token is unique for each request. The token must be an ASCII string with a maximum length of 64 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The structure of the response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ - 'description' => '', + 'description' => 'The result.', 'type' => 'object', 'properties' => [ - 'instaneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-serverless-cn-xxx', - ], - 'appId' => [ - 'type' => 'string', - ], + 'instaneId' => ['description' => 'The ID of the application instance.', 'type' => 'string', 'example' => 'es-serverless-cn-xxx', 'title' => ''], + 'appId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"instaneId\\": \\"es-serverless-cn-xxx\\",\\n \\"appId\\": \\"\\"\\n }\\n}","type":"json"}]', - ], - 'UpdateApp' => [ - 'summary' => '编辑Serverless应用', - 'path' => '/openapi/es-serverless/instances/{appName}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Create Application ', + 'requestParamsDescription' => 'The following is an example of a complete request body for creating an application:'."\n" + ."\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' => [ + ['createdAt' => '2025-04-10T02:42:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-09T03:30:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-24T02:36:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-24T12:41:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-19T06:21:26.000Z', 'description' => 'Request parameters changed'], + ], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateEndpoint' => [ + 'summary' => 'Creates a private endpoint for an ES Serverless application. You can create a maximum of 50 private endpoints per region. Only VPC-type endpoints are currently supported, which establish a private connection between your Virtual Private Cloud (VPC) and the ES Serverless service. This operation automatically creates the `AliyunServiceRoleForESServerless` service-linked role if it does not exist.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-severless-test-app', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '应用备注', - 'description' => '应用备注', - 'type' => 'string', - ], - 'network' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'enabled' => [ - 'type' => 'boolean', - ], - 'domain' => [ - 'type' => 'string', - ], - 'port' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'whiteIpGroup' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'type' => 'string', - ], - 'ips' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - 'authentication' => [ - 'type' => 'object', - 'properties' => [ - 'basicAuth' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'username' => [ - 'type' => 'string', - ], - 'password' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'privateNetwork' => [ + 'endpointZones' => [ + 'description' => 'The zone configuration for the endpoint.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'enabled' => [ - 'type' => 'boolean', - ], - 'vpcId' => [ - 'type' => 'string', - ], - 'pvlEndpointId' => [ - 'type' => 'string', - ], - 'whiteIpGroup' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'type' => 'string', - ], - 'ips' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - 'limiterInfo' => [ - 'type' => 'object', - 'properties' => [ - 'limiters' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'maxValue' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'minValue' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'type' => [ - 'type' => 'string', - ], - 'values' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], + 'zoneId' => ['description' => 'The ID of the zone. The following regions and zones are supported:'."\n" + ."\n" + .'- China (Hangzhou): cn-hangzhou-h, cn-hangzhou-g, cn-hangzhou-i'."\n" + ."\n" + .'- China (Beijing): cn-beijing-g, cn-beijing-h, cn-beijing-i'."\n" + ."\n" + .'- China (Shenzhen): cn-shenzhen-d, cn-shenzhen-e, cn-shenzhen-f'."\n" + ."\n" + .'- China (Shanghai): cn-shanghai-b, cn-shanghai-f, cn-shanghai-g', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], + 'vswitchId' => ['description' => 'The ID of the VSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6qmfkqdcw*****', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'applyReason' => [ - 'type' => 'string', - ], - 'contactInfo' => [ - 'type' => 'string', - ], + 'vpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf664nyle5khp5***', 'title' => ''], + 'name' => ['description' => 'The name of the endpoint.', 'type' => 'string', 'required' => false, 'example' => 'testendpoint', 'title' => ''], ], 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the endpoint. Default value: `VPC`.', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'endpointId' => ['description' => 'The ID of the endpoint.', 'type' => 'string', 'example' => 'essep-abd***dks', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6B297235-FC5B-590D-8218-8A5ED90AAE99\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"es-serverless-cn-8tr6u27483859****\\"\\n }\\n}","type":"json"}]', - ], - 'GetApp' => [ - 'summary' => '获取Serverless应用详情', - 'path' => '/openapi/es-serverless/instances/{appName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"essep-abd***dks\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create Endpoint', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEndpoint'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'title' => '', + 'description' => 'The body parameter.', + 'type' => 'object', + 'properties' => [ + 'snapshot' => ['description' => 'The snapshot name.', 'type' => 'string', 'required' => true, 'example' => 'qingning', 'title' => ''], + 'indices' => ['description' => 'The index name. Separate multiple indexes with commas.', 'type' => 'string', 'required' => true, 'example' => 'product_info', 'title' => ''], + ], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'detailed', + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'dryRun', 'in' => 'query', + 'schema' => ['description' => 'Validate input parameter data. The default is false.'."\n" + ."\n" + .'Values:'."\n" + ."\n" + .'- **true**: Only validate parameter data.'."\n" + ."\n" + .'- **false**: Validate parameter data and create a snapshot.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'repository', + 'in' => 'path', + 'schema' => ['description' => 'The snapshot repository name. The default is aliyun\\_auto\\_snapshot.', 'type' => 'string', 'required' => true, 'example' => 'aliyun_auto_snapshot', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => 'Schema of Response', + 'description' => 'The request result.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '03761BE5-D12F-55B4-9C93-0255C11DE44A'], + 'result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Snapshot ', + 'summary' => 'Call CreateSnapshot to create a snapshot for an Elasticsearch Serverless application.', + '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' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"03761BE5-D12F-55B4-9C93-0255C11DE44A\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'DeleteApp' => [ + 'summary' => 'Call the DeleteApp operation to delete an Elasticsearch Serverless application.', + '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' => 'Name of the application to delete. Call [ListApps](~~2539816~~) to get the application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response body structure.', 'type' => 'object', 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ - 'description' => '', + 'description' => 'Response result.', 'type' => 'object', 'properties' => [ - 'appName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-severless-test-app'."\n", - ], - 'ownerId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*******7595', - ], - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'status' => [ - 'description' => '', - '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' => '', - ], - 'appId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-app-abc'."\n", - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7.10', - ], - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'network' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'enabled' => [ - 'type' => 'boolean', - ], - 'domain' => [ - 'type' => 'string', - ], - 'port' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'whiteIpGroup' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'type' => 'string', - ], - 'ips' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - 'privateNetwork' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'enabled' => [ - 'type' => 'boolean', - ], - 'domain' => [ - 'type' => 'string', - ], - 'port' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'vpcId' => [ - 'type' => 'string', - ], - 'pvlEndpointId' => [ - 'type' => 'string', - ], - 'whiteIpGroup' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'type' => 'string', - ], - 'ips' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - 'appType' => [ - 'type' => 'string', - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - ], - ], - ], - 'scenario' => [ - 'type' => 'string', - ], - 'chargeType' => [ - 'type' => 'string', - ], + 'instanceId' => ['description' => 'Instance ID of the deleted application.', 'type' => 'string', 'example' => 'Es-serverless-***17-digit-id**', 'title' => ''], ], - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'ListApps' => [ - 'summary' => '查看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' => 'Delete Application', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DeleteDict' => [ + 'summary' => 'You can call the DeleteDict operation to delete dictionaries for an ES Serverless application.', + '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' => '', + 'description' => 'The body parameter.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The dictionary file name.', 'type' => 'string', 'required' => true, 'example' => 'a.dic', 'title' => ''], + 'type' => ['description' => 'The dictionary type:'."\n" + ."\n" + .'- MAIN: The main dictionary for IK tokenization.'."\n" + ."\n" + .'- STOP: The stop word dictionary for IK.', 'type' => 'string', 'required' => true, 'example' => 'MAIN', 'title' => ''], + ], 'required' => false, - 'example' => 'es-severless-test-app'."\n", + 'example' => '', ], ], [ - 'name' => 'description', - 'in' => 'query', + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'metrics-logs-online', + 'title' => 'Schema of Response', + 'description' => 'The request result.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2BF6B57E-5AAD-5389-80CD-E200BBF91FF9'], + 'result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Dictionary ', + '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' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2BF6B57E-5AAD-5389-80CD-E200BBF91FF9\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'DeleteEndpoint' => [ + 'summary' => 'Call the DeleteEndpoint operation to delete an endpoint from the Elasticsearch Serverless platform.', + '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' => 'The endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'essep-2f46b743f60****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2023-08-29T02:37:22Z', + 'title' => 'Schema of Response', + 'description' => 'The request result.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1305A3E0-A291-54BA-A3B2-7D1C12EC4112'], + 'result' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Endpoint ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEndpoint'], + ], + ], + 'ramActions' => [ [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ACTIVE', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', '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' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '213582', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], + ], + 'parameters' => [ [ - 'name' => 'orderType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'Name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'tags', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'repository', + 'in' => 'path', + 'schema' => ['description' => 'Name of the backup repository.', 'type' => 'string', 'required' => true, 'example' => 'aliyun_auto_snapshot', 'title' => ''], + ], + [ + 'name' => 'snapshot', + 'in' => 'path', + 'schema' => ['description' => 'Name of the snapshot.', 'type' => 'string', 'required' => true, 'example' => 'qingning', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response result.', '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' => 'OwnerID账号ID', - 'type' => 'string', - 'example' => '*********7595', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => '代表region的资源属性字段', - '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' => '', - ], - 'appId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-abc', - ], - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - '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' => '', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '16484F36-A2A3-5A05-B242-0BF2BF6AA326'], + 'result' => ['description' => 'Operation result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'DeleteApp' => [ - 'summary' => '删除Serverless应用。', - 'path' => '/openapi/es-serverless/instances/{appName}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Snapshot ', + 'summary' => 'This operation deletes a snapshot of an Elasticsearch Serverless application.', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"16484F36-A2A3-5A05-B242-0BF2BF6AA326\\",\\n \\"result\\": true\\n}","type":"json"}]', + ], + 'GetApp' => [ + 'summary' => 'Call the GetApp operation to retrieve details about an Elasticsearch Serverless application.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'Application name. Call [ListApps](~~2539816~~) to get the application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'detailed', + 'in' => 'query', + 'schema' => ['description' => 'Whether to return detailed information. Valid values:'."\n" + ."\n" + .'- **false** (default): Do not return detailed information.'."\n" + ."\n" + .'- **true**: Return detailed information.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], 'result' => [ - 'description' => '', + 'description' => 'Response result.', 'type' => 'object', 'properties' => [ - 'instanceId' => [ + 'appName' => ['description' => 'Application name.', 'type' => 'string', 'example' => 'es-severless-test-app', 'title' => ''], + 'ownerId' => ['description' => 'UID of the Alibaba Cloud account that owns the application.', 'type' => 'string', 'example' => '*******7595', 'title' => ''], + 'regionId' => ['description' => 'Region where the application is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'status' => ['description' => 'Application status:'."\n" + ."\n" + .'- **ACTIVE**: Normal.'."\n" + ."\n" + .'- **INIT**: Creating.'."\n" + ."\n" + .'- **INACTIVE**: Frozen.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''], + 'createTime' => ['description' => 'Time when the application was created.', 'type' => 'string', 'example' => '2022-08-15T11:20:52.370Z', 'title' => ''], + 'modifiedTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2022-08-15T11:21:50.000Z', 'title' => ''], + 'description' => ['description' => 'Application description.', 'type' => 'string', 'example' => 'This is a demo application.', 'title' => ''], + 'appId' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'test-app-abc', 'title' => ''], + 'version' => ['description' => 'The product version.', 'type' => 'string', 'example' => '7.10', 'title' => ''], + 'instanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'Es-serverless-***17-digit-id**', 'title' => ''], + 'network' => [ + 'description' => 'Public network information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Structure of public network information.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'Type of IP address whitelist:'."\n" + ."\n" + .'- PUBLIC\\_ES: Public access whitelist for Elasticsearch.'."\n" + ."\n" + .'- PUBLIC\\_KIBANA: Public access whitelist for Kibana.', 'type' => 'string', 'example' => 'PUBLIC_ES', 'title' => ''], + 'enabled' => ['description' => 'Whether public network access is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'Information about the domain name.', 'type' => 'string', 'example' => 'test-123.public.cn-hangzhou.es-serverless.aliyuncs.com', 'title' => ''], + 'port' => ['description' => 'Port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'whiteIpGroup' => [ + 'description' => 'IP address whitelist groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'Structure of an IP address whitelist group.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'Name of the IP address whitelist group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ips' => [ + 'description' => 'List of IP addresses or CIDR blocks in the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'An individual IP address or CIDR block.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'privateNetwork' => [ + 'description' => 'Private network information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Structure of private network information.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'Type of IP address whitelist:'."\n" + ."\n" + .'- PRIVATE\\_KIBANA: Private access whitelist for Kibana.'."\n" + ."\n" + .'- PRIVATE\\_ES: Private access whitelist for Elasticsearch.', 'type' => 'string', 'example' => 'PRIVATE_ES', 'title' => ''], + 'enabled' => ['description' => 'Whether private network access is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'Domain name.', 'type' => 'string', 'example' => 'test-123.private.cn-hangzhou.es-serverless.aliyuncs.com', 'title' => ''], + 'port' => ['description' => 'Port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'vpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-bp16ul4pwsg1mjni***', 'title' => ''], + 'pvlEndpointId' => ['description' => 'Information about the endpoint.', 'type' => 'string', 'example' => 'ep-aaaddd**', 'title' => ''], + 'whiteIpGroup' => [ + 'description' => 'IP address whitelist groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'Structure of an IP address whitelist group.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'Name of the IP address whitelist group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ips' => [ + 'description' => 'List of IP addresses or CIDR blocks in the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'An individual IP address or CIDR block.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'appType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], + 'scenario' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'chargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Obtain application details', + 'changeSet' => [ + ['createdAt' => '2025-04-10T02:42:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-19T06:25:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-22T02:35:24.000Z', 'description' => 'Response parameters changed'], + ], + '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' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"es-serverless-***17位id**\\"\\n }\\n}","type":"json"}]', + 'translator' => 'machine', ], 'GetAppQuota' => [ - 'summary' => '获取Serverless应用配额详情', + 'summary' => 'Call the GetAppQuota operation to retrieve the quota information for an Elasticsearch Serverless application.', '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the application. Call [ListApps](~~2539816~~) to obtain the application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The structure of the response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'quotaInfo' => [ - 'description' => '', - 'type' => 'object', - ], + 'quotaInfo' => ['description' => 'The quota information.', 'type' => 'object', 'title' => '', 'example' => ''], 'limiterInfo' => [ - 'description' => '', + 'description' => 'The system limit information.', 'type' => 'object', 'properties' => [ 'limiters' => [ - 'description' => '', + 'description' => 'The list of limits.', 'type' => 'array', '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' => 'The type of the system limit.', 'type' => 'string', 'example' => 'INDEX_NUMBER_OF_SHARDS', 'title' => ''], + 'immutable' => ['description' => 'Indicates whether the limit is immutable. Modifying system limits is not currently supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'minValue' => ['description' => 'The minimum threshold.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'maxValue' => ['description' => 'The maximum threshold.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View application quota ', + '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' => 'All Resource', '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"}]', ], 'GetMonitorData' => [ - 'summary' => '获取监控数据', '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' => 'Request body information.', '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"}]}', 'title' => ''], ], ], 'responses' => [ @@ -1233,1230 +1249,1293 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InternalServerError', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'internal server error', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'code' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'InternalServerError', 'title' => ''], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'internal server error', 'title' => ''], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197', 'title' => ''], + 'success' => ['description' => 'Call result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Return result.', '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' => 'Data integrity.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'summary' => ['description' => 'A property in the return value. Currently has no meaning.', 'type' => 'number', 'format' => 'float', 'example' => '172455913.18935508', 'title' => ''], + 'messageWatermark' => ['description' => 'The timestamp when the request reached the server-side, used for troubleshooting.', 'type' => 'integer', 'format' => 'int64', 'example' => '1689566839447', 'title' => ''], + 'dps' => ['description' => 'Metric real-time monitoring data. Format: `{timestamp:data}`.', 'type' => 'object', 'example' => '{'."\n" + .' "1689480600":28676235.104761902'."\n" + .'}', 'title' => ''], + 'tags' => ['description' => 'Tags.', 'type' => 'object', 'example' => '{'."\n" + .' "indexName":"test"'."\n" + .' }', 'title' => ''], + 'metric' => ['description' => 'Metric name.', 'type' => 'string', 'example' => 'elasticsearch-server.logic_cpu.cpu', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Application Monitoring Data', + 'summary' => 'Call the GetMonitorData API to retrieve metric data for Elasticsearch Serverless Application Monitoring.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonitorData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', '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"}]', ], - 'ListIndices' => [ - 'summary' => '查看索引列表', - 'path' => '/openapi/es-serverless/instances/{appName}/indices', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request result.', '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' => 'The request ID.', 'type' => 'string', 'example' => '7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC'], 'result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{"index" : ".aliyun-limiter-config"}', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'quartzRegex' => ['description' => 'The automatic backup execution policy.', 'type' => 'string', 'example' => '0 0 01 ? * * *', 'title' => ''], + 'enable' => ['description' => 'Indicates whether automatic backup is enabled.'."\n" + ."\n" + .'- true: Automatic backup is enabled.'."\n" + ."\n" + .'- false: Automatic backup is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8C85CCB3-C0C9-521C-B599-F903E14A8793\\",\\n \\"result\\": [\\n \\"{\\\\\\"index\\\\\\" : \\\\\\".aliyun-limiter-config\\\\\\"}\\"\\n ]\\n}","type":"json"}]', - ], - 'CreateSnapshot' => [ - 'summary' => '创建快照', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories/{repository}/snapshots', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Automatic Backup Configuration ', + 'summary' => 'Call the GetSnapshotSetting API to retrieve the automatic backup configuration of an ES Serverless application.', + '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' => 'All Resource', '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' => 'Call the GetSpecReviewTask API to view the details of a specification approval ticket for an ES Serverless application.', + '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' => '', - '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' => 'Application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'repository', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun_auto_snapshot', - ], + 'schema' => ['description' => 'Ticket ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '339', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '03761BE5-D12F-55B4-9C93-0255C11DE44A', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'E310AC54-957A-5FD5-B85B-E972B2BDA8DE'], 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'Query result.', + 'type' => 'object', + 'properties' => [ + 'appName' => ['description' => 'Application name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'type' => ['description' => 'The specification type of the requested ticket. Values include the following:'."\n" + ."\n" + .'- QUOTA: Quota'."\n" + ."\n" + .'- LIMITER: System limit', 'type' => 'string', 'example' => 'QUOTA', 'title' => ''], + 'source' => ['description' => 'Ticket source:'."\n" + ."\n" + .'- USER: User request'."\n" + ."\n" + .'- DEVOPS: ES Serverless O\\&M engineer', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'status' => ['description' => 'Ticket approval status:'."\n" + ."\n" + .'- Pending: Pending'."\n" + ."\n" + .'- Approved: Approved'."\n" + ."\n" + .'- Rejected: Rejected'."\n" + ."\n" + .'- Canceled: Revoked', 'type' => 'string', 'example' => 'Pending', 'title' => ''], + 'applyReason' => ['description' => 'Reason for request.', 'type' => 'string', 'example' => 'Business requirement.', 'title' => ''], + 'gmtCreate' => ['description' => 'UTC time of creation.', 'type' => 'string', 'example' => '2024-05-30T06:28:07.000Z', 'title' => ''], + 'gmtModified' => ['description' => 'UTC time of last modification.', 'type' => 'string', 'example' => '2024-05-30T06:28:07.000Z', 'title' => ''], + 'oldQuota' => ['description' => 'Original quota information.', 'type' => 'object', 'example' => '{'."\n" + .' "appType": "TRIAL",'."\n" + .' "cu": 2,'."\n" + .' "storage": 1'."\n" + .' }', 'title' => ''], + 'applyQuota' => ['description' => 'Requested quota information.', 'type' => 'object', 'example' => '{'."\n" + .' "appType": "TRIAL",'."\n" + .' "cu": 4,'."\n" + .' "storage": 100'."\n" + .' }', 'title' => ''], + 'effectiveQuota' => ['description' => 'Effective quota information.', 'type' => 'object', 'example' => '{'."\n" + .' "appType": "TRIAL",'."\n" + .' "cu": 4,'."\n" + .' "storage": 100'."\n" + .' }', 'title' => ''], + 'oldLimiter' => ['description' => 'Original system limits.', 'type' => 'object', 'example' => '{'."\n" + .' "limiters": ['."\n" + .' {'."\n" + .' "type": "INDEX_QUOTA",'."\n" + .' "maxValue": 500,'."\n" + .' "immutable": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'applyLimiter' => ['description' => 'Requested system limits.', 'type' => 'object', 'example' => '{'."\n" + .' "limiters": ['."\n" + .' {'."\n" + .' "type": "INDEX_QUOTA",'."\n" + .' "maxValue": 500,'."\n" + .' "immutable": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'effectiveLimiter' => ['description' => 'Effective system limits.', 'type' => 'object', 'example' => '{'."\n" + .' "limiters": ['."\n" + .' {'."\n" + .' "type": "INDEX_QUOTA",'."\n" + .' "maxValue": 500,'."\n" + .' "immutable": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'Id' => ['description' => 'Ticket ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '339'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"03761BE5-D12F-55B4-9C93-0255C11DE44A\\",\\n \\"result\\": true\\n}","type":"json"}]', - ], - 'UpdateSnapshotSetting' => [ - 'summary' => '修改自动备份配置', - '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' => 'View specification approval ticket details', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListApps' => [ + 'summary' => 'Call the ListApps API to retrieve a list of Elasticsearch Serverless applications.', + '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' => '', - 'type' => 'object', - 'properties' => [ - 'quartzRegex' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0 0 01 ? * * *', - ], - 'enable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - 'required' => false, - ], + 'name' => 'appName', + 'in' => 'query', + 'schema' => ['description' => 'Application name.', 'type' => 'string', 'required' => false, 'example' => 'es-severless-test-app'."\n", 'title' => ''], ], [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'Application description.', 'type' => 'string', 'required' => false, 'example' => 'metrics-logs-online', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number for paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'createTime', + 'in' => 'query', + 'schema' => ['description' => 'The application creation time. Filter applications created at or after the specified time. The time format is YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2023-08-29T02:37:22Z', 'title' => ''], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['description' => 'Application status:'."\n" + ."\n" + .'- **ACTIVE**: Normal'."\n" + ."\n" + .'- **INIT**: Initializing'."\n" + ."\n" + .'- **INACTIVE**: Frozen', 'type' => 'string', 'required' => false, 'example' => 'ACTIVE', 'title' => ''], + ], + [ + 'name' => 'orderType', + 'in' => 'query', + 'schema' => ['description' => 'The sorting method for application creation time. Default is desc.'."\n" + ."\n" + .'- **asc**: Ascending'."\n" + ."\n" + .'- **desc**: Descending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response body structure.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'A7B03723-AA73-5A5F-B71C-270792614DD8', - ], + 'totalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '0', 'default' => '0', 'title' => '', 'example' => '4'], 'result' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{'."\n" - .' "quartzRegex": "0 0 01 ? * * *",'."\n" - .' "enable": true'."\n" - .' }', + 'title' => '', + 'description' => 'Array, returns example folder.', + 'type' => 'array', + 'items' => [ + 'title' => 'AppItemType', + 'description' => 'AppItemType', + 'type' => 'object', + 'properties' => [ + 'appName' => ['description' => 'Application name.', 'type' => 'string', 'title' => '', 'example' => 'es-severless-test-app'."\n"], + 'ownerId' => ['title' => 'OwnerID', 'description' => 'The UID of the Alibaba Cloud account that owns the application.', 'type' => 'string', 'example' => '*********7595'], + 'regionId' => ['description' => 'Region ID', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'status' => ['description' => 'Application status.', 'type' => 'string', 'title' => '', 'example' => 'ACTIVE'], + 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2022-12-27T07:09:11.000Z'], + 'modifiedTime' => ['description' => 'Update time.', 'type' => 'string', 'example' => '2022-12-27T07:09:11.000Z'."\n", 'title' => ''], + 'description' => ['description' => 'Application remarks.', 'type' => 'string', 'example' => 'This is a demo application.', 'title' => ''], + 'appId' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'test-abc', 'title' => ''], + 'instanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'Es-serverless-***17-digit-id**', 'title' => ''], + 'version' => ['description' => 'The product version.', 'type' => 'string', 'example' => '7.10', 'title' => ''], + 'appType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Application List', + 'changeSet' => [ + ['createdAt' => '2025-06-09T11:38:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-10T02:42:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-19T06:25:06.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A7B03723-AA73-5A5F-B71C-270792614DD8\\",\\n \\"result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","type":"json"}]', - ], - 'ListSnapshots' => [ - 'summary' => '获取仓库的快照列表', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshots', - 'methods' => [ - 'get', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListDicts' => [ + 'summary' => 'Retrieves a list of dictionaries for an ES Serverless application.', + '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' => 'Application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'snapshot', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'qingning', - ], + 'schema' => ['description' => 'The number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Request result.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '22E9EE78-F567-550A-8F7C-20E9CD3DE489', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3'], + 'totalCount' => ['description' => 'Total number of dictionaries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'result' => [ - 'description' => '', + 'description' => 'Returned result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Returned result.', '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' => 'Dictionary name.', 'type' => 'string', 'example' => 'a.dic', 'title' => ''], + 'type' => ['description' => 'Dictionary type:'."\n" + ."\n" + .'- MAIN: IK main token dictionary'."\n" + ."\n" + .'- STOP: IK stop word dictionary'."\n" + ."\n" + .'- SYNONYMS: Synonym dictionary', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], + 'downloadUrl' => ['description' => 'File download URL.', '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', 'title' => ''], + 'sourceType' => ['description' => 'Dictionary file source type. Optional values: OSS (uses OSS open storage).', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ODgyObrnP3', - ], - 'totalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'ListSnapshotRepositories' => [ - 'summary' => '获取快照仓库列表', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Dictionary List ', + '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' => 'All Resource', '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' => 'Call the ListEndpoints operation to retrieve a list of VPC endpoints created on the Elasticsearch Serverless platform.', + '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' => 'Endpoint type. Default value: VPC.', 'type' => 'string', 'required' => true, 'example' => 'VPC', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'vpcId', + 'in' => 'query', + 'schema' => ['description' => 'VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1212sb7cj2j4e6x****', 'title' => ''], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => ['description' => 'Resource ID. For VPC-type resources, this is the PrivateLink instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id41dd116e52e****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response body structure.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '56E0591D-7D62-56A2-993E-952FB2026C69', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5'], 'result' => [ - 'description' => '', + 'description' => 'Results returned.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Results returned.', 'type' => 'object', - 'example' => '{'."\n" - .' "type": "oss",'."\n" - .' "name": "aliyun_auto_snapshot",'."\n" - .' "snapshotAmount": 5'."\n" - .' }', + 'properties' => [ + 'endpointId' => ['description' => 'Endpoint ID.', 'type' => 'string', 'example' => 'essep-2f46b743f60****', 'title' => ''], + 'resourceId' => ['description' => 'Resource ID. For VPC-type resources, this is the PrivateLink instance ID.', 'type' => 'string', 'example' => 'ep-bp1id41dd116e52e****'."\n", 'title' => ''], + 'vpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6gykvwcirp886ef****', 'title' => ''], + 'status' => ['description' => 'Endpoint status:'."\n" + ."\n" + .'- Creating: The endpoint is being created.'."\n" + ."\n" + .'- Active: The endpoint is active.'."\n" + ."\n" + .'- Pending: The endpoint is being modified.'."\n" + ."\n" + .'- Deleting: The endpoint is being deleted.', 'type' => 'string', 'example' => 'Active', 'title' => ''], + 'connectionStatus' => ['description' => 'Endpoint connection status:'."\n" + ."\n" + .'- Pending: The connection is being modified.'."\n" + ."\n" + .'- Connecting: The endpoint is connecting.'."\n" + ."\n" + .'- Connected: The endpoint is connected.'."\n" + ."\n" + .'- Disconnecting: The endpoint is disconnecting.'."\n" + ."\n" + .'- Disconnected: The endpoint is disconnected.'."\n" + ."\n" + .'- Deleting: The endpoint is being deleted.'."\n" + ."\n" + .'- ServiceDeleted: The service associated with the endpoint has been deleted.', 'type' => 'string', 'example' => 'Pending', 'title' => ''], + 'type' => ['description' => 'The node type. The default value is VPC.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'created' => ['description' => 'Creation timestamp in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1701259721', 'title' => ''], + 'updated' => ['description' => 'Last update timestamp in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1701259721', 'title' => ''], + 'name' => ['description' => 'Endpoint name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'endpointZones' => [ + 'description' => 'List of zones.', + 'type' => 'array', + 'items' => [ + 'description' => 'Zone information.', + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['description' => 'Zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''], + 'vSwitchId' => ['description' => 'vSwitch ID. The zone where the vSwitch resides must match the zone of your Serverless application.', 'type' => 'string', 'example' => 'vsw-bp194pz9iez****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'securityGroupIds' => [ + 'description' => 'List of security group IDs.', + 'type' => 'array', + 'items' => ['description' => 'Security group ID.', 'type' => 'string', 'example' => 'sg-bp1278950t9ykn2s****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'domain' => ['description' => 'Endpoint domain name.', 'type' => 'string', 'example' => 'ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'totalCount' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'GetSnapshotSetting' => [ - 'summary' => '获取自动备份配置', - 'path' => '/openapi/es-serverless/instances/{appName}/auto-snapshot-setting', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List endpoints ', + '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' => 'All Resource', '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' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'text', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The 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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'description' => 'The response data.', + 'type' => 'array', + 'items' => ['description' => 'Details of each item in the response.', 'type' => 'any', 'example' => '{"index" : ".aliyun-limiter-config"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View Index List ', + 'summary' => 'Call the ListIndices operation to view the list of indexes for an ES Serverless application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIndices'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7B6CE6E1-5BA0-56DA-BFFD-8D90692F1EFC\\",\\n \\"result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8C85CCB3-C0C9-521C-B599-F903E14A8793\\",\\n \\"result\\": [\\n \\"{\\\\\\"index\\\\\\" : \\\\\\".aliyun-limiter-config\\\\\\"}\\"\\n ]\\n}","type":"json"}]', ], - 'DeleteSnapshot' => [ - 'summary' => '删除快照', - 'path' => '/openapi/es-serverless/instances/{appName}/snapshot-repositories/{repository}/snapshots/{snapshot}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSnapshotRepositories' => [ + 'summary' => 'The ListSnapshotRepositories operation retrieves a list of backup repositories for snapshots of ES Serverless applications.', + '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' => 'Application name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Request result.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '16484F36-A2A3-5A05-B242-0BF2BF6AA326', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '56E0591D-7D62-56A2-993E-952FB2026C69'], 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'Result.', + 'type' => 'array', + 'items' => ['description' => 'Result object.', 'type' => 'object', 'example' => '{'."\n" + .' "type": "oss",'."\n" + .' "name": "aliyun_auto_snapshot",'."\n" + .' "snapshotAmount": 5'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"16484F36-A2A3-5A05-B242-0BF2BF6AA326\\",\\n \\"result\\": true\\n}","type":"json"}]', - ], - 'UpdateDict' => [ - 'summary' => '创建或更新词典', - 'path' => '/openapi/es-serverless/instances/{appName}/dicts', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the List of Snapshot Backup Repositories ', + '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' => 'All Resource', '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' => '', - 'type' => 'object', - 'properties' => [ - 'files' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dic_0.dic', - ], - 'ossObject' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'bucketName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bucket1', - ], - 'key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss/dic_0.dic', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MAIN', - ], - 'sourceType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - ], - 'required' => false, - ], - ], - [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'Name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'dryRun', + 'name' => 'repository', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Name of the snapshot repository.', 'type' => 'string', 'required' => false, 'example' => 'aliyun_auto_snapshot', 'title' => ''], ], [ - 'name' => 'allowCover', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of records per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'snapshot', + 'in' => 'query', + 'schema' => ['description' => 'Name of the snapshot backup.', 'type' => 'string', 'required' => false, 'example' => 'qingning', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response object.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '12797BCC-E0B5-5A47-B4B9-A14DDF0B0200', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '22E9EE78-F567-550A-8F7C-20E9CD3DE489'], 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'description' => 'Results returned by the operation.', + 'type' => 'array', + 'items' => ['description' => 'A single result item.', '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" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'nextToken' => ['description' => 'Paging token. Not used yet.', 'type' => 'string', 'example' => 'ODgyObrnP3', 'title' => ''], + 'totalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"12797BCC-E0B5-5A47-B4B9-A14DDF0B0200\\",\\n \\"result\\": true\\n}","type":"json"}]', - ], - 'ListDicts' => [ - 'summary' => '获取词典列表', - 'path' => '/openapi/es-serverless/instances/{appName}/dicts', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Snapshot List ', + 'summary' => 'Call the ListSnapshots operation to retrieve a list of snapshots for an ES Serverless application.', + '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' => 'All Resource', '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' => 'Call ListSpecReviewTasks to retrieve the list of approval tickets for specification changes in an ES Serverless application.', + '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' => 'Name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => 'Type of specification change requested in the ticket. Valid values:'."\n" + ."\n" + .'- QUOTA: quota.'."\n" + ."\n" + .'- LIMITER: system limit.', 'type' => 'string', 'required' => false, 'example' => 'QUOTA', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of items per page for paged queries. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['description' => 'Status of the approval ticket. Valid values:'."\n" + ."\n" + .'- Pending: pending.'."\n" + ."\n" + .'- Approved: approved.'."\n" + ."\n" + .'- Rejected: rejected.'."\n" + ."\n" + .'- Canceled: canceled.', 'type' => 'string', 'required' => false, 'example' => 'Pending', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3', - ], - 'totalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '55F7B3FE-05D8-5F0F-BD55-A18967D447DC'], 'result' => [ - 'description' => '', + 'description' => 'Results returned.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The result that is returned.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a.dic', - ], - 'type' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'OSS', - ], + 'appName' => ['description' => 'Name of the application.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'type' => ['description' => 'Type of specification change.', 'type' => 'string', 'example' => 'QUOTA', 'title' => ''], + 'source' => ['description' => 'Source of the ticket:'."\n" + ."\n" + .'- USER: user request.'."\n" + ."\n" + .'- DEVOPS: ES Serverless O\\&M engineer.', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'status' => ['description' => 'Status of the approval ticket:'."\n" + ."\n" + .'- Pending: pending.'."\n" + ."\n" + .'- Approved: approved.'."\n" + ."\n" + .'- Rejected: rejected.'."\n" + ."\n" + .'- Canceled: canceled.', 'type' => 'string', 'example' => 'Pending', 'title' => ''], + 'applyReason' => ['description' => 'Reason for the request.', 'type' => 'string', 'example' => 'Business requirement.', 'title' => ''], + 'gmtCreate' => ['description' => 'Creation time in UTC.', 'type' => 'string', 'example' => '2024-05-27T10:13:22.000Z', 'title' => ''], + 'Id' => ['description' => 'ID of the ticket.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '339'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'totalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'View the List of Specification Approval Tickets', + 'changeSet' => [ + ['createdAt' => '2025-03-20T16:03:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-09T11:22:46.000Z', 'description' => 'Request parameters changed'], ], - '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"}]', - ], - 'DeleteDict' => [ - 'summary' => '删除词典', - 'path' => '/openapi/es-serverless/instances/{appName}/dicts/actions/remove', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSpecReviewTasks'], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '213564', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a.dic', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MAIN', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSpecReviewTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - ], - ], - [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '2BF6B57E-5AAD-5389-80CD-E200BBF91FF9', - ], - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2BF6B57E-5AAD-5389-80CD-E200BBF91FF9\\",\\n \\"result\\": true\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'CreateEndpoint' => [ - 'summary' => '创建端点', - 'path' => '/openapi/es-serverless/endpoints', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateApp' => [ + 'summary' => 'Call the UpdateApp API to update Elasticsearch Serverless application information, such as remarks, network settings, IP address whitelist groups, and account passwords.', + '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' => 'create', - 'abilityTreeCode' => '206201', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '185144', + 'abilityTreeNodes' => ['FEATUREelasticsearchGXQH1U'], ], 'parameters' => [ [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The application name. Call [ListApps](~~2539816~~) to get the application name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => '', + 'description' => 'The request body.', + 'title' => 'Body parameters', 'type' => 'object', 'properties' => [ - 'endpointZones' => [ - 'description' => '', + 'description' => ['title' => 'Application Notes', 'description' => 'The description of the application.', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'network' => [ + 'description' => 'The public network settings.', 'type' => 'array', 'items' => [ + 'description' => 'The structure for the public network settings.', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'description' => '', - 'type' => 'string', + 'type' => ['description' => 'The type of the IP address whitelist. Valid values:'."\n" + ."\n" + .'- PUBLIC\\_ES: the IP address whitelist for public access to Elasticsearch'."\n" + ."\n" + .'- PUBLIC\\_KIBANA: the IP address whitelist for public access to Kibana', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC_ES', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether to enable public access.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'The domain name. This parameter cannot be modified.', 'type' => 'string', 'required' => false, 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com', 'title' => ''], + 'port' => ['description' => 'The port number. This parameter cannot be modified.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], + 'whiteIpGroup' => [ + 'description' => 'The IP address whitelists.', + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of an IP address whitelist.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the whitelist group. This parameter is required if you specify the \\`whiteIpGroup\\` parameter.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'ips' => [ + 'description' => 'The IP addresses in the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'An IP address or a CIDR block.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'cn-hangzhou-h', + 'title' => '', + 'example' => '', ], - 'vswitchId' => [ - 'description' => '', - 'type' => 'string', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'authentication' => [ + 'description' => 'The authentication settings.', + 'type' => 'object', + 'properties' => [ + 'basicAuth' => [ + 'description' => 'The basic authentication settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'Basic authentication information.', + 'type' => 'object', + 'properties' => [ + 'username' => ['description' => 'The username. The default value is the application ID. This parameter cannot be modified.', 'type' => 'string', 'required' => false, 'example' => 'test-123', 'title' => ''], + 'password' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + ], 'required' => false, - 'example' => 'vsw-uf6qmfkqdcw*****', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-uf664nyle5khp5***', + 'privateNetwork' => [ + 'description' => 'The private network settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The structure for the private network settings.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The type of the private network endpoint. Valid values:'."\n" + ."\n" + .'- PRIVATE\\_KIBANA: the IP address whitelist for private access to Kibana'."\n" + ."\n" + .'- PRIVATE\\_ES: the IP address whitelist for private access to Elasticsearch', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE_ES', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether to enable private network access.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the VPC to which the endpoint belongs.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1jy348ibzulk6hn****', 'title' => ''], + 'pvlEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id41dd116e52e****', 'title' => ''], + 'whiteIpGroup' => [ + 'description' => 'The IP address whitelists.', + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of an IP address whitelist.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the whitelist group. This parameter is required if you specify the \\`whiteIpGroup\\` parameter.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'ips' => [ + 'description' => 'The IP addresses in the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'An IP address or a CIDR block.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'name' => [ - 'description' => '', - 'type' => 'string', + 'limiterInfo' => [ + 'description' => 'The system limit settings.'."\n" + ."\n" + .'> Modify these settings in the console. After you submit the changes, a specification approval ticket is generated.', + 'type' => 'object', + 'properties' => [ + 'limiters' => [ + 'description' => 'The list of limits.', + 'type' => 'array', + 'items' => [ + 'description' => 'A limit.', + 'type' => 'object', + 'properties' => [ + 'maxValue' => ['description' => 'The maximum value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'minValue' => ['description' => 'The minimum value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'type' => ['description' => 'The type of the system limit.', 'type' => 'string', 'required' => false, 'example' => 'MAX_CU_PER_SHARD', 'title' => ''], + 'values' => [ + 'description' => 'The list of limit values.', + 'type' => 'array', + 'items' => ['description' => 'A limit value.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'testendpoint', + 'title' => '', + 'example' => '', ], + 'applyReason' => ['description' => 'The reason for the application.', 'type' => 'string', 'example' => 'Apply for system limits.', 'required' => false, 'title' => ''], + 'contactInfo' => ['description' => 'The contact information, such as a phone number or an email address.', 'type' => 'string', 'required' => false, 'example' => '1370247****', 'title' => ''], ], 'required' => false, - ], - ], - [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'VPC', + 'example' => '', ], ], ], @@ -2464,64 +2543,67 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The structure of the response body.', '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' => 'The request ID.', 'type' => 'string', 'example' => '6B297235-FC5B-590D-8218-8A5ED90AAE99'], 'result' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'endpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'essep-abd***dks', - ], + 'instanceId' => ['description' => 'The instance ID of the application.', 'type' => 'string', 'example' => 'es-serverless-cn-8tr6u27483859****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6B297235-FC5B-590D-8218-8A5ED90AAE99\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"es-serverless-cn-8tr6u27483859****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Update Application', + 'changeSet' => [ + ['createdAt' => '2024-04-24T02:36:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-24T12:41:42.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C5DAA30-****-5181-9B87-9D6181016197\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"essep-abd***dks\\"\\n }\\n}","type":"json"}]', - ], - 'UpdateEndpoint' => [ - 'summary' => '修改端点信息', - 'path' => '/openapi/es-serverless/endpoints/{endpointId}', - 'methods' => [ - 'put', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + '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' => 'update', - 'abilityTreeCode' => '206245', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchTR2X2I', - ], + 'abilityTreeCode' => '213563', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ @@ -2529,1237 +2611,1047 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => '', + 'title' => '', + 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'endpointZones' => [ - 'description' => '', + 'files' => [ + 'description' => 'File information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'File information.', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], - 'vSwitchId' => [ - 'description' => '', - 'type' => 'string', + 'name' => ['description' => 'The name of the dictionary file to upload.', 'type' => 'string', 'required' => false, 'example' => 'dic_0.dic', 'title' => ''], + 'ossObject' => [ + 'description' => 'OSS storage configuration details.', + 'type' => 'object', + 'properties' => [ + 'bucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'bucket1', 'title' => ''], + 'key' => ['description' => 'The path of the dictionary file in the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'oss/dic_0.dic', 'title' => ''], + ], 'required' => false, - 'example' => 'vsw-bp18r8uwnukv3rvi9****', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'title' => '', + 'example' => '', + ], + 'type' => ['description' => 'The type of dictionary to update:'."\n" + ."\n" + .'- MAIN: IK main tokenizer dictionary'."\n" + ."\n" + .'- STOP: IK stopword dictionary', 'type' => 'string', 'required' => false, 'example' => 'MAIN', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Only OSS is supported.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], 'required' => false, + 'example' => '', ], ], [ - 'name' => 'endpointId', + 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ep-bp1i98bcbb1540d0****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'FBAD8493-87FA-583E-8A4C-D487F2DE90FC', - ], - 'result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'endpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ep-bp1i98bcbb1540d0****'."\n", - ], - ], - ], - ], - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FBAD8493-87FA-583E-8A4C-D487F2DE90FC\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"ep-bp1i98bcbb1540d0****\\\\n\\"\\n }\\n}","type":"json"}]', - ], - 'ListEndpoints' => [ - 'summary' => '获取端点信息列表', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'VPC', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Whether to validate input parameters only, without creating or updating the dictionary. Default value: false.'."\n" + ."\n" + .'- **true**: Validate input parameters only.'."\n" + ."\n" + .'- **false**: Validate input parameters and create or update the dictionary.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'vpcId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1212sb7cj2j4e6x****', - ], - ], - [ - 'name' => 'resourceId', + 'name' => 'allowCover', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ep-bp1id41dd116e52e****', - ], + 'schema' => ['description' => 'Whether to allow overwriting an existing dictionary with the same name. Default value: false.'."\n" + ."\n" + .'- false: Do not overwrite. Returns an error if a dictionary with the same name exists.'."\n" + ."\n" + .'- true: Overwrite the existing dictionary.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5', - ], - 'result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'endpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'essep-2f46b743f60****', - ], - 'resourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ep-bp1id41dd116e52e****'."\n", - ], - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-uf6gykvwcirp886ef****', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Active', - ], - 'connectionStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Pending', - ], - 'type' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - 'vSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-bp194pz9iez****', - ], - ], - ], - ], - 'securityGroupIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '12797BCC-E0B5-5A47-B4B9-A14DDF0B0200'], + 'result' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'DeleteEndpoint' => [ - 'summary' => '删除端点', - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create or Modify Dictionary ', + 'summary' => 'Call the UpdateDict operation to create or update a dictionary for an Elasticsearch Serverless application. You can upload dictionaries only from OSS.', + 'description' => 'OSS path requirements: The folder name must contain es-serverless, or you must add the es-serverless:es-serverless tag to the OSS bucket.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDict'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'endpointId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1305A3E0-A291-54BA-A3B2-7D1C12EC4112', - ], - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1305A3E0-A291-54BA-A3B2-7D1C12EC4112\\",\\n \\"result\\": true\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"12797BCC-E0B5-5A47-B4B9-A14DDF0B0200\\",\\n \\"result\\": true\\n}","type":"json"}]', ], - 'ListSpecReviewTasks' => [ - 'summary' => '获取规格审批列表', - 'path' => '/openapi/es-serverless/instances/{appName}/spec-review-tasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateEndpoint' => [ + 'path' => '/openapi/es-serverless/endpoints/{endpointId}', + 'methods' => ['put'], + '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' => '207292', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '206245', + 'abilityTreeNodes' => ['FEATUREelasticsearchTR2X2I'], ], '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'QUOTA', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Body parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '55F7B3FE-05D8-5F0F-BD55-A18967D447DC', - ], - 'result' => [ - 'description' => '', + 'endpointZones' => [ + 'description' => 'List of zones.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A zone for the endpoint.', 'type' => 'object', 'properties' => [ - 'appName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'QUOTA', - ], - 'source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USER', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Pending', - ], - 'applyReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'gmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-27T10:13:22.000Z', - ], - 'Id' => [ - 'title' => '资源一级ID', - 'description' => '代表资源一级ID的资源属性字段', - 'type' => 'string', - 'deprecated' => false, - 'example' => '339', - 'pattern' => '', - 'default' => '', - ], + 'zoneId' => ['description' => 'The zone ID where the endpoint is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], + 'vSwitchId' => ['description' => 'The vSwitch ID where the endpoint is located.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp18r8uwnukv3rvi9****', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'totalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'name' => ['description' => 'The updated endpoint name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], - ], - ], - ], - '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"}]', - ], - 'GetSpecReviewTask' => [ - 'summary' => '获取配额审批详情', - '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', + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'taskId', + 'name' => 'endpointId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '339', - ], + 'schema' => ['description' => 'The endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'ep-bp1i98bcbb1540d0****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Request result.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E310AC54-957A-5FD5-B85B-E972B2BDA8DE', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FBAD8493-87FA-583E-8A4C-D487F2DE90FC'], 'result' => [ - 'description' => '', + 'description' => 'Response result.', 'type' => 'object', 'properties' => [ - 'appName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'QUOTA', - ], - 'source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USER', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Pending', - ], - 'applyReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'gmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-30T06:28:07.000Z', - ], - 'gmtModified' => [ - 'description' => '', - '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' => '', - ], + 'endpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'ep-bp1i98bcbb1540d0****'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'CancelSpecReviewTask' => [ - 'summary' => '撤销规格审批', - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify endpoint information ', + 'summary' => 'Call the UpdateEndpoint operation to modify an endpoint in the ES Serverless platform.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEndpoint'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'appName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '339', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD', - ], - 'result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1B64F3E0-25D5-5043-B5C8-4FF22BB12CCD\\",\\n \\"result\\": true\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FBAD8493-87FA-583E-8A4C-D487F2DE90FC\\",\\n \\"result\\": {\\n \\"endpointId\\": \\"ep-bp1i98bcbb1540d0****\\\\n\\"\\n }\\n}","type":"json"}]', ], - 'UpdatePrivateNetwrok' => [ - 'summary' => '修改应用公网信息。', - 'path' => '/openapi/es-serverless/instances/{appName}/private-networks', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateNetwork' => [ + 'path' => '/openapi/es-serverless/instances/{appName}/networks', + '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', - ], + 'abilityTreeCode' => '230419', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => 'Instance ID. ', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'autotest-8k8a8'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => '', + 'description' => 'Request body.', + 'title' => 'Body parameters ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Structure of the request body.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - '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' => 'Type of IP address whitelist:'."\n" + ."\n" + .'PUBLIC\\_ES: Elasticsearch public network access whitelist'."\n" + .'PUBLIC\\_KIBANA: Kibana public network access whitelist', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC_ES', 'title' => ''], + 'enabled' => ['description' => 'Enable public network access.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'Domain name. You cannot modify this value.', 'type' => 'string', 'required' => false, 'example' => 'autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n", 'title' => ''], + 'port' => ['description' => 'Port number. You cannot modify this value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], 'whiteIpGroup' => [ - 'description' => '', + 'description' => 'Whitelist.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Structure of an IP address whitelist.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'groupName' => ['description' => 'Name of the IP address whitelist group. Required if you specify the whiteIpGroup parameter.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'ips' => [ - 'description' => '', + 'description' => 'List of IP addresses in the whitelist group.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1'."\n", - ], - 'required' => false, - ], - 'modifyMode' => [ - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'Specific IP address or CIDR block.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'."\n", 'title' => ''], 'required' => false, - 'example' => 'Cover', + 'title' => '', + 'example' => '', ], + 'modifyMode' => ['description' => 'Modification mode. Valid values:'."\n" + ."\n" + .'- Cover (default): Replace the existing IP addresses in the whitelist with the values in the ips parameter.'."\n" + ."\n" + .'- Append: Add the IP addresses in the ips parameter to the existing whitelist.'."\n" + ."\n" + .'- Delete: Remove the IP addresses in the ips parameter from the existing whitelist. At least one IP address must remain.', 'type' => 'string', 'required' => false, 'example' => 'Cover', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-uf664nyle5khp5***', - ], - 'pvlEndpointId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ep-bp1id6dc2568****', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Structure of the response body.', 'title' => 'Schema of Response', - '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' => 'Request ID.', 'type' => 'string', 'example' => '2C5DAA30-****-5181-9B87-9D6181016197'], 'result' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Response structure.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - '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' => 'Type of IP address whitelist.', 'type' => 'string', 'example' => 'PUBLIC_ES', 'title' => ''], + 'enabled' => ['description' => 'Enable internal-facing access.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'Domain name.', 'type' => 'string', 'example' => 'test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n", 'title' => ''], + 'port' => ['description' => 'Port number.', 'type' => 'string', 'example' => '9200', 'title' => ''], 'whiteIpGroup' => [ - 'description' => '', + 'description' => 'IP address whitelist information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Structure of an IP address whitelist.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], + 'groupName' => ['description' => 'Name of the IP address whitelist group.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'ips' => [ - 'description' => '', + 'description' => 'List of IP addresses in the whitelist group.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '127.0.0.1', - ], + 'items' => ['description' => 'Specific IP address or CIDR block.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-uf6gykvwcirp886ef****', - ], - 'pvlEndpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ep-bp1id6dc2568****', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'UpdateNetwork' => [ - 'summary' => '修改应用公网配置。', - 'path' => '/openapi/es-serverless/instances/{appName}/networks', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update application Internet configuration ', + 'summary' => 'Update the public network configuration for an application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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' => 'Updates the private network information of an application.', + 'path' => '/openapi/es-serverless/instances/{appName}/private-networks', + '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' => '230419', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch4EATFC', - ], + 'abilityTreeCode' => '230430', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], ], 'parameters' => [ [ 'name' => 'appName', 'in' => 'path', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'autotest-8k8a8', - ], + 'schema' => ['title' => 'Instance ID.', 'description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => '', + 'description' => 'The body parameter.', + 'title' => 'Body parameters.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The body parameter.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - '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', - ], + 'type' => ['description' => 'PRIVATE\\_ES: Elasticsearch internal-facing whitelist'."\n" + ."\n" + .'PRIVATE\\_KIBANA: Kibana internal-facing whitelist', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE_ES', 'title' => ''], + 'enabled' => ['description' => 'Enable internal-facing access.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'The domain name information. (Modification is not supported currently)', 'type' => 'string', 'required' => false, 'example' => 'autotest-8k8a8.serverless.cn-hangzhou.elasticsearch.aliyuncs.com'."\n", 'title' => ''], + 'port' => ['description' => 'The port number. (Modification is not supported currently)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], 'whiteIpGroup' => [ - 'description' => '', + 'description' => 'The whitelist structure.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The whitelist structure.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'groupName' => ['description' => 'The group name of the whitelist group. If you specify the \\`whiteIpGroup\\` parameter, this parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'ips' => [ - 'description' => '', + 'description' => 'The specific IP address or IP segment.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1'."\n", - ], + 'items' => ['description' => 'The specific IP address or IP segment.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'."\n", 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'modifyMode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], + 'modifyMode' => ['description' => 'The modification method. Valid values:'."\n" + ."\n" + .'- Cover (default): Overwrite the IP addresses in the original whitelist with the values of the \\`ips\\` parameter.'."\n" + ."\n" + .'- Append: Add the IP addresses specified in the \\`ips\\` parameter to the original whitelist.'."\n" + ."\n" + .'- Delete: Delete the IP addresses specified in the \\`ips\\` parameter from the original whitelist. You must retain at least one IP address.', 'type' => 'string', 'required' => false, 'example' => 'Cover', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], + 'vpcId' => ['description' => 'The virtual private cloud (VPC) instance ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf664nyle5khp5***', 'title' => ''], + 'pvlEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'required' => false, 'example' => 'ep-bp1id6dc2568****', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - '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', - ], + 'type' => ['description' => 'The type of IP address whitelist.', 'type' => 'string', 'example' => 'PRIVATE_ES', 'title' => ''], + 'enabled' => ['description' => 'Indicates whether internal-facing access is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'test-**.private.cn-hangzhou.es-serverless.aliyuncs.com', 'title' => ''], + 'port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '9200', 'title' => ''], 'whiteIpGroup' => [ - 'description' => '', + 'description' => 'The whitelist structure.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The whitelist structure.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], + 'groupName' => ['description' => 'The group name of the whitelist group.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'ips' => [ - 'description' => '', + 'description' => 'The specific IP address or IP segment.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '127.0.0.1', - ], + 'items' => ['description' => 'The specific IP address or IP segment.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6gykvwcirp886ef****', 'title' => ''], + 'pvlEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'ep-bp1id6dc2568****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update application internal-facing configuration', + 'description' => 'The system automatically creates a service-linked role to grant access to OSS and other cloud services. To access OSS, the directory name must contain es-serverless, or the es-serverless:es-serverless tag must be added to the OSS Bucket.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdatePrivateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', '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' => 'The UpdateSnapshotSetting API modifies the automatic backup snapshot configuration for an Elasticsearch Serverless application.', + 'path' => '/openapi/es-serverless/instances/{appName}/auto-snapshot-setting', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '213565', + 'abilityTreeNodes' => ['FEATUREelasticsearch4EATFC'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'quartzRegex' => ['description' => 'The automatic backup schedule, defined using a Quartz cron expression.', 'type' => 'string', 'required' => true, 'example' => '0 0 01 ? * * *', 'title' => ''], + 'enable' => ['description' => 'Whether to enable automatic backup.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'appName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A7B03723-AA73-5A5F-B71C-270792614DD8'], + 'result' => ['description' => 'The response data.', 'type' => 'object', 'example' => '{'."\n" + .' "quartzRegex": "0 0 01 ? * * *",'."\n" + .' "enable": true'."\n" + .' }', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify Automatic Backup Configuration ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSnapshotSetting'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', '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-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'es-serverless.cn-hangzhou.aliyuncs.com', 'endpoint' => 'es-serverless.cn-hangzhou.aliyuncs.com', 'vpc' => 'es-serverless-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'es-serverless.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetApp'], + ['description' => 'Response parameters changed', 'api' => 'ListApps'], + ], + 'createdAt' => '2024-07-19T06:25:14.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'es-serverless.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetApp'], + ], + 'createdAt' => '2024-05-22T02:35:29.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'es-serverless.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateApp'], + ['description' => 'Request parameters changed', 'api' => 'UpdateApp'], + ], + 'createdAt' => '2024-04-24T02:36:34.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'es-serverless.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateApp'], + ['description' => 'Request parameters changed', 'api' => 'UpdateApp'], + ], + 'createdAt' => '2024-01-24T12:41:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateApp'], + ], + 'createdAt' => '2023-10-19T06:21:30.000Z', + 'description' => '', + ], + ], + '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'], + ], + ], + 'ram' => [ + 'productCode' => 'ElasticsearchServerless', + 'productName' => 'Elasticsearch', + 'ramCodes' => ['es-serverless'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ListSnapshotRepositories', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSnapshotRepositories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateEndpoint', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateEndpoint', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelSpecReviewTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:CancelSpecReviewTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSnapshotSetting', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDict', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListApps', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSpecReviewTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSpecReviewTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSnapshot', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'es-serverless:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDict', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListIndices', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateApp', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateNetwork', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateSnapshotSetting', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdateSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteApp', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAppQuota', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetAppQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetApp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListEndpoints', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMonitorData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdatePrivateNetwrok', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'es-serverless:UpdatePrivateNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSnapshot', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDicts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListDicts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSnapshots', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'es-serverless:ListSnapshots', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteEndpoint', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'es-serverless:DeleteEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSpecReviewTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'es-serverless:GetSpecReviewTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ElasticsearchServerless', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'SpecReviewTask', 'arn' => 'acs:es-serverless:{#regionId}:{#accountId}:*'], + ['validationType' => 'always', 'resourceType' => 'Endpoint', 'arn' => 'acs:es-serverless:{#regionId}:{#accountId}:*'], ], ], ]; |