'1.0',
'info' => ['style' => 'ROA', 'product' => 'Hologram', 'version' => '2022-06-01'],
'directories' => [
[
'children' => ['GetUpgradeable', 'GetUpgradeStatus', 'GetLastUpgradeRecord', 'ListUpgradeReleaseVersions', 'UpdateAutoUpgrade', 'UpgradeInstance', 'UpdateOperationEventScheduleTime', 'UpdateMaintenanceWindow', 'PrepareUpgrade', 'DiscardUpgrade'],
'type' => 'directory',
'title' => '升级',
'id' => 450648,
],
[
'children' => ['UntagResources', 'TagResources', 'DescribeTags'],
'type' => 'directory',
'title' => '标签',
'id' => 450649,
],
[
'children' => ['GetExecuteStatementEnabled', 'ExecuteStatement', 'EnableExecuteStatement', 'DisableExecuteStatement'],
'type' => 'directory',
'title' => '执行SQL',
'id' => 449579,
],
[
'children' => ['ListInstanceModel', 'UpdateModelService', 'ListModelCatalog', 'CreateModelService', 'DeleteModelResource', 'DeleteModelService', 'GetInstanceModel'],
'type' => 'directory',
'title' => '大模型',
'id' => 449084,
],
[
'children' => ['CreateDatabase', 'CreateExternalDatabase', 'CreateUser', 'DropUser', 'RevokeTablePermission', 'RevokeSchemaPermission', 'RevokeDatabasePermission', 'ListDatabases', 'GrantTablePermission', 'GrantSchemaPermission', 'GrantDatabasePermission'],
'type' => 'directory',
'title' => '数据库',
'id' => 240380,
],
[
'children' => ['BindLeaderInstance', 'ListLeaderInstances', 'ListFollowerInstances', 'UnBindLeaderInstance', 'CreateInstance', 'DeleteInstance', 'RenewInstance', 'RestartInstance', 'ResumeInstance', 'UpdateInstanceName', 'UpdateInstanceNetworkType', 'DisableHiveAccess', 'EnableHiveAccess', 'StopInstance', 'ScaleInstance', 'ChangeResourceGroup', 'ListInstances', 'GetInstance'],
'type' => 'directory',
'title' => '实例',
'id' => 182214,
],
[
'children' => ['UpdateWarehouseScheduleTask', 'ListWarehouseScheduleTask', 'ListWarehouseScheduleEvent', 'CreateWarehouse', 'CreateHoloWarehouse', 'DeleteHoloWarehouse', 'RebalanceHoloWarehouse', 'ResumeHoloWarehouse', 'SuspendHoloWarehouse', 'RenameHoloWarehouse', 'ScaleHoloWarehouse', 'RestartHoloWarehouse', 'GetWarehouseDetail', 'CreateWarehouseScheduleTask', 'ListWarehouses', 'DisableWarehouseAutoScale', 'DeleteWarehouseScheduleTask', 'EnableWarehouseAutoScale'],
'type' => 'directory',
'title' => '计算组',
'id' => 182261,
],
[
'children' => ['UpdateScheduledBackupConfig', 'UpdateBackupDataDesc', 'CreateManualBackup', 'ListBackupData', 'DeleteBackupData', 'GetScheduledBackupConfig'],
'type' => 'directory',
'title' => '备份',
'id' => 182272,
],
[
'children' => ['UpdateInstancePort', 'UpdateHoloWebLoginSetting', 'GetHoloWebLoginSetting', 'DisableSupportAccount', 'EnableSupportAccount', 'EnableSSL', 'DisableSSL', 'GetCertificateAttribute', 'GetRootCertificate', 'RenewSSLCertificate'],
'type' => 'directory',
'title' => '安全',
'id' => 175035,
],
[
'children' => ['DisableOperationEvent', 'ListMigrationZones', 'ListOperationEvents', 'ListRegions', 'MigrateInstanceZone'],
'type' => 'directory',
'title' => '其他',
'id' => 443072,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'BindLeaderInstance' => [
'summary' => '绑定从实例',
'path' => '/api/v1/instances/{instanceId}/bindReadOnly',
'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-uqm3316l1004'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'leaderInstanceId' => ['description' => '主实例Id。'."\n"
.'从实例的regionId、zoneId、version必须和主实例一致,建议从ListFollowerInstances接口返回的实例列表中选取主实例Id。', 'type' => 'string', 'required' => false, 'example' => ' '."\n"
.'hgpostcn-cn-uqm3316l1004'."\n"],
],
'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' => '6FF2EDFD-3154-5C3E-8CFA-8F7E366BCF9D'],
'Data' => [
'description' => '绑定是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Success' => [
'description' => '请求是否成功,与业务无关。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '404'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Internal server error.'],
'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'string', 'example' => '200'],
],
],
],
],
'title' => '绑定从实例',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6FF2EDFD-3154-5C3E-8CFA-8F7E366BCF9D\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'ChangeResourceGroup' => [
'summary' => '更新资源组。',
'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' => '更新资源组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'CreateDatabase' => [
'path' => '/api/v1/instances/{instanceId}/createDatabase',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramEVHI8S'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['type' => 'string', 'description' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'databaseName' => ['type' => 'string', 'description' => ''],
'permissionModel' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => ''],
'Success' => ['type' => 'string', 'description' => ''],
'ErrorCode' => ['type' => 'string', 'description' => ''],
'ErrorMessage' => ['type' => 'string', 'description' => ''],
'HttpStatusCode' => ['type' => 'string', 'description' => ''],
'Data' => ['type' => 'boolean', 'description' => ''],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''],
],
],
'title' => '创建数据库',
'summary' => '创建db',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": \\"\\",\\n \\"ErrorCode\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"HttpStatusCode\\": \\"\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'CreateExternalDatabase' => [
'summary' => '创建外部db',
'path' => '/api/v1/instances/{instanceId}/createExternalDatabase',
'methods' => ['post'],
'schemes' => ['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' => 'hgprecn-cn-i7m2vxxxx'."\n"],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'databaseName' => ['description' => '数据库名。', 'type' => 'string', 'required' => false, 'example' => ' my_db'],
'comment' => ['description' => '注释。', 'type' => 'string', 'required' => false, 'example' => 'for log stat'],
'defaultUserMapping' => ['description' => '是否使用UserMappping', 'type' => 'string', 'required' => false, 'example' => 'true'],
'metastoreType' => [
'description' => '元数据类型,比如maxcompute',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['maxcompute' => 'maxcompute', 'dlf-rest' => 'dlf-rest', 'dlf' => 'dlf'],
'example' => 'maxcompute',
],
'externalConfig' => [
'description' => '配置参数,详情参见 [CREATE EXTERNAL DATABASE](https://help.aliyun.com/zh/hologres/developer-reference/create-external-database?scm=20140722.S_help%40%40%E6%96%87%E6%A1%A3%40%402847319._.ID_help%40%40%E6%96%87%E6%A1%A3%40%402847319-RL_mapping-LOC_doc%7EUND%7Eab-OR_ser-PAR1_6a0b3e1c17775322800352312d0096-V_4-PAR3_r-RE_new5-P0_11-P1_0&spm=a2c4g.11186623.help-search.i50)',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'key' => ['description' => '配置字段名', 'type' => 'string', 'required' => false, 'example' => 'mc_project'],
'value' => ['description' => '配置字段值', 'type' => 'string', 'required' => false, 'example' => 'log_sum'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'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' => '操作是否成功。取值: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'],
'Data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''],
],
],
'title' => '创建外部数据库',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'CreateHoloWarehouse' => [
'summary' => '创建计算组。',
'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' => '集群数量', 'description' => '集群数量', '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' => '创建计算组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'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. 可前往[服务接入点](https://help.aliyun.com/zh/hologres/developer-reference/api-hologram-2022-06-01-endpoint)'."\n"
.'[服务接入点](https://www.alibabacloud.com/help/zh/hologres/developer-reference/api-hologram-2022-06-01-endpoint)。', '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' => '>该API操作涉及费用,请确保在使用该接口前,已充分了解实时数仓Hologres的收费方式和价格。>'."\n"
."\n"
.'- Hologres计费详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4)。'."\n"
."\n"
.' - Hologres计费详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview)。'."\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"
.'',
'changeSet' => [
['createdAt' => '2025-03-18T03:10:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-04-10T01:16:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-10-18T11:14:04.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateManualBackup' => [
'summary' => '创建实例备份。',
'path' => '/api/v1/backups/manual',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'instanceId' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-721344a2z001'],
],
'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' => '5C11C8CB-9851-504D-8A41-3CF5F4FC0358'],
'Data' => [
'description' => '返回结果。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', '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'],
'title' => '创建实例备份',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C11C8CB-9851-504D-8A41-3CF5F4FC0358\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'CreateModelService' => [
'summary' => '创建模型服务,支持AI function调用模型。支持创建两类模型:1)阿里云百炼模型;2)Hologres AI节点。如果是Hologres AI,需要另外购买AI节点资源。',
'path' => '/api/v1/instances/{instanceId}/createModelService',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => true, 'example' => 'hgpostcn-cn-lbj335xxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'modelType' => ['description' => '模型名称。如果是百炼模型,请调用ListModelCatalog查询;如果是Hologres AI节点,请调用GetAvailableModelsResource查询', 'type' => 'string', 'required' => true, 'example' => 'qwen3.5-plus'],
'cpu' => ['description' => 'CPU,此参数仅Hologres AI节点需要', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16'],
'memory' => ['description' => '内存规格,此参数仅Hologres AI节点需要', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64'],
'gpu' => ['description' => 'GPU规格,此参数仅Hologres AI节点需要', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'serviceCount' => ['description' => '服务副本数,此参数仅 Hologres AI 节点需要', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
'modelServiceName' => ['description' => '自定义的服务名称', 'type' => 'string', 'required' => true, 'example' => 'my_model'],
'gpuMemory' => ['description' => 'GPU 内存规格,此参数仅 Hologres AI 节点需要', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64'],
'taskType' => ['description' => '模型类型,比如chat/completions,embedding。请参考ListModelCatalog返回的类型,按需创建。', 'type' => 'string', 'required' => false, 'example' => 'embedding'],
'provider' => [
'description' => '底层模型提供方。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['hologres' => 'Hologres', 'bailian' => '阿里云百炼'],
'example' => 'bailian',
],
'apiKey' => ['description' => '百炼API Key,请登陆百炼控制台或通过API获取。此参数仅百炼模型需要', 'type' => 'string', 'required' => false, 'example' => 'api-key-xxx'],
'modelParams' => ['description' => '模型参数,请参考ListModelCatalog返回的默认参数,直接传入,有必要则修改后再传入。此参数仅百炼模型需要', 'type' => 'string', 'required' => false, 'example' => '{"timeout":600,"max_retries":10,"max_retry_delay":8,"initial_retry_delay":0.5}'],
],
'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'],
'title' => '创建模型服务',
'description' => '创建模型服务需要大量参数,如果是创建百炼模型,请调用ListModelCatalog查询模型参数;如果是Hologres AI节点,请调用GetAvailableModelsResource查询模型参数。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'CreateUser' => [
'path' => '/api/v1/instances/{instanceId}/createUser',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', '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' => '请求体',
'type' => 'object',
'properties' => [
'userName' => ['description' => '用户名称,目前只支持Ram子账号和STS账号。如果是Ram子账号,以"p4_"作为前缀,如p4_234253434;如果是STS账号,以"v4_"作为前缀,如v4_3234134.', 'type' => 'string', 'required' => false, 'example' => 'p4_2346134'],
'superUser' => ['description' => '是否为superuser', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70'],
'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'],
'Data' => ['description' => 'true:成功;false:失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建用户',
'summary' => '将Ram子账号/STS账号添加到Hologres实例,作为实例账号使用,添加后,即可以Ram/STS身份登陆实例。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'CreateWarehouse' => [
'summary' => '创建warehouse',
'path' => '/api/v1/warehouse/{instanceId}/create',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-j672yny9g001'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体',
'type' => 'object',
'properties' => [
'warehouseName' => ['description' => '计算组名称', 'type' => 'string', 'required' => false, 'example' => 'warehouse-test'],
'cpu' => ['description' => 'CPU核数。', 'type' => 'string', 'required' => false, 'example' => '32'],
'config' => ['description' => '配置信息', 'type' => 'string', 'required' => false, 'example' => '""'],
],
'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表示成功传天warehouse,false则失败。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'HttpStatusCode' => ['description' => 'http状态码。', 'type' => 'string', 'example' => '200'],
'Success' => [
'description' => '请求结果,与业务无关。',
'type' => 'string',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建Warehouse',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorMessage\\": \\"null\\"\\n}","type":"json"}]',
],
'CreateWarehouseScheduleTask' => [
'path' => '/api/v1/instances/{instanceId}/createWarehouseScheduleTask',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['type' => 'string', 'required' => true, 'description' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'warehouseId' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => ''],
'startTime' => ['type' => 'string', 'required' => true, 'description' => ''],
'endTime' => ['type' => 'string', 'required' => true, 'description' => ''],
'elasticCu' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => ''],
'description' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => ''],
'Data' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建分时弹性计划',
'summary' => '创建分时弹性计划',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\"\\n}","type":"json"}]',
],
'DeleteBackupData' => [
'summary' => '删除备份',
'path' => '/api/v1/backups/{id}/delete',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'id',
'in' => 'path',
'schema' => ['description' => '备份id。', 'type' => 'string', 'required' => false, 'example' => '1597409847370362881'],
],
],
'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' => '1907BA1B-B443-5B39-8113-7F3E260DC20D'],
'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'],
'title' => '删除实例备份',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1907BA1B-B443-5B39-8113-7F3E260DC20D\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'DeleteHoloWarehouse' => [
'summary' => '删除计算组。',
'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'],
'title' => '删除计算组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'DeleteInstance' => [
'summary' => '该接口用于释放实例。',
'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' => '>使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。>'."\n"
."\n"
.'- Hologres实例释放后,实例内的数据和对象均不可恢复,请谨慎操作。详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.0.7d413e94YMVcqe)。'."\n"
.'- Hologres实例释放后,实例内的数据和对象均不可恢复,请谨慎操作。详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview?spm=a2c63.p38356.0.0.efc33b87i5pDl7)。'."\n"
.'- 仅支持释放按量付费(PostPaid)实例。'."\n"
."\n"
.'- 如果您需要退订包年包月(PrePaid)实例,请在阿里云退订管理页面操作,详情请参见[退订包年包月实例](https://help.aliyun.com/zh/hologres/product-overview/subscription?spm=a2c4g.11186623.0.0.799b69ecPba0y1)。',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'DeleteModelResource' => [
'summary' => '删除节点资源,节点部署的所有模型将被删除,不可恢复。',
'path' => '/api/v1/instances/{instanceId}/deleteModelResource',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucxxxx'],
],
[
'name' => 'aiInstanceId',
'in' => 'query',
'schema' => ['description' => 'AI节点实例id', 'type' => 'string', 'required' => false, 'example' => 'hologram_aicombo_public_cn-yi34cxxxx'],
],
],
'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'],
'title' => '删除节点资源',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'DeleteModelService' => [
'summary' => '删除模型服务',
'path' => '/api/v1/instances/{instanceId}/deleteModelService',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-xxxxxxx'],
],
[
'name' => 'modelServiceName',
'in' => 'query',
'schema' => ['description' => '自定义的服务名称', 'type' => 'string', 'required' => false, 'example' => 'model-qwen'],
],
],
'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'],
'title' => '删除模型服务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'DeleteWarehouseScheduleTask' => [
'summary' => '删除计算组弹性计划',
'path' => '/api/v1/instances/{instanceId}/deleteWarehouseScheduleTask',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-i7m2v08uu00a'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'warehouseId' => ['description' => '计算组Id', 'type' => 'string', 'required' => false, 'example' => '1'],
'id' => ['description' => '分时弹性计划id', 'type' => 'string', 'required' => true, 'example' => '2034449120420339713'],
],
'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' => 'D1303CD4-AA70-5998-8025-F55B22C50840'],
'Data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除计算组弹性计划',
'description' => '>使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。>'."\n"
."\n"
.'- Hologres实例释放后,实例内的数据和对象均不可恢复,请谨慎操作。详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.0.7d413e94YMVcqe)。'."\n"
.'- Hologres实例释放后,实例内的数据和对象均不可恢复,请谨慎操作。详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview?spm=a2c63.p38356.0.0.efc33b87i5pDl7)。'."\n"
.'- 仅支持释放按量付费(PostPaid)实例。'."\n"
."\n"
.'- 如果您需要退订包年包月(PrePaid)实例,请在阿里云退订管理页面操作,详情请参见[退订包年包月实例](https://help.aliyun.com/zh/hologres/product-overview/subscription?spm=a2c4g.11186623.0.0.799b69ecPba0y1)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1303CD4-AA70-5998-8025-F55B22C50840\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'DescribeTags' => [
'summary' => '列出所有标签',
'path' => '/api/v1/tag',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'tagsOnly',
'in' => 'query',
'schema' => [
'description' => '是否展示标签。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '14E2358E-0499-509E-8E22-CA30EC474A9A'],
'Success' => [
'description' => '请求是否成功,与业务无关。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '404'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Internal server error.'],
'HttpStatusCode' => ['description' => 'http状态码。', 'type' => 'string', 'example' => '200'],
'TagResources' => [
'description' => '资源集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => '实例Id。', 'type' => 'string', 'example' => 'hgprecn-cn-0ju2uaanj001'],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'enumValueTitles' => ['Instance' => 'Instance'],
'example' => 'Instance',
],
'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'acs:rm:rgId'],
'TagValue' => [
'description' => '同一个tagKey下的所有tagValue集合。',
'type' => 'array',
'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'rg-acfm4lsp23l7jti'],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '列出所有标签',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14E2358E-0499-509E-8E22-CA30EC474A9A\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"hgprecn-cn-0ju2uaanj001\\",\\n \\"ResourceType\\": \\"Instance\\",\\n \\"TagKey\\": \\"acs:rm:rgId\\",\\n \\"TagValue\\": [\\n \\"rg-acfm4lsp23l7jti\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DisableExecuteStatement' => [
'summary' => '关闭指定Hologres实例的ExecuteStatement API访问权限',
'path' => '/api/v1/instances/{instanceId}/disableExecuteStatement',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '**Hologres 实例 ID**'."\n", 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-xxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '**请求 ID**'."\n", 'type' => 'string', 'example' => 'E3F4B2A7-1234-5678-9ABC-DEF012345678'],
'data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean'],
'success' => ['description' => '**是否成功**'."\n", 'type' => 'boolean'],
'errorCode' => ['description' => '**错误码(成功时为空)**'."\n", 'type' => 'string', 'example' => 'InvalidParameterValue'],
'errorMessage' => ['description' => '错误信息(成功时为空)'."\n", 'type' => 'string'],
'httpStatusCode' => ['description' => 'http状态码', 'type' => 'string', 'example' => '200'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '禁用实例的ExecuteStatement功能',
'description' => '关闭指定 Hologres 实例的 OpenAPI 执行 SQL 功能。关闭后,所有 ExecuteStatement 调用将返回错误。可通过 EnableExecuteStatement 重新开启。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E3F4B2A7-1234-5678-9ABC-DEF012345678\\",\\n \\"data\\": true,\\n \\"success\\": true,\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"\\",\\n \\"httpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'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' => '关闭数据湖加速',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHiveAccess'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:DisableHiveAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'DisableOperationEvent' => [
'summary' => '关闭运维日志',
'path' => '/api/v1/instances/{instanceId}/disableOperationEvent',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'chargeType' => 'free', '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' => [
'id' => ['description' => '事件id', 'type' => 'string', 'required' => true, 'example' => '1980869072412614657'],
],
'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' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '关闭运维日志',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'DisableSSL' => [
'summary' => '关闭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'],
'title' => '关闭SSL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:DisableSSL',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'DisableSupportAccount' => [
'summary' => '关闭服务账号',
'path' => '/api/v1/instances/{instanceId}/supportAccount/disable',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域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' => '2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A'."\n"],
'Data' => ['description' => 'true:成功;false:失败。', 'type' => 'string', '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'],
'title' => '关闭服务账号',
'description' => '关闭指定 Hologres 实例的 OpenAPI 执行 SQL 功能。关闭后,所有 ExecuteStatement 调用将返回错误。可通过 EnableExecuteStatement 重新开启。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": \\"true\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'DisableWarehouseAutoScale' => [
'path' => '/api/v1/instances/{instanceId}/disableWarehouseAutoScale',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08xxxxx'."\n"],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体',
'type' => 'object',
'properties' => [
'name' => ['description' => '计算组名称', 'type' => 'string', 'required' => false, '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' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'],
'data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '关闭自动弹性',
'summary' => '关闭自动弹性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'DiscardUpgrade' => [
'path' => '/api/v1/instances/{instanceId}/upgrade/discard',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-1wy47xsoxxxx'],
],
],
'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' => 'A47D57BE-59D1-51A6-9CC3-080C07852C4E'],
'Data' => [
'description' => '返回结果。',
'type' => 'array',
'items' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'true'],
'ReasonKey' => ['description' => '原因Key', 'type' => 'string', 'example' => 'null'],
'FailReason' => ['description' => '升级失败原因。', 'type' => 'string', 'example' => 'null'],
],
],
],
'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'],
],
],
],
],
'title' => '取消升级',
'summary' => '取消升级.请求条件:只在还未开始或者处于pre_check状态的任务按钮不置灰,显示为取消升级。一旦进入backup状态或者之后的状态,就不允许取消了。',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A47D57BE-59D1-51A6-9CC3-080C07852C4E\\",\\n \\"Data\\": [\\n {\\n \\"Success\\": true,\\n \\"ReasonKey\\": \\"null\\",\\n \\"FailReason\\": \\"null\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'DropUser' => [
'path' => '/api/v1/instances/{instanceId}/dropUser',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'userName' => ['description' => '用户名称,目前只支持 Ram 子账号和 STS 账号。如果是 Ram 子账号,以"p4_"作为前缀,如 p4_234253434;如果是 STS 账号,以"v4_"作为前缀,如 v4_3234134.', 'type' => 'string', 'required' => false, 'example' => 'p4_234253434'],
'superUser' => ['description' => '是否为superuser', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EA8F0084-5831-5907-BB31-BD05D2617844'],
'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'],
'Data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除用户',
'summary' => '将Ram子账号/STS账号从Hologres帐户体系删除,删除后,Ram/STS不能再登陆实例。如需登陆实例,请用CreateUser重新添加。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA8F0084-5831-5907-BB31-BD05D2617844\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'EnableExecuteStatement' => [
'summary' => '为指定Hologres实例启用通过OpenAPI执行SQL的功能。',
'path' => '/api/v1/instances/{instanceId}/enableExecuteStatement',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => 'Hologres 实例 ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-xxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应参数'."\n",
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID'."\n", 'type' => 'string', 'example' => 'E3F4B2A7-1234-5678-9ABC-DEF012345678'],
'data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean'],
'success' => ['description' => '是否成功'."\n", 'type' => 'boolean'],
'errorCode' => ['description' => '错误码(成功时为空)'."\n", 'type' => 'string', 'example' => 'InvalidParameterValue'],
'errorMessage' => ['description' => '错误信息(成功时为空)'."\n", 'type' => 'string', 'example' => '错误信息示例'],
'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'string', 'example' => '200'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '开启实例SQL执行API',
'description' => '启指定 Hologres 实例的 OpenAPI 执行 SQL 功能。开启后,拥有 hologram:ExecuteStatement 权限的 RAM 账号可通过 ExecuteStatement 接口执行 SQL 语句。可通过 GetExecuteStatementEnabled 查询当前状态,通过 DisableExecuteStatement 关闭。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E3F4B2A7-1234-5678-9ABC-DEF012345678\\",\\n \\"data\\": true,\\n \\"success\\": true,\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"错误信息示例\\",\\n \\"httpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'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' => '开启数据湖加速',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHiveAccess'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:EnableHiveAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'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'],
'title' => '开启SSL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:EnableSSL',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'EnableSupportAccount' => [
'path' => '/api/v1/instances/{instanceId}/supportAccount/enable',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'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-7mz2vmu30003'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'password' => ['description' => '密码', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
'expireTime' => ['description' => '过期时间', 'type' => 'string', 'required' => false, 'example' => '2023-03-24 11:19:05'],
'enabled' => ['description' => '废弃参数', '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' => 'AB71198A-2DB1-511B-AE4D-690BAA97F076'],
'Data' => ['description' => '返回结果。', 'type' => 'string', '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'],
'title' => '开启服务账号',
'summary' => '打开服务账号',
'description' => '启指定 Hologres 实例的 OpenAPI 执行 SQL 功能。开启后,拥有 hologram:ExecuteStatement 权限的 RAM 账号可通过 ExecuteStatement 接口执行 SQL 语句。可通过 GetExecuteStatementEnabled 查询当前状态,通过 DisableExecuteStatement 关闭。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AB71198A-2DB1-511B-AE4D-690BAA97F076\\",\\n \\"Data\\": \\"true\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'EnableWarehouseAutoScale' => [
'path' => '/api/v1/instances/{instanceId}/enableWarehouseAutoScale',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
'autoTest' => true,
'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' => [
'name' => ['description' => '计算组名称', 'type' => 'string', 'required' => false, 'example' => 'my_warehouse'],
'maxClusterCount' => ['description' => '最大集群数量,大于预留集群数,小于等于4.', 'type' => 'string', 'required' => false, 'example' => '3'],
],
'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' => 'string', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '开启自动弹性',
'summary' => '开启自动弹性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]',
],
'ExecuteStatement' => [
'path' => '/api/v1/instances/{instanceId}/executeStatement',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramE3EYZP'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucpyu005'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'dbName' => ['description' => '数据库', 'type' => 'string', 'required' => false, 'example' => 'test_db'],
'sql' => ['description' => '待执行的 SQL 语句,最大长度 16384 字符。支持多条 SQL 以分号分隔,多条时返回最后一条语句的结果。', 'type' => 'string', 'required' => false, 'example' => 'select * from test_table limit 10;'],
'parameters' => [
'description' => 'SQL 参数化查询的绑定参数列表,与 SQL 中的 `$1`, `$2`, ... 占位符按顺序对应。支持的值类型包括:`String`、`Long`、`Double`、`Boolean` 和 `null`(表示 `NULL`)。使用参数化查询可有效防止 SQL 注入,并提升预编译语句的缓存复用率。参数列表作用于 `Statements` 中的每条 SQL。',
'type' => 'array',
'items' => ['description' => '参数集内容', 'type' => 'any', 'required' => false, 'example' => 'test_val'],
'required' => false,
],
'maxRows' => ['description' => '最大返回行数,默认 200,最大值 1000。超出部分截断并在响应中通过 `Truncated` 字段标识'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'],
'maxBytes' => ['description' => '单次返回的最大数据量(字节)。默认 10485760(10 MB),超出时截断并标记 truncated=true。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024'],
'queryTimeout' => ['description' => 'SQL 执行超时时间(秒)。默认 30,最大 30,最小 1。超时后服务端主动取消查询。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '结果数据'."\n",
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'],
'success' => ['description' => '是否成功'."\n", 'type' => 'string', 'example' => 'True'],
'errorCode' => ['description' => '错误码(成功时为空)'."\n", 'type' => 'string', 'example' => 'InvalidParameterValue'],
'errorMessage' => ['description' => '错误信息(成功时为空)'."\n", 'type' => 'string', 'example' => '参数值不合法(如 SQL 为空、超长等)'],
'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'string', 'example' => '200'],
'data' => [
'description' => 'true:允许OpenAPI SQL执行调用;false:未允许OpenAPI SQL执行调用',
'type' => 'object',
'properties' => [
'success' => ['description' => '是否成功'."\n", 'type' => 'boolean'],
'errorCode' => ['description' => '错误码(成功时为空)'."\n", 'type' => 'string', 'example' => 'InvalidParameterValue'],
'errorMessage' => ['description' => '错误信息(成功时为空)'."\n", 'type' => 'string', 'example' => '参数值不合法(如 SQL 为空、超长等)'],
'results' => [
'description' => '执行结果列表,当前固定长度为 1。多条select查询的结果只返回最后一条select。',
'type' => 'array',
'items' => [
'description' => '结果对象',
'type' => 'object',
'properties' => [
'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
'sql' => ['description' => '实际执行的 SQL 语句', 'type' => 'string', 'example' => 'select * from test_table limit 10;'],
'count' => ['description' => '返回的行数', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
'updateCount' => ['description' => '语句(INSERT/UPDATE/DELETE)影响的行数,SELECT', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'truncated' => ['description' => '结果是否被截断(超过 `MaxResults` 时为 `true`)'."\n", 'type' => 'boolean'],
'queryId' => ['description' => '**Query ID**'."\n", 'type' => 'string', 'example' => 'E3F4B2A7-1234-5678-9ABC-DEF012345678'],
'errorMessage' => ['description' => '该条 SQL 的错误信息', 'type' => 'string', 'example' => 'ERROR: relation \\"non_existent_table\\" does not exist\\n Position: 15'],
'errorCode' => ['description' => '该条 SQL 的错误码', 'type' => 'string', 'example' => 'SQL_ERROR'],
'columnMetadata' => [
'description' => '**列元数据**'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'name' => ['description' => '**列名**'."\n", 'type' => 'string', 'example' => 'id'],
'type' => ['description' => '数据类型(如 `int4`, `text`, `bool` 等)'."\n", 'type' => 'string', 'example' => 'int4'],
'nullable' => ['description' => '是否可空'."\n", 'type' => 'boolean'],
],
'description' => '',
],
],
'records' => [
'description' => '查询结果行集合。每行为一个字符串数组,所有值序列化为 String,NULL 值表示为 "\\N"',
'type' => 'array',
'items' => [
'description' => '每一行结果列表',
'type' => 'array',
'items' => ['description' => '字段值(字符串形式)', 'type' => 'string', 'example' => ' ["1", "Alice"]'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '执行SQL语句',
'summary' => '通过OpenAPI在指定数据库上同步执行SQL语句并返回结果。',
'description' => '该 API 用于在 Hologres 实例上通过 OpenAPI 安全执行 SQL 语句。'."\n"
."\n"
.' 使用前须满足以下条件:'."\n"
.' 1. 在管控台实例详情页的"数据安全"中开启"允许通过 OpenAPI 执行 SQL"开关'."\n"
.' 2. 调用方的 RAM 账号已被授予 hologram:ExecuteStatement 权限'."\n"
."\n"
.' 支持 SELECT、DDL、DML 等语句,支持参数化查询($1, $2 占位符)防止 SQL 注入。查询结果默认最多返回 200'."\n"
.' 行(上限 1000 行)、10 MB,超出部分截断并通过 truncated 字段标识。单次执行超时 30 秒。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"success\\": \\"True\\",\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"参数值不合法(如 SQL 为空、超长等)\\",\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"success\\": true,\\n \\"errorCode\\": \\"InvalidParameterValue\\",\\n \\"errorMessage\\": \\"参数值不合法(如 SQL 为空、超长等)\\",\\n \\"results\\": [\\n {\\n \\"success\\": true,\\n \\"sql\\": \\"select * from test_table limit 10;\\",\\n \\"count\\": 25,\\n \\"updateCount\\": 10,\\n \\"truncated\\": true,\\n \\"queryId\\": \\"E3F4B2A7-1234-5678-9ABC-DEF012345678\\",\\n \\"errorMessage\\": \\"ERROR: relation \\\\\\\\\\\\\\"non_existent_table\\\\\\\\\\\\\\" does not exist\\\\\\\\n Position: 15\\",\\n \\"errorCode\\": \\"SQL_ERROR\\",\\n \\"columnMetadata\\": [\\n {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"int4\\",\\n \\"nullable\\": true\\n }\\n ],\\n \\"records\\": [\\n [\\n \\" [\\\\\\"1\\\\\\", \\\\\\"Alice\\\\\\"]\\"\\n ]\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'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'],
'title' => '查看实例证书属性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetCertificateAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"CertificateAttributeDto\\": {\\n \\"enableSSL\\": true,\\n \\"expirationTime\\": 1790583135000,\\n \\"status\\": \\"effective\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'GetExecuteStatementEnabled' => [
'path' => '/api/v1/instances/{instanceId}/executeStatementEnabled',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'],
'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 of the request', 'type' => 'string', 'example' => '2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC'],
'data' => ['description' => 'true:允许OpenAPI SQL执行调用;false:未允许OpenAPI SQL执行调用', 'type' => 'boolean', 'example' => 'true'],
'success' => ['description' => '调用是否成功', 'type' => 'boolean', 'example' => 'True'],
'errorCode' => ['description' => '- 当success为false,返回业务错误码;'."\n"
.' '."\n"
.'- 当success为true,返回空值。 ', 'type' => 'string', 'example' => 'success'],
'errorMessage' => ['description' => '- 当success为false,返回业务错误信息;'."\n"
."\n"
.'- 当success为true,返回空值。', 'type' => 'string', 'example' => 'ok'],
'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'string', 'example' => '200'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询实例是否开启ExecuteStatement功能',
'summary' => '检查指定Hologres实例是否已开启通过OpenAPI执行SQL的功能。',
'description' => '查询指定 Hologres 实例是否已开启"允许通过 OpenAPI 执行 SQL"功能。返回 true 表示已开启,false 表示未开启。开启后可通过 ExecuteStatement 接口执行 SQL。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC\\",\\n \\"data\\": true,\\n \\"success\\": true,\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"ok\\",\\n \\"httpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'GetHoloWebLoginSetting' => [
'path' => '/api/v1/instances/{instanceId}/getHoloWebLoginSetting',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx'],
],
],
'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' => 'object',
'properties' => [
'AllowExternalAccountsLogin' => ['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'],
'title' => '查询HoloWeb登录权限',
'summary' => '获取holoweb登陆权限',
'description' => '查询指定 Hologres 实例是否已开启"允许通过 OpenAPI 执行 SQL"功能。返回 true 表示已开启,false 表示未开启。开启后可通过 ExecuteStatement 接口执行 SQL。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": {\\n \\"AllowExternalAccountsLogin\\": true\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'GetInstance' => [
'summary' => '该接口用于获取实例详情。',
'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' => ['description' => '是否开启SSL。', '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'],
],
'description' => '',
],
],
],
'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":"\\n 865A02C2-B374-5DD4-9B34-0CA15DA1AEBD\\n \\n PrePaid\\n hologram_combo_public_cn\\n 32\\n 2021-02-03T13:06:06Z\\n 500\\n \\n hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80\\n Internet\\n true\\n vsw-bp1jqwp2ys6kp7tc9t983\\n vpc-uf66jjber3hgvwhki3wna\\n hgprecn-cn-uqm362o1b001-frontend-st\\n hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80\\n \\n 2021-02-03T13:06:06Z\\n hgpostcn-cn-tl32s6cgw00b\\n test\\n Standard\\n 128\\n 12345678900000\\n Running\\n r1.3.37\\n Manual\\n \\n tag\\n value\\n \\n hgpostcn-cn-i7m2ncd6w002\\n true\\n rg-aekzuq7hpybze2i\\n 2\\n cn-hangzhou-h\\n 800\\n true\\n 2\\n 4\\n 16\\n cn-hangzhou\\n Active\\n \\n true\\n null\\n null\\n 200\\n","errorExample":""}]',
'title' => '获取实例详情',
'changeSet' => [
['createdAt' => '2024-12-26T07:01:55.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-03-14T10:24:25.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-01-23T09:37:11.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-07-19T06:15:35.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-05-17T03:38:28.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-04-10T06:28:14.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-11-30T08:40:22.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-11-07T08:48:11.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'GetInstanceModel' => [
'path' => '/api/v1/instances/{instanceId}/getInstanceModel',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-7mz2vmuxxxx'],
],
],
'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'],
'cpu' => ['description' => '节点总CPU,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'gpu' => ['description' => '节点总GPU,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'memory' => ['description' => '节点总内存,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '128'],
'gpuMemory' => ['description' => '节点总显存,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '128'],
'modelServiceList' => [
'description' => '模型服务列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'gpuMemory' => ['description' => '此模型服务占用的显存,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'memory' => ['description' => '此模型服务占用的内存,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'cpu' => ['description' => '此模型服务占用的CPU, 此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'modelType' => ['description' => '模型名称', 'type' => 'string', 'example' => 'qwen3.5-plus'],
'gpu' => ['description' => '此模型服务占用的GPU,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'status' => ['description' => '状态', 'type' => 'string', 'example' => 'Running'],
'modelName' => ['description' => '模型服务自定义名称', 'type' => 'string', 'example' => 'my_model'],
'serviceCount' => ['description' => '服务副本数,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'version' => ['description' => '版本。', 'type' => 'string', 'example' => 'v1.1'],
'message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Failed'],
'taskType' => ['description' => '模型用途', 'type' => 'string', 'example' => 'embedding'],
'modelParams' => ['description' => '模型参数,此参数仅适用于百炼模型', 'type' => 'string', 'example' => '{"timeout":600,"max_retries":10,"max_retry_delay":8,"initial_retry_delay":0.5}'],
'apiKey' => ['description' => '百炼API Key(仅展示,无法直接使用)', 'type' => 'string', 'example' => 'sk-42f6c8xxxxxb'],
'provider' => ['description' => '底层模型提供方。', 'type' => 'string', 'example' => 'bailian'],
'instanceRegion' => ['description' => 'AI节点部署地域', 'type' => 'string', 'example' => 'cn-beijing'],
'serviceDeployRegion' => ['description' => '部署地域', 'type' => 'string', 'example' => 'cn-beijing'],
],
'description' => '',
],
],
'cpuUsed' => ['description' => '已使用的节点总 CPU,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'memoryUsed' => ['description' => '已使用的节点总内存,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '64'],
'gpuUsed' => ['description' => '已使用的节点总GPU,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'aiInstanceId' => ['description' => 'AI节点实例id', 'type' => 'string', 'example' => 'hologram_aicombo_public_cn-77xxx'],
'gpuMemoryUsed' => ['description' => '已使用的节点总显存,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '64'],
'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shanghai'],
'resourceType' => [
'description' => '资源类型。',
'type' => 'string',
'enumValueTitles' => ['small' => 'small', 'middle' => 'middle', 'large' => 'large'],
'example' => 'middle',
],
'nodeCount' => ['description' => '节点数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'commodityCode' => ['description' => '商品code', 'type' => 'string', 'example' => 'hologram_aipostpay_public_cn'],
'chargeType' => ['description' => '付费类型。取值:'."\n"
.'- PrePaid:包年包月。'."\n"
.'- PostPaid: 按量付费。', 'type' => 'string', 'example' => 'PrePaid'],
'status' => [
'description' => '节点状态',
'type' => 'string',
'enumValueTitles' => ['ResourceReady' => '运行正常', 'InstanceWaiting' => '创建中'],
'example' => 'ResourceReady',
],
'expirationTime' => ['description' => '过期时间(UTC)', 'type' => 'string', 'example' => '2026-01-28T07:44:27.535Z'],
'autoRenewal' => ['description' => '资源是否开启了自动续费功能。'."\n"
."\n"
.'- true:开启自动续费,资源到期后会自动续订。'."\n"
.'- false:未开启自动续费,资源到期后将停止使用。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '实例部署模型详情',
'summary' => 'Holo实例已经绑定的大模型服务列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"cpu\\": 32,\\n \\"gpu\\": 4,\\n \\"memory\\": 128,\\n \\"gpuMemory\\": 128,\\n \\"modelServiceList\\": [\\n {\\n \\"gpuMemory\\": 32,\\n \\"memory\\": 32,\\n \\"cpu\\": 32,\\n \\"modelType\\": \\"qwen3.5-plus\\",\\n \\"gpu\\": 2,\\n \\"status\\": \\"Running\\",\\n \\"modelName\\": \\"my_model\\",\\n \\"serviceCount\\": 2,\\n \\"version\\": \\"v1.1\\",\\n \\"message\\": \\"Failed\\",\\n \\"taskType\\": \\"embedding\\",\\n \\"modelParams\\": \\"{\\\\\\"timeout\\\\\\":600,\\\\\\"max_retries\\\\\\":10,\\\\\\"max_retry_delay\\\\\\":8,\\\\\\"initial_retry_delay\\\\\\":0.5}\\",\\n \\"apiKey\\": \\"sk-42f6c8xxxxxb\\",\\n \\"provider\\": \\"bailian\\",\\n \\"instanceRegion\\": \\"cn-beijing\\",\\n \\"serviceDeployRegion\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"cpuUsed\\": 32,\\n \\"memoryUsed\\": 64,\\n \\"gpuUsed\\": 2,\\n \\"aiInstanceId\\": \\"hologram_aicombo_public_cn-77xxx\\",\\n \\"gpuMemoryUsed\\": 64,\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"resourceType\\": \\"middle\\",\\n \\"nodeCount\\": 2,\\n \\"commodityCode\\": \\"hologram_aipostpay_public_cn\\",\\n \\"chargeType\\": \\"PrePaid\\",\\n \\"status\\": \\"ResourceReady\\",\\n \\"expirationTime\\": \\"2026-01-28T07:44:27.535Z\\",\\n \\"autoRenewal\\": true\\n}","type":"json"}]',
],
'GetLastUpgradeRecord' => [
'summary' => '获取上次升级历史',
'path' => '/api/v1/instances/{instanceId}/lastUpgradeRecord',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'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-i7m2v08xxxxx'."\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' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'fromVersion' => ['description' => '初始版本', 'type' => 'string', 'example' => 'r3.2.11'],
'toVersion' => ['description' => '目标版本', 'type' => 'string', 'example' => 'r4.0.2'],
'startReadonlyTime' => ['description' => '只读开始时间', 'type' => 'string', 'example' => '2025-09-24 17:29:57'],
'stopReadonlyTime' => ['description' => '只读结束时间', 'type' => 'string', 'example' => '2025-09-24 18:23:22'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询升级记录',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": {\\n \\"fromVersion\\": \\"r3.2.11\\",\\n \\"toVersion\\": \\"r4.0.2\\",\\n \\"startReadonlyTime\\": \\"2025-09-24 17:29:57\\",\\n \\"stopReadonlyTime\\": \\"2025-09-24 18:23:22\\"\\n }\\n}","type":"json"}]',
],
'GetRootCertificate' => [
'summary' => '获取根证书。',
'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'],
'title' => '下载证书',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:GetRootCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": \\"{ \\\\\\"rootCertificate\\\\\\": \\\\\\"BEGIN xxxx\\\\\\"}\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'GetScheduledBackupConfig' => [
'path' => '/api/v1/backups/scheduledConfig',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'],
],
[
'name' => 'instanceId',
'in' => 'query',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-9lb3bjg1n003'],
],
[
'name' => 'scheduleType',
'in' => 'query',
'schema' => [
'description' => '备份类型。默认返回周期和手动备份配置,如需返回远程备份配置,需要填写remote',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['periodical' => '周期备份', 'remote' => '远程备份'],
'example' => 'remote',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '623EF0B6-A6C1-5764-82CC-0BC176654CB9'],
'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'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => '配置是否生效,取值:-**true**:生效-**false**:不生效', 'type' => 'integer', 'format' => 'int64', 'example' => 'true'],
'TaskParameter' => ['description' => '任务参数。', 'type' => 'string', 'example' => '{"schedule":"0 10 * * 1,2","instance_id":"hgprecn-cn-lbj3dfgog004","week":"1,2","hour":10,"data_keep_quantity":3,"type":"periodical","enabled":true}'],
'TaskType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'backup'."\n"],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取备份配置',
'summary' => '获取备份配置。',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"623EF0B6-A6C1-5764-82CC-0BC176654CB9\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Enabled\\": 0,\\n \\"TaskParameter\\": \\"{\\\\\\"schedule\\\\\\":\\\\\\"0 10 * * 1,2\\\\\\",\\\\\\"instance_id\\\\\\":\\\\\\"hgprecn-cn-lbj3dfgog004\\\\\\",\\\\\\"week\\\\\\":\\\\\\"1,2\\\\\\",\\\\\\"hour\\\\\\":10,\\\\\\"data_keep_quantity\\\\\\":3,\\\\\\"type\\\\\\":\\\\\\"periodical\\\\\\",\\\\\\"enabled\\\\\\":true}\\",\\n \\"TaskType\\": \\"backup\\\\n\\"\\n }\\n}","type":"json"}]',
],
'GetUpgradeStatus' => [
'summary' => '查询升级状态',
'path' => '/api/v1/instances/{instanceId}/upgrade/status',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'],
'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' => 'hgprecn-cn-uqm30ptv6004'],
],
],
'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' => 'D73E42D0-AA72-5880-B96F-548B43C84736'],
'Data' => [
'description' => '返回结果。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FromVersion' => ['description' => '当前版本', 'type' => 'string', 'example' => '1.3.23'],
'ToVersion' => ['description' => '升级到此版本', 'type' => 'string', 'example' => '1.3.24'],
'Status' => [
'description' => '用于实例升级的AirFlow DAG的状态',
'type' => 'string',
'enumValueTitles' => ['archived' => '成功', 'upgrading' => '正在升级', 'preparing' => '正在准备'],
'example' => 'archived',
],
'Details' => ['description' => '详情。', 'type' => 'string', 'example' => '{"UpgradePhase":"Upgrade","StatusCode":"LeaderRestartFailed","FlightingReport":{"SQLResultStat":{"TotalExecuted":9000"Exceptions":0,"Incorrect":1,"Slow":1,"DQLSpeedup":2}"SegmentFormatStat":[{"Database":"test_db","TableUsingSegmentCount":5},{"Database":"user_order","TableUsingSegmentCount":7}],"EstimatedUpgradeTime":{"StopInstance":30,"BackupData":120,"UpgradeInstance":600},"ReadPermissionCheckStat":[{"db":"tst0","user":"v4_300433463265624129","schema":"dim_db","table":"it_rpt_org_tree_info_partition_all"},{"db":"tst1","user":"v4_300433463265624129","schema":"dim_db","table":"it_rpt_org_tree_info_partition_all_2"},]},"UpgradingSteps":{"Stop":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"Backup":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"DoUpgrade":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"Rollback":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"}},"Instances":{"LeaderInstanceId":"hgxxx","LeaderInstanceName":"ERP instance","LeaderInstanceStatus":"Running","FollowerInstances":[{"InstanceId":"hgxxx","InstanceName":"TMSinstance","Status":"Running"},{"InstanceId":"hxxx""InstanceName":"WMS readonly","Status":"Unavailable"}]}}'],
'PrepareFinishTime' => ['description' => '准备完成时间', 'type' => 'string', 'example' => '2023-05-09T06:48:28.843Z'],
],
'description' => '',
],
],
'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'],
'title' => '查询升级状态',
'changeSet' => [
['createdAt' => '2023-04-10T08:55:39.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D73E42D0-AA72-5880-B96F-548B43C84736\\",\\n \\"Data\\": [\\n {\\n \\"FromVersion\\": \\"1.3.23\\",\\n \\"ToVersion\\": \\"1.3.24\\",\\n \\"Status\\": \\"archived\\",\\n \\"Details\\": \\"{\\\\\\"UpgradePhase\\\\\\":\\\\\\"Upgrade\\\\\\",\\\\\\"StatusCode\\\\\\":\\\\\\"LeaderRestartFailed\\\\\\",\\\\\\"FlightingReport\\\\\\":{\\\\\\"SQLResultStat\\\\\\":{\\\\\\"TotalExecuted\\\\\\":9000\\\\\\"Exceptions\\\\\\":0,\\\\\\"Incorrect\\\\\\":1,\\\\\\"Slow\\\\\\":1,\\\\\\"DQLSpeedup\\\\\\":2}\\\\\\"SegmentFormatStat\\\\\\":[{\\\\\\"Database\\\\\\":\\\\\\"test_db\\\\\\",\\\\\\"TableUsingSegmentCount\\\\\\":5},{\\\\\\"Database\\\\\\":\\\\\\"user_order\\\\\\",\\\\\\"TableUsingSegmentCount\\\\\\":7}],\\\\\\"EstimatedUpgradeTime\\\\\\":{\\\\\\"StopInstance\\\\\\":30,\\\\\\"BackupData\\\\\\":120,\\\\\\"UpgradeInstance\\\\\\":600},\\\\\\"ReadPermissionCheckStat\\\\\\":[{\\\\\\"db\\\\\\":\\\\\\"tst0\\\\\\",\\\\\\"user\\\\\\":\\\\\\"v4_300433463265624129\\\\\\",\\\\\\"schema\\\\\\":\\\\\\"dim_db\\\\\\",\\\\\\"table\\\\\\":\\\\\\"it_rpt_org_tree_info_partition_all\\\\\\"},{\\\\\\"db\\\\\\":\\\\\\"tst1\\\\\\",\\\\\\"user\\\\\\":\\\\\\"v4_300433463265624129\\\\\\",\\\\\\"schema\\\\\\":\\\\\\"dim_db\\\\\\",\\\\\\"table\\\\\\":\\\\\\"it_rpt_org_tree_info_partition_all_2\\\\\\"},]},\\\\\\"UpgradingSteps\\\\\\":{\\\\\\"Stop\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"},\\\\\\"Backup\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"},\\\\\\"DoUpgrade\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"},\\\\\\"Rollback\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\",\\\\\\"StopTime\\\\\\":\\\\\\"2023-05-09T06:48:28.843Z\\\\\\"}},\\\\\\"Instances\\\\\\":{\\\\\\"LeaderInstanceId\\\\\\":\\\\\\"hgxxx\\\\\\",\\\\\\"LeaderInstanceName\\\\\\":\\\\\\"ERP instance\\\\\\",\\\\\\"LeaderInstanceStatus\\\\\\":\\\\\\"Running\\\\\\",\\\\\\"FollowerInstances\\\\\\":[{\\\\\\"InstanceId\\\\\\":\\\\\\"hgxxx\\\\\\",\\\\\\"InstanceName\\\\\\":\\\\\\"TMSinstance\\\\\\",\\\\\\"Status\\\\\\":\\\\\\"Running\\\\\\"},{\\\\\\"InstanceId\\\\\\":\\\\\\"hxxx\\\\\\"\\\\\\"InstanceName\\\\\\":\\\\\\"WMS readonly\\\\\\",\\\\\\"Status\\\\\\":\\\\\\"Unavailable\\\\\\"}]}}\\",\\n \\"PrepareFinishTime\\": \\"2023-05-09T06:48:28.843Z\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'GetUpgradeable' => [
'summary' => '查询是否可升级',
'path' => '/api/v1/instances/{instanceId}/upgradeable',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-tl32mqkmxxxx'],
],
],
'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' => 'B8E7613D-E09F-59D3-B35A-FBB7680DCE8F'],
'Data' => [
'description' => '返回结果。',
'type' => 'array',
'items' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'true 可以升级,false 不可升级,说明已经是最新版本', 'type' => 'boolean', 'example' => 'true'],
'FailReason' => ['description' => '升级失败原因。', 'type' => 'string', 'example' => 'null'],
'ReasonKey' => ['description' => '升级的原因key。', 'type' => 'string', 'example' => 'null'],
],
],
],
'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'],
'title' => '查询是否可升级',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8E7613D-E09F-59D3-B35A-FBB7680DCE8F\\",\\n \\"Data\\": [\\n {\\n \\"Success\\": true,\\n \\"FailReason\\": \\"null\\",\\n \\"ReasonKey\\": \\"null\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'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' => ['description' => '计算组当前自动弹性计算资源总量', 'type' => 'string', 'example' => '32'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"WarehouseDetail\\": {\\n \\"ReservedCpu\\": \\"64\\",\\n \\"RemainingCpu\\": \\"32\\",\\n \\"WarehouseList\\": [\\n {\\n \\"Cpu\\": 32,\\n \\"Mem\\": 128,\\n \\"Id\\": 2,\\n \\"Status\\": \\"kRunning\\",\\n \\"NodeCount\\": 2,\\n \\"Name\\": \\"MyWarehouse\\",\\n \\"ElasticCpu\\": 32,\\n \\"DefaultWarehouse\\": true,\\n \\"RebalanceStatus\\": \\"DONE\\",\\n \\"ClusterCpu\\": \\"32\\",\\n \\"ElasticType\\": \\"auto\\",\\n \\"InitClusterCount\\": \\"2\\",\\n \\"ClusterCount\\": \\"2\\",\\n \\"MaxClusterCount\\": \\"4\\",\\n \\"AutoScaleType\\": \\"Standard\\"\\n }\\n ],\\n \\"TimedElasticCpu\\": \\"64\\",\\n \\"AutoElasticCpu\\": \\"32\\"\\n }\\n}","type":"json"}]',
'title' => '计算组详情',
'changeSet' => [
['createdAt' => '2024-08-16T07:50:21.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWarehouseDetail'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetWarehouseDetail',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'GrantDatabasePermission' => [
'summary' => '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '数据库授权',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:GrantDatabasePermission',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'GrantSchemaPermission' => [
'summary' => '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Schema授权',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:GrantSchemaPermission',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'GrantTablePermission' => [
'path' => '/api/v1/instances/{instanceId}/grantTablePermission',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramOTL5KY'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例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'],
'columnNames' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '表授权',
'summary' => 'DB授权。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:GrantTablePermission',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'ListBackupData' => [
'summary' => '该接口用于查询备份数据列表。一份备份是对实例截止快照时间的全量数据快照,可以通过新购实例完全恢复原来的数据。',
'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' => '查询备份列表',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBackupData'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListBackupData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'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.', 'description' => ''],
],
],
'title' => '数据库列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListDatabases',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C4935F5-6217-569A-902F-931B2F3E28BA\\",\\n \\"DatabaseList\\": [\\n {\\n \\"Name\\": \\"my_db\\",\\n \\"PermissionModel\\": \\"SPM\\",\\n \\"Privilege\\": \\"developer\\",\\n \\"External\\": false\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'ListFollowerInstances' => [
'path' => '/api/v1/instances/{instanceId}/listFollowerInstances',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-xxxxxxx'],
],
],
'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'],
'InstanceList' => [
'description' => '实例详情。',
'type' => 'array',
'items' => [
'description' => '实例详情。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'hgpostcn-cn-aaab9ad2d8fb'],
'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'test_instance'],
'CommodityCode' => ['description' => '商品code,与费用中心产品明细code一致', 'type' => 'string', 'example' => 'hologram_postpay_public_cn'],
'InstanceStatus' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'Running'],
'ChargeType' => ['description' => '付费类型。', 'type' => 'string', 'example' => 'PostPaid'],
'CreationTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-12-16T02:24:05Z'],
'ExpirationTime' => ['description' => '到期时间。', 'type' => 'string', 'example' => '2023-05-04T16:00:00.000Z'],
'InstanceType' => ['description' => '实例类型。', 'type' => 'string', 'example' => 'Standard'],
'Tags' => [
'description' => '标签详情。',
'type' => 'array',
'items' => [
'description' => '标签详情。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'tag'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
],
'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'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '从实例列表',
'summary' => '获取只读从实例',
'description' => '## 请求说明'."\n"
.'- 该API用于获取特定Holo实例上已部署的模型服务信息,包括但不限于CPU、GPU、内存等资源占用情况。'."\n"
.'- `instanceId`参数为可选项,若不提供,则默认返回所有相关实例的信息。'."\n"
.'- 此接口适用于Hologres AI节点,对于非AI节点的部分参数可能无效或不适用。'."\n"
.'- 请确保在使用该接口前,已充分了解[阿里云Hologram产品的收费方式和价格](https://www.aliyun.com/price/product#/ecs/detail)。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"hgpostcn-cn-aaab9ad2d8fb\\",\\n \\"InstanceName\\": \\"test_instance\\",\\n \\"CommodityCode\\": \\"hologram_postpay_public_cn\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"CreationTime\\": \\"2022-12-16T02:24:05Z\\",\\n \\"ExpirationTime\\": \\"2023-05-04T16:00:00.000Z\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'ListInstanceModel' => [
'summary' => 'AI节点资源列表',
'path' => '/api/v1/instances/rpc/listInstanceModel',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
],
'parameters' => [],
'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' => '2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC'],
'instanceModelList' => [
'description' => 'AI资源列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'cpu' => ['description' => 'CPU 规格,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'gpu' => ['description' => 'gpu卡数,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'memory' => ['description' => '内存,单位GiB,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
'gpuMemory' => ['description' => '显存大小,单位GB,此参数仅适用于 Hologres AI 节点', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'cpuUsed' => ['description' => '已使用的节点总 CPU,此参数仅适用于 Hologres AI 节点'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'memoryUsed' => ['description' => '已使用的节点总内存,此参数仅适用于 Hologres AI 节点'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'gpuUsed' => ['description' => '已使用的节点总 GPU,此参数仅适用于 Hologres AI 节点'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'aiInstanceId' => ['description' => 'AI 节点实例 id'."\n", 'type' => 'string', 'example' => 'hologram_aicombo_public_cn-77xxx'],
'gpuMemoryUsed' => ['description' => '已使用的节点总显存,此参数仅适用于 Hologres AI 节点'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'regionId' => ['description' => '无', 'type' => 'string', 'example' => 'cn-hangzhou'],
'resourceType' => ['description' => '无', 'type' => 'string', 'example' => 'small'],
'nodeCount' => ['description' => '节点数量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'commodityCode' => ['description' => '无', 'type' => 'string', 'example' => 'hologram_aipostpay_public_cn'],
'chargeType' => ['description' => '无', 'type' => 'string', 'example' => 'PostPaid'],
'status' => ['description' => '**状态**'."\n", 'type' => 'string', 'example' => 'ResourceReady'],
'expirationTime' => ['description' => '过期时间(UTC)'."\n", 'type' => 'string', 'example' => '2026-01-28T07:44:27.535Z'],
'autoRenewal' => ['description' => '**是否自动续费**'."\n", 'type' => 'boolean'],
'holoInstanceId' => ['description' => '**Holo实例ID**'."\n", 'type' => 'string', 'example' => 'hgpostcn-cn-yi34hlzdx003'],
'holoInstanceName' => [
'description' => '**Holo实例名称**'."\n",
'type' => 'string',
'enumValueTitles' => [],
'example' => 'myInstance',
],
'aiSpec' => ['description' => '**AI规格**'."\n", 'type' => 'string', 'example' => 'small-8core-30G-24G'],
],
'description' => '',
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'AI节点资源列表',
'description' => '## 请求说明'."\n"
.'- 该API用于获取特定Holo实例上已部署的模型服务信息,包括但不限于CPU、GPU、内存等资源占用情况。'."\n"
.'- `instanceId`参数为可选项,若不提供,则默认返回所有相关实例的信息。'."\n"
.'- 此接口适用于Hologres AI节点,对于非AI节点的部分参数可能无效或不适用。'."\n"
.'- 请确保在使用该接口前,已充分了解[阿里云Hologram产品的收费方式和价格](https://www.aliyun.com/price/product#/ecs/detail)。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:ListInstanceModel',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC\\",\\n \\"instanceModelList\\": [\\n {\\n \\"cpu\\": 7,\\n \\"gpu\\": 1,\\n \\"memory\\": 16,\\n \\"gpuMemory\\": 32,\\n \\"cpuUsed\\": 7,\\n \\"memoryUsed\\": 32,\\n \\"gpuUsed\\": 32,\\n \\"aiInstanceId\\": \\"hologram_aicombo_public_cn-77xxx\\",\\n \\"gpuMemoryUsed\\": 32,\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"resourceType\\": \\"small\\",\\n \\"nodeCount\\": 2,\\n \\"commodityCode\\": \\"hologram_aipostpay_public_cn\\",\\n \\"chargeType\\": \\"PostPaid\\",\\n \\"status\\": \\"ResourceReady\\",\\n \\"expirationTime\\": \\"2026-01-28T07:44:27.535Z\\",\\n \\"autoRenewal\\": true,\\n \\"holoInstanceId\\": \\"hgpostcn-cn-yi34hlzdx003\\",\\n \\"holoInstanceName\\": \\"myInstance\\",\\n \\"aiSpec\\": \\"small-8core-30G-24G\\"\\n }\\n ]\\n}","type":"json"}]',
],
'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' => ['description' => '是否开启SSL。', 'type' => 'string', 'example' => 'true'],
],
],
],
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1303CD4-AA70-5998-8025-F55B22C50840\\",\\n \\"InstanceList\\": [\\n {\\n \\"CommodityCode\\": \\"hologram_postpay_public_cn\\",\\n \\"CreationTime\\": \\"2022-12-16T02:24:05Z\\",\\n \\"ExpirationTime\\": \\"2023-05-04T16:00:00.000Z\\",\\n \\"InstanceId\\": \\"hgpostcn-cn-aaab9ad2d8fb\\",\\n \\"InstanceName\\": \\"test_instance\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"InstanceChargeType\\": \\"PrePaid\\",\\n \\"LeaderInstanceId\\": \\"hgprecn-cn-2r42sqvxm006\\",\\n \\"SuspendReason\\": \\"Manual\\",\\n \\"EnableHiveAccess\\": \\"true\\",\\n \\"Version\\": \\"1.3.37\\",\\n \\"ResourceGroupId\\": \\"rg-acfmvscak73zmby\\",\\n \\"Endpoints\\": [\\n {\\n \\"Endpoint\\": \\"hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80\\",\\n \\"Type\\": \\"Internet\\",\\n \\"Enabled\\": true,\\n \\"VSwitchId\\": \\"vsw-wz9oap28raidjevhuszg4\\",\\n \\"VpcId\\": \\"vpc-uf6mrahzyu7uorlqqpz5f\\",\\n \\"VpcInstanceId\\": \\"hgpostcn-cn-wwo3665tx004-frontend-st\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageType\\": \\"redundant\\",\\n \\"EnableSSL\\": \\"true\\"\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
'title' => '获取实例列表',
'changeSet' => [
['createdAt' => '2024-12-26T07:01:55.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-07-19T06:15:35.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-06-20T03:52:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-05-16T09:37:50.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2023-04-26T06:51:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-12-02T06:20:06.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/*'],
],
],
],
],
],
'ListLeaderInstances' => [
'summary' => '获取可能的主实例Id列表。',
'path' => '/api/v1/instances/{instanceId}/primaryInstances',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zxu3001jn00d'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5600196E-78E2-50F2-B2A1-C44D3B665438'],
'InstanceList' => [
'description' => '实例列表。',
'type' => 'array',
'items' => [
'description' => '角色列表。',
'type' => 'object',
'properties' => [
'ChargeType' => [
'description' => '付费类型。',
'type' => 'string',
'enumValueTitles' => ['PostPaid' => '包年包月', 'PrePaid' => '按量付费'],
'example' => 'PostPaid',
],
'CommodityCode' => [
'description' => '商品Code',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'hologram_combo_public_cn',
],
'CreationTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-07-25T02:15:35Z'],
'ExpirationTime' => ['description' => '到期时间(按量付费类型没有到期时间)。', 'type' => 'string', 'example' => '2022-07-25T02:15:35Z'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'hgpostcn-cn-tl32vsdir00h'],
'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'user_defined_name'],
'InstanceStatus' => [
'description' => '实例状态。',
'type' => 'string',
'enumValueTitles' => ['Creating' => '正在创建', 'Running' => '正常运行', 'Suspended' => '停机', 'Allocating' => '正在处理,一些接口可能不允许操作'],
'example' => 'Running',
],
'InstanceType' => [
'description' => '实例类型。',
'type' => 'string',
'enumValueTitles' => ['Follower' => '只读从实例', 'Standard' => '普通型'],
'example' => 'Standard',
],
'Tags' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'tagKey'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value'],
],
],
],
'BindingCode' => ['description' => '主实例和从实例的匹配程度。0表示完美匹配,其他表示不匹配。', 'type' => 'string', 'example' => '0'],
],
],
],
'Success' => [
'description' => '请求结果,表示此次请求是否发生异常,与业务无关。',
'type' => 'string',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '404'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Internal server error.'],
'HttpStatusCode' => ['description' => 'http状态码。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取主实例列表',
'description' => '## 请求说明'."\n"
.'- 该API用于获取特定Holo实例上已部署的模型服务信息,包括但不限于CPU、GPU、内存等资源占用情况。'."\n"
.'- `instanceId`参数为可选项,若不提供,则默认返回所有相关实例的信息。'."\n"
.'- 此接口适用于Hologres AI节点,对于非AI节点的部分参数可能无效或不适用。'."\n"
.'- 请确保在使用该接口前,已充分了解[阿里云Hologram产品的收费方式和价格](https://www.aliyun.com/price/product#/ecs/detail)。'."\n",
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5600196E-78E2-50F2-B2A1-C44D3B665438\\",\\n \\"InstanceList\\": [\\n {\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"CommodityCode\\": \\"hologram_combo_public_cn\\",\\n \\"CreationTime\\": \\"2022-07-25T02:15:35Z\\",\\n \\"ExpirationTime\\": \\"2022-07-25T02:15:35Z\\",\\n \\"InstanceId\\": \\"hgpostcn-cn-tl32vsdir00h\\",\\n \\"InstanceName\\": \\"user_defined_name\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"InstanceType\\": \\"Standard\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tagKey\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"BindingCode\\": \\"0\\"\\n }\\n ],\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'ListMigrationZones' => [
'summary' => '查询可以迁移可用区。3AZ实例,可以在可用区之间自助迁移。',
'path' => '/api/v1/instances/{instanceId}/listMigrationZones',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram7D4MSW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-g9j4olkzhxxx'],
],
[
'name' => 'maxResults',
'in' => 'query',
'schema' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
],
[
'name' => 'nextToken',
'in' => 'query',
'schema' => ['description' => '下一次查询的令牌。', 'type' => 'string', 'required' => false, 'example' => '2'],
],
],
'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'],
'zoneList' => [
'description' => '可用区列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-i'],
'available' => ['description' => '该可用区是否可以迁移。true 可以;false:否,不满足迁移条件', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'maxResults' => ['description' => '最大返回结果数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'nextToken' => ['description' => '下一次查询的令牌。', 'type' => 'string', 'example' => '11'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询可迁移可用区',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"zoneList\\": [\\n {\\n \\"zoneId\\": \\"cn-beijing-i\\",\\n \\"available\\": true\\n }\\n ],\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"11\\"\\n}","type":"json"}]',
],
'ListModelCatalog' => [
'path' => '/api/v1/instances/{instanceId}/listModelCatalog',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2ucpyu005'],
],
[
'name' => 'maxResults',
'in' => 'query',
'schema' => ['description' => '分页大小'."\n"
.'默认值:'."\n"
.' 20'."\n"
.'最大值:'."\n"
.' 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
[
'name' => 'nextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。'."\n", 'type' => 'string', 'required' => false, 'example' => 'uat-assembly-cut-3d-bbig'],
],
[
'name' => 'provider',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => 'holo_bailian'],
],
],
'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'],
'nextToken' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。'."\n", 'type' => 'string', 'example' => 'None'],
'maxResults' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'modelList' => [
'description' => '模型列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'modelType' => ['description' => '模型名称。', 'type' => 'string', 'example' => 'qwen3.5-plus'."\n"],
'taskType' => ['description' => '模型用途', 'type' => 'string', 'example' => 'chat/completions'],
'provider' => ['description' => '底层模型提供方。', 'type' => 'string', 'example' => 'bailian'],
'defaultParams' => ['description' => '默认参数', 'type' => 'string', 'example' => '{"timeout": 600, "max_retries": 10, "max_retry_delay": 8, "initial_retry_delay": 0.5}'],
'paramsExample' => ['description' => '参数示例', 'type' => 'string', 'example' => '{'."\n"
.' "extra_body": {'."\n"
.' "translation_options": {'."\n"
.' "source_lang": "zh",'."\n"
.' "domains": "The sentence is from Ali Cloud IT domain. ", '."\n"
.' "terms": ['."\n"
.' {'."\n"
.' "source": "生物传感器",'."\n"
.' "target": "biological sensor"'."\n"
.' },'."\n"
.' {'."\n"
.' "source": "身体健康状况",'."\n"
.' "target": "health status of the body"'."\n"
.' }'."\n"
.' ],'."\n"
.' "tm_list": ['."\n"
.' {'."\n"
.' "source": "您可以通过如下方式查看集群的内核版本信息:",'."\n"
.' "target": "You can use one of the following methods to query the engine version of a cluster:"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.'}'],
'extra' => ['description' => '其他参数', 'type' => 'string', 'example' => '{\\"deepThink\\":false,\\"onlineSearch\\":true}'],
'serviceDeployRegion' => ['description' => '部署地域', 'type' => 'string', 'example' => 'cn-beijing'],
],
'description' => '',
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '模型列表',
'summary' => '模型列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListModelCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"nextToken\\": \\"None\\",\\n \\"maxResults\\": 50,\\n \\"modelList\\": [\\n {\\n \\"modelType\\": \\"qwen3.5-plus\\\\n\\",\\n \\"taskType\\": \\"chat/completions\\",\\n \\"provider\\": \\"bailian\\",\\n \\"defaultParams\\": \\"{\\\\\\"timeout\\\\\\": 600, \\\\\\"max_retries\\\\\\": 10, \\\\\\"max_retry_delay\\\\\\": 8, \\\\\\"initial_retry_delay\\\\\\": 0.5}\\",\\n \\"paramsExample\\": \\"{\\\\n \\\\\\"extra_body\\\\\\": {\\\\n \\\\\\"translation_options\\\\\\": {\\\\n \\\\\\"source_lang\\\\\\": \\\\\\"zh\\\\\\",\\\\n \\\\\\"domains\\\\\\": \\\\\\"The sentence is from Ali Cloud IT domain. \\\\\\", \\\\n \\\\\\"terms\\\\\\": [\\\\n {\\\\n \\\\\\"source\\\\\\": \\\\\\"生物传感器\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"biological sensor\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"source\\\\\\": \\\\\\"身体健康状况\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"health status of the body\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"tm_list\\\\\\": [\\\\n {\\\\n \\\\\\"source\\\\\\": \\\\\\"您可以通过如下方式查看集群的内核版本信息:\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"You can use one of the following methods to query the engine version of a cluster:\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n }\\\\n}\\",\\n \\"extra\\": \\"{\\\\\\\\\\\\\\"deepThink\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"onlineSearch\\\\\\\\\\\\\\":true}\\",\\n \\"serviceDeployRegion\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListOperationEvents' => [
'path' => '/api/v1/instances/listOperationEvents',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramUIEVQ0'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'pageSize' => ['description' => '分页大小,默认50,最大100'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'],
'pageNumber' => ['description' => '页编号,默认1'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'state' => ['description' => '状态筛选'."\n", 'type' => 'string', 'required' => false, 'example' => 'success'],
'eventName' => ['description' => '事件名称筛选'."\n", 'type' => 'string', 'required' => false, 'example' => 'COLD_UPGRADE'],
'eventType' => ['description' => '事件类型筛选'."\n", 'type' => 'string', 'required' => false, 'example' => 'SYSTEM_MAINTENANCE'],
'scheduleTimeDesc' => ['description' => '是否按计划时间降序排序'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'eventNameDesc' => ['description' => '是否按名称降序排序'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'instanceId' => ['description' => '实例Id'."\n", 'type' => 'string', 'required' => false, 'example' => 'hgpost-cn-xxx'],
],
'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' => '事件列表'."\n",
'type' => 'array',
'items' => [
'description' => '返回的结果。',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'Id'."\n", 'type' => 'string', 'example' => '1826503661244379138'],
'Cancelable' => ['description' => '是否可取消'."\n", 'type' => 'boolean', 'example' => 'true'],
'ChangeScheduleTime' => ['description' => '是否可以修改事件'."\n", 'type' => 'boolean', 'example' => 'true'],
'ScheduleTime' => ['description' => 'ScheduleTime'."\n", 'type' => 'string', 'example' => '2024-08-22 15:49:28'],
'State' => ['description' => 'State'."\n", 'type' => 'string', 'example' => 'queued'],
'ResourceId' => ['description' => '资源Id'."\n", 'type' => 'string', 'example' => 'hgpost-cn-sxfsdfsd'],
'EventType' => ['description' => '事件类型筛选'."\n", 'type' => 'string', 'example' => 'UPGRADE_ON_CUSTOMERS_BEHALF'],
'EventName' => ['description' => '事件名称筛选'."\n", 'type' => 'string', 'example' => 'HOT_UPGRADE'],
'InstanceName' => ['description' => '实例名称'."\n", 'type' => 'string', 'example' => 'haha'],
'ZoneId' => ['description' => '区域ID'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-k'],
'MaintainWindow' => ['description' => '维护时间窗口', 'type' => 'string', 'example' => '21:00-22:00'],
'FollowerInstances' => [
'description' => '从实例列表',
'type' => 'array',
'items' => [
'description' => '数组对象',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例Id', 'type' => 'string', 'example' => 'hgxxxx'],
'InstanceName' => ['description' => '实例名称', 'type' => 'string', 'example' => 'hi'],
],
],
],
'Detail' => ['description' => '事件详情', 'type' => 'string', 'example' => '{}'],
],
],
],
'PageSize' => ['description' => '分页大小,默认50,最大100', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'PageNumber' => ['description' => '页编号,默认1'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'TotalCount' => ['description' => '总数'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询操作事件列表',
'summary' => '获取指定条件下的操作事件列表,支持分页和排序。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"1826503661244379138\\",\\n \\"Cancelable\\": true,\\n \\"ChangeScheduleTime\\": true,\\n \\"ScheduleTime\\": \\"2024-08-22 15:49:28\\",\\n \\"State\\": \\"queued\\",\\n \\"ResourceId\\": \\"hgpost-cn-sxfsdfsd\\",\\n \\"EventType\\": \\"UPGRADE_ON_CUSTOMERS_BEHALF\\",\\n \\"EventName\\": \\"HOT_UPGRADE\\",\\n \\"InstanceName\\": \\"haha\\",\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"MaintainWindow\\": \\"21:00-22:00\\",\\n \\"FollowerInstances\\": [\\n {\\n \\"InstanceId\\": \\"hgxxxx\\",\\n \\"InstanceName\\": \\"hi\\"\\n }\\n ],\\n \\"Detail\\": \\"{}\\"\\n }\\n ],\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 3,\\n \\"TotalCount\\": 120\\n}","type":"json"}]',
],
'ListRegions' => [
'summary' => 'Hologres所有地域列表',
'path' => '/api/v1/regions/listRegions',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram7D4MSW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'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'],
'Regions' => [
'description' => '地域列表',
'type' => 'array',
'items' => [
'description' => '地域',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域Id', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '地域列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListUpgradeReleaseVersions' => [
'path' => '/api/v1/instances/{instanceId}/upgrade/listReleaseVersions',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-20p33yhxxxxx'],
],
],
'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' => 'F6DFB9EA-0E2A-52AC-BFD5-1ADBBFFB6A2B'],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Version' => ['description' => '版本号。', 'type' => 'string', 'example' => 'r2.2.47'],
'Type' => ['description' => '版本状态', 'type' => 'string', 'example' => 'Stable'],
'UpgradeStrategy' => [
'description' => '升级策略。',
'type' => 'array',
'items' => ['description' => '升级策略。比如热升级', 'type' => 'string', 'example' => 'hot'],
],
'ReleaseNotesUrl' => ['description' => '版本ReleaseNote', 'type' => 'string', 'example' => 'https://help.aliyun.com/zh/hologres/product-overview/release-notes'],
],
'description' => '',
],
],
'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'],
'title' => '可升级版本列表',
'summary' => '获取可升级版本列表',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6DFB9EA-0E2A-52AC-BFD5-1ADBBFFB6A2B\\",\\n \\"Data\\": [\\n {\\n \\"Version\\": \\"r2.2.47\\",\\n \\"Type\\": \\"Stable\\",\\n \\"UpgradeStrategy\\": [\\n \\"hot\\"\\n ],\\n \\"ReleaseNotesUrl\\": \\"https://help.aliyun.com/zh/hologres/product-overview/release-notes\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'ListWarehouseScheduleEvent' => [
'summary' => '查询指定实例在给定时间范围内的弹性调度事件。',
'path' => '/api/v1/instances/{instanceId}/listWarehouseScheduleEvent',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramOBEJQI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => true, 'example' => 'hgpost-cn-xxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体',
'type' => 'object',
'properties' => [
'startTime' => ['description' => '开始时间戳,默认三天前,单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777257001'],
'endTime' => ['description' => '结束时间戳,默认是当前时间,单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777516201'],
'pageSize' => ['description' => '分页大小,默认30,最大100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'],
'pageNumber' => ['description' => '页编号,默认1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'elasticType' => [
'description' => '弹性类型,包括分时弹性和自动弹性,默认返回全部类型',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['auto' => '自动弹性', 'timed' => '分时弹性'],
'example' => 'timed',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '出参:'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'RequestId'."\n", 'type' => 'string', 'example' => 'E16D32D4-DF86-1180-8220-0D39770A5AF9'],
'EventList' => [
'description' => '事件列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'WarehouseName' => ['description' => '计算组名称。', 'type' => 'string', 'example' => 'init_warehouse'],
'EventName' => [
'description' => '事件名称'."\n",
'type' => 'string',
'enumValueTitles' => ['SetWarehouseClusterCount' => '计算组集群数变更', 'AlterWarehouse' => '计算组CPU变更'],
'example' => 'AlterWarehouse',
],
'EventTime' => ['description' => '事件发生时间(UTC)', 'type' => 'string', 'example' => '2024-07-22T09:43:02.638Z'],
'Result' => [
'description' => '结果'."\n",
'type' => 'string',
'enumValueTitles' => ['success' => '成功', 'failed' => '失败'],
'example' => 'success',
],
'ReservedCpu' => ['description' => '预留CPU数,即非弹性CPU', 'type' => 'integer', 'format' => 'int64', 'example' => '64'],
'OriginalElasticCpu' => ['description' => '弃用字段', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ElasticCpu' => ['description' => '弹性CPU数量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '48'],
'ElasticType' => [
'description' => '弹性类型'."\n",
'type' => 'string',
'enumValueTitles' => ['ScaleDown' => '分时弹性缩容', 'ScaleIn' => '自动弹性缩容', 'ScaleOut' => '自动弹性扩容', 'ScaleUp' => '分时弹性扩容'],
'example' => 'ScaleUp',
],
'InitClusterCount' => ['title' => '预留集群数', 'description' => '预留集群数,即非弹性集群数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ClusterCount' => ['title' => '集群数', 'description' => '集群数', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ClusterCpu' => ['title' => '集群规格', 'description' => '集群规格', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'FailedReason' => ['description' => '失败原因', 'type' => 'string', 'example' => 'insufficient resource'],
],
'description' => '',
],
],
'PageSize' => ['description' => '分页大小,默认30,最大100'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'PageNumber' => ['description' => '页编号,默认1'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalCount' => ['description' => '事件总数', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '弹性事件列表',
'description' => '## 请求说明'."\n"
.'- 该API用于获取特定实例Id下的计算组弹性伸缩事件列表。'."\n"
.'- `startTime` 和 `endTime` 参数分别表示查询的时间范围,默认分别为三天前和当前时间。'."\n"
.'- `pageSize` 和 `pageNumber` 参数用于分页控制,其中`pageSize`最大值为100。'."\n"
.'- 如果不提供`elasticType`参数,则返回所有类型的弹性伸缩事件。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E16D32D4-DF86-1180-8220-0D39770A5AF9\\",\\n \\"EventList\\": [\\n {\\n \\"WarehouseName\\": \\"init_warehouse\\",\\n \\"EventName\\": \\"AlterWarehouse\\",\\n \\"EventTime\\": \\"2024-07-22T09:43:02.638Z\\",\\n \\"Result\\": \\"success\\",\\n \\"ReservedCpu\\": 64,\\n \\"OriginalElasticCpu\\": 0,\\n \\"ElasticCpu\\": 48,\\n \\"ElasticType\\": \\"ScaleUp\\",\\n \\"InitClusterCount\\": 2,\\n \\"ClusterCount\\": 2,\\n \\"ClusterCpu\\": 32,\\n \\"FailedReason\\": \\"insufficient resource\\"\\n }\\n ],\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 120\\n}","type":"json"}]',
],
'ListWarehouseScheduleTask' => [
'path' => '/api/v1/instances/{instanceId}/listWarehouseScheduleTask',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例Id'."\n", 'type' => 'string', 'required' => true, 'example' => 'hgpost-cn-xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => 'A0A16C46-5B56-1F9B-AA37-4C3EAD95AAA8'],
'ScheduleTaskList' => [
'description' => '分时弹性计划列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'WarehouseId' => ['description' => '计算组Id'."\n", 'type' => 'string', 'example' => '1'],
'WarehouseName' => ['description' => '计算组名称'."\n", 'type' => 'string', 'example' => 'init_warehouse'],
'Plans' => [
'description' => '单个计算弹性计划列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '开始时间(只支持整点和半点,比如凌晨1点:0100)', 'type' => 'string', 'example' => '0100'],
'EndTime' => ['description' => '结束时间(只支持整点和半点)'."\n", 'type' => 'string', 'example' => '0400'],
'ElasticCu' => ['description' => '弹性资源,16的整数倍,大于等于16,小于等于计算组规格', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'Description' => ['description' => '弹性计划描述', 'type' => 'string', 'example' => 'bill stat'],
'Id' => ['description' => '弹性计划Id', 'type' => 'string', 'example' => '1802985780260052993'],
],
'description' => '',
],
],
'ReservedCpu' => ['description' => '计算组预留资源', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'Status' => [
'description' => '计算组状态。',
'type' => 'string',
'enumValueTitles' => ['kRunning' => '运行正常', 'kSuspended' => '已停机', 'kAllocating' => '处理中'],
'example' => 'kRunning',
],
'ElasticType' => ['description' => '弹性类型', 'type' => 'string', 'example' => 'timed'],
],
'description' => '',
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '计算组分时弹性计划列表',
'summary' => '获取指定实例下的所有计算组分时弹性计划任务列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0A16C46-5B56-1F9B-AA37-4C3EAD95AAA8\\",\\n \\"ScheduleTaskList\\": [\\n {\\n \\"WarehouseId\\": \\"1\\",\\n \\"WarehouseName\\": \\"init_warehouse\\",\\n \\"Plans\\": [\\n {\\n \\"StartTime\\": \\"0100\\",\\n \\"EndTime\\": \\"0400\\",\\n \\"ElasticCu\\": 32,\\n \\"Description\\": \\"bill stat\\",\\n \\"Id\\": \\"1802985780260052993\\"\\n }\\n ],\\n \\"ReservedCpu\\": 32,\\n \\"Status\\": \\"kRunning\\",\\n \\"ElasticType\\": \\"timed\\"\\n }\\n ]\\n}","type":"json"}]',
],
'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' => '计算组列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWarehouses'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListWarehouses',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'MigrateInstanceZone' => [
'path' => '/api/v1/instances/{instanceId}/migrateInstanceZone',
'methods' => ['patch'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram7D4MSW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08uxxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'zoneId' => ['description' => '目标可用区。建议先调用ListMigrationZones确认目标可用区满足迁移条件。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'],
],
'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'],
'title' => '迁移实例',
'summary' => '迁移实例到目标可用区。仅3AZ实例支持,无需迁移存储,直接在目标可用区启动实例,大约5分钟。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'PrepareUpgrade' => [
'summary' => '启动升级前的准备。升级前需要做一轮评估,评估通过,则可以升级,否则需要联系人工升级。',
'path' => '/api/v1/instances/{instanceId}/upgrade/prepare',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-nwy3e6yxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'version' => ['description' => '目标版本。建议先调用ListUpgradeReleaseVersion查看可以升级到哪些版本。', 'type' => 'string', 'required' => false, 'example' => 'r5.0.0'],
'dryRun' => ['description' => '废弃参数', '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' => '77B97AFB-7C9D-50FF-A72D-F13FD73E49D8'],
'Data' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Success' => ['description' => '启动升级准备任务是否成功', 'type' => 'boolean', 'example' => 'true'],
'FailReason' => ['description' => '升级失败原因。', 'type' => 'string', 'example' => 'null'."\n"],
'ReasonKey' => ['description' => '升级目标key。', 'type' => 'string', 'example' => 'null'],
],
],
'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'],
'title' => '升级准备',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"77B97AFB-7C9D-50FF-A72D-F13FD73E49D8\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"FailReason\\": \\"null\\\\n\\",\\n \\"ReasonKey\\": \\"null\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'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'],
'title' => '计算组均衡分片',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebalanceHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RebalanceHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0EA5844-AB00-5653-8711-CD9FD1798412\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]',
],
'RenameHoloWarehouse' => [
'path' => '/api/v1/instances/{instanceId}/renameHoloWarehouse',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'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'],
'title' => '重命名计算组',
'summary' => '重命名计算组。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RenameHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'RenewInstance' => [
'summary' => '该接口用于为实例手动续费。可以在续费的同时开启按月自动续费。',
'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' => 'Invalid charge type'],
'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\\": \\"Invalid charge type\\",\\n \\"OrderId\\": \\"221625608580893\\",\\n \\"Success\\": true\\n },\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"false\\"\\n}","type":"json"}]',
'title' => '实例续费',
'description' => '>该API操作涉及费用,请确保在使用该接口前,已充分了解实时数仓Hologres的收费方式和价格。>'."\n"
.'- Hologres计费详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4)。'."\n"
.'- Hologres计费详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview)。'."\n"
.'- Hologres续费操作请参见[续费管理](https://help.aliyun.com/zh/hologres/product-overview/manage-renewals?spm=a2c4g.11186623.0.0.6b776c2eJ1h2vx)。'."\n"
.'- Hologres续费操作请参见[续费管理](https://www.alibabacloud.com/help/zh/hologres/product-overview/manage-renewals?spm=a2c63.p38356.0.0.38e731c9VAwtDP)。'."\n"
.'- 续费操作仅适用预付费(PrePaid)实例。',
'responseParamsDescription' => '>'."\n"
.'> - 参数校验错误,仍然会返回正常的Data,Success为false,并包含Code和Message。除非抛出异常,否则成功与否由Data.Success来判断。'."\n"
.'> - 使用新版SDK包调用本接口时,由于SDK内部的客户端默认超时时间和服务端的不一致,因此可能返回请求超时的错误,但实际上接口已调用成功。如需避免这个问题,您可以在调用前设置ReadTimeout参数为20000。'."\n"
."\n"
.'',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RenewInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'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'],
'title' => '更新证书',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:RenewSSLCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'RestartHoloWarehouse' => [
'summary' => '重启计算组。',
'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'],
'title' => '重启计算组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RestartHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'RestartInstance' => [
'summary' => '该接口用于重启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' => '重启实例',
'changeSet' => [
['createdAt' => '2023-04-26T06:51:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RestartInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'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'],
'title' => '恢复计算组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ResumeHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'ResumeInstance' => [
'summary' => '恢复暂停的实例。',
'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'],
'title' => '恢复实例',
'changeSet' => [
['createdAt' => '2023-04-26T06:51:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ResumeInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'RevokeDatabasePermission' => [
'summary' => '取消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'],
'title' => '撤销数据库授权',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'RevokeSchemaPermission' => [
'summary' => '取消Schema授权。',
'path' => '/api/v1/instances/{instanceId}/revokeSchemaPermission',
'methods' => ['put'],
'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'],
'title' => '撤销Schema授权',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'RevokeTablePermission' => [
'path' => '/api/v1/instances/{instanceId}/revokeTablePermission',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramOTL5KY'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例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'],
'columnNames' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
'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'],
'title' => '撤销表授权',
'summary' => '取消表授权。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'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' => '集群数量', 'description' => '集群数量。', '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' => '变配计算组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ScaleHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'ScaleInstance' => [
'summary' => '该接口用于变更实例的规格和存储空间。',
'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' => 'Invalid scale type'],
'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\\": \\"Invalid scale type\\",\\n \\"Success\\": true\\n },\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\"\\n}","type":"json"}]',
'title' => '实例变配',
'description' => '>该API操作涉及费用,请确保在使用该接口前,已充分了解实时数仓Hologres的收费方式和价格。>'."\n"
."\n"
.'- Hologres计费详情请参见[计费概述](https://help.aliyun.com/zh/hologres/product-overview/billing-overview?spm=a2c4g.11186623.0.i4)。'."\n"
.'- Hologres计费详情请参见[计费概述](https://www.alibabacloud.com/help/zh/hologres/product-overview/billing-overview)。'."\n"
.'- 变配实例计算资源期间实例不可用,变配实例存储资源不影响实例的正常使用。请勿频繁进行实例变配操作。详情请参见[实例升降配](https://help.aliyun.com/zh/hologres/product-overview/upgrade-or-downgrade-instance-specifications?spm=a2c4g.11186623.0.i7)。'."\n"
.'- 变配实例计算资源期间实例不可用,变配实例存储资源不影响实例的正常使用。请勿频繁进行实例变配操作。详情请参见[实例升降配](https://www.alibabacloud.com/help/zh/hologres/product-overview/upgrade-or-downgrade-instance-specifications)。',
'responseParamsDescription' => '>'."\n"
.'> - 参数校验错误,仍然会返回正常的Data,Success为false,并包含Code和Message。除非抛出异常,否则成功与否由Data.Success来判断。'."\n"
.'> - 使用新版SDK包调用本接口时,由于SDK内部的客户端默认超时时间和服务端的不一致,因此可能返回请求超时的错误,但实际上接口已调用成功。如需避免这个问题,您可以在调用前设置ReadTimeout参数为20000。'."\n"
."\n"
.'',
'changeSet' => [
['createdAt' => '2024-04-10T01:16:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-10-17T10:59:34.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ScaleInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'StopInstance' => [
'summary' => '该接口用于暂停实例。',
'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' => '停止实例',
'changeSet' => [
['createdAt' => '2023-04-26T06:51:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopInstance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:StopInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'SuspendHoloWarehouse' => [
'summary' => '停止计算组。',
'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'],
'title' => '停止计算组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendHoloWarehouse'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:SuspendHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => '新增tag',
'path' => '/api/v1/tag',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'category' => [
'description' => '资源类型.',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Custom' => '自定义标签', 'System' => '系统标签'],
'example' => 'Custom',
],
'tagOwnerUid' => ['description' => 'tag拥有者账号Id。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1062017779051424'],
'resourceIds' => [
'description' => '实例Id。',
'type' => 'array',
'items' => ['description' => '实例Id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zpr7886u9008'],
'required' => false,
],
'tags' => [
'description' => '新添加的标签集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'any_string'],
'value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'any_string'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['title' => 'terraform必须', 'description' => '实例类型', 'type' => 'string', 'required' => false, 'example' => 'Instance'],
],
],
'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' => '15CEB459-CEE0-5528-87F5-B5A9B9F9B184'],
'Data' => [
'description' => '操作成功标识。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Success' => [
'description' => '请求是否成功,与业务无关。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', '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'],
'title' => '新增实例标签',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15CEB459-CEE0-5528-87F5-B5A9B9F9B184\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UnBindLeaderInstance' => [
'summary' => '解除绑定主实例',
'path' => '/api/v1/instances/{instanceId}/unBindReadOnly',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '只读从实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-7212z8edx001'],
],
],
'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' => '288D934D-3F25-5BA6-9B50-7ABB3017A134'],
'Data' => [
'description' => '解绑是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Success' => [
'description' => '请求是否成功,与业务无关。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', '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'],
'title' => '解绑主从实例',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"288D934D-3F25-5BA6-9B50-7ABB3017A134\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UntagResources' => [
'path' => '/api/v1/tag/unTag',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'category' => [
'description' => '资源分类。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Custom' => '自定义标签', 'System' => '系统标签'],
'example' => 'Custom',
],
'resourceType' => [
'description' => '资源类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['INSTANCE' => 'INSTANCE'],
'example' => 'INSTANCe',
],
'tagOwnerUid' => ['description' => 'tag拥有者账号Id。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1062017779051424'],
'resourceIds' => [
'description' => '实例Id。',
'type' => 'array',
'items' => ['description' => '实例Id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zpr3686u9008'],
'required' => false,
],
'tagKeys' => [
'description' => '标签键集合。'."\n"
.'删除只需要提供相应的tagKey即可',
'type' => 'array',
'items' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'your_tag'],
'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' => 'CE1C813B-3445-57EC-9504-342E45D1C7EA'],
'Data' => [
'description' => '操作成功标识。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Success' => [
'description' => '请求是否成功,与业务无关。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', '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'],
'title' => '删除实例标签',
'summary' => '删除实例标签',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE1C813B-3445-57EC-9504-342E45D1C7EA\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UpdateAutoUpgrade' => [
'summary' => '开启小版本自动升级。开启后,将在运维时间窗口自动升级实例',
'path' => '/api/v1/instances/{instanceId}/autoUpgrade',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-wwoxxxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体',
'type' => 'object',
'properties' => [
'autoUpgrade' => [
'description' => '升级类型。auto:开启小版本自动升级;manual:手动升级。',
'type' => 'string',
'required' => false,
'example' => 'auto',
'enum' => ['manual', 'auto'],
],
],
'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'],
'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'],
'title' => '开启小版本自动升级',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UpdateBackupDataDesc' => [
'summary' => '更新备份描述',
'path' => '/api/v1/backups/{id}/desc',
'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' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'instanceId' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgpostcn-cn-721344a2z001'],
'desc' => ['description' => '备份描述。', 'type' => 'string', 'required' => false, 'example' => 'back up test'],
],
'required' => false,
],
],
[
'name' => 'id',
'in' => 'path',
'schema' => ['description' => '备份id。', 'type' => 'string', 'required' => false, 'example' => '1597404937581527041'],
],
],
'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' => '87060182-4B69-5C3D-B3A1-A944D20138A7'],
'Data' => ['description' => '返回数据', 'type' => 'boolean', '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'],
'title' => '修改备份描述',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"87060182-4B69-5C3D-B3A1-A944D20138A7\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UpdateHoloWebLoginSetting' => [
'summary' => '修改holoweb登陆权限',
'path' => '/api/v1/instances/{instanceId}/updateHoloWebLoginSetting',
'methods' => ['post'],
'schemes' => ['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' => 'hgprecn-cn-i7m2ucxxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'allowExternalAccountsLogin' => ['description' => 'true,允许,false,不允许', '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' => 'CB13FFDD-2DF8-5396-A848-2D6A31245B6D'],
'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' => 'Internal server error.'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改holoweb登陆权限',
'description' => '创建模型服务需要大量参数,如果是创建百炼模型,请调用ListModelCatalog查询模型参数;如果是Hologres AI节点,请调用GetAvailableModelsResource查询模型参数。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB13FFDD-2DF8-5396-A848-2D6A31245B6D\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"Internal server error.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UpdateInstanceName' => [
'summary' => '该接口用于修改实例名称。',
'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' => '修改实例名称',
'changeSet' => [
['createdAt' => '2023-07-07T04:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-25T01:49:36.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceName'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateInstanceName',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'UpdateInstanceNetworkType' => [
'summary' => '该接口用于修改实例网络类型。',
'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' => '切换实例的网络类型',
'changeSet' => [
['createdAt' => '2023-04-26T06:51:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceNetworkType'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateInstanceNetworkType',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'UpdateInstancePort' => [
'path' => '/api/v1/instances/{instanceId}/updatePort',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => [],
'produces' => [],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-i7m2v08uxxx'."\n"],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'port' => ['description' => '端口号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443'],
],
'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' => 'D1303CD4-AA70-5998-8025-F55B22C50840'],
'data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
'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'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改实例端口号',
'summary' => '修改端口号',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1303CD4-AA70-5998-8025-F55B22C50840\\",\\n \\"data\\": true,\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UpdateMaintenanceWindow' => [
'path' => '/api/v1/instances/{instanceId}/maintenanceWindow',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram7D4MSW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '`instanceId=xxx`'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'startTime' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '00:00'],
'endTime' => ['description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '02:00'],
],
'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' => 'true:成功;false:失败', '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'],
'title' => '设置可维护时间窗口',
'summary' => '用于设定实例的可维护时间段,以便进行系统维护。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UpdateModelService' => [
'summary' => '创建模型服务,只适用于Hologres AI',
'path' => '/api/v1/instances/{instanceId}/updateModelService',
'methods' => ['patch'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologramFNR69T'],
],
'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' => [
'modelServiceName' => ['description' => '自定义的服务名称', 'type' => 'string', 'required' => true, 'example' => 'model-qwen'],
'modelType' => ['description' => '模型名称。', 'type' => 'string', 'required' => false, 'example' => 'Qwen/Qwen2.5-VL-32B-Instruct'],
'cpu' => ['description' => 'CPU 规格', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32'],
'memory' => ['description' => '内存规格。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'],
'gpu' => ['description' => 'GPU规格。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'serviceCount' => ['description' => '服务副本数。', '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' => '819A7F0F-2951-540F-BD94-6A41ECF0281F'],
'data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新模型服务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"819A7F0F-2951-540F-BD94-6A41ECF0281F\\",\\n \\"data\\": true\\n}","type":"json"}]',
],
'UpdateOperationEventScheduleTime' => [
'summary' => '修改运维事件执行时间',
'path' => '/api/v1/instances/{instanceId}/updateOperationEventScheduleTime',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => true, 'example' => 'hgprecn-cn-zvp2qfwecxxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'id' => ['description' => '事件Id', 'type' => 'string', 'required' => true, 'example' => '2034449120420339713'],
'scheduleTime' => ['description' => '东八区时间', 'type' => 'string', 'required' => true, 'example' => '2024-08-23 14:55:00'],
],
'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' => '11F64C4C-EC50-5472-BC5D-7FD9F51499F6'],
'Data' => ['description' => 'true:成功;false:失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新运维事件执行时间',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11F64C4C-EC50-5472-BC5D-7FD9F51499F6\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'UpdateScheduledBackupConfig' => [
'path' => '/api/v1/backups/scheduledConfig',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'instanceId' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'hgprecn-cn-zvp25ysxxxx'],
'enabled' => ['description' => '是否开启周期备份。true 开启,false 关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'week' => ['description' => '备份日期的周配置,可以配置多个,英文逗号分隔,比如配置周一、周三、周五,参数为"1,3,5".', 'type' => 'string', 'required' => false, 'example' => '1,3,5'],
'hour' => ['description' => '备份日期的开始时间点,备份任务将在开始时间点启动。时间点对所有有效日期生效,比如week配置了1,3,5, hour配置20, 那么,每周一、周三、周五的20:00:00都会开始备份。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
'dataKeepQuantity' => ['description' => '周期备份保留个数,比如配置3,系统会自动保留最新的3个备份,其余过期备份会被自动清理。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'dstRegion' => ['description' => '备份目标地域。仅对远程备份生效,支持将本地域数据备份到其他地域,实现跨地域容灾。比如杭州的实例,可以跨地域备份到北京。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
'zoneId' => ['description' => '备份目标可用区。仅对远程备份生效', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-i'],
'manualDataKeepQuantity' => ['description' => '手动备份保留个数。手动备份和自动备份分开存储,保留策略完全分开。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'scheduleType' => [
'description' => '备份类型。仅远程备份需要配置此字段,其余类型可以忽略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['periodical' => '周期备份', 'remote' => '远程备份'],
'example' => 'remote',
],
],
'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' => '69221013-D303-5046-91A7-A0BE2BC2E7D7'],
'Data' => ['description' => 'true:成功;false:失败', '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'],
'title' => '配置备份策略',
'summary' => '配置备份策略。以周为周期,可以指定一周内的数个固定日期启动实例备份,比如周一、周三、周五的20:00:00。已完成的备份,可以配置保留个数,过期的备份会被自动清理。',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69221013-D303-5046-91A7-A0BE2BC2E7D7\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'UpdateWarehouseScheduleTask' => [
'path' => '/api/v1/instances/{instanceId}/updateWarehouseScheduleTask',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', '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' => [
'warehouseId' => ['description' => '计算组id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
'startTime' => ['description' => '开始时间。24 小时制,只能是整点或半点,比如 0030,0100,0400', 'type' => 'string', 'required' => false, 'example' => '0200'],
'endTime' => ['description' => '结束时间。24 小时制,只能是整点或半点,比如 0030,0100,0400。 结束时间必须大于开始时间。', 'type' => 'string', 'required' => false, 'example' => '0400'],
'elasticCu' => ['description' => '弹出的 CPU 核数,必须是 16 的整数倍,大于等于 16,小于等于当前计算组规格。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32'],
'id' => ['description' => '弹性计划 Id', 'type' => 'string', 'required' => false, 'example' => '1980869072412614657'],
],
'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'],
'title' => '更新计算组分时弹性计划',
'summary' => '更新计算组分时弹性计划',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'UpgradeInstance' => [
'path' => '/api/v1/instances/{instanceId}/upgrade',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhologram9SZMQ8'],
'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' => 'hgprecn-cn-jeo3n72xxxx'],
],
[
'name' => 'upgradeTime',
'in' => 'query',
'schema' => ['description' => '升级时间', 'type' => 'string', 'required' => false, 'example' => '2025-02-11 10:00:01'],
],
[
'name' => 'type',
'in' => 'query',
'schema' => ['description' => '升级类型', 'type' => 'string', 'required' => false, 'example' => 'hot'],
],
],
'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' => 'EEB0A71E-7AC7-572F-990F-EE51D3FD35B9'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Success' => ['description' => '操作是否成功。取值:true:成功。false:失败。', 'type' => 'boolean', 'example' => 'true'],
'FailReason' => ['description' => '升级失败原因。', 'type' => 'string', 'example' => 'null'],
'ReasonKey' => ['description' => '原因Key', 'type' => 'string', 'example' => 'null'],
],
],
'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'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '升级实例',
'summary' => '升级实例。如果Prepare成功,则实例可以直接开始升级。',
'changeSet' => [
['createdAt' => '2022-09-08T02:43:37.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEB0A71E-7AC7-572F-990F-EE51D3FD35B9\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"FailReason\\": \\"null\\",\\n \\"ReasonKey\\": \\"null\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"null\\",\\n \\"ErrorMessage\\": \\"null\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-shenzhen.aliyuncs.com', 'endpoint' => 'hologram.cn-shenzhen.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'hologram.cn-wulanchabu.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-beijing.aliyuncs.com', 'endpoint' => 'hologram.cn-beijing.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'regionName' => '韩国(首尔)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.ap-northeast-2.aliyuncs.com', 'endpoint' => 'hologram.ap-northeast-2.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-northeast-2.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.ap-northeast-1.aliyuncs.com', 'endpoint' => 'hologram.ap-northeast-1.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-chengdu.aliyuncs.com', 'endpoint' => 'hologram.cn-chengdu.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-shanghai.aliyuncs.com', 'endpoint' => 'hologram.cn-shanghai.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-hongkong.aliyuncs.com', 'endpoint' => 'hologram.cn-hongkong.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.ap-southeast-1.aliyuncs.com', 'endpoint' => 'hologram.ap-southeast-1.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.ap-southeast-3.aliyuncs.com', 'endpoint' => 'hologram.ap-southeast-3.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.ap-southeast-5.aliyuncs.com', 'endpoint' => 'hologram.ap-southeast-5.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'hologram.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'hologram.cn-hangzhou.aliyuncs.com', 'endpoint' => 'hologram.cn-hangzhou.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'hologram.us-west-1.aliyuncs.com', 'endpoint' => 'hologram.us-west-1.aliyuncs.com', 'vpc' => 'hologram-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'hologram.us-east-1.aliyuncs.com', 'endpoint' => 'hologram.us-east-1.aliyuncs.com', 'vpc' => 'hologram-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'hologram.eu-central-1.aliyuncs.com', 'endpoint' => 'hologram.eu-central-1.aliyuncs.com', 'vpc' => 'hologram-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'na-south-1', 'regionName' => '墨西哥', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'hologram.na-south-1.aliyuncs.com', 'endpoint' => 'hologram.na-south-1.aliyuncs.com', 'vpc' => 'hologram-vpc.na-south-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'hologram.eu-west-1.aliyuncs.com', 'endpoint' => 'hologram.eu-west-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'hologram.me-east-1.aliyuncs.com', 'endpoint' => 'hologram.me-east-1.aliyuncs.com', 'vpc' => 'hologram-vpc.me-east-1.aliyuncs.com'],
['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'hologram.ap-south-1.aliyuncs.com', 'endpoint' => 'hologram.ap-south-1.aliyuncs.com', 'vpc' => 'hologram-vpc.ap-south-1.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'hologram.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'hologram.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shanghai-finance-1.aliyuncs.com'],
['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'hologram.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'hologram.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-north-2-gov-1.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'hologram.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'hologram.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'hologram-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'DBAlreadyExist', 'message' => 'The database already exists.', 'http_code' => 409, 'description' => '数据库已存在'],
['code' => 'DBNotExist', 'message' => 'The database does not exist.', 'http_code' => 404, 'description' => '数据库不存在'],
['code' => 'HasUnreleasedResource', 'message' => 'The current user has unreleased resource.', 'http_code' => 403, 'description' => '当前用户有未释放的资源。'],
['code' => 'InstanceIdFormatError', 'message' => 'The format of the instance ID is invalid.', 'http_code' => 400, 'description' => '参数实例id格式错误'],
['code' => 'InstanceNotExists', 'message' => 'The speicified instance ID does not exist.', 'http_code' => 404, 'description' => '指定的Instance ID不存在'],
['code' => 'InstanceNotReady', 'message' => 'The instance is not ready.', 'http_code' => 403, 'description' => '实例尚未准备好'],
['code' => 'InstanceSuspended', 'message' => 'The instance is suspended.', 'http_code' => 403, 'description' => '实例已被挂起'],
['code' => 'Internal Error', 'message' => 'Server Internal Error.', 'http_code' => 500, 'description' => '服务器内部错误'],
['code' => 'InternalError', 'message' => 'A server error occurred while processing your request.', 'http_code' => 500, 'description' => '请求因服务器内部错误导致异常'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => '参数错误'],
['code' => 'MissingParameter', 'message' => 'You must specify the parameter %s.', 'http_code' => 400, 'description' => '缺少参数'],
['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 400, 'description' => '用户权限不足'],
['code' => 'NotSupportInCurrentVersion', 'message' => 'The feature is not supported in current version.', 'http_code' => 400, 'description' => '当前版本不支持该功能。'],
['code' => 'NotSupportYet', 'message' => 'This feature is not supported.', 'http_code' => 400, 'description' => '暂不支持该特性'],
['code' => 'RegionNotExist', 'message' => 'The specified region does not exist.', 'http_code' => 404, 'description' => '指定的Region不存在'],
['code' => 'Resource not exists failed', 'message' => 'resource does not exist.', 'http_code' => 404, 'description' => '实例不存在'],
['code' => 'resource not exists failed', 'message' => 'the resource not exists failed.', 'http_code' => 404, 'description' => '实例不存在'],
['code' => 'UserAlreadyExist', 'message' => 'The user already exists.', 'http_code' => 409, 'description' => '用户已存在'],
['code' => 'UserNotExist', 'message' => 'The user does not exist.', 'http_code' => 404, 'description' => '用户不存在'],
['code' => 'UserStatusIllegal', 'message' => 'The user status is invalid.', 'http_code' => 400, 'description' => '用户状态异常'],
],
'changeSet' => [
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetWarehouseDetail'],
],
'createdAt' => '2024-08-16T07:50:39.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateInstance'],
['description' => '请求参数发生变更', 'api' => 'ScaleInstance'],
],
'createdAt' => '2024-04-10T01:16:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetInstance'],
],
'createdAt' => '2024-03-14T10:24:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetInstance'],
],
'createdAt' => '2024-01-23T09:37:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateInstance'],
],
'createdAt' => '2023-10-18T11:14:14.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ScaleInstance'],
],
'createdAt' => '2023-10-17T10:59:44.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetInstance'],
['description' => '响应参数发生变更', 'api' => 'ListInstances'],
],
'createdAt' => '2023-07-19T06:15:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateInstanceName'],
],
'createdAt' => '2023-07-07T04:58:21.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListInstances'],
],
'createdAt' => '2023-06-20T03:52:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetInstance'],
],
'createdAt' => '2023-05-17T03:38:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'ListInstances'],
],
'createdAt' => '2023-05-16T09:37:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListInstances'],
['description' => '请求参数发生变更', 'api' => 'RestartInstance'],
['description' => '请求参数发生变更', 'api' => 'ResumeInstance'],
['description' => '请求参数发生变更', 'api' => 'StopInstance'],
['description' => '请求参数发生变更', 'api' => 'UpdateInstanceNetworkType'],
],
'createdAt' => '2023-04-26T06:51:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateInstanceName'],
],
'createdAt' => '2023-04-25T01:49:43.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'GetUpgradeStatus'],
],
'createdAt' => '2023-04-10T08:55:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetInstance'],
],
'createdAt' => '2023-04-10T06:28:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListInstances'],
],
'createdAt' => '2022-12-02T06:20:26.000Z',
'description' => 'ListInstance新增Endpoints信息',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetInstance'],
],
'createdAt' => '2022-11-30T08:40:45.000Z',
'description' => '新增可用区字段',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetInstanceMetrics'],
],
'createdAt' => '2022-11-16T03:45:50.000Z',
'description' => '无',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetInstance'],
],
'createdAt' => '2022-11-07T08:49:29.000Z',
'description' => '无',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'BindLeaderInstance'],
['description' => 'OpenAPI 下线', 'api' => 'CreateManualBackup'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteBackupData'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteInstance'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeTags'],
['description' => 'OpenAPI 下线', 'api' => 'DisableHiveAccess'],
['description' => 'OpenAPI 下线', 'api' => 'DiscardUpgrade'],
['description' => 'OpenAPI 下线', 'api' => 'EnableHiveAccess'],
['description' => 'OpenAPI 下线', 'api' => 'GetInstance'],
['description' => 'OpenAPI 下线', 'api' => 'GetInstanceMetrics'],
],
'createdAt' => '2022-09-08T02:44:53.000Z',
'description' => 'Hologres OPENAPI发布',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceNetworkType'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebalanceHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBackupData'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHiveAccess'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWarehouses'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScaleHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceName'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHiveAccess'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWarehouseDetail'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameHoloWarehouse'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
],
],
'ram' => [
'productCode' => 'Hologram',
'productName' => '实时数仓 Hologres',
'ramCodes' => ['hologram'],
'ramLevel' => '资源级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'GetInstance',
'description' => '获取实例详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'RenameHoloWarehouse',
'description' => '重命名计算组',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RenameHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ResumeInstance',
'description' => '恢复实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ResumeInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListLeaderInstances',
'description' => '获取主实例列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListLeaderInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateOperationEventScheduleTime',
'description' => '更新运维事件执行时间',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateOperationEventScheduleTime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListInstanceModel',
'description' => 'AI节点资源列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:ListInstanceModel',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateUser',
'description' => '创建用户',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ScaleInstance',
'description' => '实例变配',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ScaleInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'CreateWarehouseScheduleTask',
'description' => '创建分时弹性计划',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateWarehouseScheduleTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DisableOperationEvent',
'description' => '关闭运维日志',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:DisableOperationEvent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateHoloWebLoginSetting',
'description' => '修改holoweb登陆权限',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateHoloWebLoginSetting',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DeleteHoloWarehouse',
'description' => '删除计算组',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'EnableSupportAccount',
'description' => '开启服务账号',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:EnableSupportAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DeleteInstance',
'description' => '删除实例',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DeleteModelService',
'description' => '删除模型服务',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteModelService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInstanceModel',
'description' => '实例部署模型详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetInstanceModel',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetUpgradeable',
'description' => '查询是否可升级',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetUpgradeable',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetHoloWebLoginSetting',
'description' => '查询HoloWeb登录权限',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetHoloWebLoginSetting',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetWarehouseDetail',
'description' => '计算组详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetWarehouseDetail',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DropUser',
'description' => '删除用户',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DropUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
[
'apiName' => 'ChangeResourceGroup',
'description' => '更新资源组',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'StopInstance',
'description' => '停止实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:StopInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetExecuteStatementEnabled',
'description' => '查询实例是否开启ExecuteStatement功能',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetExecuteStatementEnabled',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'RestartHoloWarehouse',
'description' => '重启计算组',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RestartHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetRootCertificate',
'description' => '下载证书',
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:GetRootCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DescribeTags',
'description' => '列出所有标签',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:DescribeTags',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteModelResource',
'description' => '删除节点资源',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteModelResource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListWarehouseScheduleTask',
'description' => '计算组分时弹性计划列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListWarehouseScheduleTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '新增实例标签',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableHiveAccess',
'description' => '关闭数据湖加速',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:DisableHiveAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'EnableExecuteStatement',
'description' => '开启实例SQL执行API',
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:EnableExecuteStatement',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'CreateWarehouse',
'description' => '创建Warehouse',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListInstances',
'description' => '获取实例列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/*'],
],
],
],
[
'apiName' => 'CreateModelService',
'description' => '创建模型服务',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateModelService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateScheduledBackupConfig',
'description' => '配置备份策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateScheduledBackupConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetCertificateAttribute',
'description' => '查看实例证书属性',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetCertificateAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'MigrateInstanceZone',
'description' => '迁移实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:MigrateInstanceZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DeleteBackupData',
'description' => '删除实例备份',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteBackupData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListDatabases',
'description' => '数据库列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListDatabases',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ScaleHoloWarehouse',
'description' => '变配计算组',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ScaleHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListFollowerInstances',
'description' => '从实例列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListFollowerInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateModelService',
'description' => '更新模型服务',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateModelService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnBindLeaderInstance',
'description' => '解绑主从实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UnBindLeaderInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'BindLeaderInstance',
'description' => '绑定从实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:BindLeaderInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'RestartInstance',
'description' => '重启实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RestartInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DisableSSL',
'description' => '关闭SSL',
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:DisableSSL',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateBackupDataDesc',
'description' => '修改备份描述',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateBackupDataDesc',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'SuspendHoloWarehouse',
'description' => '停止计算组',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:SuspendHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'CreateHoloWarehouse',
'description' => '创建计算组',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetLastUpgradeRecord',
'description' => '查询升级记录',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetLastUpgradeRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListModelCatalog',
'description' => '模型列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListModelCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListRegions',
'description' => '地域列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListRegions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetScheduledBackupConfig',
'description' => '获取备份配置',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetScheduledBackupConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'EnableHiveAccess',
'description' => '开启数据湖加速',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:EnableHiveAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetUpgradeStatus',
'description' => '查询升级状态',
'operationType' => 'get',
'ramAction' => [
'action' => 'hologram:GetUpgradeStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'CreateInstance',
'description' => '创建实例',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListMigrationZones',
'description' => '查询可迁移可用区',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListMigrationZones',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListBackupData',
'description' => '查询备份列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListBackupData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UntagResources',
'description' => '删除实例标签',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UntagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GrantDatabasePermission',
'description' => '数据库授权',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:GrantDatabasePermission',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GrantTablePermission',
'description' => '表授权',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:GrantTablePermission',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateInstanceName',
'description' => '修改实例名称',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateInstanceName',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListWarehouseScheduleEvent',
'description' => '弹性事件列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListWarehouseScheduleEvent',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'RenewSSLCertificate',
'description' => '更新证书',
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:RenewSSLCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DiscardUpgrade',
'description' => '取消升级',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DiscardUpgrade',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'PrepareUpgrade',
'description' => '升级准备',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:PrepareUpgrade',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'HoloInstance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpgradeInstance',
'description' => '升级实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpgradeInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'RebalanceHoloWarehouse',
'description' => '计算组均衡分片',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RebalanceHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'EnableSSL',
'description' => '开启SSL',
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:EnableSSL',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateMaintenanceWindow',
'description' => '设置可维护时间窗口',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateMaintenanceWindow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateInstanceNetworkType',
'description' => '切换实例的网络类型',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateInstanceNetworkType',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateAutoUpgrade',
'description' => '开启小版本自动升级',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateAutoUpgrade',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListUpgradeReleaseVersions',
'description' => '可升级版本列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListUpgradeReleaseVersions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListOperationEvents',
'description' => '查询操作事件列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListOperationEvents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExecuteStatement',
'description' => '执行SQL语句',
'operationType' => 'none',
'ramAction' => [
'action' => 'hologram:ExecuteStatement',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ResumeHoloWarehouse',
'description' => '恢复计算组',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:ResumeHoloWarehouse',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListWarehouses',
'description' => '计算组列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:ListWarehouses',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateWarehouseScheduleTask',
'description' => '更新计算组分时弹性计划',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:UpdateWarehouseScheduleTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DisableSupportAccount',
'description' => '关闭服务账号',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:DisableSupportAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'CreateDatabase',
'description' => '创建数据库',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:CreateDatabase',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateManualBackup',
'description' => '创建实例备份',
'operationType' => 'create',
'ramAction' => [
'action' => 'hologram:CreateManualBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateInstancePort',
'description' => '修改实例端口号',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:UpdateInstancePort',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'CreateExternalDatabase',
'description' => '创建外部数据库',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:CreateExternalDatabase',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GrantSchemaPermission',
'description' => 'Schema授权',
'operationType' => 'list',
'ramAction' => [
'action' => 'hologram:GrantSchemaPermission',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'RenewInstance',
'description' => '实例续费',
'operationType' => 'update',
'ramAction' => [
'action' => 'hologram:RenewInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteWarehouseScheduleTask',
'description' => '删除计算组弹性计划',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hologram:DeleteWarehouseScheduleTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Hologram', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/*'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:*:{#accountId}:instance/*'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hologram:*:{#accountId}:instance/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'HoloInstance', 'arn' => 'acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
];