diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/hologram | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/hologram')
| -rw-r--r-- | data/zh_cn/hologram/2022-06-01/api-docs.php | 4969 |
1 files changed, 4969 insertions, 0 deletions
diff --git a/data/zh_cn/hologram/2022-06-01/api-docs.php b/data/zh_cn/hologram/2022-06-01/api-docs.php new file mode 100644 index 0000000..792e4cd --- /dev/null +++ b/data/zh_cn/hologram/2022-06-01/api-docs.php @@ -0,0 +1,4969 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'Hologram', + 'version' => '2022-06-01', + ], + 'directories' => [ + [ + 'id' => 321219, + 'title' => '数据库', + 'type' => 'directory', + 'children' => [ + 'RevokeTablePermission', + 'RevokeSchemaPermission', + 'RevokeDatabasePermission', + 'ListDatabases', + 'GrantTablePermission', + 'GrantSchemaPermission', + 'GrantDatabasePermission', + ], + ], + [ + 'id' => 321227, + 'title' => '实例', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'DeleteInstance', + 'RenewInstance', + 'RestartInstance', + 'ResumeInstance', + 'UpdateInstanceName', + 'UpdateInstanceNetworkType', + 'DisableHiveAccess', + 'EnableHiveAccess', + 'StopInstance', + 'ScaleInstance', + 'ChangeResourceGroup', + 'ListInstances', + 'GetInstance', + ], + ], + [ + 'id' => 321242, + 'title' => '计算组', + 'type' => 'directory', + 'children' => [ + 'CreateHoloWarehouse', + 'DeleteHoloWarehouse', + 'RebalanceHoloWarehouse', + 'ResumeHoloWarehouse', + 'SuspendHoloWarehouse', + 'RenameHoloWarehouse', + 'ScaleHoloWarehouse', + 'RestartHoloWarehouse', + 'GetWarehouseDetail', + 'ListWarehouses', + ], + ], + [ + 'id' => 321253, + 'title' => '备份', + 'type' => 'directory', + 'children' => [ + 'ListBackupData', + ], + ], + [ + 'id' => 321255, + 'title' => '安全', + 'type' => 'directory', + 'children' => [ + 'EnableSSL', + 'DisableSSL', + 'GetCertificateAttribute', + 'GetRootCertificate', + 'RenewSSLCertificate', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'RevokeTablePermission' => [ + 'summary' => '取消表授权。', + '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' => [ + 'FEATUREhologramFOIKRO', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'databaseName' => [ + 'description' => '库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + 'userName' => [ + 'description' => '用户id。请参考[Hologres账户概述](~~130393~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'p4_1234xxxx', + ], + 'schemaName' => [ + 'description' => 'schema名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_schema', + ], + 'tableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_table', + ], + 'privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限。请参考[Hologres权限模型](~~198734~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + ], + 'required' => false, + ], + 'allTable' => [ + 'description' => '是否对所有表生效。true：是，false/null：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'true:成功；false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => '撤销表授权', + ], + 'RevokeSchemaPermission' => [ + 'summary' => '取消Schema授权。', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-xxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'databaseName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + 'userName' => [ + 'description' => '用户id。请参考 [Hologres账户概述](~~130393~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'p4_1234xxxx', + ], + 'schemaName' => [ + 'description' => 'Schema名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_schema', + ], + 'privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限。请参考[Hologres权限模型](~~198734~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'developer', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'true:成功；false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => '撤销Schema授权', + ], + 'RevokeDatabasePermission' => [ + 'summary' => '取消DB授权。', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-zpr3426vxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'databaseName' => [ + 'description' => '库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + 'userName' => [ + 'description' => '用户id。请参考[Hologres账户概述](~~130393~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'p4_1234xxxx', + ], + 'privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限列表。请参考[Hologres权限模型](~~198734~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'developer', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'true:成功；false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]', + 'title' => '撤销数据库授权', + ], + 'ListDatabases' => [ + 'summary' => '获取DB列表。', + 'path' => '/api/v1/instances/{instanceId}/listDatabases', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-jfj3zckut008', + ], + ], + [ + 'name' => 'external', + 'in' => 'query', + 'schema' => [ + 'description' => '是否单独列出外表。true 是，false/null：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '权限模型。请参考[Hologres权限模型](~~198734~~)', + 'type' => 'string', + 'example' => 'SPM', + ], + 'Privilege' => [ + 'description' => '权限', + 'type' => 'string', + 'example' => 'developer', + ], + 'External' => [ + 'description' => '是否外表。true：是，false：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'Success' => [ + 'description' => '请求结果，表示此次请求是否发生异常。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', + ], + ], + ], + '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"}]', + 'title' => '数据库列表', + ], + 'GrantTablePermission' => [ + 'summary' => 'DB授权。', + 'path' => '/api/v1/instances/{instanceId}/grantTablePermission', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-zpr3426xxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'databaseName' => [ + 'description' => 'database名称。', + 'type' => 'string', + 'required' => false, + 'example' => ' my_db', + ], + 'privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限列表。请参考[Hologres权限模型](~~198734~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + ], + 'required' => false, + ], + 'userName' => [ + 'description' => '用户id。请参考 [Hologres账户概述](~~130393~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'p4_1234xxxx', + ], + 'schemaName' => [ + 'description' => 'Schema名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_schema', + ], + 'tableName' => [ + 'description' => '表名', + 'type' => 'string', + 'required' => false, + 'example' => 'orders_pay', + ], + 'allTable' => [ + 'description' => '是否给当前所有表授权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'true:成功；false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '表授权', + ], + 'GrantSchemaPermission' => [ + 'summary' => 'DB授权。', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-lbj33559xxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'databaseName' => [ + 'description' => 'database名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'db_demo', + ], + 'privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限。请参考[Hologres Schema级别授权](~~199088~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'developer', + ], + 'required' => false, + ], + 'userName' => [ + 'description' => '用户id。请参考 [Hologres账户概述](~~130393~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'p4_134xxx', + ], + 'schemaName' => [ + 'description' => 'schema名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_schema', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'true:成功；false:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'Schema授权', + ], + 'GrantDatabasePermission' => [ + 'summary' => 'DB授权。', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-zpr3426vm002', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'databaseName' => [ + 'description' => 'database名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + 'privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限。请参考[Hologres权限模型](~~198734~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'developer', + ], + 'required' => false, + ], + 'userName' => [ + 'description' => '用户id。请参考[Hologres账户概述](~~130393~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'p4_123444xxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'true：成功；false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '数据库授权', + ], + 'CreateInstance' => [ + 'summary' => '该接口用于创建实例。', + 'path' => '/api/v1/instances/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREhologramUCU2YC', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '地域Id. 可前往<props="china">[服务接入点](https://help.aliyun.com/zh/hologres/developer-reference/api-hologram-2022-06-01-endpoint)</props>'."\n" + .'<props="intl">[服务接入点](https://www.alibabacloud.com/help/zh/hologres/developer-reference/api-hologram-2022-06-01-endpoint)</props>。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + 'zoneId' => [ + 'description' => '可用区Id。参考“使用说明“', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-h', + ], + 'vpcId' => [ + 'description' => '虚拟专有网络，其所在regionId必须与实例一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-t4netc3y5xxxx', + ], + 'vSwitchId' => [ + 'description' => '虚拟专有交换机，其所在zoneId必须与实例一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-2vccsiymtxxxxxx', + ], + 'resourceGroupId' => [ + 'description' => '资源组。若为空，则为账号默认资源组。', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + 'instanceName' => [ + 'description' => '实例名称(2-64个字符，一个中文/字母算一个字符)。', + 'type' => 'string', + 'required' => true, + 'example' => 'my_holo', + ], + 'instanceType' => [ + 'description' => '实例类型。取值：'."\n" + .'- Standard：通用型。'."\n" + .'- Follower：只读从实例。'."\n" + .'- Warehouse：计算组型。'."\n" + .'- Shared：共享型。'."\n" + .'- Severless：Serverless型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Warehouse' => 'Warehouse', + 'Follower' => 'Follower', + 'Standard' => 'Standard', + 'Serverless' => 'Serverless', + 'Shared' => 'Shared', + ], + 'example' => 'Standard', + 'enum' => [ + 'Standard', + 'Follower', + 'Warehouse', + 'Shared', + 'Serverless', + ], + ], + 'cpu' => [ + 'description' => '实例规格。取值：'."\n" + .'- 32核128 GB（计算节点数量：2）'."\n" + .'- 64核256 GB（计算节点数量：4）'."\n" + .'- 96核384 GB（计算节点数量：6）'."\n" + .'- 128核512 GB（计算节点数量：8）'."\n" + .'- 等'."\n" + ."\n" + .'>'."\n" + .' >- 填写核数即可。'."\n" + .' >- 购买1024以上规格实例请提交工单申请。'."\n" + .' >- Shared实例类型无需指定规格。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '64', + ], + 'storageSize' => [ + 'description' => '实例标准存储空间。单位：GB。'."\n" + .'> 按量付费实例（PostPaid）会忽略此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '500', + ], + 'coldStorageSize' => [ + 'description' => '实例低频存储空间。单位：GB。'."\n" + .'> 按量付费（PostPaid）实例会忽略此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '500', + ], + 'gatewayCount' => [ + 'description' => '网关数量，取值[2, 50]。'."\n" + ."\n" + .'> 只有Warehouse类型需要指定该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50', + 'minimum' => '2', + 'example' => '4', + ], + 'chargeType' => [ + 'description' => '付费类型。取值：'."\n" + .'- PrePaid：包年包月。'."\n" + .'- PostPaid: 按量付费。'."\n" + .'> Shared实例类型会忽略该参数。Shared是一种固定规格类型，收费类型默认为PostPaid。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PostPaid' => 'PostPaid', + 'PrePaid' => 'PrePaid', + ], + 'example' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + 'autoPay' => [ + 'description' => '是否自动支付，默认为true。取值：'."\n" + .'- true：自动支付。'."\n" + .'- false：只生成订单，不支付。'."\n" + .'> 默认值为true。如果您的支付方式余额不足，可以将参数AutoPay设置为false，此时会生成未支付订单，您可以登录费用与成本自行支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'pricingCycle' => [ + 'description' => '计费周期。取值：'."\n" + .'- Month：按月计费。'."\n" + .'- Hour：按小时计费。'."\n" + .'>'."\n" + .'> - PrePaid 只支持Month'."\n" + .'> - PostPaid 只支持Hour'."\n" + .'> - Shared类型自动设为Hour，无需指定。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Month' => 'Month', + 'Hour' => 'Hour', + ], + 'example' => 'Month', + 'enum' => [ + 'Month', + 'Hour', + ], + ], + 'duration' => [ + 'description' => '购买周期。比如购买2个月。'."\n" + .'> 若付费类型为PostPaid，则无需指定。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'autoRenew' => [ + 'description' => '是否开启按月自动续费，默认值为false。取值：'."\n" + .'- true：开启。'."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'leaderInstanceId' => [ + 'description' => '主实例Id，Follower类型必填。'."\n" + ."\n" + .'> 主从实例必须满足以下条件：'."\n" + .'> - 主实例"运行正常"(Running)状态'."\n" + .'> - 主从实例regionId一致'."\n" + .'> - 主从实例zoneId一致'."\n" + .'> - 主实例已绑定的从实例数少于10个'."\n" + .'> - 主从实例属于同一个主账号', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-lbj3aworq112', + ], + 'initialDatabases' => [ + 'description' => '初始数据库。', + 'type' => 'string', + 'required' => false, + 'example' => 'chatbot', + ], + 'enableServerlessComputing' => [ + 'description' => '是否开启ServerlessComputing', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '开启', + 'false' => '不开启', + ], + 'example' => 'true', + ], + 'storageType' => [ + 'description' => '存储类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'local' => '本地冗余类型', + 'redundant' => '同城冗余(多AZ)', + ], + 'example' => 'redundant', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9CC37B9F-F4B4-5FF1-939B-AEE78DC70130', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'hgpostcn-cn-xxxxxx', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '217523224780172', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidVpcOrVSwitch.NotAvailable', + ], + 'Message' => [ + 'description' => '错误详细信息。', + 'type' => 'string', + 'example' => 'InvalidVpcOrVSwitch.NotAvailable'."\n", + ], + 'Success' => [ + 'description' => '创建是否成功。 '."\n" + .'- true：创建成功。'."\n" + .'- false：创建失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + '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' => '创建实例', + 'description' => '><warning>该API操作涉及费用，请确保在使用该接口前，已充分了解实时数仓Hologres的收费方式和价格。></warning>'."\n" + ."\n" + .'<props="china">- Hologres计费详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4)。</props>'."\n" + ."\n" + .'<props="intl"> - Hologres计费详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview)。</props>'."\n" + ."\n" + .'- 创建Hologres实例时，您需要指定实例所在地域和可用区。一个地域可能对应多个可用区，具体如下：'."\n" + .' ```'."\n" + .' cn-hangzhou(杭州)：cn-hangzhou-h, cn-hangzhou-j, cn-hangzhou-k'."\n" + .' cn-shanghai(上海): cn-shanghai-e, cn-shanghai-f, cn-shanghai-l'."\n" + .' cn-beijing(北京): cn-beijing-i, cn-beijing-g, cn-beijing-l'."\n" + .' cn-zhangjiakou(张家口): cn-zhangjiakou-b'."\n" + .' cn-shenzhen(深圳): cn-shenzhen-d, cn-shenzhen-f, cn-shenzhen-e'."\n" + .' cn-wulanchabu(乌兰察布): cn-wulanchabu-a'."\n" + .' cn-hongkong(香港): cn-hongkong-b, cn-hongkong-d'."\n" + .' cn-shanghai-finance-1(上海金融云): cn-shanghai-finance-1z, cn-shanghai-finance-1f'."\n" + .' cn-hangzhou-finance(杭州金融云): cn-hangzhou-finance-k'."\n" + .' cn-shenzhen-finance-1(深圳金融云): cn-shenzhen-finance-1d'."\n" + .' ap-northeast-1(日本): ap-northeast-1a'."\n" + .' ap-southeast-1(新加坡): ap-southeast-1c, ap-southeast-1a'."\n" + .' ap-southeast-3(吉隆坡): ap-southeast-3b'."\n" + .' ap-southeast-5(雅加达): ap-southeast-5b'."\n" + .' eu-central-1(法兰克福): eu-central-1a'."\n" + .' us-east-1(硅谷): us-east-1a'."\n" + .' us-west-1(弗吉尼亚): us-west-1b'."\n" + .'```', + 'responseParamsDescription' => '> '."\n" + .'> - 参数校验错误，仍然会返回正常的Data，Success为false，并包含Code和Message。除非抛出异常，否则成功与否由Data.Success来判断。'."\n" + .'> - 使用新版SDK包调用本接口时，由于SDK内部的客户端默认超时时间和服务端的不一致，因此可能返回请求超时的错误，但实际上接口已调用成功。如需避免这个问题，您可以在调用前设置ReadTimeout参数为20000。'."\n" + .'![]()'."\n" + ."\n" + .'', + ], + 'DeleteInstance' => [ + 'summary' => '该接口用于释放实例。', + 'path' => '/api/v1/instances/{instanceId}/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' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-7mz2vmu30003', + ], + ], + ], + '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' => 'CB13FFDD-2DF8-5396-A848-2D6A31245B6D', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http 状态码', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '删除实例', + 'description' => '><warning>使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。></warning>'."\n" + ."\n" + .'<props="china">- Hologres实例释放后，实例内的数据和对象均不可恢复，请谨慎操作。详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.0.7d413e94YMVcqe)。</props>'."\n" + .'<props="intl">- Hologres实例释放后，实例内的数据和对象均不可恢复，请谨慎操作。详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview?spm=a2c63.p38356.0.0.efc33b87i5pDl7)。</props>'."\n" + .'- 仅支持释放按量付费（PostPaid）实例。'."\n" + ."\n" + .'<props="china">- 如果您需要退订包年包月（PrePaid）实例，请在阿里云退订管理页面操作，详情请参见[退订包年包月实例](https://help.aliyun.com/zh/hologres/product-overview/subscription?spm=a2c4g.11186623.0.0.799b69ecPba0y1)。</props>', + ], + 'RenewInstance' => [ + 'summary' => '该接口用于为实例手动续费。可以在续费的同时开启按月自动续费。', + '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' => '实例id。', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'description' => '续费周期。单位：月。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + 'autoRenew' => [ + 'description' => '是否开启按月自动续费，默认不开启。取值：'."\n" + .'- true：开启。'."\n" + .'- false：不开启'."\n" + ."\n" + .'> 已开启自动续费的实例，再次开启会报错。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidChargeType.UnRenewable', + ], + 'Message' => [ + 'description' => '错误详细信息。', + 'type' => 'string', + 'example' => '不支持续费的付费类型', + ], + 'OrderId' => [ + 'description' => '订单Id', + 'type' => 'string', + 'example' => '221625608580893', + ], + 'Success' => [ + 'description' => '续费是否成功。 '."\n" + .'- true：续费成功。'."\n" + .'- false：续费失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求结果，表示此次请求是否发生异常，和业务无关', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => '实例续费', + 'description' => '><warning>该API操作涉及费用，请确保在使用该接口前，已充分了解实时数仓Hologres的收费方式和价格。></warning>'."\n" + .'<props="china">- Hologres计费详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4)。</props>'."\n" + .'<props="intl">- Hologres计费详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview)。</props>'."\n" + .'<props="china">- Hologres续费操作请参见[续费管理](https://help.aliyun.com/zh/hologres/product-overview/manage-renewals?spm=a2c4g.11186623.0.0.6b776c2eJ1h2vx)。</props>'."\n" + .'<props="intl">- Hologres续费操作请参见[续费管理](https://www.alibabacloud.com/help/zh/hologres/product-overview/manage-renewals?spm=a2c63.p38356.0.0.38e731c9VAwtDP)。</props>'."\n" + .'- 续费操作仅适用预付费（PrePaid）实例。', + 'responseParamsDescription' => '>'."\n" + .'> - 参数校验错误，仍然会返回正常的Data，Success为false，并包含Code和Message。除非抛出异常，否则成功与否由Data.Success来判断。'."\n" + .'> - 使用新版SDK包调用本接口时，由于SDK内部的客户端默认超时时间和服务端的不一致，因此可能返回请求超时的错误，但实际上接口已调用成功。如需避免这个问题，您可以在调用前设置ReadTimeout参数为20000。'."\n" + ."\n" + .'', + ], + 'RestartInstance' => [ + 'summary' => '该接口用于重启Hologres实例。', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-i7m2ucpyu005', + ], + ], + ], + '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' => '36291497-CDB0-53DC-8CD7-762E054F57A6', + ], + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Success' => [ + 'description' => '请求结果，表示此次请求是否发生异常，和业务无关', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '重启实例', + ], + 'ResumeInstance' => [ + 'summary' => '恢复暂停的实例。', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + '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' => '返回结果,表示操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '请求结果，表示此次请求是否发生异常，和业务无关', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '恢复实例', + ], + 'UpdateInstanceName' => [ + 'summary' => '该接口用于修改实例名称。', + 'path' => '/api/v1/instances/{instanceId}/instanceName', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-zpr30pupt004', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'instanceName' => [ + 'description' => '新实例名称(2-64个字符，一个中文/字母算一个字符)。', + 'type' => 'string', + 'required' => false, + 'example' => 'new_name', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'C6B55032-D41A-5FE0-9C07-8BD81C88422E', + ], + 'Data' => [ + 'description' => '返回结果,表示操作是否成功。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Success' => [ + 'description' => '请求结果，表示此次请求是否发生异常。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '修改实例名称', + ], + 'UpdateInstanceNetworkType' => [ + 'summary' => '该接口用于修改实例网络类型。', + 'path' => '/api/v1/instances/{instanceId}/network', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-lbj35pw74002', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'networkTypes' => [ + 'description' => '希望开启的网络类型列表，已有网络类型的组合，顺序无关。'."\n" + .'比如已经开启公网、内网和VPCSingleTunnel，如要关闭公网，'."\n" + .'则把公网类型去掉即可，即传递 “Intranet, VPCSingleTunnel” 。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VPCSingleTunnel' => '专有网络', + 'Intranet' => '内网', + 'VPCAnyTunnel' => '兼容性需求，新实例不支持，', + 'Internet' => '公网', + ], + 'example' => 'Internet,VPCSingleTunnel', + ], + 'vpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-t4netc3y5etlondfb5ra7', + ], + 'vSwitchId' => [ + 'description' => '虚拟交换机id', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2vccsiymtqr9aavew0vo3', + ], + 'vpcRegionId' => [ + 'description' => 'vpc所属地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'vpcOwnerId' => [ + 'description' => 'vpc 的ownerId，即阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1999365732646672', + ], + 'anyTunnelToSingleTunnel' => [ + 'description' => '是否从AnyTunnel转换成SingleTunnel（新实例无用，默认为null即可）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'others/null' => '不转换', + 'true' => '转换', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '9CC37B9F-F4B4-5FF1-939B-AEE78DC70130', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'string', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Success' => [ + 'description' => '请求结果。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '切换实例的网络类型', + ], + 'DisableHiveAccess' => [ + 'summary' => '该接口用于关闭数据湖加速。', + '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' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-tl330rv9k00e', + ], + ], + ], + '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' => '82B7A554-4D00-50DF-95D9-B59E7B4D5489', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Success' => [ + 'description' => '请求结果', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '404', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Internal server error.', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '关闭数据湖加速', + ], + 'EnableHiveAccess' => [ + 'summary' => '该接口用于开启数据湖加速。', + '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' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-zpr3426vm002', + ], + ], + ], + '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' => 'EA8F0084-5831-5907-BB31-BD05D2617844', + ], + 'Data' => [ + 'description' => '返回结果', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Success' => [ + 'description' => '操作是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '404', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Internal server error.', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '开启数据湖加速', + ], + 'StopInstance' => [ + 'summary' => '该接口用于暂停实例。', + 'path' => '/api/v1/instances/{instanceId}/stop', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-lbj33559x001', + ], + ], + ], + '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', + ], + 'Data' => [ + 'description' => '返回结果,表示操作是否成功。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Success' => [ + 'description' => '请求结果，表示此次请求是否发生异常，和业务无关', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '停止实例', + ], + 'ScaleInstance' => [ + 'summary' => '该接口用于变更实例的规格和存储空间。', + 'path' => '/api/v1/instances/{instanceId}/scale', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREhologramUCU2YC', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-xxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'cpu' => [ + 'description' => '实例规格。取值：'."\n" + .'- 16核64 GB （计算节点数量：1）'."\n" + .'- 32核128 GB（计算节点数量：2）'."\n" + .'- 64核256 GB（计算节点数量：4）'."\n" + .'- 96核384 GB（计算节点数量：6）'."\n" + .'- 128核512 GB（计算节点数量：8）'."\n" + .'- 等'."\n" + ."\n" + .'>'."\n" + .' >- 填写核数即可。'."\n" + .' >- 购买1024以上规格请提交工单申请。'."\n" + .' >- Shared实例类型无需指定规格。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '128', + 'default' => '0', + ], + 'storageSize' => [ + 'description' => '实例标准存储空间。单位：GB。'."\n" + ."\n" + .'> 按量付费（PostPaid）实例会忽略此参数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000G', + 'default' => '0', + ], + 'coldStorageSize' => [ + 'description' => '实例低频存储空间。单位：GB。'."\n" + ."\n" + .'> 按量付费（PostPaid）实例会忽略此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000G', + 'default' => '0', + ], + 'scaleType' => [ + 'description' => '变配类型。取值：'."\n" + .'- UPGRADE：升配'."\n" + .'- DOWNGRADE：降配'."\n" + .'> '."\n" + .'> - 升配规格不能小于原规格，为空的字段表示维持原规格不变，在此基础上，至少一项规格比原规格大。'."\n" + .'> - 降配规格不能大于原规格，为空的字段表示维持原规格不变，在此基础上，至少一项规格比原规格小。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'DOWNGRADE' => 'DOWNGRADE', + 'UPGRADE' => 'UPGRADE', + ], + 'example' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + ], + 'gatewayCount' => [ + 'description' => '网关数量，取值[2, 50]。'."\n" + ."\n" + .'> 只有Warehouse类型需要指定该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4', + ], + 'enableServerlessComputing' => [ + 'description' => '是否开启ServerlessComputing', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单Id', + 'type' => 'string', + 'example' => '219183853450000', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidScaleType.Unsupported', + ], + 'Message' => [ + 'description' => '错误详细信息。', + 'type' => 'string', + 'example' => '不支持的变配类型', + ], + 'Success' => [ + 'description' => '变配是否成功。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '实例变配', + 'description' => '><warning>该API操作涉及费用，请确保在使用该接口前，已充分了解实时数仓Hologres的收费方式和价格。></warning>'."\n" + ."\n" + .'<props="china">- Hologres计费详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4)。</props>'."\n" + .'<props="intl">- Hologres计费详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview)。</props>'."\n" + .'<props="china">- 变配实例计算资源期间实例不可用，变配实例存储资源不影响实例的正常使用。请勿频繁进行实例变配操作。详情请参见[实例升降配](https://help.aliyun.com/zh/hologres/product-overview/upgrade-or-downgrade-instance-specifications?spm=a2c4g.11186623.0.i7)。</props>'."\n" + .'<props="intl">- 变配实例计算资源期间实例不可用，变配实例存储资源不影响实例的正常使用。请勿频繁进行实例变配操作。详情请参见[实例升降配](https://www.alibabacloud.com/help/zh/hologres/product-overview/upgrade-or-downgrade-instance-specifications)。</props>', + 'responseParamsDescription' => '>'."\n" + .'> - 参数校验错误，仍然会返回正常的Data，Success为false，并包含Code和Message。除非抛出异常，否则成功与否由Data.Success来判断。'."\n" + .'> - 使用新版SDK包调用本接口时，由于SDK内部的客户端默认超时时间和服务端的不一致，因此可能返回请求超时的错误，但实际上接口已调用成功。如需避免这个问题，您可以在调用前设置ReadTimeout参数为20000。'."\n" + ."\n" + .'', + ], + 'ChangeResourceGroup' => [ + 'summary' => '更新资源组。', + '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' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'newResourceGroupId' => [ + 'description' => '新资源组Id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxwerqwerasfd', + ], + 'instanceId' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-zvp25ysv3006', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '操作是否成功。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AB71198A-2DB1-511B-AE4D-690BAA97F076\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '更新资源组', + ], + 'ListInstances' => [ + 'summary' => '获取实例列表。', + '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' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmvscak73zmby', + ], + 'tag' => [ + 'description' => '实例标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'mytag', + ], + 'value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'cmsInstanceType' => [ + 'description' => '云监控实例类型。取值：'."\n" + .'- standard'."\n" + .'- follower'."\n" + .'- mc-acceleration'."\n" + .'- warehouse'."\n" + .'- high-memory'."\n" + .'- serverless'."\n" + ."\n" + .'> 这是云监控', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D1303CD4-AA70-5998-8025-F55B22C50840', + ], + 'InstanceList' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '商品code，与费用中心产品明细code一致', + 'type' => 'string', + 'example' => 'hologram_postpay_public_cn', + ], + 'CreationTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-12-16T02:24:05Z', + ], + 'ExpirationTime' => [ + 'description' => '到期时间。', + 'type' => 'string', + 'example' => '2023-05-04T16:00:00.000Z', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'hgpostcn-cn-aaab9ad2d8fb', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test_instance', + ], + 'InstanceStatus' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Creating' => '正在创建', + 'Running' => '正常运行', + 'Suspended' => '停机', + 'Allocating' => '正在处理', + ], + 'example' => 'Running', + ], + 'InstanceType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Warehouse' => '计算组型', + 'Follower' => '只读从实例', + 'Standard' => '普通型', + 'Serverless' => 'Serverless型', + 'Shared' => '共享型', + ], + 'example' => 'Standard', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'InstanceChargeType' => [ + 'description' => '实例付费类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'PostPaid' => '按量付费', + 'PrePaid' => '包年包月', + ], + 'example' => 'PrePaid', + ], + 'LeaderInstanceId' => [ + 'description' => '主实例ID。', + 'type' => 'string', + 'example' => 'hgprecn-cn-2r42sqvxm006', + ], + 'SuspendReason' => [ + 'description' => '暂停原因。', + 'type' => 'string', + 'example' => 'Manual', + ], + 'EnableHiveAccess' => [ + 'description' => '是否启用湖仓加速。', + 'type' => 'string', + 'enumValueTitles' => [ + 'true' => '开启', + 'false' => '关闭', + ], + 'example' => 'true', + ], + 'Version' => [ + 'description' => '实例版本。', + 'type' => 'string', + 'example' => '1.3.37', + ], + 'ResourceGroupId' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'example' => 'rg-acfmvscak73zmby', + ], + 'Endpoints' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名详情。', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80', + ], + 'Type' => [ + 'description' => '网络类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'VPCSingleTunnel' => '专有网络', + 'Intranet' => '内网', + 'VPCAnyTunnel' => '新实例不再支持', + 'Internet' => '公网', + ], + 'example' => 'Internet', + ], + 'Enabled' => [ + 'description' => '是否启用Endpoint。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '开启', + 'false' => '关闭', + ], + 'example' => 'true', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-wz9oap28raidjevhuszg4', + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-uf6mrahzyu7uorlqqpz5f', + ], + 'VpcInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'hgpostcn-cn-wwo3665tx004-frontend-st', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => '可用区ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'StorageType' => [ + 'description' => '存储类型：'."\n" + .'* redundant：3AZ'."\n" + .'* local：1AZ', + 'type' => 'string', + 'example' => 'redundant', + ], + 'EnableSSL' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Success' => [ + 'description' => '调用接口是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', + ], + ], + ], + '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' => '获取实例列表', + ], + 'GetInstance' => [ + 'summary' => '该接口用于获取实例详情。', + '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' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-i7m2v08uu00a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '865A02C2-B374-5DD4-9B34-0CA15DA1AEBD', + ], + 'Instance' => [ + 'description' => '实例信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceChargeType' => [ + 'description' => '实例付费类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'PostPaid' => '按量付费', + 'PrePaid' => '包年包月', + ], + 'example' => 'PrePaid', + ], + 'CommodityCode' => [ + 'description' => '商品code。', + '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' => 'CPU核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'CreationTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2021-02-03T13:06:06Z', + ], + 'Disk' => [ + 'description' => '标准存储大小。'."\n" + .'单位：GB。', + 'type' => 'string', + 'example' => '500', + ], + 'Endpoints' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名详情。', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80', + ], + 'Type' => [ + 'description' => '网络类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'VPCSingleTunnel' => '专有网络', + 'Intranet' => '内网', + 'VPCAnyTunnel' => '（新实例不支持）', + 'Internet' => '公网', + ], + 'example' => 'Internet', + ], + 'Enabled' => [ + 'description' => '是否开启网络。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '开启', + 'false' => '关闭', + ], + 'example' => 'true', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1jqwp2ys6kp7tc9t983', + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-uf66jjber3hgvwhki3wna', + ], + 'VpcInstanceId' => [ + 'description' => 'vpc实例ID。', + 'type' => 'string', + 'example' => 'hgprecn-cn-uqm362o1b001-frontend-st', + ], + 'AlternativeEndpoints' => [ + 'description' => '一些旧实例同时开启了AnyTunnel和SingleTunnel，当从AnyTunnel切换到SingleTunnel时，会同时保留二者的Endpoint，因此需要多一个字段保存Endpoint。', + 'type' => 'string', + 'example' => 'hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80', + ], + ], + ], + ], + 'ExpirationTime' => [ + 'description' => '到期时间。'."\n" + .'按量付费类型没有到期时间。', + 'type' => 'string', + 'example' => '2021-02-03T13:06:06Z', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'hgpostcn-cn-tl32s6cgw00b', + ], + 'InstanceName' => [ + 'description' => '实例名称。'."\n" + .'2-64个字符，字母和汉字都算一个。', + 'type' => 'string', + 'example' => 'test', + ], + 'InstanceType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Warehouse' => '计算组型', + 'Follower' => '只读从实例', + 'Standard' => '普通型', + 'Serverless' => 'Serverless型', + 'Shared' => '共享型', + ], + 'example' => 'Standard', + ], + 'Memory' => [ + 'description' => '内存。'."\n" + .'单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'InstanceOwner' => [ + 'description' => '实例所有者。', + 'type' => 'string', + 'example' => '12345678900000', + ], + 'InstanceStatus' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Creating' => '正在创建', + 'Running' => '正常运行', + 'Suspended' => '停机', + 'Allocating' => '正在处理', + ], + 'example' => 'Running', + ], + 'Version' => [ + 'description' => '实例版本。', + 'type' => 'string', + 'example' => 'r1.3.37', + ], + 'SuspendReason' => [ + 'description' => '暂停原因。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Indebet' => '已欠费', + 'Manual' => '手动停机', + 'Overdue' => '已到期', + ], + 'example' => 'Manual', + ], + 'Tags' => [ + 'description' => '实例标签', + 'type' => 'array', + 'items' => [ + 'description' => '标题详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'LeaderInstanceId' => [ + 'description' => '主实例ID。', + 'type' => 'string', + 'example' => 'hgpostcn-cn-i7m2ncd6w002', + ], + 'EnableHiveAccess' => [ + 'description' => '是否启用数据湖加速。', + 'type' => 'string', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekzuq7hpybze2i', + ], + 'ComputeNodeCount' => [ + 'description' => '计算节点数量。'."\n" + .'一个节点的典型配置：16核32G内存。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ZoneId' => [ + 'description' => '可用区ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ColdStorage' => [ + 'description' => '冷存储容量。'."\n" + .'单位：GB。'."\n" + .'SSD相当于热存，也是标准存储；HDD相当于冷存。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '800', + ], + 'AutoRenewal' => [ + 'description' => '是否开启了自动续费。', + 'type' => 'string', + 'enumValueTitles' => [ + 'true' => '已开启自动续费', + 'false' => '未开启自动续费', + ], + 'example' => 'true', + ], + 'GatewayCount' => [ + 'description' => '网关节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [], + 'example' => '2', + ], + 'GatewayCpu' => [ + 'description' => '网关cpu资源。'."\n" + .'单位：core。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [], + 'example' => '4', + ], + 'GatewayMemory' => [ + 'description' => '网关内存资源。'."\n" + .'单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [], + 'example' => '16', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ReplicaRole' => [ + 'description' => '灾备实例角色。'."\n" + .'Active: 灾备主实例，'."\n" + .'Passive: 灾备容灾实例， '."\n" + .'PreActive: 未达终态的灾备主实例。', + 'type' => 'string', + 'example' => 'Active', + ], + 'EnableServerless' => [ + 'description' => '是否开启ServerlessComputing', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '已开启', + 'false' => '已关闭', + ], + 'example' => 'true', + ], + 'StorageType' => [ + 'description' => '存储类型：'."\n" + .'* redundant：3AZ'."\n" + .'* local：1AZ', + 'type' => 'string', + 'example' => 'redundant', + ], + 'EnableSSL' => [ + 'type' => 'boolean', + ], + ], + ], + 'Success' => [ + 'description' => '请求结果，表示此次请求是否发生异常，和业务无关。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '获取实例详情', + ], + 'CreateHoloWarehouse' => [ + 'summary' => '创建计算组。', + 'path' => '/api/v1/instances/{instanceId}/createHoloWarehouse', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhologramFNR69T', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'my_warehouse', + ], + 'cpu' => [ + 'description' => '计算组规格。16的整数倍，最小值16.', + 'type' => 'string', + 'required' => true, + 'example' => '32', + ], + 'clusterCount' => [ + 'title' => '集群数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'Data' => [ + 'description' => 'true：成功；false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '创建计算组', + ], + 'DeleteHoloWarehouse' => [ + 'summary' => '删除计算组。', + 'path' => '/api/v1/instances/{instanceId}/deleteHoloWarehouse', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例Id', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'my_warehouse', + ], + ], + 'required' => false, + ], + ], + ], + '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:成功；false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除计算组', + ], + 'RebalanceHoloWarehouse' => [ + 'summary' => '计算组均衡分片。', + 'path' => '/api/v1/instances/{instanceId}/rebalanceHoloWarehouse', + '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' => '实例Id', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test_oss', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'true:成功；false：失败', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0EA5844-AB00-5653-8711-CD9FD1798412\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '计算组均衡分片', + ], + 'ResumeHoloWarehouse' => [ + 'summary' => '从停机状态恢复到正常状态。', + 'path' => '/api/v1/instances/{instanceId}/resumeHoloWarehouse', + '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' => '实例Id', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'my_warehouse', + ], + ], + 'required' => false, + ], + ], + ], + '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:成功；false:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '恢复计算组', + ], + 'SuspendHoloWarehouse' => [ + 'summary' => '停止计算组。', + 'path' => '/api/v1/instances/{instanceId}/suspendHoloWarehouse', + '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' => '实例Id', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'my_warehouse', + ], + ], + 'required' => false, + ], + ], + ], + '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:成功；false:失败', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '停止计算组', + ], + 'RenameHoloWarehouse' => [ + 'summary' => '重命名计算组。', + 'path' => '/api/v1/instances/{instanceId}/renameHoloWarehouse', + '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' => '实例Id', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '原计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'my_warehouse', + ], + 'newWarehouseName' => [ + 'description' => '新计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'new_name', + ], + ], + 'required' => false, + ], + ], + ], + '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:成功；false:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '重命名计算组', + ], + 'ScaleHoloWarehouse' => [ + 'summary' => '计算组扩缩容。', + 'path' => '/api/v1/instances/{instanceId}/scaleHoloWarehouse', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhologramFNR69T', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'my_warehouse', + ], + 'cpu' => [ + 'description' => '计算组规格。16的整数倍', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '64', + ], + 'clusterCount' => [ + 'title' => '集群数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a'."\n", + ], + ], + ], + '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:成功；false:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '变配计算组', + ], + 'RestartHoloWarehouse' => [ + 'summary' => '重启计算组。', + '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' => '实例id。', + 'type' => 'string', + 'required' => true, + 'example' => 'hgprecn-cn-i7m2v08uu00a', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'my_warehouse', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'Data' => [ + 'description' => 'true:成功；false:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '重启计算组', + ], + 'GetWarehouseDetail' => [ + 'summary' => '计算组的详细信息。', + 'path' => '/api/v1/instances/{instanceId}/getWarehouseDetail', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhologramUIEVQ0', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-i7m2ucpyu005', + ], + ], + ], + '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', + ], + 'WarehouseDetail' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'ReservedCpu' => [ + 'description' => '预留计算资源。实例所有运行中的计算组计算资源不能超过计算组预留计算资源。', + 'type' => 'string', + 'example' => '64', + ], + 'RemainingCpu' => [ + 'description' => '未分配的计算资源。实例剩余未分配的计算组计算资源', + 'type' => 'string', + 'example' => '32', + ], + 'WarehouseList' => [ + 'description' => 'Warehouse列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Warehouse', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'description' => 'cpu', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'Mem' => [ + 'description' => '内存', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'Id' => [ + 'description' => 'id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Status' => [ + 'description' => '状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'kRunning' => 'kRunning', + 'kSuspended' => 'kSuspended', + 'kInit' => 'kInit', + 'kFailed' => 'kFailed', + 'kAllocating' => 'kAllocating', + ], + 'example' => 'kRunning', + ], + 'NodeCount' => [ + 'description' => '计算节点数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'example' => 'MyWarehouse', + ], + 'ElasticCpu' => [ + 'description' => '弹性计算资源', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'DefaultWarehouse' => [ + 'description' => '是否是默认计算组', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'RebalanceStatus' => [ + 'description' => '计算组Rebalance状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'DONE' => '已完成', + 'DOING' => '执行中', + ], + 'example' => 'DONE', + ], + 'ClusterCpu' => [ + 'title' => '集群规格', + 'description' => '集群规格', + 'type' => 'string', + 'example' => '32', + ], + 'ElasticType' => [ + 'title' => '弹性类型', + 'description' => '弹性类型', + 'type' => 'string', + 'example' => 'auto', + ], + 'InitClusterCount' => [ + 'title' => '预留集群数量', + 'description' => '预留集群数量', + 'type' => 'string', + 'example' => '2', + ], + 'ClusterCount' => [ + 'title' => '集群数量', + 'description' => '集群数量', + 'type' => 'string', + 'example' => '2', + ], + 'MaxClusterCount' => [ + 'title' => '最大集群数量', + 'description' => '最大集群数量', + 'type' => 'string', + 'example' => '4', + ], + 'AutoScaleType' => [ + 'title' => '自动弹性类型', + 'description' => '自动弹性类型', + 'type' => 'string', + 'example' => 'Standard', + ], + ], + ], + ], + 'TimedElasticCpu' => [ + 'description' => '计算组当前分时弹性计算资源总量', + 'type' => 'string', + 'example' => '64', + ], + 'AutoElasticCpu' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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' => '计算组详情', + ], + 'ListWarehouses' => [ + 'summary' => '获取计算组列表。', + 'path' => '/api/v1/instances/{instanceId}/listWarehouses', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-x0r382joi001', + ], + ], + ], + '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', + ], + 'WarehouseList' => [ + 'description' => '计算组列表', + 'type' => 'array', + 'items' => [ + 'description' => '计算组列表', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Cpu' => [ + 'description' => 'cpu', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'Mem' => [ + 'description' => '内存', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'Name' => [ + 'description' => '计算组名称', + 'type' => 'string', + 'example' => 'MyWarehouse', + ], + 'Status' => [ + 'description' => '状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'kRunning' => 'kRunning', + 'kSuspended' => 'kSuspended', + 'kInit' => 'kInit', + 'kFailed' => 'kFailed', + 'kAllocating' => 'kAllocating', + ], + 'example' => 'kRunning', + ], + 'NodeCount' => [ + 'description' => '计算节点数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '计算组列表', + ], + 'ListBackupData' => [ + 'summary' => '该接口用于查询备份数据列表。一份备份是对实例截止快照时间的全量数据快照，可以通过新购实例完全恢复原来的数据。', + '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' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-wwoxxxxx', + ], + ], + [ + 'name' => 'backupType', + 'in' => 'query', + 'schema' => [ + 'description' => '备份类型。根据类型过滤特定的备份数据，为空则返回所有备份数据。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'redundant_remote' => '同城冗余备份', + 'remote' => '远程备份', + 'redundant' => '同城冗余备份', + 'full_remote' => '单备份', + 'local' => '本地备份', + 'full' => '单备份', + ], + 'example' => 'redundant', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46', + ], + 'BackupDataList' => [ + 'description' => '备份列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupType' => [ + 'description' => '备份类型。备份类型总体上分两种：1）本地备份，快照与实例属于相同Region；2）远程备份，快照与实例属于不同Region。'."\n" + ."\n" + .'- redundant: 本地备份，同城跨可用区多副本存储。'."\n" + ."\n" + .'- redundant_remote: 远程备份，同城跨可用区多副本存储，redundant类型在异地的拷贝。'."\n" + ."\n" + .'- full: 本地备份，单副本存储。'."\n" + ."\n" + .'- full_remote: 远程备份，单副本存储，full类型在异地的拷贝。'."\n" + ."\n" + .'- local: 不代表具体备份类型，只用于过滤本地备份数据。'."\n" + ."\n" + .'- remote: 不代表具体备份类型，只用于过滤远程备份数据。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'redundant', + ], + 'DataGran' => [ + 'description' => '备份粒度。', + 'type' => 'string', + 'enumValueTitles' => [ + 'instance' => '实例级', + ], + 'example' => 'instance', + ], + 'Id' => [ + 'description' => '备份唯一Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1780805690994479105', + ], + 'InstanceId' => [ + 'description' => '实例id。', + 'type' => 'string', + 'example' => 'hgpostcn-cn-pe33jdxxxxx', + ], + 'StartTime' => [ + 'description' => '备份开始时间。北京时间，格式YYYY-MM-DDTHH:mm:ss.SSSTZ。下同', + 'type' => 'string', + 'example' => '2024-10-28T11:19:56.000+00:00', + ], + 'Status' => [ + 'description' => '备份状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'processing' => '处理中', + 'completed' => '已完成', + 'failed' => '失败', + ], + 'example' => 'completed', + ], + 'TriggerType' => [ + 'description' => '触发类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'scheduled' => '周期备份', + 'manual' => '手动备份', + ], + 'example' => 'scheduled', + ], + 'DataDesc' => [ + 'description' => '备份数据描述。可更新。', + 'type' => 'string', + 'example' => 'demo', + ], + 'DataTime' => [ + 'description' => '数据快照时间。格式参考StartTime。', + 'type' => 'string', + 'example' => '2024-10-28T12:23:37.000+00:00', + ], + 'DataSize' => [ + 'description' => '备份数据大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '76085723136', + ], + 'EndTime' => [ + 'description' => '备份结束时间。格式参考StartTime。', + 'type' => 'string', + 'example' => '2024-10-28T12:27:34.000+00:00', + ], + 'ColdDataSize' => [ + 'description' => '冷存数据大小。单位：字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32413521', + ], + 'InstanceType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Warehouse' => '计算组型', + 'Standard' => '标准型', + ], + 'example' => 'Warehouse', + ], + 'InstanceRegion' => [ + 'description' => '实例所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SnapshotRegion' => [ + 'description' => '备份数据所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceZoneId' => [ + 'description' => '实例所在可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'SnapshotZoneId' => [ + 'description' => '备份数据所在可用区。其中，同城冗余存储保存在多可用区，这里是其中一个。', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'my-hologres-dw', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询备份列表', + ], + 'EnableSSL' => [ + 'summary' => '打开SSL', + 'path' => '/api/v1/instances/{instanceId}/enableSSL', + 'methods' => [ + 'post', + ], + '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' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-7mz2vmu30003', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', + ], + 'Data' => [ + 'description' => 'true:成功；false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '开启SSL', + ], + 'DisableSSL' => [ + 'summary' => '关闭SSL。', + 'path' => '/api/v1/instances/{instanceId}/disableSSL', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREhologram5MV4AO', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-lbj33559x001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', + ], + 'Data' => [ + 'description' => 'true:成功；false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '关闭SSL', + ], + 'GetCertificateAttribute' => [ + 'summary' => '获得证书信息。', + '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' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-zpr3426vm002', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', + ], + 'CertificateAttributeDto' => [ + 'description' => '证书属性。', + 'type' => 'object', + 'properties' => [ + 'enableSSL' => [ + 'description' => '收否开启SSL。 true：已开启；false：未开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'expirationTime' => [ + 'description' => '证书过期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1790583135000', + ], + 'status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ineffective' => '无效', + 'effective' => '有效', + ], + 'example' => 'effective', + ], + ], + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + 'title' => '查看实例证书属性', + ], + 'GetRootCertificate' => [ + 'summary' => '获取根证书。', + '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' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgpostcn-cn-zpr3426vm002', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', + ], + 'Data' => [ + 'description' => '返回结果：一个JSON字符串，最终的证书格式为PEM。', + 'type' => 'string', + 'example' => '{ "rootCertificate": "BEGIN xxxx"}', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + 'title' => '下载证书', + ], + 'RenewSSLCertificate' => [ + 'summary' => '更新SSL证书。', + 'path' => '/api/v1/instances/{instanceId}/renewSSLCertificate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例ID。该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'hgprecn-cn-i7m2v08uu00a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F', + ], + 'Data' => [ + 'description' => 'true：成功；false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '更新证书', + ], + ], + '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-finance-1', + 'endpoint' => 'hologram.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'hologram.cn-shanghai-finance-1.aliyuncs.com', + ], + ], +]; |