diff options
Diffstat (limited to 'data/en_us/hologram/2022-06-01/api-docs.php')
| -rw-r--r-- | data/en_us/hologram/2022-06-01/api-docs.php | 11825 |
1 files changed, 7628 insertions, 4197 deletions
diff --git a/data/en_us/hologram/2022-06-01/api-docs.php b/data/en_us/hologram/2022-06-01/api-docs.php index ce716c5..57498e3 100644 --- a/data/en_us/hologram/2022-06-01/api-docs.php +++ b/data/en_us/hologram/2022-06-01/api-docs.php @@ -1,181 +1,169 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'Hologram', - 'version' => '2022-06-01', - ], + 'info' => ['style' => 'ROA', 'product' => 'Hologram', 'version' => '2022-06-01'], 'directories' => [ [ - 'id' => 321219, - 'title' => null, + 'children' => ['GetUpgradeStatus', 'GetLastUpgradeRecord', 'UpdateAutoUpgrade', 'UpdateOperationEventScheduleTime', 'UpdateMaintenanceWindow', 'PrepareUpgrade', 'DiscardUpgrade'], 'type' => 'directory', - 'children' => [ - 'RevokeTablePermission', - 'RevokeSchemaPermission', - 'RevokeDatabasePermission', - 'ListDatabases', - 'GrantTablePermission', - 'GrantSchemaPermission', - 'GrantDatabasePermission', - ], + 'title' => 'Upgrade', ], [ - 'id' => 321227, - 'title' => null, + 'children' => ['UntagResources', 'TagResources', 'DescribeTags'], 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'DeleteInstance', - 'RenewInstance', - 'RestartInstance', - 'ResumeInstance', - 'UpdateInstanceName', - 'UpdateInstanceNetworkType', - 'DisableHiveAccess', - 'EnableHiveAccess', - 'StopInstance', - 'ScaleInstance', - 'ChangeResourceGroup', - 'ListInstances', - 'GetInstance', - ], + 'title' => 'Tags', ], [ - 'id' => 321242, - 'title' => null, + 'children' => ['GetExecuteStatementEnabled', 'ExecuteStatement', 'EnableExecuteStatement', 'DisableExecuteStatement'], 'type' => 'directory', - 'children' => [ - 'CreateHoloWarehouse', - 'DeleteHoloWarehouse', - 'RebalanceHoloWarehouse', - 'ResumeHoloWarehouse', - 'SuspendHoloWarehouse', - 'RenameHoloWarehouse', - 'ScaleHoloWarehouse', - 'RestartHoloWarehouse', - 'GetWarehouseDetail', - 'ListWarehouses', - ], + 'title' => 'Execute SQL', ], [ - 'id' => 321253, - 'title' => null, + 'children' => ['ListInstanceModel', 'UpdateModelService', 'ListModelCatalog', 'CreateModelService', 'DeleteModelResource', 'DeleteModelService', 'GetInstanceModel'], 'type' => 'directory', - 'children' => [ - 'ListBackupData', - ], + 'title' => 'Large language models', ], [ - 'id' => 321255, - 'title' => null, + 'children' => ['CreateDatabase', 'CreateExternalDatabase', 'CreateUser', 'DropUser', 'RevokeTablePermission', 'RevokeSchemaPermission', 'RevokeDatabasePermission', 'ListDatabases', 'GrantTablePermission', 'GrantSchemaPermission', 'GrantDatabasePermission'], 'type' => 'directory', - 'children' => [ - 'EnableSSL', - 'DisableSSL', - 'GetCertificateAttribute', - 'GetRootCertificate', - 'RenewSSLCertificate', - ], + 'title' => 'Databases', + ], + [ + 'children' => ['BindLeaderInstance', 'ListLeaderInstances', 'UnBindLeaderInstance', 'CreateInstance', 'DeleteInstance', 'RenewInstance', 'RestartInstance', 'ResumeInstance', 'UpdateInstanceName', 'UpdateInstanceNetworkType', 'DisableHiveAccess', 'EnableHiveAccess', 'StopInstance', 'ScaleInstance', 'ChangeResourceGroup', 'ListInstances', 'GetInstance'], + 'type' => 'directory', + 'title' => 'Instances', + ], + [ + 'children' => ['UpdateWarehouseScheduleTask', 'ListWarehouseScheduleTask', 'ListWarehouseScheduleEvent', 'CreateWarehouse', 'CreateHoloWarehouse', 'DeleteHoloWarehouse', 'RebalanceHoloWarehouse', 'ResumeHoloWarehouse', 'SuspendHoloWarehouse', 'RenameHoloWarehouse', 'ScaleHoloWarehouse', 'RestartHoloWarehouse', 'GetWarehouseDetail', 'CreateWarehouseScheduleTask', 'ListWarehouses', 'DisableWarehouseAutoScale', 'DeleteWarehouseScheduleTask', 'EnableWarehouseAutoScale'], + 'type' => 'directory', + 'title' => 'Compute groups', + ], + [ + 'children' => ['UpdateScheduledBackupConfig', 'UpdateBackupDataDesc', 'CreateManualBackup', 'ListBackupData', 'DeleteBackupData', 'GetScheduledBackupConfig'], + 'type' => 'directory', + 'title' => 'Backups', + ], + [ + 'children' => ['UpdateInstancePort', 'UpdateHoloWebLoginSetting', 'GetHoloWebLoginSetting', 'DisableSupportAccount', 'EnableSupportAccount', 'EnableSSL', 'DisableSSL', 'GetCertificateAttribute', 'GetRootCertificate', 'RenewSSLCertificate'], + 'type' => 'directory', + 'title' => 'Security', + ], + [ + 'children' => ['ListMigrationZones', 'ListOperationEvents', 'MigrateInstanceZone', 'DisableOperationEvent', 'GetUpgradeable', 'ListFollowerInstances', 'ListRegions', 'ListUpgradeReleaseVersions', 'UpgradeInstance'], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'RevokeTablePermission' => [ - 'summary' => '取消表授权', - 'path' => '/api/v1/instances/{instanceId}/revokeTablePermission', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'BindLeaderInstance' => [ + 'summary' => 'Binds a follower instance to a leader instance.', + 'path' => '/api/v1/instances/{instanceId}/bindReadOnly', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramFOIKRO', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", - ], + 'schema' => ['description' => 'The ID of the follower instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-uqm3316l1004', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'databaseName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], - 'userName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'p4_1234xxxx', - ], - 'schemaName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'my_schema', - ], - 'tableName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'my_table', - ], - 'privileges' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INSERT', - ], - 'required' => false, + 'leaderInstanceId' => ['description' => 'The ID of the leader instance. The follower and leader instances must be in the same region and zone, and have the same version. Obtain this ID by calling the `ListFollowerInstances` operation.', 'type' => 'string', 'required' => false, 'example' => ' '."\n" + .'hgpostcn-cn-uqm3316l1004'."\n", 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '6FF2EDFD-3154-5C3E-8CFA-8F7E366BCF9D'], + 'Data' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'enumValueTitles' => ['true' => 'The operation succeeded.', 'false' => 'The operation failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], - 'allTable' => [ - 'description' => '', + 'Success' => [ + 'description' => 'Indicates whether the API request succeeded. This parameter is independent of the binding operation result.', + 'enumValueTitles' => ['true' => 'The request succeeded.', 'false' => 'The request failed.'], 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'example' => 'true', + 'title' => '', ], + 'ErrorCode' => ['description' => 'The error code for a failed request.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message for a failed request.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], + ], + 'title' => 'BindLeaderInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6FF2EDFD-3154-5C3E-8CFA-8F7E366BCF9D\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Updates the resource group of a Hologres instance.', + 'path' => '/api/v1/tag/changeResourceGroup', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'newResourceGroupId' => ['description' => 'New resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxwerqwerasfd', 'title' => ''], + 'instanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zvp25ysv3006', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -183,600 +171,698 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], - 'data' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AB71198A-2DB1-511B-AE4D-690BAA97F076'], + 'Data' => [ + 'description' => 'Indicates whether the operation was successful.', + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failed'], 'type' => 'boolean', 'example' => 'true', + 'title' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', - ], - 'RevokeSchemaPermission' => [ - 'summary' => '取消Schema授权', - 'path' => '/api/v1/instances/{instanceId}/revokeSchemaPermission', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AB71198A-2DB1-511B-AE4D-690BAA97F076\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'ChangeResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'CreateDatabase' => [ + 'path' => '/api/v1/instances/{instanceId}/createDatabase', + 'methods' => ['post'], + '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', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramFOIKRO', - ], + 'abilityTreeNodes' => ['FEATUREhologramEVHI8S'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgprecn-cn-xxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'databaseName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], - 'userName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'p4_1234xxxx', - ], - 'schemaName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'my_schema', - ], - 'privileges' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'developer', - ], - 'required' => false, - ], + 'databaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => ''], + 'permissionModel' => ['description' => 'The permission model of the database.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => 'The request body.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - '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' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], - 'data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned for the request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Data' => ['description' => 'Indicates whether the database was created.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'description' => 'The response body.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', - ], - 'RevokeDatabasePermission' => [ - 'summary' => '取消DB授权', - 'path' => '/api/v1/instances/{instanceId}/revokeDatabasePermission', - 'methods' => [ - 'put', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'title' => 'CreateDatabase', + 'summary' => 'Creates a database.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": \\"\\",\\n \\"ErrorCode\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"HttpStatusCode\\": \\"\\",\\n \\"Data\\": false\\n}","type":"json"}]', + ], + 'CreateExternalDatabase' => [ + 'summary' => 'Creates an external database.', + 'path' => '/api/v1/instances/{instanceId}/createExternalDatabase', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramFOIKRO', - ], + 'abilityTreeNodes' => ['FEATUREhologramE3EYZP'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-zpr3426vxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2vxxxx'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'databaseName' => [ - 'description' => '', + 'databaseName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => ' my_db', 'title' => ''], + 'comment' => ['description' => 'The comment.', 'type' => 'string', 'required' => false, 'example' => 'for log stat', 'title' => ''], + 'defaultUserMapping' => ['description' => 'Specifies whether to use the default user mapping.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'metastoreType' => [ + 'description' => 'The metastore type.', + 'enumValueTitles' => ['maxcompute' => 'MaxCompute', 'dlf-rest' => 'dlf-rest', 'dlf' => 'DLF'], 'type' => 'string', 'required' => false, - 'example' => 'test_db', + 'example' => 'maxcompute', + 'title' => '', ], - 'userName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'p4_1234xxxx', - ], - 'privileges' => [ - 'description' => '', + 'externalConfig' => [ 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The configuration key.', 'type' => 'string', 'required' => false, 'example' => 'mc_project', 'title' => ''], + 'value' => ['description' => 'The configuration value.', 'type' => 'string', 'required' => false, 'example' => 'log_sum', 'title' => ''], + ], 'required' => false, - 'example' => 'developer', + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The configuration parameters. For more information, see [CREATE EXTERNAL DATABASE](https://help.aliyun.com/zh/hologres/developer-reference/create-external-database?scm=20140722.S_help%40%40%E6%96%87%E6%A1%A3%40%402847319._.ID_help%40%40%E6%96%87%E6%A1%A3%40%402847319-RL_mapping-LOC_doc%7EUND%7Eab-OR_ser-PAR1_6a0b3e1c17775322800352312d0096-V_4-PAR3_r-RE_new5-P0_11-P1_0\\&spm=a2c4g.11186623.help-search.i50).', 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - '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' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], - 'data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values are `true` (success) and `false` (failure).', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation. `true` indicates success and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', - ], - 'ListDatabases' => [ - 'summary' => '获取DB列表', - 'path' => '/api/v1/instances/{instanceId}/listDatabases', - 'methods' => [ - 'get', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'CreateExternalDatabase', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'CreateHoloWarehouse' => [ + 'summary' => 'Creates a virtual warehouse.', + 'path' => '/api/v1/instances/{instanceId}/createHoloWarehouse', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramE3EYZP', - ], + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-jfj3zckut008', - ], + 'schema' => ['description' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a', 'title' => ''], ], [ - 'name' => 'external', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'boolean', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The virtual warehouse name.', 'type' => 'string', 'required' => true, 'example' => 'my_warehouse', 'title' => ''], + 'cpu' => ['description' => 'The specifications of the virtual warehouse. The value must be a multiple of 16. The minimum value is 16.', 'type' => 'string', 'required' => true, 'example' => '32', 'title' => ''], + 'clusterCount' => ['description' => 'The number of clusters.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => '', 'required' => false], + ], 'required' => false, - 'example' => 'false', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0C4935F5-6217-569A-902F-931B2F3E28BA', - ], - 'DatabaseList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my_db', - ], - 'PermissionModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SPM', - ], - 'Privilege' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'developer', - ], - 'External' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'], + 'Data' => ['description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'CreateHoloWarehouse', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHoloWarehouse'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C4935F5-6217-569A-902F-931B2F3E28BA\\",\\n \\"DatabaseList\\": [\\n {\\n \\"Name\\": \\"my_db\\",\\n \\"PermissionModel\\": \\"SPM\\",\\n \\"Privilege\\": \\"developer\\",\\n \\"External\\": false\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'GrantTablePermission' => [ - 'summary' => 'DB授权', - 'path' => '/api/v1/instances/{instanceId}/grantTablePermission', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateInstance' => [ + 'summary' => 'Creates a Hologres instance in the specified region.', + 'path' => '/api/v1/instances/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREhologramUCU2YC'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-zpr3426xxx', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'databaseName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => ' my_db', - ], - 'privileges' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INSERT', - ], - 'required' => false, - ], - 'userName' => [ - 'description' => '', + 'regionId' => ['description' => 'The region ID. For more information, see <props="china">[Endpoints](https://help.aliyun.com/zh/hologres/developer-reference/api-hologram-2022-06-01-endpoint)</props><props="intl">[Endpoints](https://www.alibabacloud.com/help/zh/hologres/developer-reference/api-hologram-2022-06-01-endpoint)</props>.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-h', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the virtual private cloud (VPC). The VPC must be in the same region as the instance.', 'type' => 'string', 'required' => true, 'example' => 'vpc-t4netc3y5xxxx', 'title' => ''], + 'vSwitchId' => ['description' => 'The ID of the vSwitch. The vSwitch must be in the same zone as the instance.', 'type' => 'string', 'required' => true, 'example' => 'vsw-2vccsiymtxxxxxx', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group. If you leave this parameter empty, the default resource group for your account is used.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + 'instanceName' => ['description' => 'The instance name. The name must be 2 to 64 characters in length. A letter is counted as one character.', 'type' => 'string', 'required' => true, 'example' => 'my_holo', 'title' => ''], + 'instanceType' => [ + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- Standard: General-purpose instance.'."\n" + ."\n" + .'- Follower: Read-only secondary instance.'."\n" + ."\n" + .'- Warehouse: Virtual warehouse instance.'."\n" + ."\n" + .'- Shared: Shared instance.'."\n" + ."\n" + .'- Serverless: Serverless instance.', + 'enumValueTitles' => ['Warehouse' => 'Virtual warehouse instance.', 'Follower' => 'Read-only secondary instance.', 'Standard' => 'General-purpose instance.', 'Serverless' => 'Serverless instance.', 'Shared' => 'Shared instance.'], 'type' => 'string', - 'required' => false, - 'example' => 'p4_1234xxxx', - ], - 'schemaName' => [ - 'description' => '', + 'required' => true, + 'enum' => ['Standard', 'Follower', 'Warehouse', 'Shared', 'Serverless'], + 'example' => 'Standard', + 'title' => '', + ], + 'cpu' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- 32 vCPUs and 128 GB of memory (2 compute nodes)'."\n" + ."\n" + .'- 64 vCPUs and 256 GB of memory (4 compute nodes)'."\n" + ."\n" + .'- 96 vCPUs and 384 GB of memory (6 compute nodes)'."\n" + ."\n" + .'- 128 vCPUs and 512 GB of memory (8 compute nodes)'."\n" + ."\n" + .'- and so on.'."\n" + ."\n" + .'> * Specify the number of vCPUs.'."\n" + .'>'."\n" + .'> * To purchase an instance with more than 1,024 vCPUs, submit a ticket.'."\n" + .'>'."\n" + .'> * You do not need to specify the instance type for a shared instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64', 'title' => ''], + 'storageSize' => ['description' => 'The standard storage capacity of the instance. Unit: GB.'."\n" + ."\n" + .'> This parameter is ignored for pay-as-you-go (PostPaid) instances.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', 'title' => ''], + 'coldStorageSize' => ['description' => 'The cold storage capacity of the instance. Unit: GB.'."\n" + ."\n" + .'> This parameter is ignored for pay-as-you-go (PostPaid) instances.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', 'title' => ''], + 'gatewayCount' => ['description' => 'The number of gateways. Valid values: \\[2, 50].'."\n" + ."\n" + .'> You must specify this parameter only for virtual warehouse instances.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '50', 'minimum' => '2', 'required' => false, 'example' => '4', 'title' => ''], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- PrePaid: Subscription.'."\n" + ."\n" + .'- PostPaid: Pay-as-you-go.'."\n" + ."\n" + .'> This parameter is ignored for shared instances. Shared instances use defined specifications and the default billing method is pay-as-you-go..', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go', 'PrePaid' => 'Subscription'], 'type' => 'string', - 'required' => false, - 'example' => 'my_schema', - ], - 'tableName' => [ - 'description' => '', + 'required' => true, + 'enum' => ['PrePaid', 'PostPaid'], + 'example' => 'PostPaid', + 'title' => '', + ], + 'autoPay' => ['description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- true (default): Automatic payment is enabled.'."\n" + ."\n" + .'- false: An order is generated, but no payment is made.'."\n" + ."\n" + .'> If your account balance is insufficient, set the `autoPay` parameter to `false`. When an unpaid order is generated, log on to the Expenses and Costs console to pay for the order.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'pricingCycle' => [ + 'description' => 'The billing cycle. Valid values:'."\n" + ."\n" + .'- Month: The instance is billed on a monthly basis.'."\n" + ."\n" + .'- Hour: The instance is billed on an hourly basis.'."\n" + ."\n" + .'> * Subscription instances support only `Month`.'."\n" + .'>'."\n" + .'> * Pay-as-you-go instances support only `Hour`.'."\n" + .'>'."\n" + .'> * For shared instances, the value is automatically set to `Hour`.', + 'enumValueTitles' => ['Month' => 'The instance is billed on a monthly basis.', 'Hour' => 'The instance is billed on an hourly basis.'], 'type' => 'string', + 'enum' => ['Month', 'Hour'], 'required' => false, - 'example' => 'orders_pay', - ], - 'allTable' => [ - 'description' => '', + 'example' => 'Month', + 'title' => '', + ], + 'duration' => ['description' => 'The subscription duration, such as two months.'."\n" + ."\n" + .'> Specify this parameter only for subscription instances.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + 'autoRenew' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'- true: Auto-renewal is enabled.'."\n" + ."\n" + .'- false (default): Auto-renewal is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'leaderInstanceId' => ['description' => 'The ID of the primary instance. This parameter is required for secondary instances.'."\n" + ."\n" + .'> The primary and secondary instances must meet the following conditions:'."\n" + .'>'."\n" + .'> - The primary instance is in the Running state.'."\n" + .'>'."\n" + .'> - The primary and secondary instances are in the same region and zone.'."\n" + .'>'."\n" + .'> - They are in the same zone.'."\n" + .'>'."\n" + .'> - The primary instance has less than 10 secondary instances.'."\n" + .'>'."\n" + .'> - The primary and secondary instances belong to the same Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-lbj3aworq112', 'title' => ''], + 'initialDatabases' => ['description' => 'The initial database.', 'type' => 'string', 'required' => false, 'example' => 'chatbot', 'title' => ''], + 'enableServerlessComputing' => [ + 'description' => 'Specifies whether to enable Serverless Computing.', + 'enumValueTitles' => ['true' => 'Enable Serverless Computing.', 'false' => 'Disable Serverless Computing.'], 'type' => 'boolean', 'required' => false, 'example' => 'true', + 'title' => '', + ], + 'storageType' => [ + 'description' => 'The storage class.', + 'enumValueTitles' => ['local' => 'Locally redundant storage.', 'redundant' => 'Zone-redundant storage.'], + 'type' => 'string', + 'required' => false, + 'example' => 'redundant', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response details.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n", - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9CC37B9F-F4B4-5FF1-939B-AEE78DC70130'], 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hgpostcn-cn-xxxxxx', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '217523224780172', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidVpcOrVSwitch.NotAvailable', 'title' => ''], + 'Message' => ['description' => 'The details of the error.', 'type' => 'string', 'example' => 'InvalidVpcOrVSwitch.NotAvailable'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the instance was created.'."\n" + ."\n" + .'- true: The instance was created.'."\n" + ."\n" + .'- false: The instance failed to be created.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CC37B9F-F4B4-5FF1-939B-AEE78DC70130\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"hgpostcn-cn-xxxxxx\\",\\n \\"OrderId\\": \\"217523224780172\\",\\n \\"Code\\": \\"InvalidVpcOrVSwitch.NotAvailable\\",\\n \\"Message\\": \\"InvalidVpcOrVSwitch.NotAvailable\\\\n\\",\\n \\"Success\\": \\"true\\"\\n },\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"ErrorCode\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'CreateInstance', + 'description' => '><warning>'."\n" + ."\n" + .'This API operation incurs fees. Before you call this operation, make sure that you fully understand the billing methods and pricing of Hologres.'."\n" + ."\n" + .'></warning>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- For more information about the billing of Hologres, see [Billing overview](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- For more information about the billing of Hologres, see [Billing overview](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- When you create a Hologres instance, you must specify the region and zone for the instance. A region can contain multiple zones. The following list describes the zones that are available in each region:'."\n" + ."\n" + .'```'."\n" + .' cn-hangzhou (Hangzhou): cn-hangzhou-h, cn-hangzhou-j, cn-hangzhou-k'."\n" + .' cn-hangzhou (Hangzhou): cn-hangzhou-h, cn-hangzhou-j, cn-hangzhou-k'."\n" + .' cn-shanghai (Shanghai): cn-shanghai-e, cn-shanghai-f, cn-shanghai-l'."\n" + .' cn-beijing (Beijing): cn-beijing-i, cn-beijing-g, cn-beijing-l'."\n" + .' cn-zhangjiakou (Zhangjiakou): cn-zhangjiakou-b'."\n" + .' cn-shenzhen (Shenzhen): cn-shenzhen-d, cn-shenzhen-f, cn-shenzhen-e'."\n" + .' cn-wulanchabu (Ulanqab): cn-wulanchabu-a'."\n" + .' cn-hongkong (Hong Kong): cn-hongkong-b, cn-hongkong-d'."\n" + .' cn-shanghai-finance-1 (Shanghai Finance Cloud): cn-shanghai-finance-1z, cn-shanghai-finance-1f'."\n" + .' cn-hangzhou-finance (Hangzhou Finance Cloud): cn-hangzhou-finance-k'."\n" + .' cn-shenzhen-finance-1 (Shenzhen Finance Cloud): cn-shenzhen-finance-1d'."\n" + .' ap-northeast-1 (Tokyo): ap-northeast-1a'."\n" + .' ap-southeast-1 (Singapore): ap-southeast-1c, ap-southeast-1a'."\n" + .' ap-southeast-3 (Kuala Lumpur): ap-southeast-3b'."\n" + .' ap-southeast-5 (Jakarta): ap-southeast-5b'."\n" + .' eu-central-1 (Frankfurt): eu-central-1a'."\n" + .' us-east-1 (Virginia): us-east-1a'."\n" + .' us-west-1 (Silicon Valley): us-west-1b'."\n" + .' '."\n" + .'```', + 'responseParamsDescription' => '> - If a parameter verification error occurs, a Data response is still returned. In this case, the value of the Success parameter is false, and the Code and Message parameters are included. Unless an exception is thrown, you can determine whether the call is successful based on the value of Data.Success.'."\n" + .'>'."\n" + .'> - When you use the latest software development kit (SDK) to call this API operation, a timeout error may be returned. This occurs because the default timeout period of the client in the SDK is different from that of the server. This error can be returned even if the operation was successfully called. To prevent this issue, you can set the ReadTimeout parameter to 20000 before you make the call.'."\n" + ."\n" + .'', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], - 'GrantSchemaPermission' => [ - 'summary' => 'DB授权', - 'path' => '/api/v1/instances/{instanceId}/grantSchemaPermission', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateManualBackup' => [ + 'summary' => 'Creates a manual backup for an instance.', + 'path' => '/api/v1/backups/manual', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-721344a2z001', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5C11C8CB-9851-504D-8A41-3CF5F4FC0358'], + 'Data' => [ + 'description' => 'The result of the operation.', + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failed'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failed'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response.', + 'example' => '', + ], + ], ], - 'operationType' => 'read', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateManualBackup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C11C8CB-9851-504D-8A41-3CF5F4FC0358\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'CreateModelService' => [ + 'summary' => 'Creates a model service that allows AI functions to invoke models. You can create a service for two types of models: a model from Alibaba Cloud Model Studio or a model on a Hologres AI node. If you use a Hologres AI node, you must purchase the AI node resources separately.', + 'path' => '/api/v1/instances/{instanceId}/createModelService', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-lbj33559xxxx', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'hgpostcn-cn-lbj335xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'databaseName' => [ - 'description' => '', + 'modelType' => ['description' => 'The name of the model. To find the name, call `ListModelCatalog` for a model from Alibaba Cloud Model Studio, or `GetAvailableModelsResource` for a model on a Hologres AI node.', 'type' => 'string', 'required' => true, 'example' => 'qwen3.5-plus', 'title' => ''], + 'cpu' => ['description' => 'The number of vCPUs. This parameter is required only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16', 'title' => ''], + 'memory' => ['description' => 'The memory size in GB. This parameter is required only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64', 'title' => ''], + 'gpu' => ['description' => 'The number of GPUs. This parameter is required only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'serviceCount' => ['description' => 'The number of replicas. This parameter is required only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + 'modelServiceName' => ['description' => 'A custom name for the model service.', 'type' => 'string', 'required' => true, 'example' => 'my_model', 'title' => ''], + 'gpuMemory' => ['description' => 'The GPU memory size in GB. This parameter is required only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64', 'title' => ''], + 'taskType' => ['description' => 'The type of task the model performs, such as `chat/completions` or `embedding`. To find the supported task types, see the output of the `ListModelCatalog` operation.', 'type' => 'string', 'required' => false, 'example' => 'embedding', 'title' => ''], + 'provider' => [ + 'description' => 'The provider of the underlying model.', + 'enumValueTitles' => ['hologres' => 'Hologres', 'bailian' => 'Alibaba Cloud Model Studio'], 'type' => 'string', 'required' => false, - 'example' => 'db_demo', - ], - 'privileges' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'developer', - ], - 'required' => false, - ], - 'userName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'p4_134xxx', - ], - 'schemaName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'my_schema', + 'example' => 'bailian', + 'title' => '', ], + 'apiKey' => ['description' => 'The API key for Alibaba Cloud Model Studio. This parameter is required only for Model Studio models. You can obtain this key from the Model Studio console or by calling an API.', 'type' => 'string', 'required' => false, 'example' => 'api-key-xxx', 'title' => ''], + 'modelParams' => ['description' => 'The model parameters, required only for Model Studio models. You can provide the default parameters returned by the `ListModelCatalog` operation or a modified version of them.', 'type' => 'string', 'required' => false, 'example' => '{"timeout":600,"max_retries":10,"max_retry_delay":8,"initial_retry_delay":0.5}', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -785,193 +871,301 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n", - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'Indicates whether the operation was successful. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateModelService', + 'description' => 'To create a model service, you must specify several parameters. Use the `ListModelCatalog` operation to find the parameters for a model from Alibaba Cloud Model Studio, and use the `GetAvailableModelsResource` operation for a model on a Hologres AI node.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', ], - 'GrantDatabasePermission' => [ - 'summary' => 'DB授权', - 'path' => '/api/v1/instances/{instanceId}/grantDatabasePermission', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateUser' => [ + 'path' => '/api/v1/instances/{instanceId}/createUser', + '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' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426vm002', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'userName' => ['description' => 'The user name. Only RAM users and STS accounts are supported. The user name must be prefixed with "p4\\_" for RAM users (e.g., p4\\_234253434) and "v4\\_" for STS accounts (e.g., v4\\_3234134).', 'type' => 'string', 'required' => false, 'example' => 'p4_2346134', 'title' => ''], + 'superUser' => ['description' => 'Specifies whether the user is a superuser.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'hgpostcn-cn-zpr3426vm002', + 'title' => '', + 'example' => '', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'Success' => ['description' => 'Indicates whether the operation succeeded. A value of "true" indicates success, and "false" indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Returns true on success and false on failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'The response.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateUser', + 'summary' => 'Adds a RAM user or an STS account to a Hologres instance. Once added, the account can be used to log on to the instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'CreateWarehouse' => [ + 'summary' => 'Creates a warehouse.', + 'path' => '/api/v1/warehouse/{instanceId}/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-j672yny9g001', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'databaseName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], - 'privileges' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'developer', - ], - 'required' => false, - ], - 'userName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'p4_123444xxx', - ], + 'warehouseName' => ['description' => 'The warehouse name.', 'type' => 'string', 'required' => false, 'example' => 'warehouse-test', 'title' => ''], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'required' => false, 'example' => '32', 'title' => ''], + 'config' => ['description' => 'The configuration settings.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'], + 'Data' => [ + 'description' => 'The result of the creation operation. `true` indicates success, and `false` indicates failure.', + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failure'], + 'type' => 'boolean', 'example' => 'true', + 'title' => '', ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the API call was successful. This does not reflect the outcome of the business operation.', + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failure'], 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', 'example' => 'true', + 'title' => '', ], + 'ErrorMessage' => ['description' => 'The error message for a failed request.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateWarehouse', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorMessage\\": \\"null\\"\\n}","type":"json"}]', + ], + 'CreateWarehouseScheduleTask' => [ + 'path' => '/api/v1/instances/{instanceId}/createWarehouseScheduleTask', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Hologres instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'warehouseId' => ['description' => 'The ID of the warehouse.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => ''], + 'startTime' => ['description' => 'The UTC start time of the task, in ISO 8601 format.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + 'endTime' => ['description' => 'The UTC end time of the task, in ISO 8601 format.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + 'elasticCu' => ['description' => 'The number of elastic compute units.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => ''], + 'description' => ['description' => 'A description of the warehouse schedule task.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The request body.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Data' => ['description' => 'The ID of the created warehouse schedule task.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateWarehouseScheduleTask', + 'summary' => 'Creates a warehouse schedule task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\"\\n}","type":"json"}]', ], - 'CreateInstance' => [ - 'summary' => 'Creates a Hologres instance.', - 'path' => '/api/v1/instances/create', - 'methods' => [ - 'post', + 'DeleteBackupData' => [ + 'summary' => 'Deletes a backup.', + 'path' => '/api/v1/backups/{id}/delete', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the backup.', 'type' => 'string', 'required' => false, 'example' => '1597409847370362881', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '1907BA1B-B443-5B39-8113-7F3E260DC20D'], + 'Data' => [ + 'description' => 'The result of the operation.', + 'enumValueTitles' => ['true' => 'The operation was successful.', 'false' => 'The operation failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteBackupData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1907BA1B-B443-5B39-8113-7F3E260DC20D\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'DeleteHoloWarehouse' => [ + 'summary' => 'Deletes a virtual warehouse.', + 'path' => '/api/v1/instances/{instanceId}/deleteHoloWarehouse', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -979,253 +1173,26 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREhologramUCU2YC', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'The ID of the region. You can obtain region IDs in [Endpoints](https://www.alibabacloud.com/help/en/maxcompute/user-guide/endpoints).', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'zoneId' => [ - 'description' => 'The ID of the zone. For more information, see the "Operation description" section in this topic.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-h', - ], - 'vpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC). The region in which the VPC resides must be the same as the region in which the Hologres instance resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-t4netc3y5xxxx', - ], - 'vSwitchId' => [ - 'description' => 'The ID of the vSwitch. The zone in which the vSwitch resides must be the same as the zone in which the Hologres instance resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-2vccsiymtxxxxxx', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group. If you do not specify this parameter, the default resource group of the account is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'instanceName' => [ - 'description' => 'The name of the instance. The name must be 2 to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_holo', - ], - 'instanceType' => [ - 'description' => 'The category of the instance. Valid values:'."\n" - ."\n" - .'* Standard: general-purpose instance'."\n" - .'* Follower: read-only secondary instance'."\n" - .'* Warehouse: virtual warehouse instance'."\n" - .'* Shared: Hologres Shared Cluster instance'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Warehouse' => 'Warehouse', - 'Follower' => 'Follower', - 'Standard' => 'Standard', - 'Shared' => 'Shared', - ], - 'example' => 'Standard', - 'enum' => [ - 'Standard', - 'Follower', - 'Warehouse', - 'Shared', - ], - ], - 'cpu' => [ - 'description' => 'The instance specifications. Valid values:'."\n" - ."\n" - .'* 8-core 32GB (number of compute nodes: 1)'."\n" - .'* 32-core 128GB (number of compute nodes: 2)'."\n" - .'* 64-core 256GB (number of compute nodes: 4)'."\n" - .'* 96-core 384GB (number of compute nodes: 6)'."\n" - .'* 128-core 512GB (number of compute nodes: 8)'."\n" - .'* Others'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* Set this parameter to the number of cores.'."\n" - ."\n" - .'* If you want to set this parameter to specifications with more than 1,024 GB, you must submit a ticket.'."\n" - ."\n" - .'* This parameter is invalid for Hologres Shared Cluster instances.'."\n" - ."\n" - .'* The specifications of 8-core 32GB (number of compute nodes: 1) are for trial use only and cannot be used for production.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '64', - ], - 'storageSize' => [ - 'description' => 'The standard storage space of the instance. Unit: GB.'."\n" - ."\n" - .'> This parameter is invalid for pay-as-you-go instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '500', - ], - 'coldStorageSize' => [ - 'description' => 'The infrequent access (IA) storage space of the instance. Unit: GB.'."\n" - ."\n" - .'> This parameter is invalid for pay-as-you-go instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '500', - ], - 'gatewayCount' => [ - 'description' => 'The number of gateways. Valid values: 2 to 50.'."\n" - ."\n" - .'> This parameter is required only for virtual warehouse instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '50', - 'minimum' => '2', - 'example' => '4', - ], - 'chargeType' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* PrePaid: subscription'."\n" - .'* PostPaid: pay-as-you-go'."\n" - ."\n" - .'> This parameter is invalid for Hologres Shared Cluster instances. Hologres Shared Cluster instances have fixed specifications and are pay-as-you-go instances.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'PostPaid' => 'PostPaid', - 'PrePaid' => 'PrePaid', - ], - 'example' => 'PostPaid', - 'enum' => [ - 'PrePaid', - 'PostPaid', - ], - ], - 'autoPay' => [ - 'description' => 'Specifies whether to enable auto-payment. Default value: true. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'> The default value is true. If the balance of your account is insufficient, you can set this parameter to false. In this case, an unpaid order is generated. You can log on to the Expenses and Costs console to pay for the order.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'pricingCycle' => [ - 'description' => 'The billing cycle. Valid values:'."\n" - ."\n" - .'* Month'."\n" - .'* Hour'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter can only be set to Month for subscription instances.'."\n" - ."\n" - .'* This parameter can only be set to Hour for pay-as-you-go instances.'."\n" - ."\n" - .'* By default, this parameter is set to Hour for Hologres Shared Cluster instances.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Month' => 'Month', - 'Hour' => 'Hour', - ], - 'example' => 'Month', - 'enum' => [ - 'Month', - 'Hour', - ], - ], - 'duration' => [ - 'description' => 'The validity period of the instance that you want to purchase. For example, you can specify a validity period of two months.'."\n" - ."\n" - .'> You do not need to configure this parameter for pay-as-you-go instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'autoRenew' => [ - 'description' => 'Specifies whether to enable monthly auto-renewal. The default value is false. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'leaderInstanceId' => [ - 'description' => 'The ID of the primary instance. This parameter is required for read-only secondary instances.'."\n" - ."\n" - .'> The primary and secondary instances must meet the following requirements:'."\n" - ."\n" - .'* The primary instance is in the Running state.'."\n" - ."\n" - .'* The primary instance and secondary instances are deployed in the same region.'."\n" - ."\n" - .'* The primary instance and secondary instances are deployed in the same zone.'."\n" - ."\n" - .'* Less than 10 secondary instances are associated with the primary instance.'."\n" - ."\n" - .'* The primary instance and secondary instances belong to the same Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-lbj3aworq112', - ], - 'initialDatabases' => [ - 'description' => 'The initial database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'chatbot', - ], - 'enableServerlessComputing' => [ - 'description' => 'Specifies whether to enable the Serverless Computing feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'storageType' => [ - 'type' => 'string', - ], + 'name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'my_warehouse', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -1233,107 +1200,44 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9CC37B9F-F4B4-5FF1-939B-AEE78DC70130', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'hgpostcn-cn-xxxxxx', - ], - 'OrderId' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '217523224780172', - ], - 'Code' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'InvalidVpcOrVSwitch.NotAvailable', - ], - 'Message' => [ - 'description' => 'The error details.'."\n", - 'type' => 'string', - 'example' => 'Vpc is not available', - ], - 'Success' => [ - 'description' => 'Indicates whether the instance was created.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'true: The request was successful. false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteHoloWarehouse', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHoloWarehouse'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CC37B9F-F4B4-5FF1-939B-AEE78DC70130\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"hgpostcn-cn-xxxxxx\\",\\n \\"OrderId\\": \\"217523224780172\\",\\n \\"Code\\": \\"InvalidVpcOrVSwitch.NotAvailable\\",\\n \\"Message\\": \\"InvalidVpcOrVSwitch.NotAvailable\\\\n\\",\\n \\"Success\\": \\"true\\"\\n },\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"ErrorCode\\": \\"null\\"\\n}","type":"json"}]', - 'title' => 'CreateInstance', - 'description' => '> Before you call this operation, make sure that you understand the billing method and pricing of Hologres because this operation is charged.'."\n" - ."\n" - .'* For more information about the billing details of Hologres, see [Pricing](https://www.alibabacloud.com/help/en/hologres/developer-reference/api-hologram-2022-06-01-createinstance).'."\n" - .'* When you purchase a Hologres instance, you must specify the region and zone in which the Hologres instance resides. A region may correspond to multiple zones. Example:'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' cn-hangzhou: cn-hangzhou-h, cn-hangzhou-j'."\n" - .' cn-shanghai: cn-shanghai-e, cn-shanghai-f'."\n" - .' cn-beijing: cn-beijing-i, cn-beijing-g'."\n" - .' cn-zhangjiakou: cn-zhangjiakou-b'."\n" - .' cn-shenzhen: cn-shenzhen-e'."\n" - .' cn-hongkong: cn-hongkong-b'."\n" - .' cn-shanghai-finance-1: cn-shanghai-finance-1z'."\n" - .' ap-northeast-1: ap-northeast-1a'."\n" - .' ap-southeast-1: ap-southeast-1c'."\n" - .' ap-southeast-3: ap-southeast-3b'."\n" - .' ap-southeast-5: ap-southeast-5b'."\n" - .' ap-south-1: ap-south-1b'."\n" - .' eu-central-1: eu-central-1a'."\n" - .' us-east-1: us-east-1a'."\n" - .' us-west-1: us-west-1b', - 'responseParamsDescription' => 'If parameter verification fails, data is returned. In the returned data, Success is set to false, and the Code and Message parameters are included. The value of HttpStatusCode is 200.', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], 'DeleteInstance' => [ - 'summary' => 'Deletes a Hologres instance.', + 'summary' => 'Releases an instance.', 'path' => '/api/v1/instances/{instanceId}/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1341,372 +1245,578 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the Hologres instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-7mz2vmu30003', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hgpostcn-cn-7mz2vmu30003'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CB13FFDD-2DF8-5396-A848-2D6A31245B6D', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CB13FFDD-2DF8-5396-A848-2D6A31245B6D'], 'Data' => [ - 'description' => 'The returned result, which indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", + 'description' => 'The returned result.', 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'The operation is successful.', 'false' => 'The operation failed.'], + 'title' => '', 'example' => 'true', ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status Code'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB13FFDD-2DF8-5396-A848-2D6A31245B6D\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'DeleteInstance', - 'description' => '> Before you call this operation, read the documentation and make sure that you understand the prerequisites and impacts of this operation.'."\n" + 'title' => 'Delete an instance', + 'description' => '><warning>'."\n" + ."\n" + .'Before you call this operation, make sure that you understand its prerequisites and consequences.'."\n" + ."\n" + .'></warning>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- After a Hologres instance is released, its data and objects cannot be recovered. Proceed with caution. For more information, see [Billing overview](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.0.7d413e94YMVcqe).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" ."\n" - .'* After you delete a Hologres instance, data and objects in the instance cannot be restored. Proceed with caution. For more information, see [Billing overview](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview?spm=a2c63.p38356.0.0.efc33b87i5pDl7).'."\n" - .'* You can delete only pay-as-you-go instances.'."\n", + .'- After a Hologres instance is released, its data and objects cannot be recovered. Proceed with caution. For more information, see [Billing overview](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview?spm=a2c63.p38356.0.0.efc33b87i5pDl7).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- This operation applies only to pay-as-you-go instances.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- To unsubscribe from a subscription instance, go to the Unsubscribe page in the Alibaba Cloud console. For more information, see [Unsubscribe from a subscription instance](https://help.aliyun.com/zh/hologres/product-overview/subscription?spm=a2c4g.11186623.0.0.799b69ecPba0y1).'."\n" + ."\n" + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], ], - 'RenewInstance' => [ - 'summary' => 'Manually renews a Hologres instance. You can enable monthly auto-renewal when you renew a Hologres instance.', - 'path' => '/api/v1/instances/{instanceId}/renew', - 'methods' => [ - 'post', + 'DeleteModelResource' => [ + 'summary' => 'Deletes a model resource. This action permanently deletes all models deployed on the node.', + 'path' => '/api/v1/instances/{instanceId}/deleteModelResource', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucxxxx', 'title' => ''], + ], + [ + 'name' => 'aiInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The AI node instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hologram_aicombo_public_cn-yi34cxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'Returns `true` if the operation was successful and `false` otherwise.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteModelResource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'DeleteModelService' => [ + 'summary' => 'Deletes a specified model service.', + 'path' => '/api/v1/instances/{instanceId}/deleteModelService', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'modelServiceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the model service.', 'type' => 'string', 'required' => false, 'example' => 'model-qwen', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'Indicates whether the request was successful. A value of true indicates that the request was successful. A value of false indicates that the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteModelService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'DeleteWarehouseScheduleTask' => [ + 'summary' => 'Deletes a warehouse schedule task.', + 'path' => '/api/v1/instances/{instanceId}/deleteWarehouseScheduleTask', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'duration' => [ - 'description' => 'The renewal duration. Unit: month.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'autoRenew' => [ - 'description' => 'Specifies whether to enable monthly auto-renewal. The default value is false. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'> If you enable auto-renewal for an instance for which auto-renewal is enabled, an error is reported.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'warehouseId' => ['description' => 'The ID of the warehouse.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'id' => ['description' => 'The ID of the time-sharing elastic scaling plan.', 'type' => 'string', 'required' => true, 'example' => '2034449120420339713', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'InvalidChargeType.UnRenewable', - ], - 'Message' => [ - 'description' => 'The error details.'."\n", - 'type' => 'string', - 'example' => 'InvalidChargeType.UnRenewable'."\n", - ], - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '221625608580893', - ], - 'Success' => [ - 'description' => 'Indicates whether the renewal was successful.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'The request result, which indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'false', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'D1303CD4-AA70-5998-8025-F55B22C50840'], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => 'The response.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": {\\n \\"Code\\": \\"InvalidChargeType.UnRenewable\\",\\n \\"Message\\": \\"不支持续费的付费类型\\",\\n \\"OrderId\\": \\"221625608580893\\",\\n \\"Success\\": true\\n },\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"false\\"\\n}","type":"json"}]', - 'title' => 'RenewInstance', - 'description' => '> Before you call this operation, make sure that you understand the billing method and pricing of Hologres because this operation is charged.'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteWarehouseScheduleTask', + 'description' => '><warning>'."\n" + ."\n" + .'Before calling this operation, review the feature documentation to understand its prerequisites and impact.'."\n" + ."\n" + .'></warning>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- After a warehouse schedule task is deleted, it cannot be recovered. Proceed with caution.[](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.0.7d413e94YMVcqe)'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- After a warehouse schedule task is deleted, it cannot be recovered. Proceed with caution.[](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview?spm=a2c63.p38356.0.0.efc33b87i5pDl7)'."\n" ."\n" - .'* For more information about the billing of Hologres, see [Billing overview](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview).'."\n" - .'* For more information about how to renew a Hologres instance, see [Manage renewals](https://www.alibabacloud.com/help/zh/hologres/product-overview/manage-renewals?spm=a2c63.p38356.0.0.38e731c9VAwtDP).'."\n" - .'* You can renew only subscription instances.'."\n", - 'responseParamsDescription' => '> '."\n" + .'</props>'."\n" + ."\n\n" + .'- This operation is not limited to pay-as-you-go (PostPaid) instances.'."\n" ."\n" - .'* If parameter verification fails, data is returned. In the returned data, Success is set to false, and the Code and Message parameters are included. If no exception is returned, the result of this operation is indicated by the value of Success in the returned data.'."\n" + .'<props="china">'."\n" ."\n" - .'* In the latest version of SDK, the default timeout period on the client side is different from the default timeout period on the instance. If you use the latest version of SDK to call this operation, a timeout may be reported even if this operation is successfully called. To prevent this issue, you can set the ReadTimeout parameter to 20000 before you call this operation.'."\n" + .'- This operation does not unsubscribe from a subscription (PrePaid) instance. To do so, go to the Alibaba Cloud Unsubscription page. For more information, see [Unsubscribe from a subscription instance](https://help.aliyun.com/zh/hologres/product-overview/subscription?spm=a2c4g.11186623.0.0.799b69ecPba0y1).'."\n" ."\n" - .''."\n", + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1303CD4-AA70-5998-8025-F55B22C50840\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], - 'RestartInstance' => [ - 'summary' => 'Restarts an instance.', - 'path' => '/api/v1/instances/{instanceId}/restart', - 'methods' => [ - 'post', + 'DescribeTags' => [ + 'summary' => 'Lists all tags.', + 'path' => '/api/v1/tag', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'tagsOnly', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return tags.', + 'enumValueTitles' => ['true' => 'Returns tags.', 'false' => 'Does not return tags.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '14E2358E-0499-509E-8E22-CA30EC474A9A'], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded. This parameter is independent of the business logic.', + 'enumValueTitles' => ['true' => 'The request was successful.', 'false' => 'The request failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'TagResources' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hgprecn-cn-0ju2uaanj001', 'title' => ''], + 'ResourceType' => [ + 'description' => 'The resource type.', + 'enumValueTitles' => ['Instance' => 'An instance.'], + 'type' => 'string', + 'example' => 'Instance', + 'title' => '', + ], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'acs:rm:rgId', 'title' => ''], + 'TagValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'rg-acfm4lsp23l7jti', 'title' => ''], + 'description' => 'A list of values for the corresponding tag key.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of resources.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeTags', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14E2358E-0499-509E-8E22-CA30EC474A9A\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"hgprecn-cn-0ju2uaanj001\\",\\n \\"ResourceType\\": \\"Instance\\",\\n \\"TagKey\\": \\"acs:rm:rgId\\",\\n \\"TagValue\\": [\\n \\"rg-acfm4lsp23l7jti\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DisableExecuteStatement' => [ + 'summary' => 'Shuts down the ExecuteStatement API access permissions for a specified Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/disableExecuteStatement', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The Hologres instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-xxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgprecn-cn-i7m2ucpyu005', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E3F4B2A7-1234-5678-9ABC-DEF012345678'], + 'data' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + .'- true: The operation is successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'errorCode' => ['description' => 'The error code. This parameter is empty if the operation is successful.', 'type' => 'string', 'example' => 'InvalidParameterValue', 'title' => ''], + 'errorMessage' => ['description' => 'The error message. This parameter is empty if the operation is successful.', 'type' => 'string', 'title' => '', 'example' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Disable the executeStatement feature for an instance', + 'description' => 'Disables the OpenAPI SQL execution feature for a specified Hologres instance. After the feature is disabled, all ExecuteStatement calls return an error. You can call EnableExecuteStatement to re-enable the feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E3F4B2A7-1234-5678-9ABC-DEF012345678\\",\\n \\"data\\": false,\\n \\"success\\": false,\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"\\",\\n \\"httpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'DisableHiveAccess' => [ + 'summary' => 'Disables data lake acceleration.', + 'path' => '/api/v1/instances/{instanceId}/disableHiveAccess', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-beijing'], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hgprecn-cn-tl330rv9k00e'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36291497-CDB0-53DC-8CD7-762E054F57A6', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '82B7A554-4D00-50DF-95D9-B59E7B4D5489'], 'Data' => [ - 'description' => 'Indicates whether the operation was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'The result.', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failed'], + 'title' => '', 'example' => 'true', ], 'Success' => [ - 'description' => 'The request result, which indicates whether the request was successful.'."\n", + 'description' => 'The result of the request.', 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'Request succeeded.', 'false' => 'Request failed.'], + 'title' => '', 'example' => 'true', ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '404'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Internal server error.'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82B7A554-4D00-50DF-95D9-B59E7B4D5489\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'DisableHiveAccess', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHiveAccess'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:DisableHiveAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36291497-CDB0-53DC-8CD7-762E054F57A6\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'RestartInstance', ], - 'ResumeInstance' => [ - 'summary' => 'Resumes an instance.', - 'path' => '/api/v1/instances/{instanceId}/resume', - 'methods' => [ - 'post', + 'DisableOperationEvent' => [ + 'summary' => '', + 'path' => '/api/v1/instances/{instanceId}/disableOperationEvent', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '1980869072412614657', 'title' => ''], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'Data' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'DisableSSL' => [ + 'summary' => 'Disables SSL encryption for a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/disableSSL', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1715,81 +1825,182 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram5MV4AO'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-lbj33559x001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-j672yny9g001', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'Data' => ['description' => 'The result of the operation. `true` indicates success. `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: `true` and `false`.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The schema of response.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DisableSSL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:DisableSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'DisableSupportAccount' => [ + 'summary' => 'Disables a Support Account.', + 'path' => '/api/v1/instances/{instanceId}/supportAccount/disable', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-7mz2vmu30003', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70', - ], - 'Data' => [ - 'description' => 'The returned result, which indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'The request result, which indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'The result of the operation, returned as a string. Valid values are `true` and `false`.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DisableSupportAccount', + 'description' => 'Disables the execution of SQL statements through OpenAPI for a specified Hologres instance. After this feature is disabled, all `ExecuteStatement` calls return an error. You can call the `EnableExecuteStatement` operation to re-enable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'ResumeInstance', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": \\"true\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'UpdateInstanceName' => [ - 'summary' => 'Changes the name of an instance.', - 'path' => '/api/v1/instances/{instanceId}/instanceName', - 'methods' => [ - 'post', + 'DisableWarehouseAutoScale' => [ + 'path' => '/api/v1/instances/{instanceId}/disableWarehouseAutoScale', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08xxxxx'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The compute group name.', 'type' => 'string', 'required' => false, 'example' => 'my_warehouse', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'Indicates whether the operation was successful. `true` indicates success; `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'Response schema', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DisableWarehouseAutoScale', + 'summary' => 'Disables autoscale for a specified compute group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'DiscardUpgrade' => [ + 'path' => '/api/v1/instances/{instanceId}/upgrade/discard', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1798,143 +2009,327 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-1wy47xsoxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-zpr30pupt004', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A47D57BE-59D1-51A6-9CC3-080C07852C4E'], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ReasonKey' => ['description' => 'The reason key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'FailReason' => ['description' => 'The reason the upgrade failed.', 'type' => 'string', 'example' => 'null', 'title' => ''], + ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the API request itself was successful. This does not reflect the outcome of the operation. For the operation\'s result, see the Success field in the Data array.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], + ], + 'title' => 'DiscardUpgrade', + 'summary' => 'Cancels an upgrade. You can call this operation only if the upgrade task has not started or is in the `pre_check` state. You cannot cancel the upgrade after the task enters the `backup` state or any subsequent state.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A47D57BE-59D1-51A6-9CC3-080C07852C4E\\",\\n \\"Data\\": [\\n {\\n \\"Success\\": true,\\n \\"ReasonKey\\": \\"null\\",\\n \\"FailReason\\": \\"null\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'DropUser' => [ + 'path' => '/api/v1/instances/{instanceId}/dropUser', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Hologres instance.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'instanceName' => [ - 'description' => 'The new name of the instance. The name must be 2 to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'new_name', - ], + 'userName' => ['description' => 'The user name. Only RAM users and STS accounts are supported. Prefix the name with "p4\\_" for a RAM user (for example, p4\\_234253434) or "v4\\_" for an STS account (for example, v4\\_3234134).', 'type' => 'string', 'required' => false, 'example' => 'p4_234253434', 'title' => ''], + 'superUser' => ['description' => 'Specifies whether the user is a superuser.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EA8F0084-5831-5907-BB31-BD05D2617844'], + 'Success' => ['description' => 'Indicates whether the request was successful. A value of "true" indicates success, and "false" indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the deletion. A value of true indicates success, and a value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DropUser', + 'summary' => 'Deletes a RAM user or an STS account from a Hologres instance. Once deleted, the user can no longer log in to the instance. To restore access, call the CreateUser operation to add the user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA8F0084-5831-5907-BB31-BD05D2617844\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'EnableExecuteStatement' => [ + 'path' => '/api/v1/instances/{instanceId}/enableExecuteStatement', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Hologres instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-xxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E3F4B2A7-1234-5678-9ABC-DEF012345678'], + 'data' => ['description' => 'The result of the operation, where `true` indicates success and `false` indicates failure.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'errorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'InvalidParameterValue', 'title' => ''], + 'errorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '错误信息示例', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response parameters.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'EnableExecuteStatement', + 'summary' => 'Enables SQL execution via OpenAPI for a specified Hologres instance.', + 'description' => 'Enables SQL execution via OpenAPI for a specified Hologres instance. Once enabled, RAM accounts with the `hologram:ExecuteStatement` permission can execute SQL statements by calling the `ExecuteStatement` API. To query the current status, call the `GetExecuteStatementEnabled` API. To disable the feature, call the `DisableExecuteStatement` API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E3F4B2A7-1234-5678-9ABC-DEF012345678\\",\\n \\"data\\": false,\\n \\"success\\": false,\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"错误信息示例\\",\\n \\"httpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'EnableHiveAccess' => [ + 'summary' => 'Enables data lake acceleration for a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/enableHiveAccess', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426vm002', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C6B55032-D41A-5FE0-9C07-8BD81C88422E', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EA8F0084-5831-5907-BB31-BD05D2617844'], 'Data' => [ - 'description' => 'The returned result, which indicates whether the operation was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'The request result, which indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'The result of the operation.', + 'enumValueTitles' => ['true' => 'The operation was successful.', 'false' => 'The operation failed.'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'true', + 'title' => '', ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA8F0084-5831-5907-BB31-BD05D2617844\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'EnableHiveAccess', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHiveAccess'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:EnableHiveAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C6B55032-D41A-5FE0-9C07-8BD81C88422E\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'UpdateInstanceName', ], - 'UpdateInstanceNetworkType' => [ - 'summary' => 'Modifies the network configuration of an instance.', - 'path' => '/api/v1/instances/{instanceId}/network', - 'methods' => [ - 'post', + 'EnableSSL' => [ + 'summary' => 'Enables SSL encryption for a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/enableSSL', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-7mz2vmu30003', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'EnableSSL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:EnableSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'EnableSupportAccount' => [ + 'path' => '/api/v1/instances/{instanceId}/supportAccount/enable', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1942,435 +2337,1021 @@ ], 'operationType' => 'read', 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-7mz2vmu30003', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'password' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'required' => false, 'example' => '2023-03-24 11:19:05', 'title' => ''], + 'enabled' => ['description' => 'This parameter is deprecated.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'AB71198A-2DB1-511B-AE4D-690BAA97F076'], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. This is independent of the operation\'s result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'EnableSupportAccount', + 'summary' => 'Enables a support account.', + 'description' => 'This operation lets you execute SQL statements on a specified Hologres instance through OpenAPI. After this feature is enabled, a RAM account with the `hologram:ExecuteStatement` permission can call the `ExecuteStatement` operation. You can call GetExecuteStatementEnabled to query the current status and DisableExecuteStatement to disable this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AB71198A-2DB1-511B-AE4D-690BAA97F076\\",\\n \\"Data\\": \\"true\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'EnableWarehouseAutoScale' => [ + 'path' => '/api/v1/instances/{instanceId}/enableWarehouseAutoScale', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the warehouse.', 'type' => 'string', 'required' => false, 'example' => 'my_warehouse', 'title' => ''], + 'maxClusterCount' => ['description' => 'The maximum number of clusters. The value must be greater than the number of reserved clusters and less than or equal to 4.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'hgprecn-cn-lbj35pw74002', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'A value of `true` indicates success, while `false` indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'EnableWarehouseAutoScale', + 'summary' => 'Enables auto scaling for a warehouse.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ExecuteStatement' => [ + 'summary' => 'Executes an SQL statement synchronously on a specified database via OpenAPI and returns the result.', + 'path' => '/api/v1/instances/{instanceId}/executeStatement', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramE3EYZP'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucpyu005', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'networkTypes' => [ - 'description' => 'A list of network types that you want to enable. The network types are randomly ordered in the list. For example, the Internet, Intranet, and VPCSingleTunnel network types are enabled. If you want to disable the Internet type, set this parameter to Intranet,VPCSingleTunnel.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* VPCSingleTunnel: virtual private cloud (VPC).'."\n" - .'* Intranet: internal network.'."\n" - .'* VPCAnyTunnel: compatibility requirements. This value is not supported by new instances.'."\n" - .'* Internet: Internet.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'VPCSingleTunnel' => '', - 'Intranet' => '', - 'VPCAnyTunnel' => '', - 'Internet' => '', - ], - 'example' => 'Internet,VPCSingleTunnel', - ], - 'vpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-t4netc3y5etlondfb5ra7', - ], - 'vSwitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-2vccsiymtqr9aavew0vo3', - ], - 'vpcRegionId' => [ - 'description' => 'The region in which the VPC resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'vpcOwnerId' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the VPC belongs.'."\n", - 'type' => 'string', + 'dbName' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], + 'sql' => ['description' => 'The SQL statement to execute. The maximum length is 16,384 characters. You can specify multiple SQL statements separated by semicolons. If multiple statements are provided, the API returns the result of the last statement.', 'type' => 'string', 'required' => false, 'example' => 'select * from test_table limit 10;', 'title' => ''], + 'parameters' => [ + 'type' => 'array', + 'items' => ['description' => 'The value of a parameter.', 'type' => 'any', 'required' => false, 'example' => 'test_val', 'title' => ''], + 'description' => 'An array of bound parameters for a parameterized query. These parameters map sequentially to placeholders (e.g., `$1`, `$2`) in the SQL statement. Supported types include `String`, `Long`, `Double`, `Boolean`, and `null` (for SQL `NULL`). Using parameterized queries helps prevent SQL injection and improves the cache reuse rate for prepared statements. These parameters apply to all SQL statements in the sql field.', 'required' => false, - 'example' => '1999365732646672', - ], - 'anyTunnelToSingleTunnel' => [ - 'description' => 'Specifies whether to change the network type from AnyTunnel to SingleTunnel. This parameter is invalid for new instances. For new instances, this parameter is set to null by default.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* others/null: The network type is not changed from AnyTunnel to SingleTunnel.'."\n" - .'* true: The network type is changed from AnyTunnel to SingleTunnel.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'others/null' => '', - 'true' => '', - ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], + 'maxRows' => ['description' => 'The maximum number of rows to return. Default: 200. Maximum: 1,000. If the result set exceeds this limit, it is truncated, as indicated by the `Truncated` field in the response.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], + 'maxBytes' => ['description' => 'The maximum size of the response, in bytes. Default: 10,485,760 (10 MB). If the response size exceeds this limit, it is truncated, as indicated by the Truncated field in the response.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024', 'title' => ''], + 'queryTimeout' => ['description' => 'The query timeout, in seconds. Default: 30. Maximum: 30. Minimum: 1. If a query exceeds this time limit, the server cancels it.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9CC37B9F-F4B4-5FF1-939B-AEE78DC70130', - ], - 'Data' => [ - 'description' => 'The returned result, which indicates whether the operation was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'errorCode' => ['description' => 'The error code. This parameter is returned only if the request fails.', 'type' => 'string', 'example' => 'InvalidParameterValue', 'title' => ''], + 'errorMessage' => ['description' => 'The error message. This parameter is returned only if the request fails.', 'type' => 'string', 'example' => '参数值不合法（如 SQL 为空、超长等）', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'data' => [ + 'type' => 'object', + 'properties' => [ + 'success' => ['description' => 'Indicates whether the SQL statement was executed successfully.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'errorCode' => ['description' => 'The error code for the SQL statement execution. This parameter is returned only if the execution fails.', 'type' => 'string', 'example' => 'InvalidParameterValue', 'title' => ''], + 'errorMessage' => ['description' => 'The error message for the SQL statement execution. This parameter is returned only if the execution fails.', 'type' => 'string', 'example' => '参数值不合法（如 SQL 为空、超长等）', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'success' => ['description' => 'Indicates whether the SQL statement was executed successfully.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'sql' => ['description' => 'The executed SQL statement.', 'type' => 'string', 'example' => 'select * from test_table limit 10;', 'title' => ''], + 'count' => ['description' => 'The number of rows returned by a SELECT statement.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], + 'updateCount' => ['description' => 'The number of rows affected by an INSERT, UPDATE, or DELETE statement. This parameter is not returned for SELECT statements.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'truncated' => ['description' => 'Indicates whether the result set was truncated. The value is `true` if the number of returned rows exceeds the value of `MaxResults`.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'queryId' => ['description' => 'The ID of the query.', 'type' => 'string', 'example' => 'E3F4B2A7-1234-5678-9ABC-DEF012345678', 'title' => ''], + 'errorMessage' => ['description' => 'The error message for the SQL statement.', 'type' => 'string', 'example' => 'ERROR: relation \\"non_existent_table\\" does not exist\\n Position: 15', 'title' => ''], + 'errorCode' => ['description' => 'The error code for the SQL statement.', 'type' => 'string', 'example' => 'SQL_ERROR', 'title' => ''], + 'columnMetadata' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the column.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'type' => ['description' => 'The data type of the column, such as `int4`, `text`, or `bool`.', 'type' => 'string', 'example' => 'int4', 'title' => ''], + 'nullable' => ['description' => 'Indicates whether the column can be null.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => 'An object that contains the metadata for a single column.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The metadata of columns in the result set.', + 'title' => '', + 'example' => '', + ], + 'records' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'array', + 'items' => ['description' => 'A field value, returned as a string.', 'type' => 'string', 'example' => ' ["1", "Alice"]', 'title' => ''], + 'description' => 'An array that represents a single row in the result set.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The set of records that are returned by the query. Each row is an array of strings, and all values are serialized as strings. A NULL value is represented as "\\N".', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'An object that contains the result of a single SQL statement.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of execution results. This list always contains exactly one result object. If you execute multiple SELECT statements, only the result of the last one is returned.', + 'title' => '', + 'example' => '', + ], ], - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', + 'description' => 'The execution result of the SQL statement.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The result data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CC37B9F-F4B4-5FF1-939B-AEE78DC70130\\",\\n \\"Data\\": \\"true\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'UpdateInstanceNetworkType', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ExecuteStatement', + 'description' => 'Use this API to securely execute SQL statements on a Hologres instance through OpenAPI.'."\n" + ."\n" + .'Before using this API, ensure the following prerequisites are met:'."\n" + ."\n" + .'1. The "Allow SQL execution through OpenAPI" option is enabled on the "Data Security" tab of the instance details page in the console.'."\n" + ."\n" + .'2. The calling RAM account must have the hologram:ExecuteStatement permission.'."\n" + ."\n" + .'This API supports statements such as SELECT, DDL, and DML. It also supports parameterized queries with $1 and $2 placeholders to prevent SQL injection. By default, query results are limited to 200 rows (configurable up to 1,000) and 10 MB. Result sets that exceed these limits are truncated, and the `truncated` field in the response indicates if truncation occurred. The timeout for a single execution is 30 seconds.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"success\\": \\"True\\",\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"参数值不合法（如 SQL 为空、超长等）\\",\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"success\\": false,\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"参数值不合法（如 SQL 为空、超长等）\\",\\n \\"results\\": [\\n {\\n \\"success\\": true,\\n \\"sql\\": \\"select * from test_table limit 10;\\",\\n \\"count\\": 25,\\n \\"updateCount\\": 10,\\n \\"truncated\\": false,\\n \\"queryId\\": \\"E3F4B2A7-1234-5678-9ABC-DEF012345678\\",\\n \\"errorMessage\\": \\"ERROR: relation \\\\\\\\\\\\\\"non_existent_table\\\\\\\\\\\\\\" does not exist\\\\\\\\n Position: 15\\",\\n \\"errorCode\\": \\"SQL_ERROR\\",\\n \\"columnMetadata\\": [\\n {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"int4\\",\\n \\"nullable\\": false\\n }\\n ],\\n \\"records\\": [\\n [\\n \\" [\\\\\\"1\\\\\\", \\\\\\"Alice\\\\\\"]\\"\\n ]\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DisableHiveAccess' => [ - 'summary' => 'Disables data lake acceleration.', - 'path' => '/api/v1/instances/{instanceId}/disableHiveAccess', - 'methods' => [ - 'post', + 'GetCertificateAttribute' => [ + 'summary' => 'Retrieves the SSL certificate attributes of a Hologres instance, including SSL status and certificate expiration time.', + 'path' => '/api/v1/instances/{instanceId}/certificateAttribute', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426vm002', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'CertificateAttributeDto' => [ + 'type' => 'object', + 'properties' => [ + 'enableSSL' => ['description' => 'Specifies whether SSL is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'expirationTime' => ['description' => 'The UNIX timestamp when the certificate expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1790583135000', 'title' => ''], + 'status' => [ + 'description' => 'The status of the certificate.', + 'enumValueTitles' => ['ineffective' => 'Invalid', 'effective' => 'Valid'], + 'type' => 'string', + 'example' => 'effective', + 'title' => '', + ], + ], + 'description' => 'The certificate attributes.', + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCertificateAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetCertificateAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"CertificateAttributeDto\\": {\\n \\"enableSSL\\": true,\\n \\"expirationTime\\": 1790583135000,\\n \\"status\\": \\"effective\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'GetExecuteStatementEnabled' => [ + 'summary' => 'Checks whether a specified Hologres instance allows SQL execution through OpenAPI.', + 'path' => '/api/v1/instances/{instanceId}/executeStatementEnabled', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426vm002', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC'], + 'data' => ['description' => 'Indicates whether SQL execution through OpenAPI is allowed (`true`) or not (`false`).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'errorCode' => ['description' => '- The error code that is returned if the request fails (when `success` is `false`).'."\n" + ."\n" + .'- This parameter is empty if the request is successful (when `success` is `true`).', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'errorMessage' => ['description' => '- The error message that is returned if the request fails (when `success` is `false`).'."\n" + ."\n" + .'- This parameter is empty if the request is successful (when `success` is `true`).', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetExecuteStatementEnabled', + 'description' => 'This operation checks if the "Allow SQL execution through OpenAPI" feature is enabled for a specified Hologres instance. Returns `true` if the feature is enabled, and `false` otherwise. If enabled, you can call the `ExecuteStatement` operation to execute SQL statements.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC\\",\\n \\"data\\": true,\\n \\"success\\": true,\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"ok\\",\\n \\"httpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'GetHoloWebLoginSetting' => [ + 'path' => '/api/v1/instances/{instanceId}/getHoloWebLoginSetting', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgprecn-cn-tl330rv9k00e', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '82B7A554-4D00-50DF-95D9-B59E7B4D5489', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'], 'Data' => [ - 'description' => 'The returned result.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'type' => 'object', + 'properties' => [ + 'AllowExternalAccountsLogin' => ['description' => 'Indicates whether external accounts are allowed to log in.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the request was successful. This is independent of the operation\'s result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetHoloWebLoginSetting', + 'summary' => 'Gets the external account login setting for HoloWeb.', + 'description' => 'Checks whether external accounts are allowed to log in to HoloWeb for a specified Hologres instance. The operation returns `true` if external accounts are allowed and `false` otherwise.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": {\\n \\"AllowExternalAccountsLogin\\": true\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'GetInstance' => [ + 'summary' => 'Retrieves the details of an instance.', + 'path' => '/api/v1/instances/{instanceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramNRPSXG'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. Required.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08uu00a', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '865A02C2-B374-5DD4-9B34-0CA15DA1AEBD'], + 'Instance' => [ + 'description' => 'The instance details.', + 'type' => 'object', + 'properties' => [ + 'InstanceChargeType' => [ + 'description' => 'The billing method of the instance.', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go', 'PrePaid' => 'Subscription'], + 'type' => 'string', + 'example' => 'PrePaid', + 'title' => '', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code.', + 'enumValueTitles' => ['hologram_maxcomputeAccelerate_public_cn' => 'A shared cluster sold on the China site.', 'hologram_combo_public_cn' => 'A subscription instance on the China site.', 'hologram_prepay_public_intl' => 'A subscription instance sold on the International site.', 'hologram_storage_dp_cn' => 'A storage plan sold on the China site.', 'hologram_postpay_public_cn' => 'A pay-as-you-go instance sold on the China site.', 'hologram_postpay_public_intl' => 'A pay-as-you-go instance sold on the International site.', 'hologram_maxcomputeAccelerate_public_intl' => 'A shared cluster sold on the International site.', 'hologram_cu_dp_cn' => 'A compute plan sold on the China site.'], + 'type' => 'string', + 'example' => 'hologram_combo_public_cn', + 'title' => '', + ], + 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-02-03T13:06:06Z', 'title' => ''], + 'Disk' => ['description' => 'The size of the standard storage. Unit: GB.', 'type' => 'string', 'example' => '500', 'title' => ''], + 'Endpoints' => [ + 'description' => 'The list of endpoints.', + 'type' => 'array', + 'items' => [ + 'description' => 'The endpoint details.', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => ['description' => 'The domain name of the endpoint.', 'type' => 'string', 'example' => 'hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80', 'title' => ''], + 'Type' => [ + 'description' => 'The network type.', + 'enumValueTitles' => ['VPCSingleTunnel' => 'VPC', 'Intranet' => 'Internal network', 'VPCAnyTunnel' => '(Not supported for new instances)', 'Internet' => 'Public network'], + 'type' => 'string', + 'example' => 'Internet', + 'title' => '', + ], + 'Enabled' => [ + 'description' => 'Indicates whether the network is enabled.', + 'enumValueTitles' => ['true' => 'The network is enabled.', 'false' => 'The network is disabled.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1jqwp2ys6kp7tc9t983', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf66jjber3hgvwhki3wna', 'title' => ''], + 'VpcInstanceId' => ['description' => 'The VPC instance ID.', 'type' => 'string', 'example' => 'hgprecn-cn-uqm362o1b001-frontend-st', 'title' => ''], + 'AlternativeEndpoints' => ['description' => 'Some earlier instances have both AnyTunnel and SingleTunnel enabled. When you switch from AnyTunnel to SingleTunnel, the endpoints for both are retained. This field is used to store the extra endpoint.', 'type' => 'string', 'example' => 'hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ExpirationTime' => ['description' => 'The expiration time. Pay-as-you-go instances do not expire.', 'type' => 'string', 'example' => '2021-02-03T13:06:06Z', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hgpostcn-cn-tl32s6cgw00b', 'title' => ''], + 'InstanceName' => ['description' => 'The name of the instance. The name must be 2 to 64 characters in length. Each letter or Chinese character is counted as a single character.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'InstanceType' => [ + 'description' => 'The instance type.', + 'enumValueTitles' => ['Warehouse' => 'Virtual warehouse instance', 'Follower' => 'Read-only secondary instance', 'Standard' => 'General-purpose instance', 'Serverless' => 'Serverless instance', 'Shared' => 'Shared cluster'], + 'type' => 'string', + 'example' => 'Standard', + 'title' => '', + ], + 'Memory' => ['description' => 'The memory size. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''], + 'InstanceOwner' => ['description' => 'The instance owner.', 'type' => 'string', 'example' => '12345678900000', 'title' => ''], + 'InstanceStatus' => [ + 'description' => 'The instance status.', + 'enumValueTitles' => ['Creating' => 'The instance is being created.', 'Running' => 'The instance is running.', 'Suspended' => 'The instance is stopped.', 'Allocating' => 'The instance is allocating resources.'], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'Version' => ['description' => 'The instance version.', 'type' => 'string', 'example' => 'r1.3.37', 'title' => ''], + 'SuspendReason' => [ + 'description' => 'The reason why the instance was stopped.', + 'enumValueTitles' => ['Indebet' => 'The payment is overdue.', 'Manual' => 'The instance was manually stopped.', 'Overdue' => 'The subscription has expired.'], + 'type' => 'string', + 'example' => 'Manual', + 'title' => '', + ], + 'Tags' => [ + 'description' => 'The tags of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag details.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LeaderInstanceId' => ['description' => 'The ID of the primary instance.', 'type' => 'string', 'example' => 'hgpostcn-cn-i7m2ncd6w002', 'title' => ''], + 'EnableHiveAccess' => ['description' => 'Indicates whether data lake acceleration is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aekzuq7hpybze2i', 'title' => ''], + 'ComputeNodeCount' => ['description' => 'The number of compute nodes. A node has 16 vCPUs and 32 GB of memory.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'ColdStorage' => ['description' => 'The cold storage capacity. Unit: GB. SSD is hot storage, which is also standard storage. HDD is cold storage.', 'type' => 'integer', 'format' => 'int64', 'example' => '800', 'title' => ''], + 'AutoRenewal' => [ + 'description' => 'Indicates whether auto-renewal is enabled.', + 'enumValueTitles' => ['true' => 'Auto-renewal is enabled.', 'false' => 'Auto-renewal is disabled.'], + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'GatewayCount' => [ + 'description' => 'The number of gateway nodes.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'title' => '', + ], + 'GatewayCpu' => [ + 'description' => 'The vCPU resources of the gateway. Unit: cores.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + 'title' => '', + ], + 'GatewayMemory' => [ + 'description' => 'The memory resources of the gateway. Unit: GB.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + 'title' => '', + ], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ReplicaRole' => ['description' => 'The role of instance in disaster recovery. Active: the primary instance. Passive: the secondary instance. PreActive: a primary instance that has not reached the desired state.', 'type' => 'string', 'example' => 'Active', 'title' => ''], + 'EnableServerless' => [ + 'description' => 'Indicates whether Serverless Computing is enabled.', + 'enumValueTitles' => ['true' => 'Serverless Computing is enabled.', 'false' => 'Serverless Computing is disabled.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'StorageType' => ['description' => 'The storage class:'."\n" + ."\n" + .'- redundant: Zone-redundant storage'."\n" + ."\n" + .'- local: Locally redundant storage', 'type' => 'string', 'example' => 'redundant', 'title' => ''], + 'EnableSSL' => ['description' => 'Indicates whether SSL is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'The result of the request, which indicates whether an exception occurred. This parameter is not related to the business logic.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"865A02C2-B374-5DD4-9B34-0CA15DA1AEBD\\",\\n \\"Instance\\": {\\n \\"InstanceChargeType\\": \\"PrePaid\\",\\n \\"CommodityCode\\": \\"hologram_combo_public_cn\\",\\n \\"Cpu\\": 32,\\n \\"CreationTime\\": \\"2021-02-03T13:06:06Z\\",\\n \\"Disk\\": \\"500\\",\\n \\"Endpoints\\": [\\n {\\n \\"Endpoint\\": \\"hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80\\",\\n \\"Type\\": \\"Internet\\",\\n \\"Enabled\\": true,\\n \\"VSwitchId\\": \\"vsw-bp1jqwp2ys6kp7tc9t983\\",\\n \\"VpcId\\": \\"vpc-uf66jjber3hgvwhki3wna\\",\\n \\"VpcInstanceId\\": \\"hgprecn-cn-uqm362o1b001-frontend-st\\",\\n \\"AlternativeEndpoints\\": \\"hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80\\"\\n }\\n ],\\n \\"ExpirationTime\\": \\"2021-02-03T13:06:06Z\\",\\n \\"InstanceId\\": \\"hgpostcn-cn-tl32s6cgw00b\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Memory\\": 128,\\n \\"InstanceOwner\\": \\"12345678900000\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"Version\\": \\"r1.3.37\\",\\n \\"SuspendReason\\": \\"Manual\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"LeaderInstanceId\\": \\"hgpostcn-cn-i7m2ncd6w002\\",\\n \\"EnableHiveAccess\\": \\"true\\",\\n \\"ResourceGroupId\\": \\"rg-aekzuq7hpybze2i\\",\\n \\"ComputeNodeCount\\": 2,\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ColdStorage\\": 800,\\n \\"AutoRenewal\\": \\"true\\",\\n \\"GatewayCount\\": 2,\\n \\"GatewayCpu\\": 4,\\n \\"GatewayMemory\\": 16,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ReplicaRole\\": \\"Active\\",\\n \\"EnableServerless\\": true,\\n \\"StorageType\\": \\"redundant\\",\\n \\"EnableSSL\\": true\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'GetInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82B7A554-4D00-50DF-95D9-B59E7B4D5489\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'DisableHiveAccess', ], - 'EnableHiveAccess' => [ - 'summary' => 'Enables data lake acceleration.', - 'path' => '/api/v1/instances/{instanceId}/enableHiveAccess', - 'methods' => [ - 'post', + 'GetInstanceModel' => [ + 'path' => '/api/v1/instances/{instanceId}/getInstanceModel', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-7mz2vmuxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'cpu' => ['description' => 'The total number of CPU cores on the node. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'gpu' => ['description' => 'The total number of GPUs on the node. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'memory' => ['description' => 'The total memory on the node. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''], + 'gpuMemory' => ['description' => 'The total GPU memory on the node. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''], + 'modelServiceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'gpuMemory' => ['description' => 'The GPU memory that the model service uses. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'memory' => ['description' => 'The memory that the model service uses. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'cpu' => ['description' => 'The number of CPU cores that the model service uses. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'modelType' => ['description' => 'The model type.', 'type' => 'string', 'example' => 'qwen3.5-plus', 'title' => ''], + 'gpu' => ['description' => 'The number of GPUs that the model service uses. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'status' => ['description' => 'The status of the model service.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'modelName' => ['description' => 'The user-defined name of the model service.', 'type' => 'string', 'example' => 'my_model', 'title' => ''], + 'serviceCount' => ['description' => 'The number of service replicas. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'version' => ['description' => 'The version of the model service.', 'type' => 'string', 'example' => 'v1.1', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Failed', 'title' => ''], + 'taskType' => ['description' => 'The task type of the model.', 'type' => 'string', 'example' => 'embedding', 'title' => ''], + 'modelParams' => ['description' => 'The parameters of the model. This parameter is returned only for models from Model Studio.', 'type' => 'string', 'example' => '{"timeout":600,"max_retries":10,"max_retry_delay":8,"initial_retry_delay":0.5}', 'title' => ''], + 'apiKey' => ['description' => 'The API key for Model Studio. This key is for display only and cannot be used for direct API calls.', 'type' => 'string', 'example' => 'sk-42f6c8xxxxxb', 'title' => ''], + 'provider' => ['description' => 'The provider of the underlying model. For example, the value `bailian` indicates Model Studio.', 'type' => 'string', 'example' => 'bailian', 'title' => ''], + 'instanceRegion' => ['description' => 'The deployment region of the Hologres AI node.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'serviceDeployRegion' => ['description' => 'The deployment region of the model service.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of model services.', + 'title' => '', + 'example' => '', + ], + 'cpuUsed' => ['description' => 'The total CPU cores used across all nodes. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'memoryUsed' => ['description' => 'The total memory used across all nodes. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''], + 'gpuUsed' => ['description' => 'The total GPUs used across all nodes. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'aiInstanceId' => ['description' => 'The instance ID of the Hologres AI node.', 'type' => 'string', 'example' => 'hologram_aicombo_public_cn-77xxx', 'title' => ''], + 'gpuMemoryUsed' => ['description' => 'The total GPU memory used across all nodes. This parameter is returned only for a Hologres AI node.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'resourceType' => [ + 'description' => 'The resource type.', + 'enumValueTitles' => ['small' => 'Small', 'middle' => 'Medium', 'large' => 'Large'], + 'type' => 'string', + 'example' => 'middle', + 'title' => '', + ], + 'nodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'hologram_aipostpay_public_cn', 'title' => ''], + 'chargeType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- `PrePaid`: subscription'."\n" + ."\n" + .'- `PostPaid`: pay-as-you-go', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''], + 'status' => [ + 'description' => 'The status of the node.', + 'enumValueTitles' => ['ResourceReady' => 'The node is running.', 'InstanceWaiting' => 'The node is being created.'], + 'type' => 'string', + 'example' => 'ResourceReady', + 'title' => '', + ], + 'expirationTime' => ['description' => 'The expiration time in UTC.', 'type' => 'string', 'example' => '2026-01-28T07:44:27.535Z', 'title' => ''], + 'autoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled for the resource.'."\n" + ."\n" + .'- `true`: Auto-renewal is enabled.'."\n" + ."\n" + .'- `false`: Auto-renewal is disabled. The resource is suspended upon expiration.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'The returned data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetInstanceModel', + 'summary' => 'Large model services bound to the Hologres instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"cpu\\": 32,\\n \\"gpu\\": 4,\\n \\"memory\\": 128,\\n \\"gpuMemory\\": 128,\\n \\"modelServiceList\\": [\\n {\\n \\"gpuMemory\\": 32,\\n \\"memory\\": 32,\\n \\"cpu\\": 32,\\n \\"modelType\\": \\"qwen3.5-plus\\",\\n \\"gpu\\": 2,\\n \\"status\\": \\"Running\\",\\n \\"modelName\\": \\"my_model\\",\\n \\"serviceCount\\": 2,\\n \\"version\\": \\"v1.1\\",\\n \\"message\\": \\"Failed\\",\\n \\"taskType\\": \\"embedding\\",\\n \\"modelParams\\": \\"{\\\\\\"timeout\\\\\\":600,\\\\\\"max_retries\\\\\\":10,\\\\\\"max_retry_delay\\\\\\":8,\\\\\\"initial_retry_delay\\\\\\":0.5}\\",\\n \\"apiKey\\": \\"sk-42f6c8xxxxxb\\",\\n \\"provider\\": \\"bailian\\",\\n \\"instanceRegion\\": \\"cn-beijing\\",\\n \\"serviceDeployRegion\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"cpuUsed\\": 32,\\n \\"memoryUsed\\": 64,\\n \\"gpuUsed\\": 2,\\n \\"aiInstanceId\\": \\"hologram_aicombo_public_cn-77xxx\\",\\n \\"gpuMemoryUsed\\": 64,\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"resourceType\\": \\"middle\\",\\n \\"nodeCount\\": 2,\\n \\"commodityCode\\": \\"hologram_aipostpay_public_cn\\",\\n \\"chargeType\\": \\"PrePaid\\",\\n \\"status\\": \\"ResourceReady\\",\\n \\"expirationTime\\": \\"2026-01-28T07:44:27.535Z\\",\\n \\"autoRenewal\\": true\\n}","type":"json"}]', + ], + 'GetLastUpgradeRecord' => [ + 'summary' => 'Retrieves the last upgrade record.', + 'path' => '/api/v1/instances/{instanceId}/lastUpgradeRecord', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramUIEVQ0'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08xxxxx'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => [ + 'type' => 'object', + 'properties' => [ + 'fromVersion' => ['description' => 'The source version.', 'type' => 'string', 'example' => 'r3.2.11', 'title' => ''], + 'toVersion' => ['description' => 'The destination version.', 'type' => 'string', 'example' => 'r4.0.2', 'title' => ''], + 'startReadonlyTime' => ['description' => 'The read-only start time.', 'type' => 'string', 'example' => '2025-09-24 17:29:57', 'title' => ''], + 'stopReadonlyTime' => ['description' => 'The read-only end time.', 'type' => 'string', 'example' => '2025-09-24 18:23:22', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The data structure of the response.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetLastUpgradeRecord', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": {\\n \\"fromVersion\\": \\"r3.2.11\\",\\n \\"toVersion\\": \\"r4.0.2\\",\\n \\"startReadonlyTime\\": \\"2025-09-24 17:29:57\\",\\n \\"stopReadonlyTime\\": \\"2025-09-24 18:23:22\\"\\n }\\n}","type":"json"}]', + ], + 'GetRootCertificate' => [ + 'summary' => 'Retrieves the root SSL certificate of a Hologres instance for client-side SSL connections.', + 'path' => '/api/v1/instances/{instanceId}/rootCertificate', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426vm002', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'Data' => ['description' => 'The result of the request. The value is a JSON string that contains the certificate in the PEM format.', 'type' => 'string', 'example' => '{ "rootCertificate": "BEGIN xxxx"}', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetRootCertificate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:GetRootCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": \\"{ \\\\\\"rootCertificate\\\\\\": \\\\\\"BEGIN xxxx\\\\\\"}\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'GetScheduledBackupConfig' => [ + 'path' => '/api/v1/backups/scheduledConfig', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-9lb3bjg1n003', 'title' => ''], + ], + [ + 'name' => 'scheduleType', + 'in' => 'query', 'schema' => [ - 'description' => 'The instance ID.'."\n", + 'description' => 'The backup type. By default, the operation returns periodical and manual backup configurations. To retrieve the remote backup configuration, set this parameter to \'remote\'.', + 'enumValueTitles' => ['periodical' => 'A periodical backup.', 'remote' => 'A remote backup.'], 'type' => 'string', 'required' => false, - 'example' => 'hgpostcn-cn-zpr3426vm002', + 'example' => 'remote', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EA8F0084-5831-5907-BB31-BD05D2617844', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '623EF0B6-A6C1-5764-82CC-0BC176654CB9'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['description' => 'Indicates whether the backup configuration is enabled. Valid values: **1** (enabled) and **0** (disabled).', 'type' => 'integer', 'format' => 'int64', 'example' => 'true', 'title' => ''], + 'TaskParameter' => ['description' => 'The task parameter.', 'type' => 'string', 'example' => '{"schedule":"0 10 * * 1,2","instance_id":"hgprecn-cn-lbj3dfgog004","week":"1,2","hour":10,"data_keep_quantity":3,"type":"periodical","enabled":true}', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'backup'."\n", 'title' => ''], ], - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetScheduledBackupConfig', + 'summary' => 'Retrieves the backup configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA8F0084-5831-5907-BB31-BD05D2617844\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'EnableHiveAccess', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"623EF0B6-A6C1-5764-82CC-0BC176654CB9\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Enabled\\": 0,\\n \\"TaskParameter\\": \\"{\\\\\\"schedule\\\\\\":\\\\\\"0 10 * * 1,2\\\\\\",\\\\\\"instance_id\\\\\\":\\\\\\"hgprecn-cn-lbj3dfgog004\\\\\\",\\\\\\"week\\\\\\":\\\\\\"1,2\\\\\\",\\\\\\"hour\\\\\\":10,\\\\\\"data_keep_quantity\\\\\\":3,\\\\\\"type\\\\\\":\\\\\\"periodical\\\\\\",\\\\\\"enabled\\\\\\":true}\\",\\n \\"TaskType\\": \\"backup\\\\n\\"\\n }\\n}","type":"json"}]', ], - 'StopInstance' => [ - 'summary' => 'Stops an instance.', - 'path' => '/api/v1/instances/{instanceId}/stop', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetUpgradeStatus' => [ + 'summary' => 'Queries the upgrade status of an instance.', + 'path' => '/api/v1/instances/{instanceId}/upgrade/status', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2379,478 +3360,1001 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-uqm30ptv6004', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgpostcn-cn-lbj33559x001', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D73E42D0-AA72-5880-B96F-548B43C84736'], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FromVersion' => ['description' => 'The version of the instance before the upgrade.', 'type' => 'string', 'example' => '1.3.23', 'title' => ''], + 'ToVersion' => ['description' => 'The target version of the upgrade.', 'type' => 'string', 'example' => '1.3.24', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the Airflow directed acyclic graph (DAG) used for the instance upgrade.', + 'enumValueTitles' => ['archived' => 'Indicates that the upgrade is complete.', 'upgrading' => 'The instance is being upgraded.', 'preparing' => 'The system is preparing for the upgrade.'], + 'type' => 'string', + 'example' => 'archived', + 'title' => '', + ], + 'Details' => ['description' => 'Details about the upgrade process, formatted as a JSON string.', 'type' => 'string', 'example' => '{"UpgradePhase":"Upgrade","StatusCode":"LeaderRestartFailed","FlightingReport":{"SQLResultStat":{"TotalExecuted":9000"Exceptions":0,"Incorrect":1,"Slow":1,"DQLSpeedup":2}"SegmentFormatStat":[{"Database":"test_db","TableUsingSegmentCount":5},{"Database":"user_order","TableUsingSegmentCount":7}],"EstimatedUpgradeTime":{"StopInstance":30,"BackupData":120,"UpgradeInstance":600},"ReadPermissionCheckStat":[{"db":"tst0","user":"v4_300433463265624129","schema":"dim_db","table":"it_rpt_org_tree_info_partition_all"},{"db":"tst1","user":"v4_300433463265624129","schema":"dim_db","table":"it_rpt_org_tree_info_partition_all_2"},]},"UpgradingSteps":{"Stop":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"Backup":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"DoUpgrade":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"Rollback":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"}},"Instances":{"LeaderInstanceId":"hgxxx","LeaderInstanceName":"ERP instance","LeaderInstanceStatus":"Running","FollowerInstances":[{"InstanceId":"hgxxx","InstanceName":"TMSinstance","Status":"Running"},{"InstanceId":"hxxx""InstanceName":"WMS readonly","Status":"Unavailable"}]}}', 'title' => ''], + 'PrepareFinishTime' => ['description' => 'The completion time of the preparation phase, in ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`.', 'type' => 'string', 'example' => '2023-05-09T06:48:28.843Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the API call was successful. This parameter does not reflect the status of the upgrade.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the API call fails.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the API call fails.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetUpgradeStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D73E42D0-AA72-5880-B96F-548B43C84736\\",\\n \\"Data\\": [\\n {\\n \\"FromVersion\\": \\"1.3.23\\",\\n \\"ToVersion\\": \\"1.3.24\\",\\n \\"Status\\": \\"archived\\",\\n \\"Details\\": \\"{\\\\\\"UpgradePhase\\\\\\":\\\\\\"Upgrade\\\\\\",\\\\\\"StatusCode\\\\\\":\\\\\\"LeaderRestartFailed\\\\\\",\\\\\\"FlightingReport\\\\\\":{\\\\\\"SQLResultStat\\\\\\":{\\\\\\"TotalExecuted\\\\\\":9000\\\\\\"Exceptions\\\\\\":0,\\\\\\"Incorrect\\\\\\":1,\\\\\\"Slow\\\\\\":1,\\\\\\"DQLSpeedup\\\\\\":2}\\\\\\"SegmentFormatStat\\\\\\":[{\\\\\\"Database\\\\\\":\\\\\\"test_db\\\\\\",\\\\\\"TableUsingSegmentCount\\\\\\":5},{\\\\\\"Database\\\\\\":\\\\\\"user_order\\\\\\",\\\\\\"TableUsingSegmentCount\\\\\\":7}],\\\\\\"EstimatedUpgradeTime\\\\\\":{\\\\\\"StopInstance\\\\\\":30,\\\\\\"BackupData\\\\\\":120,\\\\\\"UpgradeInstance\\\\\\":600},\\\\\\"ReadPermissionCheckStat\\\\\\":[{\\\\\\"db\\\\\\":\\\\\\"tst0\\\\\\",\\\\\\"user\\\\\\":\\\\\\"v4_300433463265624129\\\\\\",\\\\\\"schema\\\\\\":\\\\\\"dim_db\\\\\\",\\\\\\"table\\\\\\":\\\\\\"it_rpt_org_tree_info_partition_all\\\\\\"},{\\\\\\"db\\\\\\":\\\\\\"tst1\\\\\\",\\\\\\"user\\\\\\":\\\\\\"v4_300433463265624129\\\\\\",\\\\\\"schema\\\\\\":\\\\\\"dim_db\\\\\\",\\\\\\"table\\\\\\":\\\\\\"it_rpt_org_tree_info_partition_all_2\\\\\\"},]},\\\\\\"UpgradingSteps\\\\\\":{\\\\\\"Stop\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"},\\\\\\"Backup\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"},\\\\\\"DoUpgrade\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"},\\\\\\"Rollback\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"}},\\\\\\"Instances\\\\\\":{\\\\\\"LeaderInstanceId\\\\\\":\\\\\\"hgxxx\\\\\\",\\\\\\"LeaderInstanceName\\\\\\":\\\\\\"ERP instance\\\\\\",\\\\\\"LeaderInstanceStatus\\\\\\":\\\\\\"Running\\\\\\",\\\\\\"FollowerInstances\\\\\\":[{\\\\\\"InstanceId\\\\\\":\\\\\\"hgxxx\\\\\\",\\\\\\"InstanceName\\\\\\":\\\\\\"TMSinstance\\\\\\",\\\\\\"Status\\\\\\":\\\\\\"Running\\\\\\"},{\\\\\\"InstanceId\\\\\\":\\\\\\"hxxx\\\\\\"\\\\\\"InstanceName\\\\\\":\\\\\\"WMS readonly\\\\\\",\\\\\\"Status\\\\\\":\\\\\\"Unavailable\\\\\\"}]}}\\",\\n \\"PrepareFinishTime\\": \\"2023-05-09T06:48:28.843Z\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'GetUpgradeable' => [ + 'summary' => '', + 'path' => '/api/v1/instances/{instanceId}/upgradeable', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'hgprecn-cn-tl32mqkmxxxx', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'B8E7613D-E09F-59D3-B35A-FBB7680DCE8F'], 'Data' => [ - 'description' => 'The returned result, which indicates whether the operation was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'The request result, which indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'FailReason' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'ReasonKey' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', + 'description' => '', + 'title' => '', + 'example' => '', ], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['type' => 'string', 'description' => '', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'StopInstance', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8E7613D-E09F-59D3-B35A-FBB7680DCE8F\\",\\n \\"Data\\": [\\n {\\n \\"Success\\": true,\\n \\"FailReason\\": \\"null\\",\\n \\"ReasonKey\\": \\"null\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'ScaleInstance' => [ - 'summary' => 'Changes the specifications and storage space of a Hologres instance.', - 'path' => '/api/v1/instances/{instanceId}/scale', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetWarehouseDetail' => [ + 'summary' => 'Retrieves the details of a virtual warehouse.', + 'path' => '/api/v1/instances/{instanceId}/getWarehouseDetail', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREhologramUCU2YC', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramUIEVQ0'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucpyu005', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-xxxxxxx', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'WarehouseDetail' => [ + 'description' => 'The return value.', + 'type' => 'object', + 'properties' => [ + 'ReservedCpu' => ['description' => 'The reserved computing resources. The total computing resources of all running virtual warehouses in the instance cannot exceed this value.', 'type' => 'string', 'example' => '64', 'title' => ''], + 'RemainingCpu' => ['description' => 'The unallocated computing resources in the instance.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'WarehouseList' => [ + 'description' => 'The warehouses.', + 'type' => 'array', + 'items' => [ + 'description' => 'Warehouse', + 'type' => 'object', + 'properties' => [ + 'Cpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'Mem' => ['description' => 'The memory size.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''], + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'Status' => [ + 'description' => 'The status.', + 'enumValueTitles' => ['kRunning' => 'The virtual warehouse is running.', 'kSuspended' => 'The virtual warehouse is suspended.', 'kInit' => 'The virtual warehouse is being initialized.', 'kFailed' => 'The virtual warehouse failed to start.', 'kAllocating' => 'Resources are being allocated to the virtual warehouse.'], + 'type' => 'string', + 'example' => 'kRunning', + 'title' => '', + ], + 'NodeCount' => ['description' => 'The number of compute nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'Name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'example' => 'MyWarehouse', 'title' => ''], + 'ElasticCpu' => ['description' => 'The elastic computing resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'DefaultWarehouse' => [ + 'description' => 'Indicates whether this is the default virtual warehouse.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'RebalanceStatus' => [ + 'description' => 'The rebalancing status of the virtual warehouse.', + 'enumValueTitles' => ['DONE' => 'The rebalancing is complete.', 'DOING' => 'The rebalancing is in progress.'], + 'type' => 'string', + 'example' => 'DONE', + 'title' => '', + ], + 'ClusterCpu' => ['description' => 'The cluster specifications.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'ElasticType' => ['description' => 'The type of elasticity.', 'type' => 'string', 'example' => 'auto', 'title' => ''], + 'InitClusterCount' => ['description' => 'The number of reserved clusters.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ClusterCount' => ['description' => 'The number of clusters.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'MaxClusterCount' => ['description' => 'The maximum number of clusters.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'AutoScaleType' => ['description' => 'The auto scaling type.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TimedElasticCpu' => ['description' => 'The total current scheduled elastic computing resources of the virtual warehouse.', 'type' => 'string', 'example' => '64', 'title' => ''], + 'AutoElasticCpu' => ['description' => 'The total current auto elastic computing resources of the virtual warehouse.', 'type' => 'string', 'example' => '32', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"WarehouseDetail\\": {\\n \\"ReservedCpu\\": \\"64\\",\\n \\"RemainingCpu\\": \\"32\\",\\n \\"WarehouseList\\": [\\n {\\n \\"Cpu\\": 32,\\n \\"Mem\\": 128,\\n \\"Id\\": 2,\\n \\"Status\\": \\"kRunning\\",\\n \\"NodeCount\\": 2,\\n \\"Name\\": \\"MyWarehouse\\",\\n \\"ElasticCpu\\": 32,\\n \\"DefaultWarehouse\\": true,\\n \\"RebalanceStatus\\": \\"DONE\\",\\n \\"ClusterCpu\\": \\"32\\",\\n \\"ElasticType\\": \\"auto\\",\\n \\"InitClusterCount\\": \\"2\\",\\n \\"ClusterCount\\": \\"2\\",\\n \\"MaxClusterCount\\": \\"4\\",\\n \\"AutoScaleType\\": \\"Standard\\"\\n }\\n ],\\n \\"TimedElasticCpu\\": \\"64\\",\\n \\"AutoElasticCpu\\": \\"32\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetWarehouseDetail', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWarehouseDetail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetWarehouseDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], + ], + ], + 'GrantDatabasePermission' => [ + 'summary' => 'Grants permissions on a database to a specified user within a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/grantDatabasePermission', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426vm002', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'cpu' => [ - 'description' => 'The specifications of the instance. Valid values:'."\n" - ."\n" - .'* 8-core 32GB (number of compute nodes: 1)'."\n" - .'* 16-core 64GB (number of compute nodes: 1)'."\n" - .'* 32-core 128GB (number of compute nodes: 2)'."\n" - .'* 64-core 256GB (number of compute nodes: 4)'."\n" - .'* 96-core 384GB (number of compute nodes: 6)'."\n" - .'* 128-core 512GB (number of compute nodes: 8)'."\n" - .'* Others'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* Set this parameter to the number of cores.'."\n" - ."\n" - .'* If you want to set this parameter to specifications with more than 1,024 compute units (CUs), you must submit a ticket.'."\n" - ."\n" - .'* This parameter is invalid for Hologres Shared Cluster instances.'."\n" - ."\n" - .'* The specifications of 8-core 32GB (number of compute nodes: 1) are for trial use only and cannot be used for production.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '128', - 'default' => '0', - ], - 'storageSize' => [ - 'description' => 'The standard storage space of the instance. Unit: GB.'."\n" - ."\n" - .'> Ignore this parameter for pay-as-you-go instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000G', - 'default' => '0', - ], - 'coldStorageSize' => [ - 'description' => 'The infrequent access (IA) storage space of the instance. Unit: GB.'."\n" - ."\n" - .'> Ignore this parameter for pay-as-you-go instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000G', - 'default' => '0', - ], - 'scaleType' => [ - 'description' => 'The specification change type. Valid values:'."\n" - ."\n" - .'* UPGRADE'."\n" - .'* DOWNGRADE'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you set this parameter to UPGRADE, the new specifications must be higher than the original specifications. You must configure at least one of the cpu, storageSize, and coldStorageSize parameters. If you leave a parameter empty, the related configuration remains unchanged.'."\n" - ."\n" - .'* If you set this parameter to DOWNGRADE, the new specifications must be lower than the original specifications. You must configure at least one of the cpu, storageSize, and coldStorageSize parameters. If you leave a parameter empty, the related configuration remains unchanged.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'DOWNGRADE' => 'DOWNGRADE', - 'UPGRADE' => 'UPGRADE', - ], - 'example' => 'UPGRADE', - 'enum' => [ - 'UPGRADE', - 'DOWNGRADE', - ], - ], - 'gatewayCount' => [ - 'description' => 'The number of gateways. Valid values: 2 to 50.'."\n" - ."\n" - .'> This parameter is required only for virtual warehouse instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'databaseName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], + 'privileges' => [ + 'type' => 'array', + 'items' => ['description' => 'The permission. For more information, see [Hologres permission model](~~198734~~).', 'type' => 'string', 'required' => false, 'example' => 'developer', 'title' => ''], + 'description' => 'The list of permissions.', 'required' => false, - 'example' => '4', + 'title' => '', + 'example' => '', ], - 'enableServerlessComputing' => [ - 'description' => '是否开启ServerlessComputing', - 'type' => 'boolean', + 'userName' => ['description' => 'The user ID. For more information, see [Hologres account overview](~~130393~~).', 'type' => 'string', 'required' => false, 'example' => 'p4_123444xxx', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'], + 'Success' => ['description' => 'The result of the request.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation was successful. \\`true\\`: The operation was successful. \\`false\\`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GrantDatabasePermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:GrantDatabasePermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'GrantSchemaPermission' => [ + 'summary' => 'Grants permissions on a schema to a specified user within a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/grantSchemaPermission', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-lbj33559xxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'databaseName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'db_demo', 'title' => ''], + 'privileges' => [ + 'type' => 'array', + 'items' => ['description' => 'The permission. For more information, see [SLPM](~~199088~~).', 'type' => 'string', 'required' => false, 'example' => 'developer', 'title' => ''], + 'description' => 'The list of permissions.', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], + 'userName' => ['description' => 'The user ID. For more information, see [Hologres account overview](~~130393~~).', 'type' => 'string', 'required' => false, 'example' => 'p4_134xxx', 'title' => ''], + 'schemaName' => ['description' => 'The schema name.', 'type' => 'string', 'required' => false, 'example' => 'my_schema', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '219183853450000', - ], - 'Code' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'InvalidScaleType.Unsupported', - ], - 'Message' => [ - 'description' => 'The error details.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Success' => [ - 'description' => 'Indicates whether the change to specifications was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - ], - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful. This parameter is not related to the business logic.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'true: The operation was successful. false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"219183853450000\\",\\n \\"Code\\": \\"InvalidScaleType.Unsupported\\",\\n \\"Message\\": \\"不支持的变配类型\\",\\n \\"Success\\": true\\n },\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\"\\n}","type":"json"}]', - 'title' => 'ScaleInstance', - 'description' => '> Before you call this operation, make sure that you understand the billing method and pricing of Hologres because this operation is charged.'."\n" - ."\n" - .'* For more information about the billing of Hologres, see [Billing overview](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview).'."\n" - .'* During the change of computing resource specifications of a Hologres instance, the instance is unavailable. During the change of storage resource specifications of a Hologres instance, the instance can work normally. Do not frequently change instance specifications. For more information, see [Upgrade or downgrade instance specifications](https://www.alibabacloud.com/help/en/hologres/product-overview/upgrade-or-downgrade-instance-specifications).', - 'responseParamsDescription' => '> '."\n" - ."\n" - .'* If parameter verification fails, data is returned. In the returned data, Success is set to false, and the Code and Message parameters are included. If no exception is returned, the result of this operation is indicated by the value of Success in the returned data.'."\n" - ."\n" - .'* In the latest version of SDK, the default timeout period on the client side is different from the default timeout period on the instance. If you use the latest version of SDK to call this operation, a timeout may be reported even if this operation is successfully called. To prevent this issue, you can set the ReadTimeout parameter to 20000 before you call this operation.'."\n" - ."\n" - .'', - ], - 'ChangeResourceGroup' => [ - 'summary' => 'Updates a resource group.', - 'path' => '/api/v1/tag/changeResourceGroup', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GrantSchemaPermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:GrantSchemaPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'GrantTablePermission' => [ + 'path' => '/api/v1/instances/{instanceId}/grantTablePermission', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramOTL5KY'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426xxx', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'newResourceGroupId' => [ - 'description' => 'new resource group id', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxwerqwerasfd', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', + 'databaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => ' my_db', 'title' => ''], + 'privileges' => [ + 'type' => 'array', + 'items' => ['description' => 'The permissions to grant. For more information, see [Hologres permission model](~~198734~~).', 'type' => 'string', 'required' => false, 'example' => 'INSERT', 'title' => ''], + 'description' => 'The permissions to grant.', 'required' => false, - 'example' => 'hgprecn-cn-zvp25ysv3006', + 'title' => '', + 'example' => '', + ], + 'userName' => ['description' => 'The user ID. For more information, see [Hologres account overview](~~130393~~).', 'type' => 'string', 'required' => false, 'example' => 'p4_1234xxxx', 'title' => ''], + 'schemaName' => ['description' => 'The schema name.', 'type' => 'string', 'required' => false, 'example' => 'my_schema', 'title' => ''], + 'tableName' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => 'orders_pay', 'title' => ''], + 'allTable' => ['description' => 'Specifies whether to grant the permissions on all tables in the schema.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'columnNames' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - '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' => 'AB71198A-2DB1-511B-AE4D-690BAA97F076', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation. A value of `true` indicates the operation was successful, and `false` indicates it failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GrantTablePermission', + 'summary' => 'Grants permissions on a table to a specified user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:GrantTablePermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'ListBackupData' => [ + 'summary' => 'Retrieves a list of snapshots. Each snapshot represents a point-in-time backup that can be used to restore a new instance with its full data.', + 'path' => '/api/v1/backups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-wwoxxxxx', 'title' => ''], + ], + [ + 'name' => 'backupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup type, used to filter snapshots. If you leave this parameter empty, all snapshots are returned.', + 'enumValueTitles' => ['redundant_remote' => 'Stores instance snapshots across zones in a different region.', 'remote' => 'It is a filter for remote snapshots, not a backup type.', 'redundant' => 'Stores instance snapshots across zones within the same region.', 'full_remote' => 'Stores an instance snapshot remotely.', 'local' => 'It is a filter for local snapshots, not a backup type.', 'full' => 'Stores an instance snapshot locally.'], + 'type' => 'string', + 'required' => false, + 'example' => 'redundant', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46'], + 'BackupDataList' => [ + 'description' => 'The list of backups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupType' => [ + 'description' => 'The backup type.'."\n" + ."\n" + .'- redundant: Stores instance snapshots across zones within the same region.'."\n" + ."\n" + .'- redundant\\_remote: Stores instance snapshots across zones in a different region.'."\n" + ."\n" + .'- full: Stores an instance snapshot locally.'."\n" + ."\n" + .'- full\\_remote: Stores an instance snapshot remotely.'."\n" + ."\n" + .'- local: It is a filter for local snapshots, not a backup type.'."\n" + ."\n" + .'- remote: It is a filter for remote snapshots, not a backup type.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'redundant', + 'title' => '', + ], + 'DataGran' => [ + 'description' => 'The backup granularity.', + 'enumValueTitles' => ['instance' => 'Instance level.'], + 'type' => 'string', + 'example' => 'instance', + 'title' => '', + ], + 'Id' => ['description' => 'The unique snapshot ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1780805690994479105', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hgpostcn-cn-pe33jdxxxxx', 'title' => ''], + 'StartTime' => ['description' => 'The timestamp when the backup began. Format: `YYYY-MM-DDTHH:mm:ss.SSSTZ` (UTC+8). This format is used for all time-related parameters.', 'type' => 'string', 'example' => '2024-10-28T11:19:56.000+00:00', 'title' => ''], + 'Status' => [ + 'description' => 'The backup status.', + 'enumValueTitles' => ['processing' => 'The backup is in progress.', 'completed' => 'The backup is complete.', 'failed' => 'The backup failed.'], + 'type' => 'string', + 'example' => 'completed', + 'title' => '', + ], + 'TriggerType' => [ + 'description' => 'The backup trigger type.', + 'enumValueTitles' => ['scheduled' => 'Periodic backup.', 'manual' => 'Manual backup.'], + 'type' => 'string', + 'example' => 'scheduled', + 'title' => '', + ], + 'DataDesc' => ['description' => 'The description of the snapshot. It can be updated.', 'type' => 'string', 'example' => 'demo', 'title' => ''], + 'DataTime' => ['description' => 'The time when the data snapshot was created. For the format, see StartTime.', 'type' => 'string', 'example' => '2024-10-28T12:23:37.000+00:00', 'title' => ''], + 'DataSize' => ['description' => 'The size of the snapshot, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '76085723136', 'title' => ''], + 'EndTime' => ['description' => 'The time when the backup was completed. For the format, see StartTime.', 'type' => 'string', 'example' => '2024-10-28T12:27:34.000+00:00', 'title' => ''], + 'ColdDataSize' => ['description' => 'The size of the cold data, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32413521', 'title' => ''], + 'InstanceType' => [ + 'description' => 'The instance type.', + 'enumValueTitles' => ['Warehouse' => 'Virtual warehouse instance.', 'Standard' => 'General-purpose instance.'], + 'type' => 'string', + 'example' => 'Warehouse', + 'title' => '', + ], + 'InstanceRegion' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'SnapshotRegion' => ['description' => 'The region where the snapshot is stored.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'InstanceZoneId' => ['description' => 'The zone where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + 'SnapshotZoneId' => ['description' => 'The zone where backup snapshot(s). If you use zone-redundant storage, the data is stored across multiple zones. This parameter returns one of those zones.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'my-hologres-dw', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46\\",\\n \\"BackupDataList\\": [\\n {\\n \\"BackupType\\": \\"redundant\\",\\n \\"DataGran\\": \\"instance\\",\\n \\"Id\\": 1780805690994479000,\\n \\"InstanceId\\": \\"hgpostcn-cn-pe33jdxxxxx\\",\\n \\"StartTime\\": \\"2024-10-28T11:19:56.000+00:00\\",\\n \\"Status\\": \\"completed\\",\\n \\"TriggerType\\": \\"scheduled\\",\\n \\"DataDesc\\": \\"demo\\",\\n \\"DataTime\\": \\"2024-10-28T12:23:37.000+00:00\\",\\n \\"DataSize\\": 76085723136,\\n \\"EndTime\\": \\"2024-10-28T12:27:34.000+00:00\\",\\n \\"ColdDataSize\\": 32413521,\\n \\"InstanceType\\": \\"Warehouse\\",\\n \\"InstanceRegion\\": \\"cn-hangzhou\\",\\n \\"SnapshotRegion\\": \\"cn-hangzhou\\",\\n \\"InstanceZoneId\\": \\"cn-hangzhou-j\\",\\n \\"SnapshotZoneId\\": \\"cn-hangzhou-j\\",\\n \\"InstanceName\\": \\"my-hologres-dw\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListBackupData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBackupData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListBackupData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AB71198A-2DB1-511B-AE4D-690BAA97F076\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'ChangeResourceGroup', ], - 'ListInstances' => [ - 'summary' => 'Queries a list of instances.', - 'path' => '/api/v1/instances', - 'methods' => [ - 'post', + 'ListDatabases' => [ + 'summary' => 'Queries the databases in a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/listDatabases', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramE3EYZP'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-jfj3zckut008', 'title' => ''], + ], + [ + 'name' => 'external', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to list only foreign tables. If you set this parameter to \\`true\\`, only foreign tables are listed. If you set this parameter to \\`false\\` or do not specify it, all tables are listed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0C4935F5-6217-569A-902F-931B2F3E28BA'], + 'DatabaseList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'my_db', 'title' => ''], + 'PermissionModel' => ['description' => 'The permission model. For more information, see [Hologres permission models](~~198734~~).', 'type' => 'string', 'example' => 'SPM', 'title' => ''], + 'Privilege' => ['description' => 'The permission.', 'type' => 'string', 'example' => 'developer', 'title' => ''], + 'External' => ['description' => 'Indicates whether the table is a foreign table. \\`true\\`: The table is a foreign table. \\`false\\`: The table is not a foreign table.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'description' => 'The list of databases.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of databases.', + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], + ], + 'title' => 'ListDatabases', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C4935F5-6217-569A-902F-931B2F3E28BA\\",\\n \\"DatabaseList\\": [\\n {\\n \\"Name\\": \\"my_db\\",\\n \\"PermissionModel\\": \\"SPM\\",\\n \\"Privilege\\": \\"developer\\",\\n \\"External\\": false\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'ListFollowerInstances' => [ + 'summary' => '', + 'path' => '/api/v1/instances/{instanceId}/listFollowerInstances', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'InstanceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string', 'description' => '', 'example' => 'hgpostcn-cn-aaab9ad2d8fb', 'title' => ''], + 'InstanceName' => ['type' => 'string', 'description' => '', 'example' => 'test_instance', 'title' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'example' => 'hologram_postpay_public_cn', 'title' => ''], + 'InstanceStatus' => ['type' => 'string', 'description' => '', 'example' => 'Running', 'title' => ''], + 'ChargeType' => ['type' => 'string', 'description' => '', 'example' => 'PostPaid', 'title' => ''], + 'CreationTime' => ['type' => 'string', 'description' => '', 'example' => '2022-12-16T02:24:05Z', 'title' => ''], + 'ExpirationTime' => ['type' => 'string', 'description' => '', 'example' => '2023-05-04T16:00:00.000Z', 'title' => ''], + 'InstanceType' => ['type' => 'string', 'description' => '', 'example' => 'Standard', 'title' => ''], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'example' => 'tag', 'title' => ''], + 'Value' => ['type' => 'string', 'description' => '', 'example' => 'value', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Success' => ['type' => 'string', 'description' => '', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['type' => 'string', 'description' => '', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '## 请求说明'."\n" + .'- 该API用于获取特定Holo实例上已部署的模型服务信息，包括但不限于CPU、GPU、内存等资源占用情况。'."\n" + .'- `instanceId`参数为可选项，若不提供，则默认返回所有相关实例的信息。'."\n" + .'- 此接口适用于Hologres AI节点，对于非AI节点的部分参数可能无效或不适用。'."\n" + .'- 请确保在使用该接口前，已充分了解[阿里云Hologram产品的收费方式和价格](https://www.aliyun.com/price/product#/ecs/detail)。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"hgpostcn-cn-aaab9ad2d8fb\\",\\n \\"InstanceName\\": \\"test_instance\\",\\n \\"CommodityCode\\": \\"hologram_postpay_public_cn\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"CreationTime\\": \\"2022-12-16T02:24:05Z\\",\\n \\"ExpirationTime\\": \\"2023-05-04T16:00:00.000Z\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'ListInstanceModel' => [ + 'summary' => 'AI node resources.', + 'path' => '/api/v1/instances/rpc/listInstanceModel', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramNRPSXG', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC'], + 'instanceModelList' => [ + 'description' => 'The list of AI node resources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cpu' => ['description' => 'The CPU specifications. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'gpu' => ['description' => 'The number of GPU cards. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'memory' => ['description' => 'The memory size. Unit: GiB. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'gpuMemory' => ['description' => 'The GPU memory size. Unit: GB. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'cpuUsed' => ['description' => 'The total CPU used by the node. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'memoryUsed' => ['description' => 'The total memory used by the node. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'gpuUsed' => ['description' => 'The total GPU used by the node. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'aiInstanceId' => ['description' => 'The AI node instance ID.', 'type' => 'string', 'example' => 'hologram_aicombo_public_cn-77xxx', 'title' => ''], + 'gpuMemoryUsed' => ['description' => 'The total GPU memory used by the node. This parameter applies only to Hologres AI nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'resourceType' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'small', 'title' => ''], + 'nodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'commodityCode' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'hologram_aipostpay_public_cn', 'title' => ''], + 'chargeType' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], + 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'ResourceReady', 'title' => ''], + 'expirationTime' => ['description' => 'The expiration time in UTC.', 'type' => 'string', 'example' => '2026-01-28T07:44:27.535Z', 'title' => ''], + 'autoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'holoInstanceId' => ['description' => 'The Hologres instance ID.', 'type' => 'string', 'example' => 'hgpostcn-cn-yi34hlzdx003', 'title' => ''], + 'holoInstanceName' => [ + 'description' => 'The Hologres instance name.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'myInstance', + 'title' => '', + ], + 'aiSpec' => ['description' => 'The AI specifications.', 'type' => 'string', 'example' => 'small-8core-30G-24G', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AI node resources', + 'description' => '## Operation description'."\n" + .'- This API operation retrieves information about model services deployed on a specific Hologres instance, including but not limited to CPU, GPU, and memory resource usage.'."\n" + .'- The `instanceId` parameter is optional. If you do not specify this parameter, information about all related instances is returned by default.'."\n" + .'- This operation applies to Hologres AI nodes. Some parameters may be invalid or inapplicable to non-AI nodes.'."\n" + .'- Before you call this operation, make sure that you understand the [billing methods and pricing of Alibaba Cloud Hologres](https://www.aliyun.com/price/product#/ecs/detail).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:ListInstanceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC\\",\\n \\"instanceModelList\\": [\\n {\\n \\"cpu\\": 7,\\n \\"gpu\\": 1,\\n \\"memory\\": 16,\\n \\"gpuMemory\\": 32,\\n \\"cpuUsed\\": 7,\\n \\"memoryUsed\\": 32,\\n \\"gpuUsed\\": 32,\\n \\"aiInstanceId\\": \\"hologram_aicombo_public_cn-77xxx\\",\\n \\"gpuMemoryUsed\\": 32,\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"resourceType\\": \\"small\\",\\n \\"nodeCount\\": 2,\\n \\"commodityCode\\": \\"hologram_aipostpay_public_cn\\",\\n \\"chargeType\\": \\"PostPaid\\",\\n \\"status\\": \\"ResourceReady\\",\\n \\"expirationTime\\": \\"2026-01-28T07:44:27.535Z\\",\\n \\"autoRenewal\\": false,\\n \\"holoInstanceId\\": \\"hgpostcn-cn-yi34hlzdx003\\",\\n \\"holoInstanceName\\": \\"myInstance\\",\\n \\"aiSpec\\": \\"small-8core-30G-24G\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListInstances' => [ + 'summary' => 'Retrieves a list of instances.', + 'path' => '/api/v1/instances', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramNRPSXG'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ @@ -2859,47 +4363,47 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmvscak73zmby', - ], + 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvscak73zmby', 'title' => ''], 'tag' => [ - 'description' => 'The tags to add to the resource.'."\n", + 'description' => 'The tags of the instance.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of the tag.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mytag', - ], - 'value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'mytag', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'cmsInstanceType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], + 'title' => '', + 'example' => '', + ], + 'cmsInstanceType' => ['description' => 'The instance type for Cloud Monitor. Valid values:'."\n" + ."\n" + .'- standard'."\n" + ."\n" + .'- follower'."\n" + ."\n" + .'- mc-acceleration'."\n" + ."\n" + .'- warehouse'."\n" + ."\n" + .'- high-memory'."\n" + ."\n" + .'- serverless'."\n" + ."\n" + .'> This parameter is for Cloud Monitor.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2908,446 +4412,525 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D1303CD4-AA70-5998-8025-F55B22C50840', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D1303CD4-AA70-5998-8025-F55B22C50840'], 'InstanceList' => [ - 'description' => 'The instances.'."\n", + 'description' => 'The list of instances.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the instance.'."\n", + 'description' => 'The instance details.', 'type' => 'object', 'properties' => [ - 'CommodityCode' => [ - 'description' => 'The commodity code, which is the same as that on the Billing Management page.'."\n", - 'type' => 'string', - 'example' => 'hologram_postpay_public_cn', - ], - 'CreationTime' => [ - 'description' => 'The time when the cluster was created.'."\n", - 'type' => 'string', - 'example' => '2022-12-16T02:24:05Z', - ], - 'ExpirationTime' => [ - 'description' => 'The time when the cluster expires.'."\n", - 'type' => 'string', - 'example' => '2023-05-04T16:00:00.000Z', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'hgpostcn-cn-aaab9ad2d8fb', - ], - 'InstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'test_instance', - ], + 'CommodityCode' => ['description' => 'The commodity code. This code is the same as the product detail code in the User Center.', 'type' => 'string', 'example' => 'hologram_postpay_public_cn', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2022-12-16T02:24:05Z', 'title' => ''], + 'ExpirationTime' => ['description' => 'The time when the instance expires.', 'type' => 'string', 'example' => '2023-05-04T16:00:00.000Z', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hgpostcn-cn-aaab9ad2d8fb', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test_instance', 'title' => ''], 'InstanceStatus' => [ - 'description' => 'The status of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Creating'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Running'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Suspended'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Allocating'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'The instance status.', + 'enumValueTitles' => ['Creating' => 'The instance is being created.', 'Running' => 'The instance is running.', 'Suspended' => 'The instance is suspended.', 'Allocating' => 'The instance is being allocated.'], 'type' => 'string', - 'enumValueTitles' => [ - 'Creating' => '', - 'Running' => '', - 'Suspended' => '', - 'Allocating' => '', - ], 'example' => 'Running', + 'title' => '', ], 'InstanceType' => [ - 'description' => 'The type of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Follower'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' read-only secondary instance'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* Standard'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' normal instance'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", + 'description' => 'The instance type.', + 'enumValueTitles' => ['Warehouse' => 'Virtual warehouse instance', 'Follower' => 'Read-only secondary instance', 'Standard' => 'General-purpose instance', 'Serverless' => 'Serverless instance', 'Shared' => 'Shared instance'], 'type' => 'string', - 'enumValueTitles' => [ - 'Follower' => '', - 'Standard' => '', - ], 'example' => 'Standard', + 'title' => '', ], 'Tags' => [ - 'description' => 'The tags that are added to the resource.'."\n", + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of the tag.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tag', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'InstanceChargeType' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' pay-as-you-go'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* PrePaid'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' subscription'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", + 'description' => 'The billing method of the instance.', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go', 'PrePaid' => 'Subscription'], 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], 'example' => 'PrePaid', + 'title' => '', ], - 'LeaderInstanceId' => [ - 'description' => 'The ID of the primary instance.'."\n", - 'type' => 'string', - 'example' => 'hgprecn-cn-2r42sqvxm006', - ], - 'SuspendReason' => [ - 'description' => 'The reason for the suspension.'."\n", - 'type' => 'string', - 'example' => 'Manual', - ], + 'LeaderInstanceId' => ['description' => 'The ID of the primary instance.', 'type' => 'string', 'example' => 'hgprecn-cn-2r42sqvxm006', 'title' => ''], + 'SuspendReason' => ['description' => 'The reason why the instance was suspended.', 'type' => 'string', 'example' => 'Manual', 'title' => ''], 'EnableHiveAccess' => [ - 'description' => 'Indicates whether lakehouse acceleration is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'Indicates whether lakehouse acceleration is enabled.', + 'enumValueTitles' => ['true' => 'Enabled', 'false' => 'Disabled'], 'type' => 'string', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', + 'title' => '', ], - 'Version' => [ - 'description' => 'The version of the cluster.'."\n", - 'type' => 'string', - 'example' => '1.3.37', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmvscak73zmby', - ], + 'Version' => ['description' => 'The instance version.', 'type' => 'string', 'example' => '1.3.37', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-acfmvscak73zmby', 'title' => ''], 'Endpoints' => [ - 'description' => 'The list of endpoints.'."\n", + 'description' => 'The list of endpoints.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The endpoint details.', 'type' => 'object', 'properties' => [ - 'Endpoint' => [ - 'description' => 'The endpoint.'."\n", - 'type' => 'string', - 'example' => 'hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80', - ], + 'Endpoint' => ['description' => 'Domain name.', 'type' => 'string', 'example' => 'hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80', 'title' => ''], 'Type' => [ - 'description' => 'The network type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* VPCSingleTunnel'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' virtual private cloud (VPC)'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* Intranet'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' internal network'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* VPCAnyTunnel'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' : This value is not supported by new instances'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* Internet'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' Internet'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", + 'description' => 'The network type.', + 'enumValueTitles' => ['VPCSingleTunnel' => 'VPC', 'Intranet' => 'Internal network', 'VPCAnyTunnel' => 'No longer supported for new instances', 'Internet' => 'Internet'], 'type' => 'string', - 'enumValueTitles' => [ - 'VPCSingleTunnel' => 'VPCSingleTunnel', - 'Intranet' => '', - 'VPCAnyTunnel' => '', - 'Internet' => '', - ], 'example' => 'Internet', + 'title' => '', ], 'Enabled' => [ - 'description' => 'Indicates whether the endpoint is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'Indicates whether the endpoint is enabled.', + 'enumValueTitles' => ['true' => 'Enabled', 'false' => 'Disabled'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'true', + 'title' => '', ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-wz9oap28raidjevhuszg4', - ], - 'VpcId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf6mrahzyu7uorlqqpz5f', - ], - 'VpcInstanceId' => [ - 'description' => 'The ID of the VPC to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'hgpostcn-cn-wwo3665tx004-frontend-st', - ], + 'VSwitchId' => ['description' => 'The ID of the virtual switch.', 'type' => 'string', 'example' => 'vsw-wz9oap28raidjevhuszg4', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6mrahzyu7uorlqqpz5f', 'title' => ''], + 'VpcInstanceId' => ['description' => 'The VPC instance ID.', 'type' => 'string', 'example' => 'hgpostcn-cn-wwo3665tx004-frontend-st', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RegionId' => [ - 'description' => '', + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'StorageType' => ['description' => 'The storage class:'."\n" + ."\n" + .'- redundant: Zone-redundant storage (three zones)'."\n" + ."\n" + .'- local: Locally redundant storage (one zone)', 'type' => 'string', 'example' => 'redundant', 'title' => ''], + 'EnableSSL' => ['description' => 'Indicates whether SSL encryption is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1303CD4-AA70-5998-8025-F55B22C50840\\",\\n \\"InstanceList\\": [\\n {\\n \\"CommodityCode\\": \\"hologram_postpay_public_cn\\",\\n \\"CreationTime\\": \\"2022-12-16T02:24:05Z\\",\\n \\"ExpirationTime\\": \\"2023-05-04T16:00:00.000Z\\",\\n \\"InstanceId\\": \\"hgpostcn-cn-aaab9ad2d8fb\\",\\n \\"InstanceName\\": \\"test_instance\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"InstanceChargeType\\": \\"PrePaid\\",\\n \\"LeaderInstanceId\\": \\"hgprecn-cn-2r42sqvxm006\\",\\n \\"SuspendReason\\": \\"Manual\\",\\n \\"EnableHiveAccess\\": \\"true\\",\\n \\"Version\\": \\"1.3.37\\",\\n \\"ResourceGroupId\\": \\"rg-acfmvscak73zmby\\",\\n \\"Endpoints\\": [\\n {\\n \\"Endpoint\\": \\"hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80\\",\\n \\"Type\\": \\"Internet\\",\\n \\"Enabled\\": true,\\n \\"VSwitchId\\": \\"vsw-wz9oap28raidjevhuszg4\\",\\n \\"VpcId\\": \\"vpc-uf6mrahzyu7uorlqqpz5f\\",\\n \\"VpcInstanceId\\": \\"hgpostcn-cn-wwo3665tx004-frontend-st\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageType\\": \\"redundant\\",\\n \\"EnableSSL\\": \\"true\\"\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'ListInstances', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], + ], + ], + 'ListLeaderInstances' => [ + 'summary' => 'Retrieves a list of potential leader instances.', + 'path' => '/api/v1/instances/{instanceId}/primaryInstances', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zxu3001jn00d', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '5600196E-78E2-50F2-B2A1-C44D3B665438'], + 'InstanceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChargeType' => [ + 'description' => 'The billing method.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go', 'PrePaid' => 'subscription'], 'type' => 'string', - 'example' => 'cn-hangzhou', + 'example' => 'PostPaid', + 'title' => '', ], - 'ZoneId' => [ - 'description' => '', + 'CommodityCode' => [ + 'description' => 'The commodity code.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'cn-hangzhou-h', + 'example' => 'hologram_combo_public_cn', + 'title' => '', ], - 'StorageType' => [ + 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-07-25T02:15:35Z', 'title' => ''], + 'ExpirationTime' => ['description' => 'The expiration time. This parameter is not returned for pay-as-you-go instances.', 'type' => 'string', 'example' => '2022-07-25T02:15:35Z', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hgpostcn-cn-tl32vsdir00h', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'user_defined_name', 'title' => ''], + 'InstanceStatus' => [ + 'description' => 'The instance status.', + 'enumValueTitles' => ['Creating' => 'The instance is being created.', 'Running' => 'The instance is running.', 'Suspended' => 'The instance is suspended.', 'Allocating' => 'The instance is being allocated. Some operations may be unavailable.'], 'type' => 'string', + 'example' => 'Running', + 'title' => '', ], - 'EnableSSL' => [ + 'InstanceType' => [ + 'description' => 'The instance type.', + 'enumValueTitles' => ['Follower' => 'follower instance', 'Standard' => 'Standard'], 'type' => 'string', + 'example' => 'Standard', + 'title' => '', ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'tagKey', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'description' => 'A tag object.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of tags.', + 'title' => '', + 'example' => '', + ], + 'BindingCode' => ['description' => 'Indicates the compatibility between the leader instance and the follower instance. A value of `0` indicates a perfect match. Any other value indicates a mismatch.', 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'description' => 'Contains the details of an instance.', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of instances.', + 'title' => '', + 'example' => '', ], 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", + 'description' => 'Indicates whether the request was successfully processed. This does not reflect the business outcome of the operation.', + 'enumValueTitles' => ['true' => 'Successful', 'false' => 'Failed'], 'type' => 'string', 'example' => 'true', + 'title' => '', ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListLeaderInstances', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves a list of leader instances that are associated with a specific Holo instance.'."\n" + ."\n" + .'- The `instanceId` parameter is optional. If omitted, the API returns all related instances by default.'."\n" + ."\n" + .'- This API applies to Hologres AI nodes. Some parameters may be invalid for non-AI nodes.'."\n" + ."\n" + .'- Before you call this operation, review the [billing and pricing of Alibaba Cloud Hologres](https://www.aliyun.com/price/product#/ecs/detail).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1303CD4-AA70-5998-8025-F55B22C50840\\",\\n \\"InstanceList\\": [\\n {\\n \\"CommodityCode\\": \\"hologram_postpay_public_cn\\",\\n \\"CreationTime\\": \\"2022-12-16T02:24:05Z\\",\\n \\"ExpirationTime\\": \\"2023-05-04T16:00:00.000Z\\",\\n \\"InstanceId\\": \\"hgpostcn-cn-aaab9ad2d8fb\\",\\n \\"InstanceName\\": \\"test_instance\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"InstanceChargeType\\": \\"PrePaid\\",\\n \\"LeaderInstanceId\\": \\"hgprecn-cn-2r42sqvxm006\\",\\n \\"SuspendReason\\": \\"Manual\\",\\n \\"EnableHiveAccess\\": \\"true\\",\\n \\"Version\\": \\"1.3.37\\",\\n \\"ResourceGroupId\\": \\"rg-acfmvscak73zmby\\",\\n \\"Endpoints\\": [\\n {\\n \\"Endpoint\\": \\"hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80\\",\\n \\"Type\\": \\"Internet\\",\\n \\"Enabled\\": true,\\n \\"VSwitchId\\": \\"vsw-wz9oap28raidjevhuszg4\\",\\n \\"VpcId\\": \\"vpc-uf6mrahzyu7uorlqqpz5f\\",\\n \\"VpcInstanceId\\": \\"hgpostcn-cn-wwo3665tx004-frontend-st\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageType\\": \\"redundant\\",\\n \\"EnableSSL\\": \\"\\"\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'ListInstances', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5600196E-78E2-50F2-B2A1-C44D3B665438\\",\\n \\"InstanceList\\": [\\n {\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"CommodityCode\\": \\"hologram_combo_public_cn\\",\\n \\"CreationTime\\": \\"2022-07-25T02:15:35Z\\",\\n \\"ExpirationTime\\": \\"2022-07-25T02:15:35Z\\",\\n \\"InstanceId\\": \\"hgpostcn-cn-tl32vsdir00h\\",\\n \\"InstanceName\\": \\"user_defined_name\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tagKey\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"BindingCode\\": \\"0\\"\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'GetInstance' => [ - 'summary' => 'Obtains the details of an instance.', - 'path' => '/api/v1/instances/{instanceId}', - 'methods' => [ - 'get', + 'ListMigrationZones' => [ + 'summary' => 'Lists the availability zones to which an instance can be migrated. This operation applies to instances that are deployed across three availability zones.', + 'path' => '/api/v1/instances/{instanceId}/listMigrationZones', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram7D4MSW'], + 'tenantRelevance' => 'tenant', ], - 'schemes' => [ - 'http', - 'https', + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-g9j4olkzhxxx', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token from a previous call to retrieve the next page of results. Omit this parameter to get the first page.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'zoneList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['description' => 'The ID of the availability zone.', 'type' => 'string', 'example' => 'cn-beijing-i', 'title' => ''], + 'available' => ['description' => 'Indicates whether the instance can be migrated to the availability zone. A value of false indicates that the migration conditions are not met.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of availability zones.', + 'title' => '', + 'example' => '', + ], + 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'nextToken' => ['description' => 'A token used to retrieve the next page of results. This parameter is not returned if no more results are available.', 'type' => 'string', 'example' => '11', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMigrationZones', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"zoneList\\": [\\n {\\n \\"zoneId\\": \\"cn-beijing-i\\",\\n \\"available\\": true\\n }\\n ],\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"11\\"\\n}","type":"json"}]', + ], + 'ListModelCatalog' => [ + 'path' => '/api/v1/instances/{instanceId}/listModelCatalog', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramNRPSXG', - ], + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucpyu005', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + .'Default value:'."\n" + .' 20'."\n" + .'Maximum value:'."\n" + .' 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'uat-assembly-cut-3d-bbig', 'title' => ''], + ], + [ + 'name' => 'provider', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'holo_bailian', 'description' => '', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the instance. This parameter is required.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'nextToken' => ['description' => 'The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'maxResults' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'modelList' => [ + 'description' => 'The list of models.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'modelType' => ['description' => 'The model name.', 'type' => 'string', 'example' => 'qwen3.5-plus'."\n", 'title' => ''], + 'taskType' => ['description' => 'The model purpose.', 'type' => 'string', 'example' => 'chat/completions', 'title' => ''], + 'provider' => ['description' => 'The underlying model provider.', 'type' => 'string', 'example' => 'bailian', 'title' => ''], + 'defaultParams' => ['description' => 'The default parameters.', 'type' => 'string', 'example' => '{"timeout": 600, "max_retries": 10, "max_retry_delay": 8, "initial_retry_delay": 0.5}', 'title' => ''], + 'paramsExample' => ['description' => 'The parameter examples.', 'type' => 'string', 'example' => '{'."\n" + .' "extra_body": {'."\n" + .' "translation_options": {'."\n" + .' "source_lang": "zh",'."\n" + .' "domains": "The sentence is from Ali Cloud IT domain. ", '."\n" + .' "terms": ['."\n" + .' {'."\n" + .' "source": "生物传感器",'."\n" + .' "target": "biological sensor"'."\n" + .' },'."\n" + .' {'."\n" + .' "source": "身体健康状况",'."\n" + .' "target": "health status of the body"'."\n" + .' }'."\n" + .' ],'."\n" + .' "tm_list": ['."\n" + .' {'."\n" + .' "source": "您可以通过如下方式查看集群的内核版本信息:",'."\n" + .' "target": "You can use one of the following methods to query the engine version of a cluster:"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'extra' => ['description' => 'The additional parameters.', 'type' => 'string', 'example' => '{\\"deepThink\\":false,\\"onlineSearch\\":true}', 'title' => ''], + 'serviceDeployRegion' => ['description' => 'The deployment region.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List models', + 'summary' => 'Lists models.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListModelCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"nextToken\\": \\"None\\",\\n \\"maxResults\\": 50,\\n \\"modelList\\": [\\n {\\n \\"modelType\\": \\"qwen3.5-plus\\\\n\\",\\n \\"taskType\\": \\"chat/completions\\",\\n \\"provider\\": \\"bailian\\",\\n \\"defaultParams\\": \\"{\\\\\\"timeout\\\\\\": 600, \\\\\\"max_retries\\\\\\": 10, \\\\\\"max_retry_delay\\\\\\": 8, \\\\\\"initial_retry_delay\\\\\\": 0.5}\\",\\n \\"paramsExample\\": \\"{\\\\n \\\\\\"extra_body\\\\\\": {\\\\n \\\\\\"translation_options\\\\\\": {\\\\n \\\\\\"source_lang\\\\\\": \\\\\\"zh\\\\\\",\\\\n \\\\\\"domains\\\\\\": \\\\\\"The sentence is from Ali Cloud IT domain. \\\\\\", \\\\n \\\\\\"terms\\\\\\": [\\\\n {\\\\n \\\\\\"source\\\\\\": \\\\\\"生物传感器\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"biological sensor\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"source\\\\\\": \\\\\\"身体健康状况\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"health status of the body\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"tm_list\\\\\\": [\\\\n {\\\\n \\\\\\"source\\\\\\": \\\\\\"您可以通过如下方式查看集群的内核版本信息:\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"You can use one of the following methods to query the engine version of a cluster:\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n }\\\\n}\\",\\n \\"extra\\": \\"{\\\\\\\\\\\\\\"deepThink\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"onlineSearch\\\\\\\\\\\\\\":true}\\",\\n \\"serviceDeployRegion\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListOperationEvents' => [ + 'path' => '/api/v1/instances/listOperationEvents', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramUIEVQ0'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'pageSize' => ['description' => 'The page size. Default value: 50. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + 'pageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'state' => ['description' => 'Filters events by state.', 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], + 'eventName' => ['description' => 'Filters events by name.', 'type' => 'string', 'required' => false, 'example' => 'COLD_UPGRADE', 'title' => ''], + 'eventType' => ['description' => 'Filters events by type.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM_MAINTENANCE', 'title' => ''], + 'scheduleTimeDesc' => ['description' => 'Specifies whether to sort events by schedule time in descending order.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'eventNameDesc' => ['description' => 'Specifies whether to sort events by event name in descending order.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpost-cn-xxx', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'hgprecn-cn-i7m2v08uu00a', + 'title' => '', + 'example' => '', ], ], ], @@ -3356,769 +4939,725 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '865A02C2-B374-5DD4-9B34-0CA15DA1AEBD', - ], - 'Instance' => [ - 'description' => 'The information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceChargeType' => [ - 'description' => 'The billing method of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' pay-as-you-go'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* PrePaid'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' subscription'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', - ], - 'CommodityCode' => [ - 'description' => 'The commodity code.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* hologram_maxcomputeAccelerate_public_cn'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' China site/Lakehouse Acceleration Edition'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* hologram_combo_public_cn'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' China site/Subscription'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* hologram_prepay_public_intl'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' International site/Subscription'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* hologram_storage_dp_cn'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' China site/Storage plan'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* hologram_postpay_public_cn'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' China site/Pay-as-you-go'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* hologram_postpay_public_intl'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' International site/Pay-as-you-go'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* hologram_maxcomputeAccelerate_public_intl'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' International site/Lakehouse Acceleration Edition'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* hologram_cu_dp_cn'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' China site/Compute plan'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'hologram_maxcomputeAccelerate_public_cn' => '', - 'hologram_combo_public_cn' => '', - 'hologram_prepay_public_intl' => '', - 'hologram_storage_dp_cn' => '', - 'hologram_postpay_public_cn' => '', - 'hologram_postpay_public_intl' => '', - 'hologram_maxcomputeAccelerate_public_intl' => '', - 'hologram_cu_dp_cn' => '', - ], - 'example' => 'hologram_combo_public_cn', - ], - 'Cpu' => [ - 'description' => 'The number of CPU cores.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'CreationTime' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '2021-02-03T13:06:06Z', - ], - 'Disk' => [ - 'description' => 'The amount of data that can be stored in the disk of the Standard storage class. Unit: GB.'."\n", - 'type' => 'string', - 'example' => '500', - ], - 'Endpoints' => [ - 'description' => 'The list of endpoints.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Endpoint object', - 'type' => 'object', - 'properties' => [ - 'Endpoint' => [ - 'description' => 'The endpoint.'."\n", - 'type' => 'string', - 'example' => 'hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80', - ], - 'Type' => [ - 'description' => 'The network type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* VPCSingleTunnel'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' virtual private cloud (VPC)'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* Intranet'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' internal network'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* VPCAnyTunnel'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' not supported by new instances'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Internet'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' Internet'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'VPCSingleTunnel' => '', - 'Intranet' => '', - 'VPCAnyTunnel' => '', - 'Internet' => '', - ], - 'example' => 'Internet', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the network is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1jqwp2ys6kp7tc9t983', - ], - 'VpcId' => [ - 'description' => 'The ID of the VPC to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf66jjber3hgvwhki3wna', - ], - 'VpcInstanceId' => [ - 'description' => 'The ID of the instance that is deployed in the VPC.'."\n", - 'type' => 'string', - 'example' => 'hgprecn-cn-uqm362o1b001-frontend-st', - ], - 'AlternativeEndpoints' => [ - 'description' => 'The endpoint. This parameter is returned if both the AnyTunnel and SingleTunnel modes are enabled for an instance, and the instance is switched from the AnyTunnel mode to the SingleTunnel mode. In this case, two endpoints are returned.'."\n", - 'type' => 'string', - 'example' => 'hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '1826503661244379138', 'title' => ''], + 'Cancelable' => ['description' => 'Specifies whether the event can be canceled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ChangeScheduleTime' => ['description' => 'Specifies whether the scheduled time for the event can be changed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ScheduleTime' => ['description' => 'The scheduled time of the event.', 'type' => 'string', 'example' => '2024-08-22 15:49:28', 'title' => ''], + 'State' => ['description' => 'The state of the event.', 'type' => 'string', 'example' => 'queued', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'hgpost-cn-sxfsdfsd', 'title' => ''], + 'EventType' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'UPGRADE_ON_CUSTOMERS_BEHALF', 'title' => ''], + 'EventName' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'HOT_UPGRADE', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'haha', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''], + 'MaintainWindow' => ['description' => 'The maintenance window.', 'type' => 'string', 'example' => '21:00-22:00', 'title' => ''], + 'FollowerInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hgxxxx', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'hi', 'title' => ''], ], + 'description' => 'A follower instance object.', + 'title' => '', + 'example' => '', ], + 'description' => 'The follower instance list.', + 'title' => '', + 'example' => '', ], + 'Detail' => ['description' => 'The event details.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], - 'ExpirationTime' => [ - 'description' => 'The expiration time. This parameter is invalid for pay-as-you-go instances.'."\n", - 'type' => 'string', - 'example' => '2021-02-03T13:06:06Z', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'hgpostcn-cn-tl32s6cgw00b', - ], - 'InstanceName' => [ - 'description' => 'The instance name. The instance name must be 2 to 64 characters in length.'."\n", - 'type' => 'string', - 'example' => 'test', + 'description' => 'An event object.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The event list.', + 'title' => '', + 'example' => '', + ], + 'PageSize' => ['description' => 'The number of entries to return on each page. Default value: 50. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number to return. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + ], + 'title' => '', + 'description' => 'Response schema', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListOperationEvents', + 'summary' => 'Retrieves action events that match specified criteria, supporting pagination and sorting.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"1826503661244379138\\",\\n \\"Cancelable\\": true,\\n \\"ChangeScheduleTime\\": true,\\n \\"ScheduleTime\\": \\"2024-08-22 15:49:28\\",\\n \\"State\\": \\"queued\\",\\n \\"ResourceId\\": \\"hgpost-cn-sxfsdfsd\\",\\n \\"EventType\\": \\"UPGRADE_ON_CUSTOMERS_BEHALF\\",\\n \\"EventName\\": \\"HOT_UPGRADE\\",\\n \\"InstanceName\\": \\"haha\\",\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"MaintainWindow\\": \\"21:00-22:00\\",\\n \\"FollowerInstances\\": [\\n {\\n \\"InstanceId\\": \\"hgxxxx\\",\\n \\"InstanceName\\": \\"hi\\"\\n }\\n ],\\n \\"Detail\\": \\"{}\\"\\n }\\n ],\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 3,\\n \\"TotalCount\\": 120\\n}","type":"json"}]', + ], + 'ListRegions' => [ + 'summary' => '', + 'path' => '/api/v1/regions/listRegions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram7D4MSW'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'Regions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['type' => 'string', 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''], ], - 'InstanceType' => [ - 'description' => 'The type of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Follower'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' read-only secondary instance'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* Standard'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' normal instance'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Warehouse' => '', - 'Follower' => '', - 'Standard' => '', - 'Shared' => '', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListUpgradeReleaseVersions' => [ + 'summary' => '', + 'path' => '/api/v1/instances/{instanceId}/upgrade/listReleaseVersions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'hgprecn-cn-20p33yhxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'F6DFB9EA-0E2A-52AC-BFD5-1ADBBFFB6A2B'], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => ['type' => 'string', 'description' => '', 'example' => 'r2.2.47', 'title' => ''], + 'Type' => ['type' => 'string', 'description' => '', 'example' => 'Stable', 'title' => ''], + 'UpgradeStrategy' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'example' => 'hot', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => 'Standard', - ], - 'Memory' => [ - 'description' => 'The memory size. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '128', - ], - 'InstanceOwner' => [ - 'description' => 'The owner of the instance.'."\n", - 'type' => 'string', - 'example' => '12345678900000', + 'ReleaseNotesUrl' => ['type' => 'string', 'description' => '', 'example' => 'https://help.aliyun.com/zh/hologres/product-overview/release-notes', 'title' => ''], ], - 'InstanceStatus' => [ - 'description' => 'The status of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Creating'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Running'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Suspended'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Allocating'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Creating' => '', - 'Running' => '', - 'Suspended' => '', - 'Allocating' => '', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['type' => 'string', 'description' => '', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6DFB9EA-0E2A-52AC-BFD5-1ADBBFFB6A2B\\",\\n \\"Data\\": [\\n {\\n \\"Version\\": \\"r2.2.47\\",\\n \\"Type\\": \\"Stable\\",\\n \\"UpgradeStrategy\\": [\\n \\"hot\\"\\n ],\\n \\"ReleaseNotesUrl\\": \\"https://help.aliyun.com/zh/hologres/product-overview/release-notes\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'ListWarehouseScheduleEvent' => [ + 'summary' => 'Retrieves the elastic scheduling events for a specified instance and time range.', + 'path' => '/api/v1/instances/{instanceId}/listWarehouseScheduleEvent', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramOBEJQI'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgpost-cn-xxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start timestamp, in seconds. Defaults to three days ago.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777257001', 'title' => ''], + 'endTime' => ['description' => 'The end timestamp, in seconds. Defaults to the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777516201', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page. Default: 30. Maximum: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + 'pageNumber' => ['description' => 'The page number. Defaults to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'elasticType' => [ + 'description' => 'The elastic type. If this parameter is omitted, events of all types are returned. Valid values:', + 'enumValueTitles' => ['auto' => 'auto elasticity', 'timed' => 'timed elasticity'], + 'type' => 'string', + 'required' => false, + 'example' => 'timed', + 'title' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E16D32D4-DF86-1180-8220-0D39770A5AF9'], + 'EventList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WarehouseName' => ['description' => 'The warehouse name.', 'type' => 'string', 'example' => 'init_warehouse', 'title' => ''], + 'EventName' => [ + 'description' => 'The event name.', + 'enumValueTitles' => ['SetWarehouseClusterCount' => 'A change in the cluster count of the warehouse.', 'AlterWarehouse' => 'A change in the CPU resources of the warehouse.'], + 'type' => 'string', + 'example' => 'AlterWarehouse', + 'title' => '', ], - 'example' => 'Running', - ], - 'Version' => [ - 'description' => 'The instance version.'."\n", - 'type' => 'string', - 'example' => 'r1.3.37', - ], - 'SuspendReason' => [ - 'description' => 'The reason for the suspension.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Indebet'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The instance has an overdue payment'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* Manual'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The instance is manually suspended'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* Overdue'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The instance has expired'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Indebet' => '', - 'Manual' => '', - 'Overdue' => '', + 'EventTime' => ['description' => 'The event time (UTC).', 'type' => 'string', 'example' => '2024-07-22T09:43:02.638Z', 'title' => ''], + 'Result' => [ + 'description' => 'The result of the event.', + 'enumValueTitles' => ['success' => 'The event succeeded.', 'failed' => 'The event failed.'], + 'type' => 'string', + 'example' => 'success', + 'title' => '', ], - 'example' => 'Manual', + 'ReservedCpu' => ['description' => 'The number of reserved CPU cores (non-elastic).', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''], + 'OriginalElasticCpu' => ['description' => 'This field is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ElasticCpu' => ['description' => 'The number of elastic CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '48', 'title' => ''], + 'ElasticType' => [ + 'description' => 'The elastic type.', + 'enumValueTitles' => ['ScaleDown' => 'scheduled scale-down', 'ScaleIn' => 'auto scale-in', 'ScaleOut' => 'auto scale-out', 'ScaleUp' => 'scheduled scale-up'], + 'type' => 'string', + 'example' => 'ScaleUp', + 'title' => '', + ], + 'InitClusterCount' => ['description' => 'The number of reserved clusters (non-elastic).', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ClusterCount' => ['description' => 'The cluster count.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ClusterCpu' => ['description' => 'The cluster specification, measured in CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'FailedReason' => ['description' => 'The failure reason. This parameter is returned only if the value of `Result` is `failed`.', 'type' => 'string', 'example' => 'insufficient resource', 'title' => ''], ], - 'Tags' => [ - 'description' => 'The instance tag.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Tag object', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N.'."\n", - 'type' => 'string', - 'example' => 'tag', - ], - 'Value' => [ - 'description' => 'The value of tag N.'."\n", - 'type' => 'string', - 'example' => 'value', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The event list.', + 'title' => '', + 'example' => '', + ], + 'PageSize' => ['description' => 'The number of entries to return on each page. Default value: 30. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of events.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + ], + 'title' => '', + 'description' => 'The output parameters.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListWarehouseScheduleEvent', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves compute group scaling events for a specific instance ID.'."\n" + ."\n" + .'- The `startTime` and `endTime` parameters specify the time range for the query, which defaults to the last three days.'."\n" + ."\n" + .'- The `pageSize` and `pageNumber` parameters control pagination. The maximum value for `pageSize` is 100.'."\n" + ."\n" + .'- If the `elasticType` parameter is omitted, the API returns scaling events of all types.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E16D32D4-DF86-1180-8220-0D39770A5AF9\\",\\n \\"EventList\\": [\\n {\\n \\"WarehouseName\\": \\"init_warehouse\\",\\n \\"EventName\\": \\"AlterWarehouse\\",\\n \\"EventTime\\": \\"2024-07-22T09:43:02.638Z\\",\\n \\"Result\\": \\"success\\",\\n \\"ReservedCpu\\": 64,\\n \\"OriginalElasticCpu\\": 0,\\n \\"ElasticCpu\\": 48,\\n \\"ElasticType\\": \\"ScaleUp\\",\\n \\"InitClusterCount\\": 2,\\n \\"ClusterCount\\": 2,\\n \\"ClusterCpu\\": 32,\\n \\"FailedReason\\": \\"insufficient resource\\"\\n }\\n ],\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 120\\n}","type":"json"}]', + ], + 'ListWarehouseScheduleTask' => [ + 'path' => '/api/v1/instances/{instanceId}/listWarehouseScheduleTask', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgpost-cn-xxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A0A16C46-5B56-1F9B-AA37-4C3EAD95AAA8'], + 'ScheduleTaskList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WarehouseId' => ['description' => 'The ID of the warehouse.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'WarehouseName' => ['description' => 'The name of the warehouse.', 'type' => 'string', 'example' => 'init_warehouse', 'title' => ''], + 'Plans' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The start time of the plan. The time must be on the hour or half-hour and in the HHmm format. For example, 0100 represents 01:00.', 'type' => 'string', 'example' => '0100', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the plan. The time must be on the hour or half-hour and in the HHmm format.', 'type' => 'string', 'example' => '0400', 'title' => ''], + 'ElasticCu' => ['description' => 'The number of elastic resources. The value must be a multiple of 16, with a minimum value of 16, and cannot exceed the warehouse specification.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'Description' => ['description' => 'The description of the scaling plan.', 'type' => 'string', 'example' => 'bill stat', 'title' => ''], + 'Id' => ['description' => 'The ID of the scaling plan.', 'type' => 'string', 'example' => '1802985780260052993', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The scaling plans for the warehouse.', + 'title' => '', + 'example' => '', ], - ], - 'LeaderInstanceId' => [ - 'description' => 'The ID of the primary instance.'."\n", - 'type' => 'string', - 'example' => 'hgpostcn-cn-i7m2ncd6w002', - ], - 'EnableHiveAccess' => [ - 'description' => 'Indicates whether data lake acceleration is enabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aekzuq7hpybze2i', - ], - 'ComputeNodeCount' => [ - 'description' => 'The number of compute nodes. In a typical configuration, a node has 16 CPU cores and 32 GB of memory.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ZoneId' => [ - 'description' => 'The ID of the zone where the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'ColdStorage' => [ - 'description' => 'The cold storage capacity of the instance. Unit: GB. Standard SSD is used for hot storage, and HDD is used for cold storage.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - ], - 'AutoRenewal' => [ - 'description' => 'Indicates whether auto-renewal is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'GatewayCount' => [ - 'description' => 'The number of gateway nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [], - 'example' => '2', - ], - 'GatewayCpu' => [ - 'description' => 'The number of CPU cores of the gateway. Unit: core.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [], - 'example' => '4', - ], - 'GatewayMemory' => [ - 'description' => 'The size of memory resources of the gateway. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [], - 'example' => '16', - ], - 'RegionId' => [ - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ReplicaRole' => [ - 'description' => 'Disaster recovery instance role. '."\n" - .'* Active: Primary disaster recovery instance.'."\n" - .'* Passive: Disaster tolerance instance.'."\n" - .'* PreActive: Primary disaster recovery instance not yet in final state.', - 'type' => 'string', - 'example' => 'Active', - ], - 'EnableServerless' => [ - 'description' => 'EnableServerless', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'ReservedCpu' => ['description' => 'The number of reserved resources for the warehouse.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the warehouse.', + 'enumValueTitles' => ['kRunning' => 'The warehouse is running.', 'kSuspended' => 'The warehouse is suspended.', 'kAllocating' => 'The warehouse resources are being allocated.'], + 'type' => 'string', + 'example' => 'kRunning', + 'title' => '', ], - 'example' => 'true', - ], - 'StorageType' => [ - 'description' => 'The storage type.'."\n" - ."\n" - .'* redundant: 3 copies'."\n" - .'* local: single copy', - 'type' => 'string', - 'example' => 'redundant', - ], - 'EnableSSL' => [ - 'type' => 'boolean', + 'ElasticType' => ['description' => 'The scaling type.', 'type' => 'string', 'example' => 'timed', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Success' => [ - 'description' => 'The request result, which indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned if the request failed.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal server error.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '200', + 'description' => 'The list of warehouse schedule tasks.', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListWarehouseScheduleTask', + 'summary' => 'Lists all warehouse schedule tasks for a specified instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"865A02C2-B374-5DD4-9B34-0CA15DA1AEBD\\",\\n \\"Instance\\": {\\n \\"InstanceChargeType\\": \\"PrePaid\\",\\n \\"CommodityCode\\": \\"hologram_combo_public_cn\\",\\n \\"Cpu\\": 32,\\n \\"CreationTime\\": \\"2021-02-03T13:06:06Z\\",\\n \\"Disk\\": \\"500\\",\\n \\"Endpoints\\": [\\n {\\n \\"Endpoint\\": \\"hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80\\",\\n \\"Type\\": \\"Internet\\",\\n \\"Enabled\\": true,\\n \\"VSwitchId\\": \\"vsw-bp1jqwp2ys6kp7tc9t983\\",\\n \\"VpcId\\": \\"vpc-uf66jjber3hgvwhki3wna\\",\\n \\"VpcInstanceId\\": \\"hgprecn-cn-uqm362o1b001-frontend-st\\",\\n \\"AlternativeEndpoints\\": \\"hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80\\"\\n }\\n ],\\n \\"ExpirationTime\\": \\"2021-02-03T13:06:06Z\\",\\n \\"InstanceId\\": \\"hgpostcn-cn-tl32s6cgw00b\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Memory\\": 128,\\n \\"InstanceOwner\\": \\"12345678900000\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"Version\\": \\"r1.3.37\\",\\n \\"SuspendReason\\": \\"Manual\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"LeaderInstanceId\\": \\"hgpostcn-cn-i7m2ncd6w002\\",\\n \\"EnableHiveAccess\\": \\"true\\",\\n \\"ResourceGroupId\\": \\"rg-aekzuq7hpybze2i\\",\\n \\"ComputeNodeCount\\": 2,\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ColdStorage\\": 800,\\n \\"AutoRenewal\\": \\"true\\",\\n \\"GatewayCount\\": 2,\\n \\"GatewayCpu\\": 4,\\n \\"GatewayMemory\\": 16,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ReplicaRole\\": \\"Active\\",\\n \\"EnableServerless\\": true,\\n \\"StorageType\\": \\"redundant\\",\\n \\"EnableSSL\\": true\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceResponse>\\n <RequestId>865A02C2-B374-5DD4-9B34-0CA15DA1AEBD</RequestId>\\n <Instance>\\n <InstanceChargeType>PrePaid</InstanceChargeType>\\n <CommodityCode>hologram_combo_public_cn</CommodityCode>\\n <Cpu>32</Cpu>\\n <CreationTime>2021-02-03T13:06:06Z</CreationTime>\\n <Disk>500</Disk>\\n <Endpoints>\\n <Endpoint>hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80</Endpoint>\\n <Type>Internet</Type>\\n <Enabled>true</Enabled>\\n <VSwitchId>vsw-bp1jqwp2ys6kp7tc9t983</VSwitchId>\\n <VpcId>vpc-uf66jjber3hgvwhki3wna</VpcId>\\n <VpcInstanceId>hgprecn-cn-uqm362o1b001-frontend-st</VpcInstanceId>\\n <AlternativeEndpoints>hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80</AlternativeEndpoints>\\n </Endpoints>\\n <ExpirationTime>2021-02-03T13:06:06Z</ExpirationTime>\\n <InstanceId>hgpostcn-cn-tl32s6cgw00b</InstanceId>\\n <InstanceName>test</InstanceName>\\n <InstanceType>Standard</InstanceType>\\n <Memory>128</Memory>\\n <InstanceOwner>12345678900000</InstanceOwner>\\n <InstanceStatus>Running</InstanceStatus>\\n <Version>r1.3.37</Version>\\n <SuspendReason>Manual</SuspendReason>\\n <Tags>\\n <Key>tag</Key>\\n <Value>value</Value>\\n </Tags>\\n <LeaderInstanceId>hgpostcn-cn-i7m2ncd6w002</LeaderInstanceId>\\n <EnableHiveAccess>true</EnableHiveAccess>\\n <ResourceGroupId>rg-aekzuq7hpybze2i</ResourceGroupId>\\n <ComputeNodeCount>2</ComputeNodeCount>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <ColdStorage>800</ColdStorage>\\n <AutoRenewal>true</AutoRenewal>\\n <GatewayCount>2</GatewayCount>\\n <GatewayCpu>4</GatewayCpu>\\n <GatewayMemory>16</GatewayMemory>\\n <RegionId>cn-hangzhou</RegionId>\\n <ReplicaRole>Active</ReplicaRole>\\n </Instance>\\n <Success>true</Success>\\n <ErrorCode>null</ErrorCode>\\n <ErrorMessage>null</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</GetInstanceResponse>","errorExample":""}]', - 'title' => 'GetInstance', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0A16C46-5B56-1F9B-AA37-4C3EAD95AAA8\\",\\n \\"ScheduleTaskList\\": [\\n {\\n \\"WarehouseId\\": \\"1\\",\\n \\"WarehouseName\\": \\"init_warehouse\\",\\n \\"Plans\\": [\\n {\\n \\"StartTime\\": \\"0100\\",\\n \\"EndTime\\": \\"0400\\",\\n \\"ElasticCu\\": 32,\\n \\"Description\\": \\"bill stat\\",\\n \\"Id\\": \\"1802985780260052993\\"\\n }\\n ],\\n \\"ReservedCpu\\": 32,\\n \\"Status\\": \\"kRunning\\",\\n \\"ElasticType\\": \\"timed\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateHoloWarehouse' => [ - 'summary' => 'Creates a virtual warehouse.', - 'path' => '/api/v1/instances/{instanceId}/createHoloWarehouse', - 'methods' => [ - 'post', + 'ListWarehouses' => [ + 'summary' => 'Retrieves a list of virtual warehouses.', + 'path' => '/api/v1/instances/{instanceId}/listWarehouses', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-x0r382joi001', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of response.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'WarehouseList' => [ + 'description' => 'The list of virtual warehouses.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Cpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'Mem' => ['description' => 'The memory size.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''], + 'Name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'example' => 'MyWarehouse', 'title' => ''], + 'Status' => [ + 'description' => 'The status.', + 'enumValueTitles' => ['kRunning' => 'kRunning', 'kSuspended' => 'kSuspended', 'kInit' => 'kInit', 'kFailed' => 'kFailed', 'kAllocating' => 'kAllocating'], + 'type' => 'string', + 'example' => 'kRunning', + 'title' => '', + ], + 'NodeCount' => ['description' => 'The number of compute nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"WarehouseList\\": [\\n {\\n \\"Id\\": 3,\\n \\"Cpu\\": 32,\\n \\"Mem\\": 128,\\n \\"Name\\": \\"MyWarehouse\\",\\n \\"Status\\": \\"kRunning\\",\\n \\"NodeCount\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListWarehouses', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWarehouses'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListWarehouses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + ], + 'MigrateInstanceZone' => [ + 'path' => '/api/v1/instances/{instanceId}/migrateInstanceZone', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramFNR69T', - ], + 'abilityTreeNodes' => ['FEATUREhologram7D4MSW'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08uxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance ID. This parameter is required.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a', + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['description' => 'The ID of the target availability zone. Call the `ListMigrationZones` operation to confirm that the target availability zone meets the migration requirements.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'Specifies whether the operation was successful. `true` indicates success and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'MigrateInstanceZone', + 'summary' => 'Migrates an instance to a target availability zone. This operation only supports instances deployed across three availability zones. The instance is launched in the target availability zone without migrating its storage. The process takes approximately 5 minutes.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'PrepareUpgrade' => [ + 'summary' => 'Prepares an instance for an upgrade by running a pre-upgrade assessment. You can upgrade the instance only if the assessment passes. If it fails, contact technical support for a manual upgrade.', + 'path' => '/api/v1/instances/{instanceId}/upgrade/prepare', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-nwy3e6yxxx', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_warehouse', - ], - 'cpu' => [ - 'description' => 'The specifications of the virtual warehouse. The number of vCPUs must be an integer multiple of 16 CPUs. Minimum value: 16.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '32', - ], - 'clusterCount' => [ - 'title' => '集群数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'version' => ['description' => 'The target version for the upgrade. Call the ListUpgradeReleaseVersion operation to get a list of available versions.', 'type' => 'string', 'required' => false, 'example' => 'r5.0.0', 'title' => ''], + 'dryRun' => ['description' => 'This parameter is deprecated.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '77B97AFB-7C9D-50FF-A72D-F13FD73E49D8'], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the preparation task started successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailReason' => ['description' => 'The reason the preparation task failed.', 'type' => 'string', 'example' => 'null'."\n", 'title' => ''], + 'ReasonKey' => ['description' => 'A key that identifies the reason for the failure.', 'type' => 'string', 'example' => 'null', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the API call was successful. This does not indicate the result of the upgrade preparation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'description' => 'The data structure of the response.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'PrepareUpgrade', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'CreateHoloWarehouse', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"77B97AFB-7C9D-50FF-A72D-F13FD73E49D8\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"FailReason\\": \\"null\\\\n\\",\\n \\"ReasonKey\\": \\"null\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'DeleteHoloWarehouse' => [ - 'summary' => 'Deletes a virtual warehouse.', - 'path' => '/api/v1/instances/{instanceId}/deleteHoloWarehouse', - 'methods' => [ - 'post', + 'RebalanceHoloWarehouse' => [ + 'summary' => 'Rebalances shards in a virtual warehouse.', + 'path' => '/api/v1/instances/{instanceId}/rebalanceHoloWarehouse', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'test_oss', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => 'C0EA5844-AB00-5653-8711-CD9FD1798412'], + 'Data' => ['description' => 'The result of the request. "true" indicates success, and "false" indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RebalanceHoloWarehouse', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebalanceHoloWarehouse'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RebalanceHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0EA5844-AB00-5653-8711-CD9FD1798412\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'RenameHoloWarehouse' => [ + 'path' => '/api/v1/instances/{instanceId}/renameHoloWarehouse', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4126,39 +5665,107 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The original name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'my_warehouse', 'title' => ''], + 'newWarehouseName' => ['description' => 'The new name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'new_name', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'true: The request was successful. false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RenameHoloWarehouse', + 'summary' => 'Renames a virtual warehouse.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameHoloWarehouse'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RenameHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'RenewInstance' => [ + 'summary' => 'Renews a subscription Hologres instance. You can also enable monthly auto-renewal.', + 'path' => '/api/v1/instances/{instanceId}/renew', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_warehouse', - ], + 'duration' => ['description' => 'The renewal period, in months.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], + 'autoRenew' => ['description' => 'Specifies whether to enable monthly auto-renewal. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false (default): Disabled.'."\n" + ."\n" + .'> Enabling auto-renewal on an instance where it is already enabled causes an error.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4166,40 +5773,99 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidChargeType.UnRenewable', 'title' => ''], + 'Message' => ['description' => 'The error details.', 'type' => 'string', 'example' => 'Invalid charge type', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '221625608580893', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the renewal is successful.'."\n" + ."\n" + .'- true: The renewal is successful.'."\n" + ."\n" + .'- false: The renewal failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful. This parameter is not related to the business result.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteHoloWarehouse', - ], - 'RebalanceHoloWarehouse' => [ - 'summary' => 'Triggers shard rebalancing for a virtual warehouse.', - 'path' => '/api/v1/instances/{instanceId}/rebalanceHoloWarehouse', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": {\\n \\"Code\\": \\"InvalidChargeType.UnRenewable\\",\\n \\"Message\\": \\"Invalid charge type\\",\\n \\"OrderId\\": \\"221625608580893\\",\\n \\"Success\\": true\\n },\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"false\\"\\n}","type":"json"}]', + 'title' => 'RenewInstance', + 'description' => '><warning>'."\n" + ."\n" + .'This is a paid operation. Before you call this operation, make sure that you understand the billing methods and pricing of Hologres.'."\n" + ."\n" + .'></warning>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- For more information about Hologres billing, see [Billing overview](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- For more information about Hologres billing, see [Billing overview](https://www.alibabacloud.com/help/en/hologres/product-overview/billing-overview).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="china">'."\n" + ."\n" + .'- For more information about Hologres renewal, see [Manage renewals](https://help.aliyun.com/zh/hologres/product-overview/manage-renewals?spm=a2c4g.11186623.0.0.6b776c2eJ1h2vx).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- For more information about Hologres renewal, see [Manage renewals](https://www.alibabacloud.com/help/en/hologres/product-overview/manage-renewals?spm=a2c63.p38356.0.0.38e731c9VAwtDP).'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'- Renewal is available only for subscription (PrePaid) instances.', + 'responseParamsDescription' => '> - If parameter verification fails, a Data object is still returned. The Success parameter is false, and the response includes the Code and Message parameters. The Data.Success parameter indicates whether the operation is successful.'."\n" + .'>'."\n" + .'> - A request timeout error may be returned even if the operation is successful when you use a later version of the software development kit (SDK). This is because the default client timeout period in the SDK may differ from the server-side timeout period. To prevent this issue, set the ReadTimeout parameter to 20000 before you make the call.'."\n" + ."\n" + .'', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RenewInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RenewSSLCertificate' => [ + 'summary' => 'Renews the SSL certificate of a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/renewSSLCertificate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4207,39 +5873,85 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08uu00a', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RenewSSLCertificate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:RenewSSLCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'RestartHoloWarehouse' => [ + 'summary' => 'Restarts a virtual warehouse.', + 'path' => '/api/v1/instances/{instanceId}/restartHoloWarehouse', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_oss', - ], + 'name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'my_warehouse', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4247,289 +5959,479 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'C0EA5844-AB00-5653-8711-CD9FD1798412', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'], + 'Data' => ['description' => 'The result of the request. A value of true indicates that the request was successful. A value of false indicates that the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RestartHoloWarehouse', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartHoloWarehouse'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RestartHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'RestartInstance' => [ + 'summary' => 'Restarts a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/restart', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hgprecn-cn-i7m2ucpyu005'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36291497-CDB0-53DC-8CD7-762E054F57A6'], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'string', + 'description' => 'Indicates whether the operation is successful.', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'The operation is successful.', 'false' => 'The operation failed.'], + 'title' => '', 'example' => 'true', ], + 'Success' => ['description' => 'Indicates whether an exception occurred during the request. This parameter is not related to the business outcome.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36291497-CDB0-53DC-8CD7-762E054F57A6\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'RestartInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RestartInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0EA5844-AB00-5653-8711-CD9FD1798412\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'RebalanceHoloWarehouse', ], 'ResumeHoloWarehouse' => [ - 'summary' => 'Resumes a virtual warehouse.', + 'summary' => 'Resumes a virtual warehouse from Stopped to Running.', 'path' => '/api/v1/instances/{instanceId}/resumeHoloWarehouse', - 'methods' => [ - 'post', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'my_warehouse', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'true: The request is successful. false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ResumeHoloWarehouse', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeHoloWarehouse'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ResumeHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'ResumeInstance' => [ + 'summary' => 'Resumes a paused instance.', + 'path' => '/api/v1/instances/{instanceId}/resume', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hgpostcn-cn-j672yny9g001'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'Data' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Success' => ['description' => 'Indicates whether the request was successful. This parameter is not related to the business logic.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ResumeInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ResumeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'RevokeDatabasePermission' => [ + 'summary' => 'Revokes permissions on a database from a specified user within a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/revokeDatabasePermission', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramFOIKRO'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-zpr3426vxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_warehouse', + 'databaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], + 'userName' => ['description' => 'The user ID. For more information, see [Hologres account overview](~~130393~~).', 'type' => 'string', 'required' => false, 'example' => 'p4_1234xxxx', 'title' => ''], + 'privileges' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of permissions. For more information, see [Hologres permission model](~~198734~~).', 'type' => 'string', 'required' => false, 'example' => 'developer', 'title' => ''], + 'description' => 'The list of permissions.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n", - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success and a value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RevokeDatabasePermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'ResumeHoloWarehouse', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', ], - 'SuspendHoloWarehouse' => [ - 'summary' => 'Suspends a virtual warehouse.', - 'path' => '/api/v1/instances/{instanceId}/suspendHoloWarehouse', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RevokeSchemaPermission' => [ + 'summary' => 'Revokes permissions on a schema from a specified user within a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/revokeSchemaPermission', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramFOIKRO'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_warehouse', + 'databaseName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], + 'userName' => ['description' => 'The user ID. For more information, see [Hologres account overview](~~130393~~).', 'type' => 'string', 'required' => false, 'example' => 'p4_1234xxxx', 'title' => ''], + 'schemaName' => ['description' => 'The schema name.', 'type' => 'string', 'required' => false, 'example' => 'my_schema', 'title' => ''], + 'privileges' => [ + 'type' => 'array', + 'items' => ['description' => 'The permission. For more information, see [Hologres permission model](~~198734~~).', 'type' => 'string', 'required' => false, 'example' => 'developer', 'title' => ''], + 'description' => 'The list of permissions.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n", - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'true: The operation succeeded. false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RevokeSchemaPermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'SuspendHoloWarehouse', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', ], - 'RenameHoloWarehouse' => [ - 'summary' => 'Renames a virtual warehouse.', - 'path' => '/api/v1/instances/{instanceId}/renameHoloWarehouse', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RevokeTablePermission' => [ + 'path' => '/api/v1/instances/{instanceId}/revokeTablePermission', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologramOTL5KY'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The original name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_warehouse', + 'databaseName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], + 'userName' => ['description' => 'The user ID. For more information, see [Hologres account overview](~~130393~~).', 'type' => 'string', 'required' => false, 'example' => 'p4_1234xxxx', 'title' => ''], + 'schemaName' => ['description' => 'The schema name.', 'type' => 'string', 'required' => false, 'example' => 'my_schema', 'title' => ''], + 'tableName' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => 'my_table', 'title' => ''], + 'privileges' => [ + 'type' => 'array', + 'items' => ['description' => 'The permission to revoke. For more information, see [Hologres permission model](~~198734~~).', 'type' => 'string', 'required' => false, 'example' => 'INSERT', 'title' => ''], + 'description' => 'The permissions to revoke.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'newWarehouseName' => [ - 'description' => 'The new name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'new_name', + 'allTable' => ['description' => 'Specifies whether this operation applies to all tables in the schema. If true, permissions are revoked from all tables. If false or not specified, permissions are revoked only from the table specified by tableName.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'columnNames' => [ + 'type' => 'array', + 'items' => ['description' => 'The column name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The columns from which you want to revoke permissions. This is required only for column-level permissions.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n", - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => 'Indicates whether the operation succeeded. A value of true indicates success and false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RevokeTablePermission', + 'summary' => 'Revokes permissions on a table from a specified user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'RenameHoloWarehouse', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', ], 'ScaleHoloWarehouse' => [ - 'summary' => 'Scales in or out a virtual warehouse.', + 'summary' => 'Scales a virtual warehouse.', 'path' => '/api/v1/instances/{instanceId}/scaleHoloWarehouse', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4541,9 +6443,7 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramFNR69T', - ], + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ @@ -4552,81 +6452,66 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the virtual warehouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_warehouse', - ], - 'cpu' => [ - 'description' => 'The specifications of the virtual warehouse. The number of vCPUs must be an integer multiple of 16.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '64', - ], - 'clusterCount' => [ - 'title' => '集群数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'my_warehouse', 'title' => ''], + 'cpu' => ['description' => 'The number of vCPUs for the virtual warehouse. The value must be a multiple of 16.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '64', 'title' => ''], + 'clusterCount' => ['description' => 'The number of clusters.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => '', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n", - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'The result of the operation. A value of true indicates that the operation was successful. A value of false indicates that the operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', 'title' => 'ScaleHoloWarehouse', - ], - 'RestartHoloWarehouse' => [ - 'summary' => 'Restarts a virtual warehouse.', - 'path' => '/api/v1/instances/{instanceId}/restartHoloWarehouse', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleHoloWarehouse'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ScaleHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'ScaleInstance' => [ + 'summary' => 'Changes the specifications and storage space of a Hologres instance.', + 'path' => '/api/v1/instances/{instanceId}/scale', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4636,37 +6521,82 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREhologramUCU2YC'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hgprecn-cn-i7m2v08uu00a', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the virtual warehouse.'."\n", + 'cpu' => ['description' => 'The instance specifications. Valid values:'."\n" + ."\n" + .'- `16`: 16 vCPUs and 64 GB of memory (1 compute node)'."\n" + ."\n" + .'- `32`: 32 vCPUs and 128 GB of memory (2 compute nodes)'."\n" + ."\n" + .'- `64`: 64 vCPUs and 256 GB of memory (4 compute nodes)'."\n" + ."\n" + .'- `96`: 96 vCPUs and 384 GB memory (6 compute nodes)'."\n" + ."\n" + .'- `128`: 128 vCPUs and 512 GB memory (8 compute nodes)'."\n" + ."\n" + .'- and so on.'."\n" + ."\n" + .'> * Specify the number of vCPUs.'."\n" + .'>'."\n" + .'> * To purchase an instance type with more than 1024 vCPUs, submit a ticket.'."\n" + .'>'."\n" + .'> * Skip this parameter for shared instances.', 'type' => 'integer', 'format' => 'int64', 'default' => '0', 'required' => false, 'example' => '128', 'title' => ''], + 'storageSize' => ['description' => 'The standard storage space of the instance. Unit: GB.'."\n" + ."\n" + .'> This parameter is ignored for pay-as-you-go instances.', 'type' => 'integer', 'format' => 'int64', 'default' => '0', 'required' => false, 'example' => '1000G', 'title' => ''], + 'coldStorageSize' => ['description' => 'The cold storage space of the instance. Unit: GB.'."\n" + ."\n" + .'> This parameter is ignored for pay-as-you-go instances.', 'type' => 'integer', 'format' => 'int64', 'default' => '0', 'required' => false, 'example' => '1000G', 'title' => ''], + 'scaleType' => [ + 'description' => 'The scaling type.'."\n" + ."\n" + .'- UPGRADE: Upgrades the instance.'."\n" + ."\n" + .'- DOWNGRADE: Downgrades the instance.'."\n" + ."\n" + .'> * **Upgrade an instance:** New specifications must be equal to or greater than original specifications. Leaving a parameter empty retains its original specification. At least one specification must be increased.'."\n" + .'>'."\n" + .'> * **Downgrade an instance:** New specifications must be equal to or less than original specifications. Leaving a parameter empty retains its original specification. At least one specification must be decreased.', + 'enumValueTitles' => ['DOWNGRADE' => 'Downgrade the instance.', 'UPGRADE' => 'Upgrade the instance.'], 'type' => 'string', 'required' => true, - 'example' => 'my_warehouse', + 'enum' => ['UPGRADE', 'DOWNGRADE'], + 'example' => 'UPGRADE', + 'title' => '', + ], + 'gatewayCount' => ['description' => 'The number of gateways. Valid values: \\[2, 50].'."\n" + ."\n" + .'> This parameter applies only to virtual warehouse instances.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], + 'enableServerlessComputing' => [ + 'description' => 'Specifies whether to enable Serverless Computing.', + 'enumValueTitles' => ['true' => 'Enable Serverless Computing.', 'false' => 'Disable Serverless Computing.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4674,40 +6604,98 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '219183853450000', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidScaleType.Unsupported', 'title' => ''], + 'Message' => ['description' => 'The details of the error.', 'type' => 'string', 'example' => 'Invalid scale type', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the scaling was successful.', + 'enumValueTitles' => ['true' => 'The operation was successful.', 'false' => 'The operation failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'RestartHoloWarehouse', - ], - 'GetWarehouseDetail' => [ - 'summary' => 'Queries details of a virtual warehouse instance.', - 'path' => '/api/v1/instances/{instanceId}/getWarehouseDetail', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"219183853450000\\",\\n \\"Code\\": \\"InvalidScaleType.Unsupported\\",\\n \\"Message\\": \\"Invalid scale type\\",\\n \\"Success\\": true\\n },\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'ScaleInstance', + 'description' => '><warning>'."\n" + ."\n" + .'This is a paid operation. Before you call this operation, make sure that you understand the billing methods and pricing of Hologres.'."\n" + ."\n" + .'></warning>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- For more information about Hologres billing, see [Billing overview](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- For more information about Hologres billing, see [Billing overview](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- The instance becomes unavailable when you upgrade or downgrade its computing resources. Upgrading or downgrading its storage resources does not affect the services of the instance. Avoid frequently upgrading or downgrading the instance. For more information, see [Upgrade or downgrade instance specifications](https://help.aliyun.com/zh/hologres/product-overview/upgrade-or-downgrade-instance-specifications?spm=a2c4g.11186623.0.i7).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- The instance becomes unavailable when you upgrade or downgrade its computing resources. Upgrading or downgrading its storage resources does not affect the services of the instance. Avoid frequently upgrading or downgrading the instance. For more information, see [Upgrade or downgrade instance specifications](https://www.alibabacloud.com/help/zh/hologres/product-overview/upgrade-or-downgrade-instance-specifications).'."\n" + ."\n" + .'</props>', + 'responseParamsDescription' => '> - If parameter verification fails, the system returns the Data object. In this case, the value of the Success parameter is false, and the Code and Message parameters are also returned. The value of Data.Success indicates whether the operation was successful, unless an exception is thrown.'."\n" + .'>'."\n" + .'> - When you use a new software development kit (SDK) to call this operation, a request timeout error may be returned. This is because the default timeout period of the client is different from that of the server. However, the operation is still successfully called. To prevent this issue, set the ReadTimeout parameter to 20000 before the call.'."\n" + ."\n" + .'', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ScaleInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'StopInstance' => [ + 'summary' => 'Stops a running instance.', + 'path' => '/api/v1/instances/{instanceId}/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4715,237 +6703,99 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologramUIEVQ0', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hgprecn-cn-i7m2ucpyu005', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hgpostcn-cn-lbj33559x001'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'], + 'Data' => [ + 'description' => 'Indicates whether the operation was successful.', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'The operation was successful.', 'false' => 'The operation failed.'], + 'title' => '', + 'example' => 'true', ], - 'WarehouseDetail' => [ - 'description' => 'The returned values.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReservedCpu' => [ - 'description' => 'The reserved computing resources. The amount of computing resources in all running virtual warehouses in an instance cannot exceed the amount of reserved computing resources in the virtual warehouses.'."\n", - 'type' => 'string', - 'example' => '64', - ], - 'RemainingCpu' => [ - 'description' => 'The remaining unallocated computing resources of the virtual warehouse instance.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'WarehouseList' => [ - 'description' => 'The list of virtual warehouses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Warehouse'."\n", - 'type' => 'object', - 'properties' => [ - 'Cpu' => [ - 'description' => 'The number of CPU cores.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'Mem' => [ - 'description' => 'The memory capacity.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '128', - ], - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Status' => [ - 'description' => 'The status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* kRunning'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kSuspended'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kInit'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kFailed'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kAllocating'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'kRunning' => 'kRunning', - 'kSuspended' => 'kSuspended', - 'kInit' => 'kInit', - 'kFailed' => 'kFailed', - 'kAllocating' => 'kAllocating', - ], - 'example' => 'kRunning', - ], - 'NodeCount' => [ - 'description' => 'The number of compute nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Name' => [ - 'description' => 'The name of the virtual warehouse instance.'."\n", - 'type' => 'string', - 'example' => 'MyWarehouse', - ], - 'ElasticCpu' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'DefaultWarehouse' => [ - 'type' => 'boolean', - ], - 'RebalanceStatus' => [ - 'type' => 'string', - ], - 'ClusterCpu' => [ - 'title' => '集群规格', - 'type' => 'string', - 'example' => '32', - ], - 'ElasticType' => [ - 'title' => '弹性类型', - 'type' => 'string', - 'example' => 'auto', - ], - 'InitClusterCount' => [ - 'title' => '预留集群数量', - 'type' => 'string', - 'example' => '2', - ], - 'ClusterCount' => [ - 'title' => '集群数量', - 'type' => 'string', - 'example' => '2', - ], - 'MaxClusterCount' => [ - 'title' => '最大集群数量', - 'type' => 'string', - 'example' => '4', - ], - 'AutoScaleType' => [ - 'title' => '自动弹性类型', - 'type' => 'string', - 'example' => 'Standard', - ], - ], - ], - ], - 'TimedElasticCpu' => [ - 'type' => 'string', - ], - 'AutoElasticCpu' => [ - 'type' => 'string', - ], - ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. This parameter is not related to the result of the business operation.', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'The request was successful.', 'false' => 'The request failed.'], + 'title' => '', + 'example' => 'true', ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"WarehouseDetail\\": {\\n \\"ReservedCpu\\": \\"64\\",\\n \\"RemainingCpu\\": \\"32\\",\\n \\"WarehouseList\\": [\\n {\\n \\"Cpu\\": 32,\\n \\"Mem\\": 128,\\n \\"Id\\": 2,\\n \\"Status\\": \\"kRunning\\",\\n \\"NodeCount\\": 2,\\n \\"Name\\": \\"MyWarehouse\\",\\n \\"ElasticCpu\\": 32,\\n \\"DefaultWarehouse\\": true,\\n \\"RebalanceStatus\\": \\"DONE\\",\\n \\"ClusterCpu\\": \\"32\\",\\n \\"ElasticType\\": \\"auto\\",\\n \\"InitClusterCount\\": \\"2\\",\\n \\"ClusterCount\\": \\"2\\",\\n \\"MaxClusterCount\\": \\"4\\",\\n \\"AutoScaleType\\": \\"Standard\\"\\n }\\n ],\\n \\"TimedElasticCpu\\": \\"64\\",\\n \\"AutoElasticCpu\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetWarehouseDetail', - ], - 'ListWarehouses' => [ - 'summary' => 'Queries the list of virtual warehouse instances.', - 'path' => '/api/v1/instances/{instanceId}/listWarehouses', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'StopInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:StopInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'SuspendHoloWarehouse' => [ + 'summary' => 'Stops a virtual warehouse.', + 'path' => '/api/v1/instances/{instanceId}/suspendHoloWarehouse', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the virtual warehouse.', 'type' => 'string', 'required' => true, 'example' => 'my_warehouse', 'title' => ''], + ], 'required' => false, - 'example' => 'hgpostcn-cn-x0r382joi001', + 'title' => '', + 'example' => '', ], ], ], @@ -4953,128 +6803,327 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'The result of the request. `true` indicates the request is successful. `false` indicates the request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SuspendHoloWarehouse', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendHoloWarehouse'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:SuspendHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to one or more resources.', + 'path' => '/api/v1/tag', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'description' => 'The resource type.', + 'enumValueTitles' => ['Custom' => 'A custom tag.', 'System' => 'A system tag.'], 'type' => 'string', - 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', + 'required' => false, + 'example' => 'Custom', + 'title' => '', ], - 'WarehouseList' => [ - 'description' => 'The list of virtual warehouse instances.'."\n", + 'tagOwnerUid' => ['description' => 'The ID of the account that owns the tag.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1062017779051424', 'title' => ''], + 'resourceIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zpr7886u9008', 'title' => ''], + 'description' => 'The instance IDs.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'tags' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Cpu' => [ - 'description' => 'The number of CPU cores.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'Mem' => [ - 'description' => 'The memory capacity.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '128', - ], - 'Name' => [ - 'description' => 'The name of the virtual warehouse instance.'."\n", - 'type' => 'string', - 'example' => 'MyWarehouse', - ], - 'Status' => [ - 'description' => 'The status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* kRunning'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kSuspended'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kInit'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kFailed'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* kAllocating'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'kRunning' => 'kRunning', - 'kSuspended' => 'kSuspended', - 'kInit' => 'kInit', - 'kFailed' => 'kFailed', - 'kAllocating' => 'kAllocating', - ], - 'example' => 'kRunning', - ], - 'NodeCount' => [ - 'description' => 'The number of compute nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'any_string', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'any_string', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'A collection of tags to add.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The instance type. Set the value to `instance`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Instance'], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '15CEB459-CEE0-5528-87F5-B5A9B9F9B184'], + 'Data' => [ + 'description' => 'Indicates whether the tagging operation succeeded.', + 'enumValueTitles' => ['true' => 'The tagging operation succeeded.', 'false' => 'The tagging operation failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates if the API call was accepted. This is separate from whether the tagging operation itself succeeded.', + 'enumValueTitles' => ['true' => 'The API call was accepted.', 'false' => 'The API call failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"WarehouseList\\": [\\n {\\n \\"Id\\": 3,\\n \\"Cpu\\": 32,\\n \\"Mem\\": 128,\\n \\"Name\\": \\"MyWarehouse\\",\\n \\"Status\\": \\"kRunning\\",\\n \\"NodeCount\\": 2\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListWarehouses', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'TagResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15CEB459-CEE0-5528-87F5-B5A9B9F9B184\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'ListBackupData' => [ - 'summary' => 'Queries a list of backups. A backup is a full data snapshot of an instance at the end of the snapshot time. You can purchase another instance to completely restore the original data.', - 'path' => '/api/v1/backups', - 'methods' => [ - 'get', + 'UnBindLeaderInstance' => [ + 'summary' => 'Detaches a read-only instance from its primary instance.', + 'path' => '/api/v1/instances/{instanceId}/unBindReadOnly', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the read-only instance.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-7212z8edx001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '288D934D-3F25-5BA6-9B50-7ABB3017A134'], + 'Data' => [ + 'description' => 'Whether the instance was successfully detached.', + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failure'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the API call was successful. This does not indicate the outcome of the detach operation.', + 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failure'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UnBindLeaderInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"288D934D-3F25-5BA6-9B50-7ABB3017A134\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'path' => '/api/v1/tag/unTag', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'description' => 'The resource category.', + 'enumValueTitles' => ['Custom' => 'custom tag', 'System' => 'system tag'], + 'type' => 'string', + 'required' => false, + 'example' => 'Custom', + 'title' => '', + ], + 'resourceType' => [ + 'description' => 'The resource type.', + 'enumValueTitles' => ['INSTANCE' => 'The resource is an instance.'], + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCe', + 'title' => '', + ], + 'tagOwnerUid' => ['description' => 'The account ID of the tag owner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1062017779051424', 'title' => ''], + 'resourceIds' => [ + 'type' => 'array', + 'items' => ['description' => 'An instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zpr3686u9008', 'title' => ''], + 'description' => 'An array of instance IDs.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'tagKeys' => [ + 'type' => 'array', + 'items' => ['description' => 'A tag key.', 'type' => 'string', 'required' => false, 'example' => 'your_tag', 'title' => ''], + 'description' => 'An array of tag keys. To remove tags, you only need to provide the corresponding tag keys.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CE1C813B-3445-57EC-9504-342E45D1C7EA'], + 'Data' => [ + 'description' => 'Indicates whether the operation was successful.', + 'enumValueTitles' => ['true' => 'The operation was successful.', 'false' => 'The operation failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successfully processed. This parameter does not indicate the outcome of the untagging operation.', + 'enumValueTitles' => ['true' => 'The request was successful.', 'false' => 'The request failed.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UntagResources', + 'summary' => 'Removes tags from one or more instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE1C813B-3445-57EC-9504-342E45D1C7EA\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'UpdateAutoUpgrade' => [ + 'summary' => 'Enables automatic minor version upgrades for an instance. The upgrade occurs automatically during the maintenance window.', + 'path' => '/api/v1/instances/{instanceId}/autoUpgrade', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5083,222 +7132,209 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', - 'in' => 'query', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-wwoxxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'autoUpgrade' => [ + 'description' => 'The upgrade type. Valid values: `auto` and `manual`. A value of auto specifies to enable automatic minor version upgrades. A value of manual specifies to disable automatic minor version upgrades.', + 'type' => 'string', + 'enum' => ['manual', 'auto'], + 'required' => false, + 'example' => 'auto', + 'title' => '', + ], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'hgprecn-cn-wwoxxxxx', + 'title' => '', + 'example' => '', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'Indicates whether the operation was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. This parameter is independent of the business data returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateAutoUpgrade', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'UpdateBackupDataDesc' => [ + 'summary' => 'Updates the description of a backup.', + 'path' => '/api/v1/backups/{id}/desc', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'backupType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The backup type. Specific backup data is filtered based on the type. If you leave this parameter empty, all backup data is returned.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* redundant_remote'."\n" - .'* remote'."\n" - .'* redundant'."\n" - .'* full_remote'."\n" - .'* local'."\n" - .'* full'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'redundant_remote' => '', - 'remote' => '', - 'redundant' => '', - 'full_remote' => '', - 'local' => '', - 'full' => '', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-721344a2z001', 'title' => ''], + 'desc' => ['description' => 'The backup description.', 'type' => 'string', 'required' => false, 'example' => 'back up test', 'title' => ''], ], - 'example' => 'redundant', + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'id', + 'in' => 'path', + 'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => false, 'example' => '1597404937581527041', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46', - ], - 'BackupDataList' => [ - 'description' => 'The backups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackupType' => [ - 'description' => 'The backup type. In general, the following two types are supported: local backup and remote backup. In the local backup type, snapshots reside in the same region as your instance. The following two sub-types are available: full (single backup, single replica) and redundant (zone-redundant storage, multiple replicas). In the remote backup type, snapshots and your instance reside in different regions. Remote backups are the replicas of the backups of the full or redundant type in another region. The values local and remote do not represent specific types, but are used only for data filtering. The value local indicates all local backups, and the value remote indicates all remote backups.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'redundant', - ], - 'DataGran' => [ - 'description' => 'The backup granularity.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* instance'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'instance' => '', - ], - 'example' => 'instance', - ], - 'Id' => [ - 'description' => 'The unique ID of the backup.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1780805690994479105', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'hgpostcn-cn-pe33jdxxxxx', - ], - 'StartTime' => [ - 'description' => 'The start time of the backup task. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ss.SSSTZ format. The time is displayed in UTC (the same below).'."\n", - 'type' => 'string', - 'example' => '2024-10-28T11:19:56.000+00:00', - ], - 'Status' => [ - 'description' => 'The status of the backup task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* processing'."\n" - .'* completed'."\n" - .'* failed'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'processing' => '', - 'completed' => '', - 'failed' => '', - ], - 'example' => 'completed', - ], - 'TriggerType' => [ - 'description' => 'The mode in which the backup task is triggered.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* scheduled: periodic backup'."\n" - .'* manual: manual backup'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'scheduled' => '', - 'manual' => '', - ], - 'example' => 'scheduled', - ], - 'DataDesc' => [ - 'description' => 'The description of the backup data.'."\n", - 'type' => 'string', - 'example' => 'demo', - ], - 'DataTime' => [ - 'description' => 'The snapshot time. The value format of this parameter follows the same standard as that of the StartTime parameter.'."\n", - 'type' => 'string', - 'example' => '2024-10-28T12:23:37.000+00:00', - ], - 'DataSize' => [ - 'description' => 'The size of the backup data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '76085723136', - ], - 'EndTime' => [ - 'description' => 'The end time of the backup task. The value format of this parameter follows the same standard as that of the StartTime parameter.'."\n", - 'type' => 'string', - 'example' => '2024-10-28T12:27:34.000+00:00', - ], - 'ColdDataSize' => [ - 'description' => 'The size of cold data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32413521', - ], - 'InstanceType' => [ - 'description' => 'The type of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Warehouse: virtual warehouse instance'."\n" - .'* Standard: general-purpose instance'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Warehouse' => '', - 'Standard' => '', - ], - 'example' => 'Warehouse', - ], - 'InstanceRegion' => [ - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'SnapshotRegion' => [ - 'description' => 'The region in which the backup data resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'InstanceZoneId' => [ - 'description' => 'The zone in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'SnapshotZoneId' => [ - 'description' => 'The zone in which the backup data resides. In zone-redundant storage mode, backup data is stored in different zones, including the current zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'InstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'my-hologres-dw', - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '87060182-4B69-5C3D-B3A1-A944D20138A7'], + 'Data' => ['description' => 'The result of the operation. A value of \'true\' indicates that the backup description was updated successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateBackupDataDesc', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46\\",\\n \\"BackupDataList\\": [\\n {\\n \\"BackupType\\": \\"redundant\\",\\n \\"DataGran\\": \\"instance\\",\\n \\"Id\\": 1780805690994479000,\\n \\"InstanceId\\": \\"hgpostcn-cn-pe33jdxxxxx\\",\\n \\"StartTime\\": \\"2024-10-28T11:19:56.000+00:00\\",\\n \\"Status\\": \\"completed\\",\\n \\"TriggerType\\": \\"scheduled\\",\\n \\"DataDesc\\": \\"demo\\",\\n \\"DataTime\\": \\"2024-10-28T12:23:37.000+00:00\\",\\n \\"DataSize\\": 76085723136,\\n \\"EndTime\\": \\"2024-10-28T12:27:34.000+00:00\\",\\n \\"ColdDataSize\\": 32413521,\\n \\"InstanceType\\": \\"Warehouse\\",\\n \\"InstanceRegion\\": \\"cn-hangzhou\\",\\n \\"SnapshotRegion\\": \\"cn-hangzhou\\",\\n \\"InstanceZoneId\\": \\"cn-hangzhou-j\\",\\n \\"SnapshotZoneId\\": \\"cn-hangzhou-j\\",\\n \\"InstanceName\\": \\"my-hologres-dw\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListBackupData', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"87060182-4B69-5C3D-B3A1-A944D20138A7\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'EnableSSL' => [ - 'summary' => '打开SSL', - 'path' => '/api/v1/instances/{instanceId}/enableSSL', - 'methods' => [ - 'post', + 'UpdateHoloWebLoginSetting' => [ + 'summary' => 'Modifies the login settings for holoweb.', + 'path' => '/api/v1/instances/{instanceId}/updateHoloWebLoginSetting', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'allowExternalAccountsLogin' => ['description' => 'Set to `true` to allow logins from external accounts, or `false` to deny these logins.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CB13FFDD-2DF8-5396-A848-2D6A31245B6D'], + 'Data' => ['description' => 'The result of the operation. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` (success) and `false` (failure).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Internal server error.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateHoloWebLoginSetting', + 'description' => 'Creating a model service requires multiple parameters. To find the parameters for a Model Studio model, call the `ListModelCatalog` operation. For a Hologres AI node, call the `GetAvailableModelsResource` operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB13FFDD-2DF8-5396-A848-2D6A31245B6D\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'UpdateInstanceName' => [ + 'summary' => 'Changes the name of an instance.', + 'path' => '/api/v1/instances/{instanceId}/instanceName', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5306,21 +7342,26 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hgpostcn-cn-zpr30pupt004'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'instanceName' => ['description' => 'The new name of the instance. The name must be 2 to 64 characters in length. A letter is counted as one character.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'new_name'], + ], 'required' => false, - 'example' => 'hgpostcn-cn-7mz2vmu30003', + 'title' => '', + 'example' => '', ], ], ], @@ -5328,59 +7369,60 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response details.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C6B55032-D41A-5FE0-9C07-8BD81C88422E'], 'Data' => [ - 'description' => '', + 'description' => 'The result of the operation. This indicates whether the operation was successful.', 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'The operation was successful.', 'false' => 'The operation failed.'], + 'title' => '', 'example' => 'true', ], 'Success' => [ - 'description' => '', + 'description' => 'The result of the request. This indicates whether an exception occurred.', 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'The request was successful.', 'false' => 'The request failed.'], + 'title' => '', 'example' => 'true', ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - ], - 'DisableSSL' => [ - 'summary' => '关闭SSL', - 'path' => '/api/v1/instances/{instanceId}/disableSSL', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C6B55032-D41A-5FE0-9C07-8BD81C88422E\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstanceName', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceName'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateInstanceName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'UpdateInstanceNetworkType' => [ + 'summary' => 'Modifies the network type of an instance.', + 'path' => '/api/v1/instances/{instanceId}/network', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5388,24 +7430,45 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREhologram5MV4AO', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hgprecn-cn-lbj35pw74002'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'networkTypes' => [ + 'description' => 'The network types to enable. The order of the network types does not matter. For example, if an instance has the Internet, Intranet, and VPCSingleTunnel network types enabled, disable the Internet network type by specifying \\`Intranet,VPCSingleTunnel\\`.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['VPCSingleTunnel' => 'The virtual private cloud (VPC) network type.', 'Intranet' => 'The classic network type.', 'VPCAnyTunnel' => 'Used for compatibility. This network type is not supported for new instances.', 'Internet' => 'The public access network type.'], + 'title' => '', + 'example' => 'Internet,VPCSingleTunnel', + ], + 'vpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vpc-t4netc3y5etlondfb5ra7'], + 'vSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vsw-2vccsiymtqr9aavew0vo3'], + 'vpcRegionId' => ['description' => 'The region ID of the VPC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], + 'vpcOwnerId' => ['description' => 'The ID of the Alibaba Cloud account that owns the VPC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1999365732646672'], + 'anyTunnelToSingleTunnel' => [ + 'description' => 'Specifies whether to change the network type from AnyTunnel to SingleTunnel. This parameter is not applicable to new instances. Keep the default value of null.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['others/null' => 'Does not change the network type.', 'true' => 'Change the network type.'], + 'title' => '', + 'example' => 'true', + ], + ], 'required' => false, - 'example' => 'hgpostcn-cn-lbj33559x001', + 'title' => '', + 'example' => '', ], ], ], @@ -5413,59 +7476,123 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '9CC37B9F-F4B4-5FF1-939B-AEE78DC70130'], 'Data' => [ - 'description' => '', - 'type' => 'boolean', + 'description' => 'The result of the operation.', + 'type' => 'string', + 'enumValueTitles' => ['true' => 'The operation was successful.', 'false' => 'The operation failed.'], + 'title' => '', 'example' => 'true', ], 'Success' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'The request was successful.', 'false' => 'The request failed.'], + 'title' => '', 'example' => 'true', ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CC37B9F-F4B4-5FF1-939B-AEE78DC70130\\",\\n \\"Data\\": \\"true\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstanceNetworkType', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceNetworkType'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateInstanceNetworkType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'GetCertificateAttribute' => [ - 'summary' => '获得证书信息', - 'path' => '/api/v1/instances/{instanceId}/certificateAttribute', - 'methods' => [ - 'get', + 'UpdateInstancePort' => [ + 'path' => '/api/v1/instances/{instanceId}/updatePort', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08uxxx'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'port' => ['description' => 'The port of the instance. Valid values: 1 to 65535.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D1303CD4-AA70-5998-8025-F55B22C50840'], + 'data' => ['description' => 'The result of the operation. A value of `true` indicates that the operation is successful. A value of `false` indicates that the operation fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. This parameter is independent of the result of the operation.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateInstancePort', + 'summary' => 'Updates the port of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1303CD4-AA70-5998-8025-F55B22C50840\\",\\n \\"data\\": true,\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + ], + 'UpdateMaintenanceWindow' => [ + 'path' => '/api/v1/instances/{instanceId}/maintenanceWindow', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5474,320 +7601,1624 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram7D4MSW'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time of the maintenance window, in UTC and `HH:mm` format.', 'type' => 'string', 'required' => false, 'example' => '00:00', 'title' => ''], + 'endTime' => ['description' => 'The end time of the maintenance window, in UTC and `HH:mm` format.', 'type' => 'string', 'required' => false, 'example' => '02:00', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'hgpostcn-cn-zpr3426vm002', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], - 'CertificateAttributeDto' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'enableSSL' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'expirationTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1790583135000', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'ineffective' => '', - 'effective' => '', - ], - 'example' => 'effective', - ], - ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'], + 'Data' => ['description' => 'A value of `true` indicates that the maintenance window was successfully updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. A value of `false` indicates that a server-side error occurred.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateMaintenanceWindow', + 'summary' => 'Updates the maintenance window of a specified instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"CertificateAttributeDto\\": {\\n \\"enableSSL\\": true,\\n \\"expirationTime\\": 1790583135000,\\n \\"status\\": \\"effective\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'GetRootCertificate' => [ - 'summary' => '获得根证书', - 'path' => '/api/v1/instances/{instanceId}/rootCertificate', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateModelService' => [ + 'summary' => 'Updates a model service. This operation applies only to Hologres AI.', + 'path' => '/api/v1/instances/{instanceId}/updateModelService', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREhologramFNR69T'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'modelServiceName' => ['description' => 'A custom name for the model service.', 'type' => 'string', 'required' => true, 'example' => 'model-qwen', 'title' => ''], + 'modelType' => ['description' => 'The model name.', 'type' => 'string', 'required' => false, 'example' => 'Qwen/Qwen2.5-VL-32B-Instruct', 'title' => ''], + 'cpu' => ['description' => 'The CPU specifications.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32', 'title' => ''], + 'memory' => ['description' => 'The memory specifications.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + 'gpu' => ['description' => 'The GPU specifications.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'serviceCount' => ['description' => 'The number of service replicas.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'hgpostcn-cn-zpr3426vm002', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{ "rootCertificate": "BEGIN xxxx"}', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'], + 'data' => ['description' => '`true` if the operation was successful; `false` otherwise.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateModelService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + ], + 'UpdateOperationEventScheduleTime' => [ + 'summary' => 'Updates the scheduled execution time for an operation event.', + 'path' => '/api/v1/instances/{instanceId}/updateOperationEventScheduleTime', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-zvp2qfwecxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The event ID.', 'type' => 'string', 'required' => true, 'example' => '2034449120420339713', 'title' => ''], + 'scheduleTime' => ['description' => 'The new scheduled time in `YYYY-MM-DD HH:mm:ss` format. The time zone is UTC+8.', 'type' => 'string', 'required' => true, 'example' => '2024-08-23 14:55:00', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'title' => '', 'example' => '11F64C4C-EC50-5472-BC5D-7FD9F51499F6'], + 'Data' => ['description' => 'Returns `true` if the scheduled time is successfully updated, or `false` otherwise.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'Container for the response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateOperationEventScheduleTime', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11F64C4C-EC50-5472-BC5D-7FD9F51499F6\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'UpdateScheduledBackupConfig' => [ + 'path' => '/api/v1/backups/scheduledConfig', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zvp25ysxxxx', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether to enable scheduled backups. Set this parameter to `true` to enable scheduled backups, or `false` to disable them.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'week' => ['description' => 'Specifies the days of the week on which to perform a backup. Separate multiple days with commas. For example, to perform backups on Monday, Wednesday, and Friday, set this parameter to `1,3,5`.', 'type' => 'string', 'required' => false, 'example' => '1,3,5', 'title' => ''], + 'hour' => ['description' => 'The hour to start the backup. This start time applies to all specified days. For example, if you set `week` to `1,3,5` and `hour` to `20`, a backup starts at 20:00:00 every Monday, Wednesday, and Friday.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'dataKeepQuantity' => ['description' => 'The number of scheduled backups to retain. For example, if you set this parameter to `3`, the system retains the three most recent backups and automatically deletes any older ones.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'dstRegion' => ['description' => 'The destination region for the backup. This parameter applies only to remote backups and enables cross-region disaster recovery. For example, you can back up an instance from China (Hangzhou) to China (Beijing).', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + 'zoneId' => ['description' => 'The destination availability zone for the backup. This parameter applies only to remote backups.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-i', 'title' => ''], + 'manualDataKeepQuantity' => ['description' => 'The number of manual backups to retain. Manual backups and automatic backups are stored separately and have independent retention policies.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'scheduleType' => [ + 'description' => 'The backup type. This parameter is required only for remote backups.', + 'enumValueTitles' => ['periodical' => 'scheduled backup', 'remote' => 'remote backup'], 'type' => 'string', - 'example' => '200', + 'required' => false, + 'example' => 'remote', + 'title' => '', ], ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '69221013-D303-5046-91A7-A0BE2BC2E7D7'], + 'Data' => ['description' => 'Indicates whether the configuration was successful. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'description' => 'The data returned by the operation.', + 'example' => '', + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": \\"{ \\\\\\"rootCertificate\\\\\\": \\\\\\"BEGIN xxxx\\\\\\"}\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateScheduledBackupConfig', + 'summary' => 'This operation configures a backup policy for an instance. You can set a weekly schedule to back up an instance on specific days, such as every Monday, Wednesday, and Friday at 20:00:00. You can also specify the number of completed backups to retain. The system automatically deletes expired backups.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69221013-D303-5046-91A7-A0BE2BC2E7D7\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'RenewSSLCertificate' => [ - 'summary' => '更新证书', - 'path' => '/api/v1/instances/{instanceId}/renewSSLCertificate', - 'methods' => [ - 'post', + 'UpdateWarehouseScheduleTask' => [ + 'path' => '/api/v1/instances/{instanceId}/updateWarehouseScheduleTask', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'warehouseId' => ['description' => 'The warehouse ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'startTime' => ['description' => 'The start time. The time must be in 24-hour HHmm format, on the hour or half-hour. For example, `0030`, `0100`, and `0400`.', 'type' => 'string', 'required' => false, 'example' => '0200', 'title' => ''], + 'endTime' => ['description' => 'The end time. The time must be in 24-hour HHmm format, on the hour or half-hour. The end time must be later than the start time. For example, `0030`, `0100`, and `0400`.', 'type' => 'string', 'required' => false, 'example' => '0400', 'title' => ''], + 'elasticCu' => ['description' => 'The number of CUs to add. The value must be a multiple of 16, be at least 16, and not exceed the current warehouse size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32', 'title' => ''], + 'id' => ['description' => 'The elastic schedule ID.', 'type' => 'string', 'required' => false, 'example' => '1980869072412614657', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"], + 'Data' => ['description' => 'Indicates whether the operation succeeded. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateWarehouseScheduleTask', + 'summary' => 'Updates an elastic schedule for a warehouse.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'UpgradeInstance' => [ + 'summary' => '', + 'path' => '/api/v1/instances/{instanceId}/upgrade', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hgprecn-cn-i7m2v08uu00a', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'hgprecn-cn-jeo3n72xxxx', 'title' => ''], + ], + [ + 'name' => 'upgradeTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '2025-02-11 10:00:01', 'title' => ''], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'hot', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'EEB0A71E-7AC7-572F-990F-EE51D3FD35B9'], 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'FailReason' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'ReasonKey' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', + 'title' => '', + 'example' => '', ], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'example' => 'null', 'title' => ''], + 'HttpStatusCode' => ['type' => 'string', 'description' => '', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEB0A71E-7AC7-572F-990F-EE51D3FD35B9\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"FailReason\\": \\"null\\",\\n \\"ReasonKey\\": \\"null\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'hologram.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'hologram.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'hologram.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'hologram.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'hologram.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'hologram.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'hologram.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'hologram.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'hologram.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'hologram.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'hologram.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'hologram.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'hologram.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'hologram.ap-south-1.aliyuncs.com', + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-shenzhen.aliyuncs.com', 'endpoint' => 'hologram.cn-shenzhen.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'hologram.cn-wulanchabu.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-beijing.aliyuncs.com', 'endpoint' => 'hologram.cn-beijing.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.ap-northeast-2.aliyuncs.com', 'endpoint' => 'hologram.ap-northeast-2.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.ap-northeast-1.aliyuncs.com', 'endpoint' => 'hologram.ap-northeast-1.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-chengdu.aliyuncs.com', 'endpoint' => 'hologram.cn-chengdu.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-shanghai.aliyuncs.com', 'endpoint' => 'hologram.cn-shanghai.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-hongkong.aliyuncs.com', 'endpoint' => 'hologram.cn-hongkong.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.ap-southeast-1.aliyuncs.com', 'endpoint' => 'hologram.ap-southeast-1.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.ap-southeast-3.aliyuncs.com', 'endpoint' => 'hologram.ap-southeast-3.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.ap-southeast-5.aliyuncs.com', 'endpoint' => 'hologram.ap-southeast-5.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'hologram.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hologram.cn-hangzhou.aliyuncs.com', 'endpoint' => 'hologram.cn-hangzhou.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hologram.us-west-1.aliyuncs.com', 'endpoint' => 'hologram.us-west-1.aliyuncs.com', 'vpc' => 'hologram-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hologram.us-east-1.aliyuncs.com', 'endpoint' => 'hologram.us-east-1.aliyuncs.com', 'vpc' => 'hologram-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hologram.eu-central-1.aliyuncs.com', 'endpoint' => 'hologram.eu-central-1.aliyuncs.com', 'vpc' => 'hologram-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hologram.na-south-1.aliyuncs.com', 'endpoint' => 'hologram.na-south-1.aliyuncs.com', 'vpc' => 'hologram-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hologram.eu-west-1.aliyuncs.com', 'endpoint' => 'hologram.eu-west-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hologram.me-east-1.aliyuncs.com', 'endpoint' => 'hologram.me-east-1.aliyuncs.com', 'vpc' => 'hologram-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hologram.ap-south-1.aliyuncs.com', 'endpoint' => 'hologram.ap-south-1.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hologram.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'hologram.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hologram.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'hologram.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-north-2-gov-1.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hologram.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'hologram.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'DBAlreadyExist', 'message' => 'The database already exists.', 'http_code' => 409, 'description' => 'Database already exist.'], + ['code' => 'DBNotExist', 'message' => 'The database does not exist.', 'http_code' => 404, 'description' => 'Database not exist.'], + ['code' => 'HasUnreleasedResource', 'message' => 'The current user has unreleased resource.', 'http_code' => 403, 'description' => 'The current user has unreleased resource.'], + ['code' => 'InstanceIdFormatError', 'message' => 'The format of the instance ID is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InstanceNotExists', 'message' => 'The speicified instance ID does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'InstanceNotReady', 'message' => 'The instance is not ready.', 'http_code' => 403, 'description' => 'The instance is not ready.'], + ['code' => 'InstanceSuspended', 'message' => 'The instance is suspended.', 'http_code' => 403, 'description' => 'Instance is suspended.'], + ['code' => 'Internal Error', 'message' => 'Server Internal Error.', 'http_code' => 500, 'description' => 'Server Internal Error'], + ['code' => 'InternalError', 'message' => 'A server error occurred while processing your request.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingParameter', 'message' => 'You must specify the parameter %s.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'NotSupportInCurrentVersion', 'message' => 'The feature is not supported in current version.', 'http_code' => 400, 'description' => 'The feature is not supported in current version.'], + ['code' => 'NotSupportYet', 'message' => 'This feature is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'RegionNotExist', 'message' => 'The specified region does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'Resource not exists failed', 'message' => 'resource does not exist.', 'http_code' => 404, 'description' => 'Instance does not exist'], + ['code' => 'resource not exists failed', 'message' => 'the resource not exists failed.', 'http_code' => 404, 'description' => 'Instance does not exist'], + ['code' => 'UserAlreadyExist', 'message' => 'The user already exists.', 'http_code' => 409, 'description' => 'User already exist.'], + ['code' => 'UserNotExist', 'message' => 'The user does not exist.', 'http_code' => 404, 'description' => 'User not exist.'], + ['code' => 'UserStatusIllegal', 'message' => 'The user status is invalid.', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceNetworkType'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebalanceHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBackupData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHiveAccess'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWarehouses'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceName'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHiveAccess'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWarehouseDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameHoloWarehouse'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'hologram.cn-shenzhen-finance-1.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'Hologram', + 'productName' => 'Hologres', + 'ramCodes' => ['hologram'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RenameHoloWarehouse', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RenameHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ResumeInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ResumeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListLeaderInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListLeaderInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateOperationEventScheduleTime', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateOperationEventScheduleTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceModel', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:ListInstanceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateUser', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ScaleInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ScaleInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateWarehouseScheduleTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateWarehouseScheduleTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DisableOperationEvent', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:DisableOperationEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateHoloWebLoginSetting', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateHoloWebLoginSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteHoloWarehouse', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'EnableSupportAccount', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:EnableSupportAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteModelService', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteModelService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceModel', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetInstanceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetUpgradeable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetUpgradeable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetHoloWebLoginSetting', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetHoloWebLoginSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetWarehouseDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetWarehouseDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DropUser', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DropUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#instanceId}'], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'StopInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:StopInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetExecuteStatementEnabled', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetExecuteStatementEnabled', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RestartHoloWarehouse', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RestartHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetRootCertificate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:GetRootCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeTags', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:DescribeTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteModelResource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteModelResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWarehouseScheduleTask', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListWarehouseScheduleTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DisableHiveAccess', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:DisableHiveAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'EnableExecuteStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:EnableExecuteStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateWarehouse', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], + [ + 'apiName' => 'CreateModelService', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateModelService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateScheduledBackupConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateScheduledBackupConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetCertificateAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetCertificateAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'MigrateInstanceZone', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:MigrateInstanceZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteBackupData', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteBackupData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListDatabases', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ScaleHoloWarehouse', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ScaleHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListFollowerInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListFollowerInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateModelService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateModelService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UnBindLeaderInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UnBindLeaderInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'BindLeaderInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:BindLeaderInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RestartInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RestartInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DisableSSL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:DisableSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateBackupDataDesc', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateBackupDataDesc', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'SuspendHoloWarehouse', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:SuspendHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateHoloWarehouse', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetLastUpgradeRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetLastUpgradeRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListModelCatalog', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListModelCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRegions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetScheduledBackupConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetScheduledBackupConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'EnableHiveAccess', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:EnableHiveAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetUpgradeStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hologram:GetUpgradeStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMigrationZones', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListMigrationZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListBackupData', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListBackupData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GrantDatabasePermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:GrantDatabasePermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GrantTablePermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:GrantTablePermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstanceName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateInstanceName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListWarehouseScheduleEvent', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListWarehouseScheduleEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RenewSSLCertificate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:RenewSSLCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DiscardUpgrade', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DiscardUpgrade', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'PrepareUpgrade', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:PrepareUpgrade', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'HoloInstance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpgradeInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpgradeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RebalanceHoloWarehouse', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RebalanceHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'EnableSSL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:EnableSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateMaintenanceWindow', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateMaintenanceWindow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstanceNetworkType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateInstanceNetworkType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateAutoUpgrade', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateAutoUpgrade', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListUpgradeReleaseVersions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListUpgradeReleaseVersions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListOperationEvents', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListOperationEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecuteStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'hologram:ExecuteStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ResumeHoloWarehouse', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:ResumeHoloWarehouse', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListWarehouses', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:ListWarehouses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateWarehouseScheduleTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:UpdateWarehouseScheduleTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DisableSupportAccount', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:DisableSupportAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateDatabase', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:CreateDatabase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateManualBackup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hologram:CreateManualBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstancePort', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:UpdateInstancePort', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateExternalDatabase', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:CreateExternalDatabase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GrantSchemaPermission', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'hologram:GrantSchemaPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RenewInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hologram:RenewInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteWarehouseScheduleTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hologram:DeleteWarehouseScheduleTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'hologram.cn-shanghai-finance-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:*:{#accountId}:instance/*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:*:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'HoloInstance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ]; |