summaryrefslogtreecommitdiff
path: root/data/en_us/clickhouse/2023-05-22/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/clickhouse/2023-05-22/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/clickhouse/2023-05-22/api-docs.php')
-rw-r--r--data/en_us/clickhouse/2023-05-22/api-docs.php10882
1 files changed, 5580 insertions, 5302 deletions
diff --git a/data/en_us/clickhouse/2023-05-22/api-docs.php b/data/en_us/clickhouse/2023-05-22/api-docs.php
index 4a7e3cc..5876e76 100644
--- a/data/en_us/clickhouse/2023-05-22/api-docs.php
+++ b/data/en_us/clickhouse/2023-05-22/api-docs.php
@@ -1,137 +1,188 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'clickhouse',
- 'version' => '2023-05-22',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'clickhouse', 'version' => '2023-05-22'],
'directories' => [
[
- 'id' => 222452,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'CreateDBInstance',
- 'DeleteDBInstance',
- 'StartDBInstance',
- 'RestartDBInstance',
- 'StopDBInstance',
- 'ModifyDBInstanceClass',
- 'ModifyDBInstanceAttribute',
- 'DescribeDBInstances',
- 'DescribeDBInstanceAttribute',
- 'UpgradeMinorVersion',
- ],
- ],
- [
- 'id' => 222463,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'CreateAccount',
- 'DeleteAccount',
- 'ResetAccountPassword',
- 'ModifyAccountDescription',
- 'ModifyAccountAuthority',
- 'DescribeAccounts',
- 'DescribeAccountAuthority',
- ],
- ],
- [
- 'id' => 222471,
- 'title' => null,
+ 'children' => ['CreateDB', 'DeleteDB', 'DescribeDBInstanceDataSources'],
'type' => 'directory',
- 'children' => [
- 'CreateDB',
- 'DeleteDB',
- 'DescribeDBInstanceDataSources',
- ],
+ 'title' => 'Database management',
],
[
- 'id' => 222475,
- 'title' => null,
+ 'children' => ['DescribeProcessList', 'KillProcess', 'DescribeSlowLogTrend'],
'type' => 'directory',
- 'children' => [
- 'CreateEndpoint',
- 'DeleteEndpoint',
- 'ModifyDBInstanceConnectionString',
- 'ModifySecurityIPList',
- 'DescribeSecurityIPList',
- 'DescribeEndpoints',
- ],
+ 'title' => 'Task and log management',
],
[
- 'id' => 222482,
- 'title' => null,
- 'type' => 'directory',
'children' => [
- 'DescribeProcessList',
- 'KillProcess',
- 'DescribeSlowLogTrend',
- 'DescribeSlowLogRecords',
+ 'AttachWhitelistTemplateToInstance', 'ChangeResourceGroup', 'CreateAccount', 'CreateBackupPolicy', 'CreateDBInstance', 'CreateEndpoint', 'CreateLangfuseOrg', 'CreateLangfuseOrgMember', 'CreateLangfuseProject', 'CreateLangfuseUser', 'CreateWhitelistTemplate', 'DeleteAccount', 'DeleteBackupPolicy', 'DeleteDBInstance', 'DeleteEndpoint', 'DeleteLangfuseInstance', 'DeleteLangfuseOrg', 'DeleteLangfuseOrgMembership', 'DeleteLangfuseProject', 'DeleteLangfuseUser',
+ 'DeleteWhitelistTemplate', 'DescribeAccountAuthority', 'DescribeAccounts', 'DescribeBackupPolicy', 'DescribeBackups', 'DescribeDBInstanceAttribute', 'DescribeDBInstanceConfig', 'DescribeDBInstanceConfigChangeLog', 'DescribeDBInstances', 'DescribeEndpoints', 'DescribeLangfuseEndpoints', 'DescribeLangfuseOrgMemberships', 'DescribeLangfuseOrgs', 'DescribeLangfuseProjectMemberships', 'DescribeLangfuseProjects', 'DescribeLangfuseSecurityIPList', 'DescribeLangfuseUser', 'DescribeLangfuseUsers', 'DescribeRegions', 'DescribeSecurityIPList',
+ 'DescribeSlowLogRecords', 'DetachWhitelistTemplateToInstance', 'GetWhitelistTemplate', 'ListClickHouseDBTimezones', 'ListInstanceLinkedWhitelistTemplates', 'ListWhitelistTemplates', 'ModifyAccountAuthority', 'ModifyAccountDescription', 'ModifyBackupPolicy', 'ModifyDBInstanceAttribute', 'ModifyDBInstanceClass', 'ModifyDBInstanceConfig', 'ModifyDBInstanceConnectionString', 'ModifyLangfuseOrgMembership', 'ModifyLangfuseProjectMembership', 'ModifySecurityIPList', 'ResetAccountPassword', 'ResetLangfuseUserPassword', 'RestartDBInstance', 'StartDBInstance',
+ 'StopDBInstance', 'UpdateWhitelistTemplate', 'UpgradeMinorVersion',
],
- ],
- [
- 'id' => 222487,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'ModifyBackupPolicy',
- 'DescribeBackupPolicy',
- 'DeleteBackupPolicy',
- 'CreateBackupPolicy',
- 'DescribeBackups',
- ],
- ],
- [
- 'id' => 222493,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'ModifyDBInstanceConfig',
- 'DescribeDBInstanceConfigChangeLog',
- 'DescribeDBInstanceConfig',
- ],
- ],
- [
- 'id' => 222497,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'ChangeResourceGroup',
- ],
- ],
- [
- 'id' => 0,
'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'ListClickHouseDBTimezones',
- 'DeleteWhitelistTemplate',
- 'CreateWhitelistTemplate',
- 'DetachWhitelistTemplateToInstance',
- 'UpdateWhitelistTemplate',
- 'GetWhitelistTemplate',
- 'AttachWhitelistTemplateToInstance',
- 'ListWhitelistTemplates',
- 'ListInstanceLinkedWhitelistTemplates',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateDBInstance' => [
- 'summary' => 'Creates an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'get',
- 'post',
+ 'AttachWhitelistTemplateToInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185639',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the whitelist template.', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', 'title' => ''],
+ ],
+ [
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ClickHouse instance ID. Separate multiple instance IDs with commas. A maximum of 20 instances can be attached at a time.', 'type' => 'string', 'required' => true, 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', 'title' => ''],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
+ 'Data' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the operation. A value of `ok` indicates success.', 'type' => 'string', 'example' => 'ok', 'title' => ''],
+ 'AttachFailList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'my-database', 'title' => ''],
+ 'Reason' => ['description' => 'The reason for the attachment failure.', 'type' => 'string', 'example' => '处理异常', 'title' => ''],
+ ],
+ 'description' => 'Details of the attachment failure for the instance.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'Instances that failed to be attached.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AttachSuccessedList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'my-database', 'title' => ''],
+ 'Templates' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The ID of the whitelist template.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'TemplateName' => ['description' => 'The name of the whitelist template.', 'type' => 'string', 'example' => 'demo_template', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ 'DbInstances' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'asdfwef', 'title' => ''],
+ ],
+ 'description' => 'The details of the instance.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of attached instances.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The details of the template.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of whitelist templates.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'Details about the instances to which the template was successfully attached.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'Instances to which the template was successfully attached.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The returned data.',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'Schema of response.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''],
+ ['errorCode' => 'InvalidDBInstanceId.TooManyItems', 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.DBInstanceId', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidAttachTemplate.QuotaExceeded', 'errorMessage' => 'Exceed the upper limit of the template that the instance can bind.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'AttachWhitelistTemplateToInstance',
+ 'summary' => 'Attaches a whitelist template to instances.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:AttachWhitelistTemplateToInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"AttachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"AttachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ChangeResourceGroup' => [
+ 'summary' => 'Changes the resource group of a ClickHouse Enterprise instance.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -140,127 +191,521 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '182031',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseN0HBPQ',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '163948',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
- 'name' => 'ClientToken',
+ 'name' => 'ResourceType',
'in' => 'query',
- 'allowEmptyValue' => false,
'schema' => [
- 'title' => '幂等参数',
- 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n",
'type' => 'string',
'required' => false,
- 'example' => 'AB',
+ 'default' => 'EnterpriseDBCluster',
+ 'title' => '',
+ 'description' => 'The resource type.',
+ 'enumValueTitles' => [],
+ 'example' => 'EnterpriseDBCluster',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The resource ID.', 'example' => 'cc-bp1i43033051****'],
+ ],
+ [
+ 'name' => 'ResourceRegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The region ID.', 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The ID of the destination resource group.', 'example' => 'rg-4690g37929****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- 'title' => '地域id',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => 'C342F3DD-1FF7-55E9-A1A1-098D*******'],
+ ],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', 'description' => ''],
+ ['errorCode' => 'MissingParameter.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', 'description' => ''],
+ ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''],
+ ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''],
+ ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''],
+ ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', 'description' => ''],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'ChangeResourceGroup',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098D*******\\"\\n}","type":"json"}]',
+ ],
+ 'CreateAccount' => [
+ 'summary' => 'Creates a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ZoneId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185272',
+ 'abilityTreeNodes' => ['FEATUREclickhouseL1079N'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AccountType',
'in' => 'query',
'schema' => [
- 'description' => 'The zone ID.'."\n",
+ 'description' => 'The type of the database account. Valid values:'."\n"
+ ."\n"
+ .'- **NormalAccount**: standard account'."\n"
+ ."\n"
+ .'- **SuperAccount**: privileged account',
'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-h',
- 'title' => '可用区',
+ 'required' => true,
+ 'enum' => ['SuperAccount', 'NormalAccount'],
+ 'example' => 'NormalAccount',
+ 'title' => '',
],
],
[
- 'name' => 'VpcId',
+ 'name' => 'Account',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Password',
'in' => 'query',
+ 'schema' => ['description' => 'The password of the database account. The password must meet the following requirements:'."\n"
+ ."\n"
+ .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
+ ."\n"
+ .'- The following special characters are supported: ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n"
+ ."\n"
+ .'- The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'a1b2c3d4@', 'title' => ''],
+ ],
+ [
+ 'name' => 'DmlAuthSetting',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The virtual private cloud (VPC) ID.'."\n",
- 'type' => 'string',
+ 'description' => 'The information about permissions.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DmlAuthority' => [
+ 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n"
+ ."\n"
+ .'- **1**: The account only has the permissions to read data from the database.'."\n"
+ ."\n"
+ .'- **2**: The account only has the permissions to read data from the database and modify the settings of the database.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enum' => ['0', '1', '2'],
+ 'required' => false,
+ 'example' => '0',
+ 'title' => '',
+ ],
+ 'DdlAuthority' => ['description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The account has the permissions to execute DDL statements.'."\n"
+ ."\n"
+ .'- **false**: The account does not have the permissions to execute DDL statements.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'AllowDictionaries' => [
+ 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).',
+ 'type' => 'array',
+ 'items' => ['description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'dc1,dc2', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AllowDatabases' => [
+ 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).',
+ 'type' => 'array',
+ 'items' => ['description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'db1,db2', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => 'vpc-uf6xmupdn7v6ui9f****',
- 'title' => 'VPC ID。',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'VswitchId',
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'Product',
'in' => 'query',
+ 'schema' => ['description' => 'The code of the cloud service.', 'type' => 'string', 'default' => 'clickhouse', 'required' => false, 'example' => 'clickhouse', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the account.', 'type' => 'string', 'example' => 'For testing', 'required' => false, 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-uf632qye9oqt4x4sr****',
- 'title' => '交换机ID。',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA****'],
+ 'Data' => [
+ 'description' => 'The data returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'Account' => ['description' => 'The name of the database account.', 'type' => 'string', 'example' => 'test1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter "AccountType" is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter "Account" is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter "Password" is not valid.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''],
+ ],
[
- 'name' => 'DBInstanceDescription',
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'CreateAccount',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'translator' => 'manual',
+ ],
+ 'CreateBackupPolicy' => [
+ 'summary' => 'Creates a backup policy for a specified ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '206399',
+ 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DBInstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-2ze0eb0w182xh8549', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'PreferredBackupTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UTC time range to perform the backup. For example, `12:00Z-13:00Z` means that the backup starts between 12:00 and 13:00 UTC.', 'type' => 'string', 'required' => true, 'example' => '10:00Z-11:00Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'PreferredBackupPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The backup cycle. Specify the days of the week for backups. Separate multiple days with commas (`,`).', 'type' => 'string', 'required' => true, 'example' => 'Monday,Friday', 'title' => ''],
+ ],
+ [
+ 'name' => 'BackupRetentionPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of days to retain backups.', 'type' => 'string', 'required' => false, 'example' => '8', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The cluster description.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Used for test',
- 'title' => '集群说明。',
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'StorageTypeDoNotSupportBackup', 'errorMessage' => 'Current StorageType Does Not Support Backup.', 'description' => 'The current storage type does not support backup'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'CreateBackupPolicy',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]',
+ ],
+ 'CreateDB' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'EngineVersion',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185311',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
+ ],
+ [
+ 'name' => 'DBName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database. The name must meet the following requirements:'."\n"
+ ."\n"
+ .'- Consist of lowercase letters, digits, underscores (\\_), and hyphens (-).'."\n"
+ ."\n"
+ .'- Start with a lowercase letter and end with a lowercase letter or a digit.'."\n"
+ ."\n"
+ .'- Be up to 64 characters in length.'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'An underscore (\\_) is counted as two characters.'."\n"
+ ."\n"
+ .'></notice>', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testdb001'],
+ ],
+ [
+ 'name' => 'Comment',
'in' => 'query',
+ 'schema' => ['description' => 'The description of the database.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The engine version.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '23.8',
- 'title' => '引擎版本。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD'],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
+ 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'testdb001'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'CreateDB',
+ 'summary' => 'Creates a database.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateDB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateDBInstance' => [
+ 'summary' => 'To create a ClickHouse Enterprise Edition cluster, call the `CreateDBInstance` API.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '182031',
+ 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => 'A client-provided token to ensure request idempotence. It must be unique across requests, contain only ASCII characters, and not exceed 64 characters in length.', 'type' => 'string', 'example' => 'AB', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6xmupdn7v6ui9f****', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'VswitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf632qye9oqt4x4sr****', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'DBInstanceDescription',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'Cluster test', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'EngineVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '23.8', 'title' => '', 'required' => false],
+ ],
[
'name' => 'ScaleMin',
'in' => 'query',
- 'schema' => [
- 'description' => 'The minimum capacity for auto scaling.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '8',
- 'title' => 'serverless弹性伸缩最小值。',
- ],
+ 'schema' => ['description' => 'This parameter is deprecated. Use the `NodeCount`, `NodeScaleMin`, and `NodeScaleMax` parameters to configure elastic scaling.', 'type' => 'string', 'required' => false, 'example' => '8', 'title' => ''],
],
[
'name' => 'ScaleMax',
'in' => 'query',
- 'schema' => [
- 'description' => 'The maximum capacity for auto scaling.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '32',
- 'title' => 'serverless弹性伸缩最大值。',
- ],
+ 'schema' => ['description' => 'This parameter is deprecated. Use the `NodeCount`, `NodeScaleMin`, and `NodeScaleMax` parameters to configure elastic scaling.', 'type' => 'string', 'required' => false, 'example' => '32', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
- 'description' => 'The engine type.'."\n",
+ 'description' => 'The engine type.',
'type' => 'string',
- 'required' => false,
'example' => 'clickhouse',
- 'enum' => [
- 'clickhouse',
- ],
- 'title' => '引擎类型。',
+ 'enum' => ['clickhouse'],
+ 'title' => '',
+ 'required' => false,
],
],
[
@@ -268,189 +713,101 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => 'The configurations of multi-zone deployment.'."\n",
+ 'description' => 'The multi-zone configuration.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ZoneId' => [
- 'description' => 'The zone ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-h',
- 'title' => '可用区ID。',
- ],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => '', 'required' => false],
'VSwitchIds' => [
- 'description' => 'The vSwitch IDs.'."\n",
+ 'description' => 'The vSwitch IDs.',
'type' => 'array',
- 'items' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-8vb05l07h3sdayqhe****',
- 'title' => '交换机ID。',
- ],
+ 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-8vb05l07h3sdayqhe****', 'title' => '', 'required' => false],
'required' => false,
- 'title' => '交换机ID。',
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
- 'description' => '',
- 'title' => '多可用区配置。',
+ 'description' => 'The configuration for a single zone.',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'title' => '多可用区配置。',
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'DeploySchema',
'in' => 'query',
- 'schema' => [
- 'description' => 'The deployment status of the cluster.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'multi_az',
- 'title' => '集群可用区部署状态。',
- ],
+ 'schema' => ['description' => 'The deployment mode of the instance.', 'type' => 'string', 'example' => 'multi_az', 'title' => '', 'required' => false],
],
[
'name' => 'SourceDBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc-2ze1*********',
- 'title' => '集群例ID。',
- ],
+ 'schema' => ['description' => 'The ID of the source instance. This parameter is required when restoring from a backup.', 'type' => 'string', 'example' => 'cc-2ze1*********', 'title' => '', 'required' => false],
],
[
'name' => 'BackupSetId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The backup set ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- 'title' => '备份集ID。',
- ],
+ 'schema' => ['description' => 'The backup set ID.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-*****',
- 'title' => '集群所属的资源组ID。',
- ],
+ 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-*****', 'title' => '', 'required' => false],
],
[
'name' => 'NodeScaleMax',
'in' => 'query',
- 'schema' => [
- 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'maximum' => '128',
- 'minimum' => '4',
- 'example' => '4',
- ],
+ 'schema' => ['description' => 'The maximum number of nodes for serverless elastic scaling. Valid values: 4 to 32. The value must be greater than the `NodeScaleMin` parameter.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '128', 'minimum' => '4', 'example' => '4', 'title' => '', 'required' => false],
],
[
'name' => 'NodeScaleMin',
'in' => 'query',
- 'schema' => [
- 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32',
- 'type' => 'integer',
- 'format' => 'int32',
- 'maximum' => '128',
- 'minimum' => '4',
- 'example' => '32',
- ],
+ 'schema' => ['description' => 'The minimum number of nodes for serverless elastic scaling. Valid values: 4 to 32.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '128', 'minimum' => '4', 'example' => '32', 'title' => '', 'required' => false],
],
[
'name' => 'NodeCount',
'in' => 'query',
- 'schema' => [
- 'title' => '节点个数，取值范围2-16',
- 'type' => 'integer',
- 'format' => 'int32',
- 'maximum' => '64',
- 'minimum' => '2',
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'StorageQuota',
- 'in' => 'query',
- 'schema' => [
- 'title' => '存储预购量（GB）',
- 'type' => 'integer',
- 'format' => 'int64',
- 'minimum' => '0',
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'StorageType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '存储类型。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'enum' => [
- 'oss',
- 'ESSD_L1',
- 'ESSD_L2',
- 'ESSD_L3',
- 'SSD',
- 'ESSD_L0',
- ],
- ],
+ 'schema' => ['description' => 'The number of nodes. Valid values: 2 to 16. This parameter is required when you configure an elastic scaling range by using the `NodeScaleMin` and `NodeScaleMax` parameters.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '64', 'minimum' => '2', 'example' => '2', 'title' => '', 'required' => false],
],
[
'name' => 'DBTimeZone',
'in' => 'query',
- 'schema' => [
- 'title' => '数据库内核时区设置，应为IANA时区标识符。',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The time zone of the database, which must be an IANA time zone identifier.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Asia/Shanghai'],
],
[
'name' => 'Category',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'default' => 'enterprise',
- ],
+ 'schema' => ['description' => 'The edition of the instance. Valid value:'."\n"
+ ."\n"
+ .'- `enterprise`: Enterprise Edition', 'type' => 'string', 'default' => 'enterprise', 'required' => false, 'example' => 'enterprise', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '标签列表',
'type' => 'array',
'items' => [
- 'title' => '标签列表。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '实例标签键。',
- 'type' => 'string',
- 'example' => 'user_123',
- ],
- 'Value' => [
- 'title' => '实例标签值。',
- 'type' => 'string',
- 'example' => '示例字符串',
- ],
+ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'user_123', 'title' => '', 'required' => false],
+ 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'example string', 'title' => '', 'required' => false],
],
+ 'title' => '',
+ 'description' => 'A tag.',
+ 'required' => false,
+ 'example' => '',
],
'maxItems' => 20,
'minItems' => 0,
+ 'title' => '',
+ 'description' => 'The tags to add to the instance.',
+ 'required' => false,
+ 'example' => '',
],
],
],
@@ -458,72 +815,58 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
'Data' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- 'title' => '集群ID。',
- ],
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21154955706****',
- 'title' => '订单ID。',
- ],
- 'ConnectionString' => [
- 'description' => 'The endpoint.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com',
- 'title' => '连接地址。',
- ],
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21154955706****', 'title' => ''],
+ 'ConnectionString' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', 'title' => ''],
],
- 'title' => '返回结果。',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"OrderId\\": 0,\\n \\"ConnectionString\\": \\"cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com\\"\\n }\\n}","type":"json"}]',
'title' => 'CreateDBInstance',
- ],
- 'DeleteDBInstance' => [
- 'summary' => 'Releases an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'CreateEndpoint' => [
+ 'summary' => 'Creates a public endpoint that provides a public address to access a cluster.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -532,374 +875,333 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185379',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '185384',
+ 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ ],
+ [
+ 'name' => 'DBInstanceNetType',
+ 'in' => 'query',
'schema' => [
- 'description' => 'The ID of the destination cluster.'."\n",
+ 'description' => 'The network type. Set this value to Public to create a public endpoint.',
'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
+ 'enum' => ['Public'],
+ 'required' => false,
+ 'example' => 'Public',
+ 'title' => '',
],
],
+ [
+ 'name' => 'ConnectionPrefix',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The prefix for the connection string.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'ComputingGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The computing group ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC',
- ],
- 'Data' => [
- 'description' => 'The data returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\"\\n }\\n}","type":"json"}]',
- 'title' => 'DeleteDBInstance',
- ],
- 'StartDBInstance' => [
- 'summary' => 'Starts an ApsaraDB for ClickHouse Enterprise Edition cluster.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]',
+ 'title' => 'CreateEndpoint',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateLangfuseOrg' => [
+ 'summary' => 'Creates a Langfuse organization.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'abilityTreeCode' => '189351',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '182031',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the Langfuse organization.', 'type' => 'string', 'required' => true, 'example' => 'org_name', 'title' => ''],
+ ],
+ [
+ 'name' => 'OwnerEmail',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email address of the Langfuse organization owner.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'title' => '',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100000837',
- ],
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
- ],
+ 'OrganizationId' => ['title' => '', 'description' => 'The Langfuse organization ID.', 'type' => 'string', 'example' => 'cmrbhzx930005jw****'],
+ 'Name' => ['description' => 'The name of the Langfuse organization.', 'type' => 'string', 'example' => 'org_name', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The time when the Langfuse organization was created.', 'type' => 'string', 'example' => '2026-06-25T09:28:30.949Z', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000837,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]',
- 'title' => 'StartDBInstance',
- ],
- 'RestartDBInstance' => [
- 'summary' => 'Restarts an ApsaraDB for ClickHouse Enterprise Edition cluster.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
+ 'title' => 'Create a langfuse organization',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw****\\",\\n \\"Name\\": \\"org_name\\",\\n \\"CreatedAt\\": \\"2026-06-25T09:28:30.949Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateLangfuseOrgMember' => [
+ 'summary' => 'Adds a user to a Langfuse organization.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'abilityTreeCode' => '192305',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrganizationId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'Role',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The role of the user in the organization.', 'type' => 'string', 'required' => true, 'example' => 'VIEWER', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The information about the user added to the Langfuse organization.',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100001080',
- ],
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
- ],
+ 'Role' => ['description' => 'The role of the user in the organization.', 'type' => 'string', 'example' => 'VIEWER', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100001080,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]',
- 'title' => 'RestartDBInstance',
+ 'title' => 'Add a user to a langfuse organization',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"Role\\": \\"VIEWER\\",\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]',
],
- 'StopDBInstance' => [
- 'summary' => 'Stops an ApsaraDB for ClickHouse Enterprise Edition cluster.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateLangfuseProject' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'abilityTreeCode' => '189348',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrganizationId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The organization ID to which the Langfuse project belongs.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Langfuse project name.', 'type' => 'string', 'required' => true, 'example' => 'project_name', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2C7393F1-5FD1-5CEE-A2EA-270A2CF99693'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100000785',
- ],
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
- ],
+ 'OrganizationId' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ 'ProjectId' => ['description' => 'The Langfuse project ID.', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ 'Name' => ['description' => 'The Langfuse project name.', 'type' => 'string', 'example' => 'project_name', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The time when the Langfuse project was created.', 'type' => 'string', 'example' => '2026-06-24T10:14:33Z', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000785,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]',
- 'title' => 'StopDBInstance',
+ 'title' => 'Create a langfuse project',
+ 'summary' => 'Creates a Langfuse project.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C7393F1-5FD1-5CEE-A2EA-270A2CF99693\\",\\n \\"Data\\": {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"ProjectId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Name\\": \\"project_name\\",\\n \\"CreatedAt\\": \\"2026-06-24T10:14:33Z\\"\\n }\\n}","type":"json"}]',
],
- 'ModifyDBInstanceClass' => [
- 'summary' => 'Modifies the elastic scaling settings of an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateLangfuseUser' => [
+ 'summary' => 'Creates a Langfuse user.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -910,220 +1212,110 @@
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '188578',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '182031',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- 'title' => '地域ID。',
- ],
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxxxx',
- 'title' => '集群ID。',
- ],
- ],
- [
- 'name' => 'ScaleMin',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The minimum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2',
- 'title' => '（参数废弃）serverless弹性伸缩最小值。',
- ],
- ],
- [
- 'name' => 'ScaleMax',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The maximum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '32',
- 'title' => '（参数废弃）serverless弹性伸缩最大值。',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'NodeScaleMax',
+ 'name' => 'Email',
'in' => 'query',
- 'schema' => [
- 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'maximum' => '128',
- 'minimum' => '4',
- 'example' => '4',
- ],
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
],
[
- 'name' => 'NodeScaleMin',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32',
- 'type' => 'integer',
- 'format' => 'int32',
- 'maximum' => '128',
- 'minimum' => '4',
- 'example' => '32',
- ],
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => true, 'example' => 'john', 'title' => ''],
],
[
- 'name' => 'NodeCount',
- 'in' => 'query',
- 'schema' => [
- 'title' => '节点个数，取值范围2-16',
- 'type' => 'integer',
- 'format' => 'int32',
- 'maximum' => '64',
- 'minimum' => '1',
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'StorageQuota',
+ 'name' => 'Password',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'minimum' => '0',
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'The password of the user account. The password must meet the following requirements:'."\n"
+ ."\n"
+ .'- Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
+ ."\n"
+ .'- The following special characters are supported: !@#$%^&*()_+-='."\n"
+ ."\n"
+ .'- The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => '2F9e9@******', 'title' => ''],
],
[
- 'name' => 'StorageType',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'title' => '存储类型。',
- 'type' => 'string',
- 'example' => 'OSS',
- 'enum' => [
- 'oss',
- 'ESSD_L1',
- 'ESSD_L2',
- 'ESSD_L3',
- 'SSD',
- 'ESSD_L0',
- ],
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => false, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
],
[
- 'name' => 'ComputingGroupId',
+ 'name' => 'OrgRole',
'in' => 'query',
- 'schema' => [
- 'title' => '计算组id',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The role of the user in the organization.', 'type' => 'string', 'required' => false, 'example' => 'VIEWER', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
'Data' => [
- 'description' => 'The returned result.'."\n",
+ 'title' => '',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000****',
- 'title' => '任务ID。',
- ],
- 'ScaleMin' => [
- 'description' => 'The minimum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- 'title' => 'serverless弹性伸缩最小值。',
- ],
- 'ScaleMax' => [
- 'description' => 'The maximum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '32',
- 'title' => 'serverless弹性伸缩最大值。',
- ],
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'cc-xxxxxxx'."\n",
- 'title' => '集群ID。',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'cc-xxxxxxx'."\n",
- 'title' => '集群名称。',
- ],
- 'ComputingGroupId' => [
- 'type' => 'string',
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
+ 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'john', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The time when the user was created.', 'type' => 'string', 'example' => '2026-03-04T10:20:33Z', 'title' => ''],
+ 'Membership' => [
+ 'description' => 'The role of the user.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrganizationId' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ 'Role' => ['description' => 'The role of the user in the organization.', 'type' => 'string', 'example' => 'VIEWER', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => '返回数据。',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidSpecification',
- 'errorMessage' => 'Specification parameter is not valid.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"ScaleMin\\": 2,\\n \\"ScaleMax\\": 32,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"ComputingGroupId\\": \\"\\"\\n }\\n}","type":"json"}]',
- 'title' => 'ModifyDBInstanceClass',
- ],
- 'ModifyDBInstanceAttribute' => [
- 'summary' => 'Modifies the configurations of an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
+ 'title' => 'Create a langfuse user',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\",\\n \\"Name\\": \\"john\\",\\n \\"CreatedAt\\": \\"2026-03-04T10:20:33Z\\",\\n \\"Membership\\": {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Role\\": \\"VIEWER\\"\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateWhitelistTemplate' => [
+ 'summary' => 'Creates a whitelist template.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1132,956 +1324,526 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '185639',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the whitelist template.', 'type' => 'string', 'required' => true, 'example' => 'InvoiceTemplate', 'title' => ''],
+ ],
+ [
+ 'name' => 'SecurityIPList',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The IP addresses in the whitelist. Separate multiple IP addresses with commas (,). You can add up to 100 IP addresses.', 'type' => 'string', 'required' => true, 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
+ 'Data' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Templates' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The ID of the whitelist template.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'TemplateName' => ['description' => 'The name of the whitelist template.', 'type' => 'string', 'example' => 'demo_template', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The list of IP addresses in the whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The details of the template.',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'description' => 'The list of whitelist templates.',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The returned data.',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of response.',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'Specified IPList is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplateName.Duplicated', 'errorMessage' => 'Whitelist template name duplicated.', 'description' => ''],
+ ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => ''],
+ ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplateName.CreateLimit', 'errorMessage' => 'Created Whitelist template name exceeded limit.', 'description' => ''],
+ ['errorCode' => 'InvalidIpWhitelistTemplateName.Malformed', 'errorMessage' => 'The templateName is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => ''],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'CreateWhitelistTemplate',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteAccount' => [
+ 'summary' => 'Deletes a database account from an ApsaraDB for ClickHouse cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '185273',
+ 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'],
+ ],
+ 'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
[
- 'name' => 'AttributeType',
+ 'name' => 'Account',
'in' => 'query',
- 'schema' => [
- 'description' => 'The configuration that you want to modify.'."\n"
- ."\n"
- .'* MaintainTime: the O\\&M time'."\n"
- .'* DBInstanceDescription: the cluster name'."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'DBInstanceDescription',
- 'enum' => [
- 'MaintainTime',
- 'DBInstanceDescription',
- ],
- ],
+ 'schema' => ['description' => 'The destination database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'AttributeValue',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The new value of the configuration.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Product',
'in' => 'query',
- 'schema' => [
- 'description' => 'The code of the cloud service.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clickhouse',
- 'default' => 'clickhouse',
- ],
+ 'schema' => ['description' => 'The code of the cloud service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.',
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '21D06907-CEA5-561D-B6B1-198BCCE99ED1'],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'Account' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]',
- 'title' => 'ModifyDBInstanceAttribute',
- ],
- 'DescribeDBInstances' => [
- 'summary' => 'Queries a list of ApsaraDB for ClickHouse clusters.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteAccount',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21D06907-CEA5-561D-B6B1-198BCCE99ED1\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteBackupPolicy' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '183135',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '206399',
+ 'abilityTreeNodes' => ['FEATUREclickhouseN8BUWF'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-xxxxx'],
],
[
- 'name' => 'DBInstanceIds',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster IDs. Separate multiple cluster IDs with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc-xxxxx,cx-xxxx',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
- [
- 'name' => 'DBInstanceStatus',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The cluster status.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'active',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response that is returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '60DDD29D-E5A8-563C-88FB-06D3A1F1C609'],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster description.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DeleteBackupPolicy',
+ 'summary' => 'Deletes the backup policy for a ClickHouse Enterprise Edition cluster.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60DDD29D-E5A8-563C-88FB-06D3A1F1C609\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteDB' => [
+ 'summary' => 'Call this operation to delete a database.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- 'default' => '30',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185312',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ ],
+ 'parameters' => [
[
- 'name' => 'PageNumber',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The resource group ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-4690g37929****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
],
[
- 'name' => 'Tags',
+ 'name' => 'DBName',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '标签信息。',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签信息。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'type' => 'string',
- 'example' => 'user_123',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'type' => 'string',
- 'example' => '示例值',
- ],
- ],
- ],
- 'maxItems' => 20,
- ],
+ 'schema' => ['description' => 'The name of the target database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testdb001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C'],
'Data' => [
- 'description' => 'The returned result.'."\n",
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DBInstances' => [
- 'description' => 'The clusters.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The cluster.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-xxxxxxx',
- ],
- 'Description' => [
- 'description' => 'The cluster description.'."\n",
- 'type' => 'string',
- 'example' => 'test_desc',
- ],
- 'Engine' => [
- 'description' => 'The engine type.'."\n",
- 'type' => 'string',
- 'example' => 'clickhouse',
- ],
- 'EngineVersion' => [
- 'description' => 'The engine version.'."\n",
- 'type' => 'string',
- 'example' => '22.8',
- ],
- 'AliUid' => [
- 'description' => 'The user ID.'."\n",
- 'type' => 'string',
- 'example' => '1294****',
- ],
- 'Bid' => [
- 'description' => 'The channel ID.'."\n",
- 'type' => 'string',
- 'example' => '186681****',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ZoneId' => [
- 'description' => 'The zone ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou-i',
- ],
- 'ChargeType' => [
- 'description' => 'The billing method. Valid values:'."\n"
- ."\n"
- .'* PrePaid: subscription'."\n"
- .'* PostPaid: pay-as-you-go'."\n",
- 'type' => 'string',
- 'example' => 'PostPaid',
- ],
- 'Status' => [
- 'description' => 'The cluster status.'."\n",
- 'type' => 'string',
- 'example' => 'active',
- ],
- 'VpcId' => [
- 'description' => 'The virtual private cloud (VPC) ID.'."\n",
- 'type' => 'string',
- 'example' => 'vpc-uf6kg****',
- ],
- 'VSwitchId' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'example' => 'vsw-8vb5mw****',
- ],
- 'ScaleMin' => [
- 'description' => 'The minimum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ScaleMax' => [
- 'description' => 'The maximum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '13',
- ],
- 'ExpireTime' => [
- 'description' => 'The time when the cluster expires.'."\n",
- 'type' => 'string',
- 'example' => '2024-02-16 11:51:06',
- ],
- 'LockMode' => [
- 'description' => 'The lock mode.'."\n",
- 'type' => 'string',
- 'example' => '0',
- ],
- 'LockReason' => [
- 'description' => 'The reason why the cluster was locked.'."\n",
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'MaintainStartTime' => [
- 'description' => 'The start time of the maintenance window.'."\n",
- 'type' => 'string',
- 'example' => '00:00Z',
- ],
- 'MaintainEndTime' => [
- 'description' => 'The end time of the maintenance window.'."\n",
- 'type' => 'string',
- 'example' => '04:00:00Z',
- ],
- 'DeletionProtection' => [
- 'description' => 'Indicates whether the release protection feature is enabled for the cluster.'."\n",
- 'type' => 'string',
- 'example' => 'False',
- ],
- 'ResourceGroupId' => [
- 'description' => 'The resource group ID.'."\n",
- 'type' => 'string',
- 'example' => 'rg-acfmzy****',
- ],
- 'CreateTime' => [
- 'description' => 'The time when the cluster was created.'."\n",
- 'type' => 'string',
- 'example' => '2022-12-04 21:16:15',
- ],
- 'Tags' => [
- 'description' => 'The tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The tag.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'tag',
- ],
- 'Value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- 'StorageType' => [
- 'title' => '实例存储类型',
- 'type' => 'string',
- 'example' => 'oss',
- ],
- ],
- ],
- ],
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
+ 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'testdb001'],
],
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-xxxxxxx\\",\\n \\"Description\\": \\"test_desc\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"22.8\\",\\n \\"AliUid\\": \\"1294****\\",\\n \\"Bid\\": \\"186681****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"Status\\": \\"active\\",\\n \\"VpcId\\": \\"vpc-uf6kg****\\",\\n \\"VSwitchId\\": \\"vsw-8vb5mw****\\",\\n \\"ScaleMin\\": 1,\\n \\"ScaleMax\\": 13,\\n \\"ExpireTime\\": \\"2024-02-16 11:51:06\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"DeletionProtection\\": \\"False\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzy****\\",\\n \\"CreateTime\\": \\"2022-12-04 21:16:15\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StorageType\\": \\"oss\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]',
- 'title' => 'DescribeDBInstances',
- ],
- 'DescribeDBInstanceAttribute' => [
- 'summary' => 'Queries the details of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteDB',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteDB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteDBInstance' => [
+ 'summary' => 'The DeleteDBInstance operation releases an ApsaraDB for ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '183134',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- 'title' => '集群ID。',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* cn-beijing'."\n",
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'cn-beijing' => 'cn-beijing',
- ],
- 'example' => 'cn-hangzhou',
- 'title' => '地域ID。',
- ],
+ 'schema' => ['description' => 'The ID of the target cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
'Data' => [
- 'description' => 'The result returned.'."\n",
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- 'title' => '集群ID。',
- ],
- 'Description' => [
- 'description' => 'The cluster description.'."\n",
- 'type' => 'string',
- 'example' => 'Used for test',
- 'title' => '集群描述。',
- ],
- 'Engine' => [
- 'description' => 'The engine type.'."\n",
- 'type' => 'string',
- 'example' => 'clickhouse',
- 'title' => '引擎类型。',
- ],
- 'EngineVersion' => [
- 'description' => 'The engine version.'."\n",
- 'type' => 'string',
- 'example' => '23.8',
- 'title' => '引擎版本。',
- ],
- 'AliUid' => [
- 'description' => 'The ID of the Alibaba Cloud account.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '140692647406****',
- 'title' => '阿里云账号ID。',
- ],
- 'Bid' => [
- 'description' => 'The channel ID.'."\n",
- 'type' => 'string',
- 'example' => 'PD39050615820269****',
- 'title' => '渠道ID。',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- 'title' => '地域ID。',
- ],
- 'DeploySchema' => [
- 'description' => 'The deployment mode of the cluster. Valid values: single_az and multi_az.'."\n"
- ."\n"
- .'* single_az: indicates that the server nodes are deployed in the primary zone. The ID of the primary zone is specified by the ZoneID parameter.'."\n"
- .'* multi_az: indicates that the server nodes are deployed in multiple zones. The information about the zones is specified by the MultiZones parameter.'."\n"
- ."\n"
- .'The keeper nodes are deployed in multiple zones.'."\n",
- 'type' => 'string',
- 'example' => 'single_az',
- 'title' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n"
- ."\n"
- .'- single_az：server部署到主可用区ZoneId。'."\n"
- .'- multi_az：server部署到多可用区MultiZones。'."\n"
- ."\n"
- .'keeper始终部署到多可用区MultiZones。',
- ],
- 'MultiZones' => [
- 'description' => 'The information about the zones.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'VSwitchIds' => [
- 'description' => 'The vSwitch IDs.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'example' => 'vsw-bj9kpwhcb9iekphje1ljz',
- 'title' => '交换机ID。',
- ],
- 'title' => '交换机ID。',
- ],
- 'ZoneId' => [
- 'description' => 'The zone ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- 'title' => '可用区ID。',
- ],
- ],
- 'description' => '',
- 'title' => '多可用信息。',
- ],
- 'title' => '多可用信息。',
- ],
- 'ChargeType' => [
- 'description' => 'The billing method. Enterprise Edition clusters use the pay-as-you-go billing method.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- 'title' => '付费方式。 '."\n"
- .'企业版集群的付费方式都是按量付费方式。',
- ],
- 'Status' => [
- 'description' => 'The cluster status.'."\n",
- 'type' => 'string',
- 'example' => 'active',
- 'title' => '实例状态。',
- ],
- 'VpcId' => [
- 'description' => 'The virtual private cloud (VPC) ID.'."\n",
- 'type' => 'string',
- 'example' => 'vpc-wz9duj8xd6r1gzhsg*****',
- 'title' => 'VPC ID。',
- ],
- 'VSwitchId' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'example' => 'vsw-uf67ij56zm9x4uc6hmilg',
- 'title' => '交换机ID。',
- ],
- 'ScaleMin' => [
- 'description' => 'The minimum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- 'title' => 'serverless弹性伸缩最小值。',
- ],
- 'ScaleMax' => [
- 'description' => 'The maximum capacity for elastic scaling.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- 'title' => 'serverless弹性伸缩最大值。',
- ],
- 'StorageSize' => [
- 'description' => 'The size of the storage space. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- 'title' => '存储空间大小。单位：GB',
- ],
- 'StorageType' => [
- 'description' => 'The storage type.'."\n",
- 'type' => 'string',
- 'example' => '100',
- 'title' => '存储类型。',
- ],
- 'ObjectStoreSize' => [
- 'description' => 'The size of the object storage space.'."\n",
- 'type' => 'string',
- 'example' => '13',
- 'title' => '对象存储大小。',
- ],
- 'ExpireTime' => [
- 'description' => 'The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n"
- ."\n"
- .'> Pay-as-you-go clusters never expire. If the cluster is a pay-as-you-go cluster, an empty string is returned for this parameter.'."\n",
- 'type' => 'string',
- 'example' => '2024-04-17T08:14:48Z',
- 'title' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n"
- .'>按量付费集群无到期时间，返回值为空。',
- ],
- 'LockMode' => [
- 'description' => 'The lock mode of the cluster.'."\n",
- 'type' => 'string',
- 'example' => '0',
- 'title' => '集群的锁定模式。',
- ],
- 'LockReason' => [
- 'description' => 'The reason why the cluster was locked.'."\n",
- 'type' => 'string',
- 'example' => 'nolock',
- 'title' => '锁定原因。',
- ],
- 'MaintainStartTime' => [
- 'description' => 'The start time of the maintenance window.'."\n",
- 'type' => 'string',
- 'example' => '12:00',
- 'title' => '可维护时间开始时间。',
- ],
- 'MaintainEndTime' => [
- 'description' => 'The end time of the maintenance window.'."\n",
- 'type' => 'string',
- 'example' => '21:00',
- 'title' => '可维护时间结束时间。',
- ],
- 'DeletionProtection' => [
- 'description' => 'Indicates whether the release protection feature is enabled for the cluster.'."\n",
- 'type' => 'boolean',
- 'example' => '0/1',
- 'title' => '是否已开启释放保护功能。',
- ],
- 'ResourceGroupId' => [
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'example' => 'rg-acfmzygvt54****',
- 'title' => '资源ID。',
- ],
- 'Tags' => [
- 'description' => 'The details of the tags.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The details of the tag.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The key of the tag.'."\n",
- 'type' => 'string',
- 'example' => 'id',
- 'title' => '标签的名称。',
- ],
- 'Value' => [
- 'description' => 'The value of the tag.'."\n",
- 'type' => 'string',
- 'example' => 'ck',
- 'title' => '标签的值。',
- ],
- ],
- 'title' => '标签信息。',
- ],
- 'title' => '标签信息。',
- ],
- 'Nodes' => [
- 'description' => 'The nodes.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The node.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ZoneId' => [
- 'description' => 'The zone ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- 'title' => '可用区ID。',
- ],
- 'NodeStatus' => [
- 'description' => 'The node status.'."\n",
- 'type' => 'string',
- 'example' => 'active',
- 'title' => '节点运行状态。',
- ],
- ],
- 'title' => '节点信息。',
- ],
- 'title' => '节点信息。',
- ],
- 'CreateTime' => [
- 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n",
- 'type' => 'string',
- 'example' => '2023-09-14T08:14:48Z',
- 'title' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。',
- ],
- 'EngineMinorVersion' => [
- 'description' => 'The minor engine version of the cluster.'."\n",
- 'type' => 'string',
- 'example' => '23.8.1.41495_6',
- 'title' => '集群引擎的小版本号。',
- ],
- 'LatestEngineMinorVersion' => [
- 'description' => 'The latest minor engine version.'."\n",
- 'type' => 'string',
- 'example' => '23.8.1.41495_6',
- 'title' => '最新内核小版本号。',
- ],
- 'DisabledPorts' => [
- 'description' => 'The disabled database ports. Multiple database ports are separated by commas (,).'."\n",
- 'type' => 'string',
- 'example' => '9001,8123',
- 'title' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。',
- ],
- 'ZoneId' => [
- 'description' => 'The zone ID.'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- 'title' => '可用区ID。',
- ],
- 'StorageQuota' => [
- 'title' => '存储预购量（GB）。',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'NodeScaleMax' => [
- 'title' => 'Serverless节点弹性最大值。',
- 'type' => 'string',
- 'example' => '32',
- ],
- 'NodeScaleMin' => [
- 'title' => 'Serverless节点弹性最小值。',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'NodeCount' => [
- 'title' => '节点数量。',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'Category' => [
- 'title' => '类型，取值说明：'."\n"
- ."\n"
- .'- enterprise 企业版',
- 'type' => 'string',
- 'example' => 'enterprise',
- ],
- 'ClickObserveServiceStatus' => [
- 'title' => 'ClickObserve服务状态',
- 'type' => 'string',
- 'example' => 'activation',
- ],
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
],
- 'title' => '返回结果。',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Description\\": \\"集群测试\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"23.8\\",\\n \\"AliUid\\": 0,\\n \\"Bid\\": \\"PD39050615820269****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeploySchema\\": \\"single_az\\",\\n \\"MultiZones\\": [\\n {\\n \\"VSwitchIds\\": [\\n \\"vsw-bj9kpwhcb9iekphje1ljz\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-wz9duj8xd6r1gzhsg*****\\",\\n \\"VSwitchId\\": \\"vsw-uf67ij56zm9x4uc6hmilg\\",\\n \\"ScaleMin\\": 8,\\n \\"ScaleMax\\": 32,\\n \\"StorageSize\\": 12,\\n \\"StorageType\\": \\"100\\",\\n \\"ObjectStoreSize\\": \\"13\\",\\n \\"ExpireTime\\": \\"2024-04-17T08:14:48Z\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"nolock\\",\\n \\"MaintainStartTime\\": \\"11:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmzygvt54****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"ck\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"NodeStatus\\": \\"active\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-14T08:14:48Z\\",\\n \\"EngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"LatestEngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"DisabledPorts\\": \\"9001,8123\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageQuota\\": \\"100\\",\\n \\"NodeScaleMax\\": \\"32\\",\\n \\"NodeScaleMin\\": \\"4\\",\\n \\"NodeCount\\": \\"2\\",\\n \\"Category\\": \\"enterprise\\",\\n \\"ClickObserveServiceStatus\\": \\"activation\\"\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeDBInstanceAttribute',
- ],
- 'UpgradeMinorVersion' => [
- 'summary' => 'Updates the minor engine version of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteDBInstance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteEndpoint' => [
+ 'summary' => 'Deletes a public endpoint.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '196979',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseN0HBPQ',
- ],
- 'tenantRelevance' => 'tenant',
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185385',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp1jyis8p15we****',
- ],
+ 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'SwitchTimeMode',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '切换模式',
- 'description' => 'Specifies whether to update the minor engine version of the cluster immediately. Valid values:'."\n"
- ."\n"
- .'* **Immediate**: The system immediately performs the update.'."\n"
- .'* **MaintainTime**: The system performs the update during the specified maintenance window.'."\n"
- .'* **SpecifyTime**: The system performs the update at a specified time.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Immediate',
- 'default' => 'Immediate',
- 'enum' => [
- 'Immediate',
- 'MaintainTime',
- 'SpecifyTime',
- ],
- ],
+ 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
[
- 'name' => 'SwitchTime',
+ 'name' => 'ConnectionString',
'in' => 'query',
- 'schema' => [
- 'title' => '指定时间点切换时，指定切换时间点。',
- 'description' => 'The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n"
- ."\n"
- .'> If you set SwitchTimeMode to SpecifyTime, you must configure this parameter to specify the update time.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-01-09T05:00:00Z',
- ],
+ 'schema' => ['description' => 'The connection string of the public endpoint to delete.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', 'title' => ''],
],
[
- 'name' => 'TargetMinorVersion',
+ 'name' => 'DBInstanceNetType',
'in' => 'query',
'schema' => [
- 'title' => '目标内核小版本，默认升级到最新。',
- 'description' => 'The minor engine version to which you want to update.'."\n"
+ 'description' => 'The network type of the endpoint. Valid values:'."\n"
."\n"
- .'> By default, TargetMinorVersion is not set and the minor engine version of the cluster is updated to the latest version.'."\n",
+ .'- VPC: a virtual private cloud (VPC) network.'."\n"
+ ."\n"
+ .'- Public: a public network.',
+ 'enumValueTitles' => ['Vpc' => '', 'Public' => ''],
'type' => 'string',
'required' => false,
- 'example' => '23.8.1.41495_6',
+ 'example' => 'Public',
+ 'title' => '',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ComputingGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the computing group.', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze34****-clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7',
- ],
- 'Data' => [
- 'description' => 'The returned result.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceName' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-uf6x229yeq166****',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"cc-uf6x229yeq166****\\"\\n }\\n}","type":"json"}]',
- 'title' => 'UpgradeMinorVersion',
- ],
- 'CreateAccount' => [
- 'summary' => 'Creates a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteEndpoint',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteLangfuseInstance' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2090,237 +1852,140 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185272',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseL1079N',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- ],
- [
- 'name' => 'AccountType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the database account. Valid values:'."\n"
- ."\n"
- .'* **NormalAccount**: standard account'."\n"
- .'* **SuperAccount**: privileged account'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NormalAccount',
- 'enum' => [
- 'SuperAccount',
- 'NormalAccount',
- ],
- ],
- ],
- [
- 'name' => 'Account',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test1',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Password',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The password of the database account. The password must meet the following requirements:'."\n"
- ."\n"
- .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
- .'- The following special characters are supported: ! @ # $ % ^ & * ( ) _ + - ='."\n"
- .'- The password must be 8 to 32 characters in length.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a1b2c3d4@',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
- [
- 'name' => 'DmlAuthSetting',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The information about permissions.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'DmlAuthority' => [
- 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n"
- ."\n"
- .'* **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n"
- .'* **1**: The account only has the permissions to read data from the database.'."\n"
- .'* **2**: The account only has the permissions to read data from the database and modify the settings of the database.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- 'enum' => [
- '0',
- '1',
- '2',
- ],
- ],
- 'DdlAuthority' => [
- 'description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n"
- ."\n"
- .'* **true**: The account has the permissions to execute DDL statements.'."\n"
- .'* **false**: The account does not have the permissions to execute DDL statements.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'AllowDictionaries' => [
- 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dc1,dc2',
- ],
- 'required' => false,
- ],
- 'AllowDatabases' => [
- 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'db1,db2',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
+ 'Data' => [
+ 'description' => 'The response data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'example' => 'lfs-****', 'title' => ''],
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- 'required' => false,
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Release a langfuse instance',
+ 'summary' => 'Releases a Langfuse instance.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"lfs-****\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteLangfuseOrg' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Product',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The code of the cloud service.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clickhouse',
- 'default' => 'clickhouse',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the account.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Used for account',
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The response result.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'Account' => [
- 'description' => 'The name of the database account.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
- ],
+ 'DBInstanceId' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'example' => 'lfs-****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidAccountType.Malformed',
- 'errorMessage' => 'The specified parameter "AccountType" is not valid.',
- ],
- [
- 'errorCode' => 'InvalidAccountName.Malformed',
- 'errorMessage' => 'The specified parameter "Account" is not valid.',
- ],
- [
- 'errorCode' => 'InvalidAccountPassword.Malformed',
- 'errorMessage' => 'The specified parameter "Password" is not valid.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'InvalidDBInstanceState.NotSupport',
- 'errorMessage' => 'The specified instance state does\'t support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
- 'title' => 'CreateAccount',
+ 'title' => 'Delete a langfuse organization',
+ 'summary' => 'Deletes a Langfuse organization.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"lfs-****\\"\\n }\\n}","type":"json"}]',
],
- 'DeleteAccount' => [
- 'summary' => 'Deletes a database account from an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteLangfuseOrgMembership' => [
+ 'summary' => 'Removes a user from a Langfuse organization.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2329,121 +1994,76 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '185273',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouse2H8YOY',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Account',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The destination database account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
],
[
- 'name' => 'Product',
+ 'name' => 'Email',
'in' => 'query',
- 'schema' => [
- 'description' => 'The code of the cloud service.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clickhouse',
- 'default' => 'clickhouse',
- ],
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '21D06907-CEA5-561D-B6B1-198BCCE99ED1',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The response result.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'Account' => [
- 'description' => 'The name of the account.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
- ],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'InvalidDBInstanceState.NotSupport',
- 'errorMessage' => 'The specified instance state does\'t support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21D06907-CEA5-561D-B6B1-198BCCE99ED1\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
- 'title' => 'DeleteAccount',
+ 'title' => 'Remove a user from a langfuse organization',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]',
],
- 'ResetAccountPassword' => [
- 'summary' => 'Resets the password of a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteLangfuseProject' => [
+ 'summary' => 'Deletes a Langfuse project.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2455,134 +2075,137 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185276',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouse2H8YOY',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
],
[
- 'name' => 'Account',
+ 'name' => 'ProjectId',
'in' => 'query',
+ 'schema' => ['description' => 'The Langfuse project ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The name of the database account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test1',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Delete a langfuse project',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteLangfuseUser' => [
+ 'summary' => 'Deletes a Langfuse user.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Password',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The password of the database account. The password must meet the following requirements:'."\n"
- ."\n"
- .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
- .'- The following special characters are supported: ! @ # $ % ^ & * ( ) _ + - ='."\n"
- .'- The password must be 8 to 32 characters in length.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123456Aa',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Product',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The service name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clickhouse',
- 'default' => 'clickhouse',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '5A6A077A-577C-536E-AC13-8E715D7A34C8',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
'Data' => [
- 'description' => 'The result returned.'."\n",
+ 'description' => 'The response result.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'Account' => [
- 'description' => 'The name of the account.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
- ],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'InvalidDBInstanceState.NotSupport',
- 'errorMessage' => 'The specified instance state does\'t support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6A077A-577C-536E-AC13-8E715D7A34C8\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
- 'title' => 'ResetAccountPassword',
+ 'title' => 'Delete a langfuse user',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]',
],
- 'ModifyAccountDescription' => [
- 'summary' => 'Modifies the description of a database account.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteWhitelistTemplate' => [
+ 'summary' => 'Deletes a whitelist template.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2591,295 +2214,241 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185303',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185639',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DBInstanceId',
+ 'name' => 'TemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxxxx',
- ],
+ 'schema' => ['description' => 'The whitelist template ID.', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', 'title' => ''],
],
[
- 'name' => 'Account',
+ 'name' => 'TemplateName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testuser',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The name of the whitelist template.', 'type' => 'string', 'example' => '98a6d3db05984dca', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
'Data' => [
- 'description' => 'The returned data.'."\n",
+ 'title' => '',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-xxxxx',
- ],
- 'Account' => [
- 'description' => 'The name of the database account.'."\n",
- 'type' => 'string',
- 'example' => 'testuser',
+ 'Templates' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The whitelist template ID.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ 'DbInstances' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DbInstanceName' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'asdfwef', 'title' => ''],
+ ],
+ 'description' => 'Details of an associated instance.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The instances associated with the template.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'Details of a whitelist template.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The whitelist templates.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'The data returned from the call.',
+ 'example' => '',
],
],
+ 'description' => 'The response data.',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'InvalidDBInstanceState.NotSupport',
- 'errorMessage' => 'The specified instance state does\'t support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FFC9EBE-5023-5D5D-A5F0-1607E0F2****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp1anv7jo84t****\\",\\n \\"Account\\": \\"testuser\\"\\n }\\n}","type":"json"}]',
- 'title' => 'ModifyAccountDescription',
- ],
- 'ModifyAccountAuthority' => [
- 'summary' => 'Modifies the permissions of a database account.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteWhitelistTemplate',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DbInstanceName\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeAccountAuthority' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185304',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185309',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
],
[
'name' => 'Account',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the database account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test1',
- ],
- ],
- [
- 'name' => 'DmlAuthSetting',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The information about permissions.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'DmlAuthority' => [
- 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n"
- ."\n"
- .'* **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n"
- .'* **1**: The account only has the permissions to read data from the database.'."\n"
- .'* **2**: The account only has the permissions to read data from the database and modify the settings of the database.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '0',
- 'enum' => [
- '0',
- '1',
- '2',
- ],
- ],
- 'DdlAuthority' => [
- 'description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n"
- ."\n"
- .'* **true**: The account has the permissions to execute DDL statements.'."\n"
- .'* **false**: The account does not have the permissions to execute DDL statements.'."\n",
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'AllowDictionaries' => [
- 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'db1,db2',
- ],
- 'required' => false,
- ],
- 'AllowDatabases' => [
- 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'db1,db2',
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => 'The name of the database account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The details of the response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC911****'],
'Data' => [
- 'description' => 'The result returned.'."\n",
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
+ 'Account' => ['description' => 'The name of the database account.', 'type' => 'string', 'title' => '', 'example' => 'test1'],
+ 'DmlAuthority' => ['description' => 'The DML permissions that are granted to the database account. Valid values:'."\n"
+ ."\n"
+ .'- 0: Read, write, and change settings queries are allowed.'."\n"
+ ."\n"
+ .'- 1: Only read data queries are allowed.'."\n"
+ ."\n"
+ .'- 2: Read data and change settings queries are allowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'DdlAuthority' => ['description' => 'Indicates whether DDL permissions are granted to the database account. Valid values:'."\n"
+ ."\n"
+ .'- **true**: DDL operations are allowed.'."\n"
+ ."\n"
+ .'- **false**: DDL operations are prohibited.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'AllowDatabases' => [
+ 'description' => 'A list of authorized databases.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A list of authorized databases.', 'type' => 'string', 'title' => '', 'example' => 'db1'],
+ 'title' => '',
+ 'example' => '',
],
- 'Account' => [
- 'description' => 'The name of the database account.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
+ 'AllowDictionaries' => [
+ 'description' => 'A list of authorized dictionaries.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A list of authorized dictionaries.', 'type' => 'string', 'title' => '', 'example' => 'dt1'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalDatabases' => [
+ 'description' => 'A list of all databases.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A list of all databases.', 'type' => 'string', 'title' => '', 'example' => 'db1,db2'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalDictionaries' => [
+ 'description' => 'The database.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A dictionary in a database. The format is db.dict.', 'type' => 'string', 'title' => '', 'example' => 'test1.range_key_dict'],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'InvalidDBInstanceState.NotSupport',
- 'errorMessage' => 'The specified instance state does\'t support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => 'The specified account name does not exist.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
- 'title' => 'ModifyAccountAuthority',
+ 'title' => 'DescribeAccountAuthority',
+ 'summary' => 'Call the DescribeAccountAuthority operation to query the permissions of an account.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeAccountAuthority',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC911****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\",\\n \\"DmlAuthority\\": 0,\\n \\"DdlAuthority\\": true,\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"test1.range_key_dict\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeAccounts' => [
'summary' => 'Queries database accounts for an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2892,223 +2461,365 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '185288',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Valid values:'."\n"
- ."\n"
- .'* **30** (default)'."\n"
- .'* **50**'."\n"
- .'* **100**'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n"
+ ."\n"
+ .'- **30** (default)'."\n"
+ ."\n"
+ .'- **50**'."\n"
+ ."\n"
+ .'- **100**', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'Product',
'in' => 'query',
- 'schema' => [
- 'description' => 'The code of the cloud service.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clickhouse',
- 'default' => 'clickhouse',
- ],
+ 'schema' => ['description' => 'The code of the cloud service.', 'type' => 'string', 'default' => 'clickhouse', 'required' => false, 'example' => 'clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
'Data' => [
- 'description' => 'The result returned.'."\n",
+ 'description' => 'The result returned.',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageNumber' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of entries per page. Valid values:'."\n"
- ."\n"
- .'* **30** (default)'."\n"
- .'* **50**'."\n"
- .'* **100**'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n"
+ ."\n"
+ .'- **30** (default)'."\n"
+ ."\n"
+ .'- **50**'."\n"
+ ."\n"
+ .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'Accounts' => [
- 'description' => 'The database accounts.'."\n",
+ 'description' => 'The database accounts.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Account' => [
- 'description' => 'The username of the database account.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => 'The description.'."\n",
- 'type' => 'string',
- 'example' => 'Used for test',
- ],
- 'AccountType' => [
- 'description' => 'The type of the database account. Valid values:'."\n"
- ."\n"
- .'* **1**: standard account'."\n"
- .'* **6**: privileged account'."\n",
- 'type' => 'string',
- 'example' => 'NormalAccount',
- ],
- 'Status' => [
- 'description' => 'The state of the database account. Valid values:'."\n"
- ."\n"
- .'* **0**: The database account is being created.'."\n"
- .'* **1**: The database account is in use.'."\n"
- .'* **3**: The database account is being deleted.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'Account' => ['description' => 'The username of the database account.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'For testing', 'title' => ''],
+ 'AccountType' => ['description' => 'The type of the database account. Valid values:'."\n"
+ ."\n"
+ .'- **1**: standard account'."\n"
+ ."\n"
+ .'- **6**: privileged account', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The state of the database account. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The database account is being created.'."\n"
+ ."\n"
+ .'- **1**: The database account is in use.'."\n"
+ ."\n"
+ .'- **3**: The database account is being deleted.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ',
- ],
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Accounts\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"AccountType\\": \\"1\\",\\n \\"Status\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Accounts\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"Description\\": \\"For testing\\",\\n \\"AccountType\\": \\"1\\",\\n \\"Status\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'DescribeAccounts',
- ],
- 'DescribeAccountAuthority' => [
- 'summary' => 'Queries the permissions of a database account.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeAccounts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'DescribeBackupPolicy' => [
+ 'summary' => 'Queries the backup policy of a ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185309',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '206399',
+ 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'],
],
'parameters' => [
[
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'title' => 'Schema of Response',
+ 'description' => 'The data returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PreferredBackupPeriod' => ['description' => 'The backup cycle. Valid values:'."\n"
+ ."\n"
+ .'- **Monday**'."\n"
+ .'- **Tuesday**'."\n"
+ .'- **Wednesday**'."\n"
+ .'- **Thursday**'."\n"
+ .'- **Friday**'."\n"
+ .'- **Saturday**'."\n"
+ .'- **Sunday**', 'type' => 'string', 'example' => 'Monday', 'title' => ''],
+ 'Switch' => ['description' => 'Indicates whether the backup feature is enabled. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The backup feature is enabled.'."\n"
+ .'- **false**: The backup feature is disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''],
+ 'PreferredBackupTime' => ['description' => 'The backup time. The time is in UTC.', 'type' => 'string', 'example' => '15:00Z-16:00Z', 'title' => ''],
+ 'BackupRetentionPeriod' => ['description' => 'The number of days for which the backup files are retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
+ 'BackupSize' => ['description' => 'The size of the backup file. Unit: MB.', 'type' => 'string', 'example' => '123124', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DescribeBackupPolicy',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeBackups' => [
+ 'summary' => 'Queries the backup sets of a ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '206399',
+ 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'],
+ ],
+ 'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp1v9kq45u0o80cvh'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-beijing'],
+ ],
+ [
+ 'name' => 'BackupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The backup record ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '117403****'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The beginning of the time range to query. The time is in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2021-11-21T16:00Z'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end of the time range to query. The time is in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2021-11-25T16:00Z'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'title' => '', 'example' => '30'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'title' => '', 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => 'The total number of backups.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'string', 'title' => '', 'example' => '30'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'Items' => [
+ 'description' => 'The list of backup sets.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of backup sets.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp179i5956tih2m93'],
+ 'BackupStatus' => ['description' => 'The status of the backup set.', 'type' => 'string', 'title' => '', 'example' => 'Success'],
+ 'BackupType' => ['description' => 'The backup type.'."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **FullBackup**: full backup.'."\n"
+ ."\n"
+ .'- **IncrementalBackup**: incremental backup.', 'type' => 'string', 'title' => '', 'example' => 'IncrementalBackup'],
+ 'BackupStartTime' => ['description' => 'The start time of the backup.', 'type' => 'string', 'title' => '', 'example' => '2021-11-22T18:28:22Z'],
+ 'BackupSize' => ['description' => 'The size of the backup file in MB.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '131072'],
+ 'BackupEndTime' => ['description' => 'The end time of the backup. The time is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2021-11-22T18:28:41Z'],
+ 'BackupSetInfo' => ['description' => 'The information about the backup set.', 'type' => 'string', 'title' => '', 'example' => '{"shard_count": 4}'],
+ 'BackupId' => ['description' => 'The backup record ID.', 'type' => 'string', 'title' => '', 'example' => '117403****'],
+ 'BackupMethod' => ['description' => 'The backup method.', 'type' => 'string', 'title' => '', 'example' => 'Physical'],
+ 'ExpireDate' => ['description' => 'The expiration time of the backup set.', 'type' => 'string', 'title' => '', 'example' => '2022-07-22T18:28:41Z'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DescribeBackups',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeBackups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-bp179i5956tih2m93\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeDBInstanceAttribute' => [
+ 'summary' => 'Call DescribeDBInstanceAttribute to query the details of an ApsaraDB for ClickHouse enterprise edition cluster.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Account',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '183134',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
'in' => 'query',
'schema' => [
- 'description' => 'The name of the database account.'."\n",
+ 'description' => 'The region ID. You can call the [~~DescribeRegions~~](cdb.doc.dita#doc-api-clickhouse-DescribeRegions) operation to query the most recent region list.',
+ 'enumValueTitles' => ['cn-beijing' => 'cn-beijing'],
'type' => 'string',
- 'required' => true,
- 'example' => 'test1',
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
+ 'required' => false,
],
],
],
@@ -3116,296 +2827,406 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
'Data' => [
- 'description' => 'The returned result.'."\n",
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'Account' => [
- 'description' => 'The name of the database account.'."\n",
- 'type' => 'string',
- 'example' => 'test1',
- ],
- 'DmlAuthority' => [
- 'description' => 'Indicates whether the DML permissions are granted to the database account. Valid values:'."\n"
- ."\n"
- .'* 0: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n"
- .'* 1: The account only has the permissions to read data from the database.'."\n"
- .'* 2: The account only has the permissions to read data from the database and modify the settings of the database.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'DdlAuthority' => [
- 'description' => 'Indicates whether the DDL permissions are granted to the database account. Valid values:'."\n"
- ."\n"
- .'* **true**: The account has the permissions to execute DDL statements.'."\n"
- .'* **false**: The account does not have the permissions to execute DDL statements.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'AllowDatabases' => [
- 'description' => 'The databases on which permissions are granted.'."\n",
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'Description' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'cluster test', 'title' => ''],
+ 'Engine' => ['description' => 'The engine.', 'type' => 'string', 'example' => 'clickhouse', 'title' => ''],
+ 'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '23.8', 'title' => ''],
+ 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140692647406****', 'title' => ''],
+ 'Bid' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'PD39050615820269****', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'DeploySchema' => ['description' => 'The deployment architecture of the cluster. Valid values: `single_az` and `multi_az`.'."\n"
+ ."\n"
+ .'- `single_az`: The nodes are deployed in the primary zone specified by `ZoneId`.'."\n"
+ ."\n"
+ .'- `multi_az`: The nodes are deployed across the zones specified in `MultiZones`.'."\n"
+ ."\n"
+ .'Keeper nodes are always deployed across the zones specified in `MultiZones`.', 'type' => 'string', 'example' => 'single_az', 'title' => ''],
+ 'MultiZones' => [
+ 'description' => 'The zones for a multi-zone deployment.',
'type' => 'array',
'items' => [
- 'description' => 'The database on which permissions are granted.'."\n",
- 'type' => 'string',
- 'example' => 'db1',
+ 'type' => 'object',
+ 'properties' => [
+ 'VSwitchIds' => [
+ 'description' => 'An array of vSwitch IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bj9kpwhcb9iekphje1ljz', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''],
+ ],
+ 'description' => 'Details of a zone.',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'AllowDictionaries' => [
- 'description' => 'The dictionaries on which permissions are granted.'."\n",
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ChargeType' => ['description' => 'The billing method of the cluster.'."\n"
+ .'enterprise edition clusters are billed on a pay-as-you-go basis.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
+ 'Status' => ['description' => 'The status of the instance.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
+ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-wz9duj8xd6r1gzhsg*****', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf67ij56zm9x4uc6hmilg', 'title' => ''],
+ 'ScaleMin' => ['description' => 'The minimum value for serverless auto scaling.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'ScaleMax' => ['description' => 'The maximum value for serverless auto scaling.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ 'StorageSize' => ['description' => 'The storage space, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'StorageType' => ['description' => 'The storage type.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'ObjectStoreSize' => ['description' => 'The storage capacity of Object Storage Service (OSS).', 'type' => 'string', 'example' => '13', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time of the cluster, in `YYYY-MM-DDTHH:mm:ssZ` format.'."\n"
+ ."\n"
+ .'> Pay-as-you-go clusters do not expire. An empty string is returned.', 'type' => 'string', 'example' => '2024-04-17T08:14:48Z', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock mode of the cluster.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'LockReason' => ['description' => 'The reason for the lock.', 'type' => 'string', 'example' => 'nolock', 'title' => ''],
+ 'MaintainStartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '11:00Z', 'title' => ''],
+ 'MaintainEndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '12:00Z', 'title' => ''],
+ 'DeletionProtection' => ['description' => 'Whether deletion protection is enabled.', 'type' => 'boolean', 'example' => '0/1', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmzygvt54****', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'The cluster tags.',
'type' => 'array',
'items' => [
- 'description' => 'The dictionary on which permissions are granted.'."\n",
- 'type' => 'string',
- 'example' => 'dt1',
+ 'description' => 'Details of a tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'id', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'ck', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'TotalDatabases' => [
- 'description' => 'All databases.'."\n",
+ 'Nodes' => [
+ 'description' => 'The cluster nodes.',
'type' => 'array',
'items' => [
- 'description' => 'The databases.'."\n",
- 'type' => 'string',
- 'example' => 'db1,db2',
+ 'description' => 'Details of a node.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''],
+ 'NodeStatus' => ['description' => 'The status of the node.', 'type' => 'string', 'example' => 'active', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'TotalDictionaries' => [
- 'description' => 'The database.'."\n",
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateTime' => ['description' => 'The creation time of the cluster, in `YYYY-MM-DDTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2023-09-14T08:14:48Z', 'title' => ''],
+ 'EngineMinorVersion' => ['description' => 'The minor version of the cluster engine.', 'type' => 'string', 'example' => '23.8.1.41495_6', 'title' => ''],
+ 'LatestEngineMinorVersion' => ['description' => 'The latest minor version of the cluster engine.', 'type' => 'string', 'example' => '23.8.1.41495_6', 'title' => ''],
+ 'DisabledPorts' => ['description' => 'A comma-separated list of disabled database ports.', 'type' => 'string', 'example' => '9001,8123', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''],
+ 'StorageQuota' => ['description' => 'The provisioned storage, in GB.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'NodeScaleMax' => ['description' => 'The maximum number of nodes for auto scaling of a serverless cluster.', 'type' => 'string', 'example' => '32', 'title' => ''],
+ 'NodeScaleMin' => ['description' => 'The minimum number of nodes for auto scaling of a serverless cluster.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'NodeCount' => ['description' => 'The number of nodes.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'Category' => ['description' => 'The edition of the cluster. Valid value:'."\n"
+ ."\n"
+ .'- `enterprise`: enterprise edition', 'type' => 'string', 'example' => 'enterprise', 'title' => ''],
+ 'ClickObserveServiceStatus' => ['description' => 'The status of the ClickObserve service.', 'type' => 'string', 'example' => 'activation', 'title' => ''],
+ 'LangfuseInstanceIds' => [
'type' => 'array',
- 'items' => [
- 'description' => 'The dictionary of a database. The value is in the db.dict format.'."\n",
- 'type' => 'string',
- 'example' => 'test1.range_key_dict',
- ],
+ 'items' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'example' => 'lfs-2ze172q******', 'title' => ''],
+ 'description' => 'A list of Langfuse instance IDs.',
+ 'title' => '',
+ 'example' => '',
],
+ 'WebUISnatStatus' => ['type' => 'string', 'example' => 'active', 'description' => '', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
- [
- 'errorCode' => 'InvalidAccountName.NotFound',
- 'errorMessage' => 'Specified account name does not exist.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC911****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\",\\n \\"DmlAuthority\\": 0,\\n \\"DdlAuthority\\": true,\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"test1.range_key_dict\\"\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeAccountAuthority',
- ],
- 'CreateDB' => [
- 'summary' => 'Creates an ApsaraDB for ClickHouse database.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DescribeDBInstanceAttribute',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Description\\": \\"cluster test\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"23.8\\",\\n \\"AliUid\\": 0,\\n \\"Bid\\": \\"PD39050615820269****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeploySchema\\": \\"single_az\\",\\n \\"MultiZones\\": [\\n {\\n \\"VSwitchIds\\": [\\n \\"vsw-bj9kpwhcb9iekphje1ljz\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-wz9duj8xd6r1gzhsg*****\\",\\n \\"VSwitchId\\": \\"vsw-uf67ij56zm9x4uc6hmilg\\",\\n \\"ScaleMin\\": 8,\\n \\"ScaleMax\\": 32,\\n \\"StorageSize\\": 12,\\n \\"StorageType\\": \\"100\\",\\n \\"ObjectStoreSize\\": \\"13\\",\\n \\"ExpireTime\\": \\"2024-04-17T08:14:48Z\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"nolock\\",\\n \\"MaintainStartTime\\": \\"11:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmzygvt54****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"ck\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"NodeStatus\\": \\"active\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-14T08:14:48Z\\",\\n \\"EngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"LatestEngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"DisabledPorts\\": \\"9001,8123\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageQuota\\": \\"100\\",\\n \\"NodeScaleMax\\": \\"32\\",\\n \\"NodeScaleMin\\": \\"4\\",\\n \\"NodeCount\\": \\"2\\",\\n \\"Category\\": \\"enterprise\\",\\n \\"ClickObserveServiceStatus\\": \\"activation\\",\\n \\"LangfuseInstanceIds\\": [\\n \\"lfs-2ze172q******\\"\\n ],\\n \\"WebUISnatStatus\\": \\"active\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeDBInstanceConfig' => [
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185311',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '204414',
+ 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'],
],
'parameters' => [
[
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-wz9go4x*****'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'title' => '',
+ 'description' => 'The response schema',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The ID of the request', 'type' => 'string', 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n"],
+ 'Data' => [
+ 'description' => 'The returned results.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp100p4q1g9z3****'],
+ 'Params' => [
+ 'description' => 'The user parameters.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'IsDynamic' => ['description' => 'Indicates whether the parameter takes effect dynamically (without requiring a restart).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'IsUserModifiable' => ['description' => 'Indicates whether the parameter can be modified by users.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'DefaultValue' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'title' => '', 'example' => 'max_concurrent_queries'],
+ 'Optional' => ['description' => 'The valid values of the parameter.', 'type' => 'string', 'title' => '', 'example' => '[0-100]'],
+ 'Comment' => ['description' => 'The parameter description.', 'type' => 'string', 'title' => '', 'example' => 'Maximum number of concurrently executed queries. Zero means unlimited.'],
+ 'ParamRelyRule' => ['description' => 'The parameter dependencies.', 'type' => 'string', 'title' => '', 'example' => '0'],
+ 'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'title' => '', 'example' => '100'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'DescribeDBInstanceConfig',
+ 'summary' => 'Queries the parameter configuration of an instance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Params\\": [\\n {\\n \\"IsDynamic\\": 1,\\n \\"IsUserModifiable\\": 1,\\n \\"DefaultValue\\": \\"1\\",\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"Optional\\": \\"[0-100]\\",\\n \\"Comment\\": \\"Maximum number of concurrently executed queries. Zero means unlimited.\\",\\n \\"ParamRelyRule\\": \\"0\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeDBInstanceConfigChangeLog' => [
+ 'summary' => 'Queries the parameter configuration records of an instance',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '206401',
+ 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'],
+ ],
+ 'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-uf6lkzf*****', 'title' => ''],
],
[
- 'name' => 'DBName',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The database name. The name must meet the following requirements:'."\n"
- ."\n"
- .'* The name can contain lowercase letters, digits, underscores (\\_), and hyphens (-).'."\n"
- .'* The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n"
- .'* The name can be up to 64 characters in length.'."\n"
- ."\n"
- .'> An underscore (\\_) is counted as two characters.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testdb001',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
[
- 'name' => 'Comment',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'Database remark information.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The start time of the query. Format: yyyy-MM-dd hh:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-01-01 10:00:00', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end time of the query. Format: yyyy-MM-dd hh:mm:ss.', 'type' => 'string', 'required' => true, 'example' => '2025-01-01 10:00:00'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return per page. Default value: 30. Valid values:'."\n"
+ ."\n"
+ .'- **30** (default)'."\n"
+ .'- **50**'."\n"
+ .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '780DE414-*********-88BE-A2E21B862B57'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The result set.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'DBName' => [
- 'description' => 'The name of the database.'."\n",
- 'type' => 'string',
- 'example' => 'testdb001',
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'ParamChangeLogs' => [
+ 'description' => 'The parameter change records.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The parameter change record.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ID' => ['description' => 'The operation ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'max_concurrent_queries', 'title' => ''],
+ 'OldValue' => ['description' => 'The old parameter value.', 'type' => 'string', 'example' => '50', 'title' => ''],
+ 'NewValue' => ['description' => 'The new parameter value.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'Applied' => ['description' => 'Indicates whether the configuration takes effect:'."\n"
+ ."\n"
+ .'- true: The execution plan takes effect.'."\n"
+ .'- false: The execution plan does not take effect.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'GmtCreated' => ['description' => 'The time when the change was created.', 'type' => 'string', 'example' => '2025-06-25 13:46:06', 'title' => ''],
+ 'GmtModified' => ['description' => 'The time when the change was modified.', 'type' => 'string', 'example' => '2025-06-25 13:46:06'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'InvalidDBInstanceState.NotSupport',
- 'errorMessage' => 'The specified instance state does\'t support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]',
- 'title' => 'CreateDB',
- ],
- 'DeleteDB' => [
- 'summary' => 'Deletes an ApsaraDB for ClickHouse database.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceConfigChangeLog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"780DE414-*********-88BE-A2E21B862B57\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"ParamChangeLogs\\": [\\n {\\n \\"ID\\": 1,\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"OldValue\\": \\"50\\",\\n \\"NewValue\\": \\"100\\",\\n \\"Applied\\": false,\\n \\"GmtCreated\\": \\"2025-06-25 13:46:06\\",\\n \\"GmtModified\\": \\"2025-06-25 13:46:06\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeDBInstanceDataSources' => [
+ 'summary' => 'Queries the schema of a database or a table.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185312',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185313',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the destination database.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testdb001',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'dbtest', 'title' => ''],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => 'tableTest', 'title' => ''],
],
],
'responses' => [
@@ -3415,64 +3236,85 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.',
- 'type' => 'string',
- 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F543E6CC-6868-523D-8D28-0E92CF977ED2'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
+ 'DBInstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'Schemas' => ['description' => 'The account.', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'Tables' => [
+ 'description' => 'The tables.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The table.', 'type' => 'string', 'example' => 'table_test', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'DBName' => [
- 'description' => 'The name of the database.'."\n",
- 'type' => 'string',
- 'example' => 'testdb001',
+ 'Columns' => [
+ 'description' => 'The columns.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The column.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'dbtest', 'title' => ''],
+ 'Type' => ['description' => 'The type of the stored data.', 'type' => 'string', 'example' => 'UInt64', 'title' => ''],
+ 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'tableTest', 'title' => ''],
+ 'ColumnName' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'c31', 'title' => ''],
+ 'PrimaryKey' => ['description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'Comment' => ['description' => 'The description of the database account.', 'type' => 'string', 'example' => 'Test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'InvalidDBInstanceState.NotSupport',
- 'errorMessage' => 'The specified instance state does\'t support this operation.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound ', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]',
- 'title' => 'DeleteDB',
- ],
- 'DescribeDBInstanceDataSources' => [
- 'summary' => 'Queries the schema of a database or a table.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F543E6CC-6868-523D-8D28-0E92CF977ED2\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Schemas\\": \\"default\\",\\n \\"Tables\\": [\\n \\"table_test\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"DBName\\": \\"dbtest\\",\\n \\"Type\\": \\"UInt64\\",\\n \\"TableName\\": \\"tableTest\\",\\n \\"ColumnName\\": \\"c31\\",\\n \\"PrimaryKey\\": \\"false\\",\\n \\"Comment\\": \\"Test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DescribeDBInstanceDataSources',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceDataSources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'DescribeDBInstances' => [
+ 'summary' => 'Call the DescribeDBInstances API to query a list of DB instances.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3484,50 +3326,72 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185313',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '183135',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DBInstanceId',
+ 'name' => 'DBInstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'A comma-separated list of instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'cc-xxxxx,cx-xxxx', 'title' => ''],
],
[
- 'name' => 'DBName',
+ 'name' => 'VpcIds',
'in' => 'query',
- 'schema' => [
- 'description' => 'The database name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dbtest',
- ],
+ 'schema' => ['description' => 'A comma-separated list of VPC IDs.', 'type' => 'string', 'example' => 'vpc-2ze4ee9z******,vpc-2ze4ee9z5l******', 'title' => '', 'required' => false],
],
[
- 'name' => 'TableName',
+ 'name' => 'DBInstanceStatus',
'in' => 'query',
+ 'schema' => ['description' => 'The instance status.', 'type' => 'string', 'required' => false, 'example' => 'active', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '30', 'required' => false, 'example' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The table name.'."\n",
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'user_123', 'title' => '', 'required' => false],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'example value', 'title' => '', 'required' => false],
+ ],
+ 'title' => '',
+ 'description' => 'A tag, which is a key-value pair.',
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'maxItems' => 20,
+ 'title' => '',
+ 'description' => 'The tags for filtering instances.',
'required' => false,
- 'example' => 'tableTest',
+ 'example' => 'DescribeDBInstances',
],
],
],
@@ -3535,484 +3399,668 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The details of the response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F543E6CC-6868-523D-8D28-0E92CF977ED2',
- ],
'Data' => [
- 'description' => 'The returned result.'."\n",
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'Schemas' => [
- 'description' => 'The account.'."\n",
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'Tables' => [
- 'description' => 'The tables.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The table.'."\n",
- 'type' => 'string',
- 'example' => 'table_test',
- ],
- ],
- 'Columns' => [
- 'description' => 'The columns.'."\n",
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'DBInstances' => [
+ 'description' => 'The list of instance details.',
'type' => 'array',
'items' => [
- 'description' => 'The column.'."\n",
+ 'description' => 'Details of an instance.',
'type' => 'object',
'properties' => [
- 'DBName' => [
- 'description' => 'The database name.'."\n",
- 'type' => 'string',
- 'example' => 'dbtest',
- ],
- 'Type' => [
- 'description' => 'The type of the stored data.'."\n",
- 'type' => 'string',
- 'example' => 'UInt64',
- ],
- 'TableName' => [
- 'description' => 'The table name.'."\n",
- 'type' => 'string',
- 'example' => 'tableTest',
- ],
- 'ColumnName' => [
- 'description' => 'The column name.'."\n",
- 'type' => 'string',
- 'example' => 'c31',
- ],
- 'PrimaryKey' => [
- 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n"
- ."\n"
- .'* **true**'."\n"
- .'* **false**'."\n",
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'Comment' => [
- 'description' => 'The description of the database account.'."\n",
- 'type' => 'string',
- 'example' => 'Used for test',
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cc-xxxxxxx', 'title' => ''],
+ 'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'test_desc', 'title' => ''],
+ 'Engine' => ['description' => 'The engine.', 'type' => 'string', 'example' => 'clickhouse', 'title' => ''],
+ 'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '22.8', 'title' => ''],
+ 'AliUid' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '1294****', 'title' => ''],
+ 'Bid' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => '186681****', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
+ 'ChargeType' => ['description' => 'The billing method for the instance. Valid values:'."\n"
+ ."\n"
+ .'- `PrePaid`: subscription.'."\n"
+ ."\n"
+ .'- `PostPaid`: pay-as-you-go.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''],
+ 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'active', 'title' => ''],
+ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6kg****', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-8vb5mw****', 'title' => ''],
+ 'ScaleMin' => ['description' => 'The minimum compute capacity for serverless elastic scaling.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ScaleMax' => ['description' => 'The maximum compute capacity for serverless elastic scaling.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2024-02-16 11:51:06', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock mode.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'LockReason' => ['description' => 'The reason for the lock.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'MaintainStartTime' => ['description' => 'The maintenance window start time.', 'type' => 'string', 'example' => '00:00Z', 'title' => ''],
+ 'MaintainEndTime' => ['description' => 'The maintenance window end time.', 'type' => 'string', 'example' => '04:00:00Z', 'title' => ''],
+ 'DeletionProtection' => ['description' => 'Indicates whether deletion protection is enabled.', 'type' => 'string', 'example' => 'False', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmzy****', 'title' => ''],
+ 'CreateTime' => ['description' => 'The instance creation time.', 'type' => 'string', 'example' => '2022-12-04 21:16:15', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'The tags attached to the instance.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'StorageType' => ['description' => 'The instance storage type.', 'type' => 'string', 'example' => 'oss', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxx-xxx-xxx', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound ',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F543E6CC-6868-523D-8D28-0E92CF977ED2\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Schemas\\": \\"default\\",\\n \\"Tables\\": [\\n \\"table_test\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"DBName\\": \\"dbtest\\",\\n \\"Type\\": \\"UInt64\\",\\n \\"TableName\\": \\"tableTest\\",\\n \\"ColumnName\\": \\"c31\\",\\n \\"PrimaryKey\\": \\"false\\",\\n \\"Comment\\": \\"测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeDBInstanceDataSources',
- ],
- 'CreateEndpoint' => [
- 'summary' => 'Applies for a public endpoint.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-xxxxxxx\\",\\n \\"Description\\": \\"test_desc\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"22.8\\",\\n \\"AliUid\\": \\"1294****\\",\\n \\"Bid\\": \\"186681****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"Status\\": \\"active\\",\\n \\"VpcId\\": \\"vpc-uf6kg****\\",\\n \\"VSwitchId\\": \\"vsw-8vb5mw****\\",\\n \\"ScaleMin\\": 1,\\n \\"ScaleMax\\": 13,\\n \\"ExpireTime\\": \\"2024-02-16 11:51:06\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"DeletionProtection\\": \\"False\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzy****\\",\\n \\"CreateTime\\": \\"2022-12-04 21:16:15\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StorageType\\": \\"oss\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]',
+ 'title' => 'DescribeDBInstances',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeEndpoints' => [
+ 'summary' => 'To retrieve the cluster endpoints, call DescribeEndpoints.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185384',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseZHDS8I',
- ],
+ 'abilityTreeCode' => '185373',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', 'title' => ''],
],
[
- 'name' => 'DBInstanceNetType',
+ 'name' => 'ComputingGroupId',
'in' => 'query',
+ 'schema' => ['description' => 'The computing group ID.', 'type' => 'string', 'example' => 'cc-*****-clickhouse', 'title' => '', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The network type.'."\n"
- ."\n"
- .'Valid values:'."\n"
- ."\n"
- .'* Public'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Public',
- 'enum' => [
- 'Public',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxx-xxx-xxx'],
+ 'Data' => [
+ 'description' => 'The response data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **VPC**'."\n"
+ ."\n"
+ .'- **PUBLIC**: Internet.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'Endpoints' => [
+ 'description' => 'The endpoints.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of an endpoint.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NetType' => ['description' => 'The network type of the endpoint. Valid values:'."\n"
+ ."\n"
+ .'- VPC'."\n"
+ ."\n"
+ .'- PUBLIC: Internet.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'Status' => ['description' => 'The status of the endpoint.', 'type' => 'string', 'example' => 'active', 'title' => ''],
+ 'ConnectionString' => ['description' => 'The instance connection string.', 'type' => 'string', 'example' => 'cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com', 'title' => ''],
+ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf61z****', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-0xi8829****', 'title' => ''],
+ 'VpcInstanceId' => ['description' => 'The VPC instance ID.', 'type' => 'string', 'example' => 'vpc-uf61z****', 'title' => ''],
+ 'Ports' => [
+ 'description' => 'The ports.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of a port.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Protocol' => ['description' => 'The protocol type. Valid values:'."\n"
+ ."\n"
+ .'- HttpPort: HTTP port.'."\n"
+ ."\n"
+ .'- HttpsPort: HTTPS port.'."\n"
+ ."\n"
+ .'- TcpPort: TCP port.', 'type' => 'string', 'example' => 'HttpPort', 'title' => ''],
+ 'Port' => ['description' => 'The port number. The value varies based on the protocol type. For example:'."\n"
+ ."\n"
+ .'- HttpPort: 8123'."\n"
+ ."\n"
+ .'- HttpsPort: 8443'."\n"
+ ."\n"
+ .'- TcpPort: 9000', 'type' => 'integer', 'format' => 'int32', 'example' => '8123', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '172.30.XX.XX', 'title' => ''],
+ 'ComputingGroupId' => ['description' => 'The computing group ID.', 'type' => 'string', 'example' => 'cc-ad321**-clickhouse', 'title' => ''],
+ 'EndpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'example' => 'cc-*****-clickhouse', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"Status\\": \\"active\\",\\n \\"ConnectionString\\": \\"cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"VpcInstanceId\\": \\"vpc-uf61z****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"HttpPort\\",\\n \\"Port\\": 8123\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.XX.XX\\",\\n \\"ComputingGroupId\\": \\"cc-ad321**-clickhouse\\",\\n \\"EndpointName\\": \\"cc-*****-clickhouse\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DescribeEndpoints',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeEndpoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribeLangfuseEndpoints' => [
+ 'summary' => 'Queries the access endpoint of a Langfuse instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185373',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'ConnectionPrefix',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The prefix of the new endpoint. The prefix of the ConnectionString parameter.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ComputingGroupId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n"
+ ."\n"
+ .'* **VPC**: virtual private cloud (VPC).', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'Endpoints' => [
+ 'description' => 'The list of endpoints.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of endpoints.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NetType' => ['description' => 'The network type of the endpoint. Valid values:'."\n"
+ ."\n"
+ .'- VPC: VPC.'."\n"
+ .'- PUBLIC: Internet.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'ConnectionString' => ['description' => 'The endpoint of the instance.', 'type' => 'string', 'example' => 'lfs-2zeejcvmzn1******.com', 'title' => ''],
+ 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-uf61z****', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-0xi8829****', 'title' => ''],
+ 'Ports' => [
+ 'description' => 'The port details.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The port details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Protocol' => ['description' => 'The protocol type. Valid values:'."\n"
+ ."\n"
+ .'- http: HTTP port.', 'type' => 'string', 'example' => 'http', 'title' => ''],
+ 'Port' => ['description' => 'The access port. Valid values:'."\n"
+ ."\n"
+ .'- http: 3000', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '172.30.****.****', 'title' => ''],
+ 'EndpointName' => ['title' => '', 'description' => 'The endpoint name.', 'type' => 'string', 'example' => 'lfs-2zeejcvmzn1******'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]',
- 'title' => 'CreateEndpoint',
+ 'title' => 'Query langfuse instance access endpoint',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"ConnectionString\\": \\"lfs-2zeejcvmzn1******.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"http\\",\\n \\"Port\\": 3000\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.****.****\\",\\n \\"EndpointName\\": \\"lfs-2zeejcvmzn1******\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'DeleteEndpoint' => [
- 'summary' => 'Releases a public endpoint.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeLangfuseOrgMemberships' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185385',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'ConnectionString',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The prefix of the endpoint, which indicates the prefix of the value of the ConnectionString parameter.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com',
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
],
[
- 'name' => 'DBInstanceNetType',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ComputingGroupId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0'],
+ 'Data' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Memberships' => [
+ 'description' => 'The list of user roles in the organization.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
+ 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'john', 'title' => ''],
+ 'Role' => ['description' => 'The role of the user.', 'type' => 'string', 'example' => 'VIEWER', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The time when the user was created.', 'type' => 'string', 'example' => '2026-06-24T10:14:33Z', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
- ],
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]',
- 'title' => 'DeleteEndpoint',
+ 'title' => 'Query langfuse organization member information',
+ 'summary' => 'Queries the member information of a Langfuse organization.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\",\\n \\"Data\\": {\\n \\"Memberships\\": [\\n {\\n \\"Email\\": \\"john@company.com\\",\\n \\"Name\\": \\"john\\",\\n \\"Role\\": \\"VIEWER\\",\\n \\"CreatedAt\\": \\"2026-06-24T10:14:33Z\\"\\n }\\n ],\\n \\"TotalCount\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]',
],
- 'ModifyDBInstanceConnectionString' => [
- 'summary' => 'Modifies the endpoint of an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeLangfuseOrgs' => [
+ 'summary' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '186649',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '183135',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxx',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'ConnectionString',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The endpoint of the cluster.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'default' => '30', 'description' => '', 'required' => false, 'example' => '30', 'title' => ''],
],
[
- 'name' => 'ConnectionStringPrefix',
+ 'name' => 'PageNumber',
'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'default' => '1', 'description' => '', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The prefix of the endpoint that is used to connect to the database.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc-****-clickhouse',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '17', 'title' => ''],
+ 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '20', 'title' => ''],
+ 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '1', 'title' => ''],
+ 'Organizations' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrganizationId' => ['type' => 'string', 'description' => '', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ 'Name' => ['type' => 'string', 'description' => '', 'example' => 'org_name', 'title' => ''],
+ 'CreatedAt' => ['type' => 'string', 'description' => '', 'example' => '2026-06-11T10:27:23Z', 'title' => ''],
+ 'UpdatedAt' => ['type' => 'string', 'description' => '', 'example' => '2026-06-09T10:27:55', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 17,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Organizations\\": [\\n {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Name\\": \\"org_name\\",\\n \\"CreatedAt\\": \\"2026-06-11T10:27:23Z\\",\\n \\"UpdatedAt\\": \\"2026-06-09T10:27:55\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeLangfuseProjectMemberships' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'DisablePorts',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '* The database ports that you want to disable. Separate multiple ports with commas (,).'."\n"
- ."\n"
- .'* This parameter is supported only for clusters whose minor engine version is 24.10.1.11098\\_1 or later.'."\n"
- ."\n"
- .' **'."\n"
- ."\n"
- .' **Note** If you create a cluster whose minor engine version is earlier than 24.10.1.11098\\_1 and you update the minor engine version to 24.10.1.11098\\_1 or later, the cluster still does not support this parameter.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '9001,8123',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DBInstanceNetType',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'enum' => [
- 'Public',
- ],
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'ComputingGroupId',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Langfuse project ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A82758F8-E793-5610-BE11-0E46664305C2'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'cc-xxxxx',
- ],
- 'ConnectionString' => [
- 'description' => 'The endpoint of the cluster.'."\n",
- 'type' => 'string',
- 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'cc-xxxxx',
- ],
- 'DisabledPorts' => [
- 'description' => 'The disabled database ports.'."\n",
- 'type' => 'string',
- 'example' => '9001,8123',
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
+ 'Memberships' => [
+ 'description' => 'The list of user roles in the Langfuse project.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'john', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
+ 'ProjectRole' => ['description' => 'The role of the user in the Langfuse project.', 'type' => 'string', 'example' => 'VIEWER', 'title' => ''],
+ 'OrgRole' => ['description' => 'The role of the user in the Langfuse organization.', 'type' => 'string', 'example' => 'ADMIN', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"ConnectionString\\": \\"cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"cc-xxxxx\\",\\n \\"DisabledPorts\\": \\"9001,8123\\"\\n }\\n}","type":"json"}]',
- 'title' => 'ModifyDBInstanceConnectionString',
+ 'title' => 'Query langfuse project user roles',
+ 'summary' => 'Queries user roles in a Langfuse project.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A82758F8-E793-5610-BE11-0E46664305C2\\",\\n \\"Data\\": {\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 4,\\n \\"Memberships\\": [\\n {\\n \\"Name\\": \\"john\\",\\n \\"Email\\": \\"john@company.com\\",\\n \\"ProjectRole\\": \\"VIEWER\\",\\n \\"OrgRole\\": \\"ADMIN\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'ModifySecurityIPList' => [
- 'summary' => 'Modifies the whitelist settings of an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeLangfuseProjects' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4021,287 +4069,175 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxx',
- ],
- ],
- [
- 'name' => 'GroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the whitelist whose settings you want to modify.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'SecurityIPList',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.0.0/24,172.16.0.0/24',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'ModifyMode',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The modification mode.'."\n"
- ."\n"
- .'* 0: overwrites the original IP addresses and CIDR blocks in the whitelist.'."\n"
- .'* 1: adds the IP addresses and CIDR blocks to the whitelist.'."\n"
- .'* 2: removes the IP addresses and CIDR blocks from the whitelist.'."\n"
- ."\n"
- .'> We recommend that you set the value to 0.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
'Data' => [
- 'description' => 'The returned result.'."\n",
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'GroupName' => [
- 'description' => 'The name of the whitelist.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'SecurityIPType' => [
- 'description' => 'The IP address type.'."\n",
- 'type' => 'string',
- 'example' => 'ipv4',
- ],
- 'GroupTag' => [
- 'description' => 'The tag of the whitelist.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'TaskId' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SecurityIPList' => [
- 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n",
- 'type' => 'string',
- 'example' => '192.168.0.0/24,172.16.0.0/24',
- ],
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'cc-xxxx',
- ],
- 'WhitelistNetType' => [
- 'description' => 'The network type of the whitelist.'."\n",
- 'type' => 'string',
- 'example' => 'mix',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'cc-xxxx',
+ 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Projects' => [
+ 'description' => 'The list of Langfuse projects.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of Langfuse projects.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectId' => ['description' => 'The Langfuse project ID.', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ 'Name' => ['description' => 'The Langfuse project name.', 'type' => 'string', 'example' => 'project_name', 'title' => ''],
+ 'OrganizationId' => ['description' => 'The organization ID to which the Langfuse project belongs.', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ 'UpdatedAt' => ['description' => 'The time when the Langfuse project was last updated.', 'type' => 'string', 'example' => '2026-06-09T10:27:35', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The time when the Langfuse project was created.', 'type' => 'string', 'example' => '2026-05-27T08:23:45Z', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ',
- ],
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"TaskId\\": 1,\\n \\"SecurityIPList\\": \\"192.168.0.0/24,172.16.0.0/24\\",\\n \\"DBInstanceID\\": 0,\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"cc-xxxx\\"\\n }\\n}","type":"json"}]',
- 'title' => 'ModifySecurityIPList',
+ 'title' => 'Query langfuse project list',
+ 'summary' => 'Queries the list of Langfuse projects.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Projects\\": [\\n {\\n \\"ProjectId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Name\\": \\"project_name\\",\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"UpdatedAt\\": \\"2026-06-09T10:27:35\\",\\n \\"CreatedAt\\": \\"2026-05-27T08:23:45Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'DescribeSecurityIPList' => [
- 'summary' => 'Queries the whitelist of an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeLangfuseSecurityIPList' => [
+ 'summary' => 'Queries the Langfuse whitelist.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '185650',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'TestCluster',
- ],
+ 'DBInstanceID' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int32', 'example' => 'lfs-****', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'lfs-****', 'title' => ''],
'GroupItems' => [
- 'description' => 'The details about the whitelists.'."\n",
+ 'description' => 'The whitelist group list.',
'type' => 'array',
'items' => [
- 'description' => 'The details about the whitelist.'."\n",
+ 'description' => 'The whitelist group list.',
'type' => 'object',
'properties' => [
- 'GroupName' => [
- 'description' => 'The name of the whitelist.'."\n",
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'SecurityIPType' => [
- 'description' => 'The IP address type.'."\n",
- 'type' => 'string',
- 'example' => 'ipv4',
- ],
- 'GroupTag' => [
- 'description' => 'The tag of the whitelist.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'SecurityIPList' => [
- 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n",
- 'type' => 'string',
- 'example' => '127.0.XX.XX',
- ],
- 'WhitelistNetType' => [
- 'description' => 'The network type of the whitelist.'."\n",
- 'type' => 'string',
- 'example' => 'mix',
- ],
+ 'GroupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'SecurityIPType' => ['description' => 'The IP address type. The value is fixed to IPv4. IPv6 is not supported.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''],
+ 'GroupTag' => ['description' => 'The group tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The list of IP addresses in the whitelist group.', 'type' => 'string', 'example' => '127.0.XX.XX', 'title' => ''],
+ 'WhitelistNetType' => ['description' => 'The network type of the whitelist.', 'type' => 'string', 'example' => 'mix', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeSecurityIPList',
+ 'title' => 'Query langfuse whitelist',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"lfs-****\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'DescribeEndpoints' => [
- 'summary' => 'Queries the endpoint of an ApsaraDB for ClickHouse cluster.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeLangfuseUser' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4310,190 +4246,216 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185373',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxx',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'ComputingGroupId',
+ 'name' => 'Email',
'in' => 'query',
- 'schema' => [
- 'title' => '计算组ID。',
- 'type' => 'string',
- 'example' => 'cc-*****-clickhouse',
- ],
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
'Data' => [
- 'description' => 'The returned result.'."\n",
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'InstanceNetworkType' => [
- 'description' => 'The network type of the cluster. Valid values:'."\n"
- ."\n"
- .'* **VPC**'."\n"
- .'* **PUBLIC**'."\n",
- 'type' => 'string',
- 'example' => 'VPC',
- ],
- 'Endpoints' => [
- 'description' => 'The details of the endpoints.'."\n",
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
+ 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'john', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The time when the user was created.', 'type' => 'string', 'example' => '2026-06-01T10:03:05Z', 'title' => ''],
+ 'UpdatedAt' => ['description' => 'The time when the user was last updated.', 'type' => 'string', 'example' => '2026-06-01T10:03:05Z', 'title' => ''],
+ 'Memberships' => [
+ 'description' => 'The role information of the user.',
'type' => 'array',
'items' => [
- 'description' => 'The details of the endpoint.'."\n",
+ 'description' => 'The role information of the user.',
'type' => 'object',
'properties' => [
- 'NetType' => [
- 'description' => 'The network type of the endpoint. Valid values:'."\n"
- ."\n"
- .'* VPC'."\n"
- .'* PUBLIC'."\n",
- 'type' => 'string',
- 'example' => 'VPC',
- ],
- 'Status' => [
- 'description' => 'The state of the cluster.'."\n",
- 'type' => 'string',
- 'example' => 'active',
- ],
- 'ConnectionString' => [
- 'description' => 'The endpoint of the cluster.'."\n",
- 'type' => 'string',
- 'example' => 'cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com',
- ],
- 'VpcId' => [
- 'description' => 'The ID of the virtual private cloud (VPC).'."\n",
- 'type' => 'string',
- 'example' => 'vpc-uf61z****',
- ],
- 'VSwitchId' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'example' => 'vsw-0xi8829****',
- ],
- 'VpcInstanceId' => [
- 'description' => 'The VPC ID.'."\n",
- 'type' => 'string',
- 'example' => 'vpc-uf61z****',
- ],
- 'Ports' => [
- 'description' => 'The details of the ports.'."\n",
+ 'OrgRole' => ['description' => 'The role of the user within the organization.', 'type' => 'string', 'example' => 'ADMIN', 'title' => ''],
+ 'OrganizationId' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ 'OrganizationName' => ['description' => 'The Langfuse organization name.', 'type' => 'string', 'example' => 'org_name', 'title' => ''],
+ 'Projects' => [
+ 'description' => 'The list of Langfuse projects.',
'type' => 'array',
'items' => [
- 'description' => 'The details of the port.'."\n",
+ 'description' => 'The list of Langfuse projects.',
'type' => 'object',
'properties' => [
- 'Protocol' => [
- 'description' => 'The protocol type. Valid values:'."\n"
- ."\n"
- .'* HttpPort'."\n"
- .'* HttpsPort'."\n"
- .'* TcpPort'."\n",
- 'type' => 'string',
- 'example' => 'HttpPort',
- ],
- 'Port' => [
- 'description' => 'The port used to connect to the cluster. Valid values:'."\n"
- ."\n"
- .'* 8123: This value is returned when the value of Protocol is HttpPort.'."\n"
- .'* 8443: This value is returned when the value of Protocol is HttpsPort.'."\n"
- .'* 9000: This value is returned when the value of Protocol is TcpPort.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8123',
- ],
+ 'ProjectRole' => ['description' => 'The role of the user within the project.', 'type' => 'string', 'example' => 'VIEWER', 'title' => ''],
+ 'ProjectName' => ['description' => 'The Langfuse project name.', 'type' => 'string', 'example' => 'project_name', 'title' => ''],
+ 'ProjectId' => ['description' => 'The Langfuse project ID.', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'IPAddress' => [
- 'description' => 'The IP address.'."\n",
- 'type' => 'string',
- 'example' => '172.30.XX.XX',
- ],
- 'ComputingGroupId' => [
- 'title' => '计算组id',
- 'type' => 'string',
- 'example' => 'cc-ad321**-clickhouse',
- ],
- 'EndpointName' => [
- 'title' => '连接串名称',
- 'type' => 'string',
- 'example' => 'cc-*****-clickhouse',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'InvalidDBInstanceId.NotFound',
- 'errorMessage' => 'The DBInstanceId provided does not exist in our records.',
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Query langfuse user details',
+ 'summary' => 'Queries the details of a Langfuse user.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\",\\n \\"Name\\": \\"john\\",\\n \\"CreatedAt\\": \\"2026-06-01T10:03:05Z\\",\\n \\"UpdatedAt\\": \\"2026-06-01T10:03:05Z\\",\\n \\"Memberships\\": [\\n {\\n \\"OrgRole\\": \\"ADMIN\\",\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"OrganizationName\\": \\"org_name\\",\\n \\"Projects\\": [\\n {\\n \\"ProjectRole\\": \\"VIEWER\\",\\n \\"ProjectName\\": \\"project_name\\",\\n \\"ProjectId\\": \\"cmrbhzx930005jw2q****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeLangfuseUsers' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => false, 'example' => 'john@company.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'john', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2'],
+ 'Data' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'Users' => [
+ 'description' => 'The list of users.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of users.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'john', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The time when the user was created.', 'type' => 'string', 'example' => '2026-06-01T10:03:05Z', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"Status\\": \\"active\\",\\n \\"ConnectionString\\": \\"cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"VpcInstanceId\\": \\"vpc-uf61z****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"HttpPort\\",\\n \\"Port\\": 8123\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.XX.XX\\",\\n \\"ComputingGroupId\\": \\"cc-ad321**-clickhouse\\",\\n \\"EndpointName\\": \\"cc-*****-clickhouse\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeEndpoints',
+ 'title' => 'Query langfuse user list',
+ 'summary' => 'Queries the list of Langfuse users.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2\\",\\n \\"Data\\": {\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10,\\n \\"Users\\": [\\n {\\n \\"Name\\": \\"john\\",\\n \\"Email\\": \\"john@company.com\\",\\n \\"CreatedAt\\": \\"2026-06-01T10:03:05Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeProcessList' => [
- 'summary' => 'Views running queries.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Describes currently running queries.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4506,331 +4468,320 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '186631',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', 'title' => ''],
],
[
'name' => 'QueryDurationMs',
'in' => 'query',
- 'schema' => [
- 'description' => 'The execution duration of slow SQL queries. Minimum value: 1000. Unit: milliseconds.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1000',
- ],
+ 'schema' => ['description' => 'The minimum query execution duration, in milliseconds (ms). Only queries that run for this duration or longer are returned. The minimum value is 1,000.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''],
],
[
'name' => 'InitialUser',
'in' => 'query',
- 'schema' => [
- 'description' => 'The user who executes the query statement.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testuser',
- ],
+ 'schema' => ['description' => 'The query user.', 'type' => 'string', 'required' => false, 'example' => 'testuser', 'title' => ''],
],
[
'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'description' => 'The keyword of the query statement.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SELECT',
- ],
+ 'schema' => ['description' => 'The keyword in the query statement.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''],
],
[
'name' => 'InitialQueryId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The query ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The query ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'QueryOrder',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies the columns by which the query results are sorted in descending order.'."\n"
- ."\n"
- .'* 0: The query results are sorted by the query_duration_ms column.'."\n"
- .'* 1: The query results are sorted by the query_duration_ms and query_start_time columns.'."\n"
- .'* 2: The query results are sorted by the query_duration_ms, query_start_time, and user columns.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'id',
- ],
+ 'schema' => ['description' => 'The criteria by which to sort the results. The results are sorted in descending order. Valid values:'."\n"
+ ."\n"
+ .'- 0: Sorts by `query_duration_ms`.'."\n"
+ ."\n"
+ .'- 1: Sorts by `query_duration_ms` and `query_start_time`.'."\n"
+ ."\n"
+ .'- 2: Sorts by `query_duration_ms`, `query_start_time`, and `user`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ComputingGroupId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The computing group ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-gs5j3sua77******-clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxx-xxx-xxx'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The data object.',
'type' => 'object',
'properties' => [
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'cc-xxxx',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxx', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'For testing', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries that match the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ResultSet' => [
- 'description' => 'The result sets.'."\n",
+ 'description' => 'The result set.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'InitialQueryId' => [
- 'description' => 'The query ID.'."\n",
- 'type' => 'string',
- 'example' => '\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'',
- ],
- 'QueryStartTime' => [
- 'description' => 'The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2023-07-23T10:13:23Z',
- ],
- 'InitialAddress' => [
- 'description' => 'The address to which the query statement is sent.'."\n",
- 'type' => 'string',
- 'example' => '0:0:0:0:0:ffff:1edd65ea',
- ],
- 'Query' => [
- 'description' => 'The query statement that is running.'."\n",
- 'type' => 'string',
- 'example' => 'select * from test',
- ],
- 'InitialUser' => [
- 'description' => 'The user who executes the query statement.'."\n",
- 'type' => 'string',
- 'example' => 'bany',
- ],
- 'QueryDurationMs' => [
- 'description' => 'The minimum query duration. Minimum value: **1000**. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
+ 'InitialQueryId' => ['description' => 'The query ID.', 'type' => 'string', 'example' => '\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'', 'title' => ''],
+ 'QueryStartTime' => ['description' => 'The start time of the query. The time is in UTC and follows the `yyyy-MM-ddTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2023-07-23T10:13:23Z', 'title' => ''],
+ 'InitialAddress' => ['description' => 'The address from which the query was initiated.', 'type' => 'string', 'example' => '0:0:0:0:0:ffff:1edd65ea', 'title' => ''],
+ 'Query' => ['description' => 'The query statement.', 'type' => 'string', 'example' => 'select * from test', 'title' => ''],
+ 'InitialUser' => ['description' => 'The user who initiated the query.', 'type' => 'string', 'example' => 'bany', 'title' => ''],
+ 'QueryDurationMs' => ['description' => 'The execution duration of the query, in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
],
- 'description' => '',
+ 'description' => 'The details of a query.',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"测试使用\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"InitialQueryId\\": \\"\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'\\",\\n \\"QueryStartTime\\": \\"2023-07-23T10:13:23Z\\",\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"For testing\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"InitialQueryId\\": \\"\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'\\",\\n \\"QueryStartTime\\": \\"2023-07-23T10:13:23Z\\",\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'DescribeProcessList',
- ],
- 'KillProcess' => [
- 'summary' => 'Terminates an ongoing query.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeProcessList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeRegions' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '186648',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '19455',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'RegionId',
- 'in' => 'query',
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''],
+ 'Regions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Region' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Zones' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Zone' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-k', 'title' => ''],
+ 'VpcEnabled' => ['description' => 'Indicates whether the zone supports deployments in a VPC.'."\n"
+ ."\n"
+ .'- **true**: The zone supports VPC deployments.'."\n"
+ ."\n"
+ .'- **false**: The zone does not support VPC deployments.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => 'The details of a zone.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'An array of zones.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ 'description' => 'The details of a region.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'An array of regions.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'DescribeRegions',
+ 'summary' => 'Returns information about the available regions and zones for ApsaraDB for ClickHouse.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-k\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeSecurityIPList' => [
+ 'summary' => 'Queries a whitelist.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'DBInstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxxxx',
- ],
+ 'AK' => [],
],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '185650',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ ],
+ 'parameters' => [
[
- 'name' => 'InitialQueryId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The query ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ComputingGroupId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'cc-xxxxxxx',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'cc-xxxxxxx'."\n",
- ],
- 'Count' => [
- 'description' => 'The number of queries that are terminated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Cluster test', 'title' => ''],
+ 'GroupItems' => [
+ 'description' => 'The whitelist groups.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A whitelist group.',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'SecurityIPType' => ['description' => 'The IP address type.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''],
+ 'GroupTag' => ['description' => 'The group tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP addresses in the whitelist group.', 'type' => 'string', 'example' => '127.0.XX.XX', 'title' => ''],
+ 'WhitelistNetType' => ['description' => 'The network type of the whitelist.', 'type' => 'string', 'example' => 'mix', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"Count\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'KillProcess',
- ],
- 'DescribeSlowLogTrend' => [
- 'summary' => 'Queries the trend of slow query logs.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Cluster test\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DescribeSecurityIPList',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeSecurityIPList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeSlowLogRecords' => [
+ 'summary' => 'Call DescribeSlowLogRecords to query slow log records.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4839,176 +4790,136 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '186604',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '186629',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The start of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-04-13 17:48:00',
- ],
+ 'schema' => ['description' => 'The start time of the query. The time must be in UTC and in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2023-09-11 16:00:00', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-06-07 10:03:00',
- ],
+ 'schema' => ['description' => 'The end time of the query. The time must be in UTC and in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2023-09-15 16:00:00', 'title' => ''],
],
[
'name' => 'QueryDurationMs',
'in' => 'query',
- 'schema' => [
- 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '3000',
- ],
+ 'schema' => ['description' => 'The minimum duration, in milliseconds, for a slow SQL query to be returned. The minimum value is **1000**.', 'type' => 'string', 'required' => false, 'example' => '3000', 'title' => ''],
],
[
- 'name' => 'Product',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The code of the cloud service.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clickhouse',
- 'default' => 'clickhouse',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n"
+ ."\n"
+ .'- 30 (default)'."\n"
+ ."\n"
+ .'- 50'."\n"
+ ."\n"
+ .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ComputingGroupId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The computing group ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-wz9v6y29y3******-clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A'],
'Data' => [
- 'description' => 'The returned result.'."\n",
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'clusterTest',
- ],
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z32****', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Cluster test', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ResultSet' => [
- 'description' => 'The result sets.'."\n",
+ 'description' => 'The list of slow log records.',
'type' => 'array',
'items' => [
- 'description' => 'The result set.'."\n",
+ 'description' => 'The details of a slow log record.',
'type' => 'object',
'properties' => [
- 'QueryStartTime' => [
- 'description' => 'The beginning of the time range to query. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2023-04-13 17:48:00',
- ],
- 'MaxQueryDurationMs' => [
- 'description' => 'The maximum execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3000',
- ],
- 'Cnt' => [
- 'description' => 'The total number of SQL queries within the specified time range.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MinQueryDurationMs' => [
- 'description' => 'The minimum execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'AvgQueryDurationMs' => [
- 'description' => 'The average execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
+ 'QueryStartTime' => ['description' => 'The start time of the query. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-09-11 16:00:00', 'title' => ''],
+ 'InitialQueryId' => ['description' => 'The query ID.', 'type' => 'string', 'example' => '\'ae915a3ad30e77e67a7215d05b658cc6\'', 'title' => ''],
+ 'ReadRows' => ['description' => 'The number of rows read.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'InitialAddress' => ['description' => 'The IP address from which the query was initiated.', 'type' => 'string', 'example' => '0:0:0:0:0:ffff:1edd65ea', 'title' => ''],
+ 'Query' => ['description' => 'The statement that was being executed.', 'type' => 'string', 'example' => 'select * from test', 'title' => ''],
+ 'MemoryUsage' => ['description' => 'The peak memory usage for the query. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '4941696', 'title' => ''],
+ 'Type' => ['description' => 'The type of the slow query log.', 'type' => 'string', 'example' => 'ExceptionWhileProcessing', 'title' => ''],
+ 'ReadBytes' => ['description' => 'The size of the scanned data. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '4507128020832', 'title' => ''],
+ 'InitialUser' => ['description' => 'The user who initiated the query.', 'type' => 'string', 'example' => 'bany', 'title' => ''],
+ 'QueryDurationMs' => ['description' => 'The execution duration of the slow query. The minimum value is **1000**. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''],
+ 'ResultBytes' => ['description' => 'The size of the result data. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-04-13 17:48:00\\",\\n \\"MaxQueryDurationMs\\": 3000,\\n \\"Cnt\\": 1,\\n \\"MinQueryDurationMs\\": 1000,\\n \\"AvgQueryDurationMs\\": 2000\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeSlowLogTrend',
- ],
- 'DescribeSlowLogRecords' => [
- 'summary' => 'Queries the details of slow query logs.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Cluster test\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-09-11 16:00:00\\",\\n \\"InitialQueryId\\": \\"\'ae915a3ad30e77e67a7215d05b658cc6\'\\",\\n \\"ReadRows\\": 10,\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"MemoryUsage\\": 4941696,\\n \\"Type\\": \\"ExceptionWhileProcessing\\",\\n \\"ReadBytes\\": 4507128020832,\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 3000,\\n \\"ResultBytes\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DescribeSlowLogRecords',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeSlowLogRecords',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DescribeSlowLogTrend' => [
+ 'summary' => 'Queries the slow log trend.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5017,228 +4928,118 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '186629',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '186604',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-09-11 16:00:00',
- ],
+ 'schema' => ['description' => 'The start of the time range to query. The time is in UTC and uses the yyyy-MM-dd hh:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '2023-04-13 17:48:00', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-09-15 16:00:00',
- ],
+ 'schema' => ['description' => 'The end of the time range to query. The time is in UTC and uses the yyyy-MM-dd hh:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '2023-06-07 10:03:00', 'title' => ''],
],
[
'name' => 'QueryDurationMs',
'in' => 'query',
- 'schema' => [
- 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '3000',
- ],
+ 'schema' => ['description' => 'The minimum execution duration of a slow SQL query, in milliseconds. The minimum value is **1000**.', 'type' => 'string', 'required' => false, 'example' => '3000', 'title' => ''],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Valid values:'."\n"
- ."\n"
- .'* 30 (default)'."\n"
- .'* 50'."\n"
- .'* 100'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
- ],
- [
- 'name' => 'PageNumber',
+ 'name' => 'Product',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The product code.', 'type' => 'string', 'default' => 'clickhouse', 'required' => false, 'example' => 'clickhouse', 'title' => ''],
],
[
'name' => 'ComputingGroupId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The computing group ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF'],
'Data' => [
- 'description' => 'The data returned.'."\n",
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'DBInstanceID' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'cc-bp100p4q1g9z32****',
- ],
- 'DBInstanceName' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'TestCluster',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Cluster test', 'title' => ''],
'ResultSet' => [
- 'description' => 'The result sets.'."\n",
+ 'description' => 'The result set.',
'type' => 'array',
'items' => [
- 'description' => 'The result set.'."\n",
+ 'description' => 'An array of data points for the slow log trend.',
'type' => 'object',
'properties' => [
- 'QueryStartTime' => [
- 'description' => 'The beginning of the time range to query. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2023-09-11 16:00:00',
- ],
- 'InitialQueryId' => [
- 'description' => 'The query ID.'."\n",
- 'type' => 'string',
- 'example' => '\'ae915a3ad30e77e67a7215d05b658cc6\'',
- ],
- 'ReadRows' => [
- 'description' => 'The number of read rows.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'InitialAddress' => [
- 'description' => 'The address to which the query statement is sent.'."\n",
- 'type' => 'string',
- 'example' => '0:0:0:0:0:ffff:1edd65ea',
- ],
- 'Query' => [
- 'description' => 'The query statement that is running.'."\n",
- 'type' => 'string',
- 'example' => 'select * from test',
- ],
- 'MemoryUsage' => [
- 'description' => 'The peak memory usage for the query. Unit: bytes.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4941696',
- ],
- 'Type' => [
- 'description' => 'The type of the slow query logs.'."\n",
- 'type' => 'string',
- 'example' => 'ExceptionWhileProcessing',
- ],
- 'ReadBytes' => [
- 'description' => 'The size of the data that is scanned. Unit: bytes.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4507128020832',
- ],
- 'InitialUser' => [
- 'description' => 'The user who executes the query statement.'."\n",
- 'type' => 'string',
- 'example' => 'bany',
- ],
- 'QueryDurationMs' => [
- 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3000',
- ],
- 'ResultBytes' => [
- 'description' => 'The size of the result data. Unit: bytes.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
+ 'QueryStartTime' => ['description' => 'The start of the time interval for the data point. The time is in UTC and uses the yyyy-MM-dd hh:mm:ss format.', 'type' => 'string', 'example' => '2023-04-13 17:48:00', 'title' => ''],
+ 'MaxQueryDurationMs' => ['description' => 'The maximum execution duration, in milliseconds, of slow SQL queries within the time interval.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''],
+ 'Cnt' => ['description' => 'The number of slow SQL queries in the time interval.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'MinQueryDurationMs' => ['description' => 'The minimum execution duration, in milliseconds, of slow SQL queries within the time interval.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'AvgQueryDurationMs' => ['description' => 'The average execution duration, in milliseconds, of slow SQL queries within the time interval.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-09-11 16:00:00\\",\\n \\"InitialQueryId\\": \\"\'ae915a3ad30e77e67a7215d05b658cc6\'\\",\\n \\"ReadRows\\": 10,\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"MemoryUsage\\": 4941696,\\n \\"Type\\": \\"ExceptionWhileProcessing\\",\\n \\"ReadBytes\\": 4507128020832,\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 3000,\\n \\"ResultBytes\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'DescribeSlowLogRecords',
- ],
- 'ModifyBackupPolicy' => [
- 'summary' => 'Modifies the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Cluster test\\",\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-04-13 17:48:00\\",\\n \\"MaxQueryDurationMs\\": 3000,\\n \\"Cnt\\": 1,\\n \\"MinQueryDurationMs\\": 1000,\\n \\"AvgQueryDurationMs\\": 2000\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DescribeSlowLogTrend',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeSlowLogTrend',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'DetachWhitelistTemplateToInstance' => [
+ 'summary' => 'Disassociate a whitelist template from an instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5247,201 +5048,261 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '206399',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseIL81EM',
- ],
+ 'abilityTreeCode' => '185639',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxx',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-beijing',
- ],
- ],
- [
- 'name' => 'PreferredBackupTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '15:00Z-16:00Z',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PreferredBackupPeriod',
+ 'name' => 'TemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Monday',
- ],
+ 'schema' => ['description' => 'The whitelist template ID.', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', 'title' => ''],
],
[
- 'name' => 'BackupRetentionPeriod',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7',
- ],
+ 'schema' => ['description' => 'The IDs of the ClickHouse instances, separated by commas. You can specify up to 20 IDs.', 'type' => 'string', 'required' => true, 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', 'title' => ''],
],
],
'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' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
+ 'Data' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the operation. A value of `ok` indicates success.', 'type' => 'string', 'example' => 'ok', 'title' => ''],
+ 'DetachFailList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'my-database', 'title' => ''],
+ 'Reason' => ['description' => 'The reason the detach operation failed.', 'type' => 'string', 'example' => '处理异常', 'title' => ''],
+ ],
+ 'description' => 'Details of an instance that failed to detach.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of instances that failed to detach.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DetachSuccessedList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'my-database', 'title' => ''],
+ 'Templates' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The whitelist template ID.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'TemplateName' => ['description' => 'The whitelist template name.', 'type' => 'string', 'example' => 'demo_template', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ 'DbInstances' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'asdfwef', 'title' => ''],
+ ],
+ 'description' => 'Details of an associated instance.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of associated instances.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'Details of a whitelist template.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of whitelist templates.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'Details of a successfully detached instance.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of successfully detached instances.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The returned data.',
+ 'example' => '',
],
],
+ 'description' => 'The response.',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''],
+ ['errorCode' => 'InvalidDBInstanceId.TooManyItems', 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter.DBInstanceId', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', 'description' => ''],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]',
- 'title' => 'ModifyBackupPolicy',
- ],
- 'DescribeBackupPolicy' => [
- 'summary' => 'View the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'DetachWhitelistTemplateToInstance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DetachWhitelistTemplateToInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"DetachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"DetachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetWhitelistTemplate' => [
+ 'summary' => 'Queries the details of a whitelist template.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '206399',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseIL81EM',
- ],
+ 'abilityTreeCode' => '185639',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'TemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the whitelist template.', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'PreferredBackupPeriod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Monday',
- ],
- 'Switch' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
- ],
- 'PreferredBackupTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '15:00Z-16:00Z',
- ],
- 'BackupRetentionPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'BackupSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123124',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
+ 'Data' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Templates' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The ID of the whitelist template.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'TemplateName' => ['description' => 'The name of the whitelist template.', 'type' => 'string', 'example' => 'demo_template', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ 'DbInstances' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cc-asdfwef', 'title' => ''],
+ ],
+ 'description' => 'The details of an instance.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of associated instances.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The details of a whitelist template.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of whitelist templates.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The whitelist template details.',
+ 'example' => '',
],
],
+ 'description' => 'The response object.',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","type":"json"}]',
- 'title' => 'DescribeBackupPolicy',
- ],
- 'DeleteBackupPolicy' => [
- 'summary' => 'Deletes the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'GetWhitelistTemplate',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:GetWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'KillProcess' => [
+ 'summary' => 'Terminates a running task.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5453,267 +5314,453 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '206399',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseN8BUWF',
- ],
+ 'abilityTreeCode' => '186648',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-xxxxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxxxx', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'InitialQueryId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The query ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ComputingGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The computing group ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-gs5j3sua77******-clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '60DDD29D-E5A8-563C-88FB-06D3A1F1C609',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxx-xxx-xxx'],
+ 'Data' => [
+ 'description' => 'The response data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxxxxx', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cc-xxxxxxx'."\n", 'title' => ''],
+ 'Count' => ['description' => 'The number of terminated tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60DDD29D-E5A8-563C-88FB-06D3A1F1C609\\"\\n}","type":"json"}]',
- 'title' => 'DeleteBackupPolicy',
- ],
- 'CreateBackupPolicy' => [
- 'summary' => 'Creates a backup policy for a specified ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"Count\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'KillProcess',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:KillProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListClickHouseDBTimezones' => [
+ 'summary' => 'Lists the available time zones for ClickHouse.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '206399',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseIL81EM',
- ],
+ 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'],
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-2ze0eb0w182xh8549',
- ],
+ 'schema' => ['description' => 'The number of records on each page. Valid values:'."\n"
+ ."\n"
+ .'- **30** (default)'."\n"
+ ."\n"
+ .'- **50**'."\n"
+ ."\n"
+ .'- **100**', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '30', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'PageNumber',
'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
+ 'TimeZones' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['description' => 'The enumeration value for the time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of time zones that ClickHouse supports.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListClickHouseDBTimezones',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"TimeZones\\": [\\n {\\n \\"ZoneId\\": \\"Asia/Shanghai\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListInstanceLinkedWhitelistTemplates' => [
+ 'summary' => 'Lists the IP address whitelist templates linked to an instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PreferredBackupTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The backup time window within which the backup task is performed. The time is displayed in `UTC`. For example, `12:00Z-13:00Z` indicates that the backup time window ranges from `12:00` (UTC) to `13:00` `(UTC)`.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '10:00Z-11:00Z',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185639',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ ],
+ 'parameters' => [
[
- 'name' => 'PreferredBackupPeriod',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The backup cycle, which indicates the day of the week when the system regularly backs up data. Separate multiple dates with commas (`,`).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Monday,Friday',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'BackupRetentionPeriod',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of days for which you can retain the backup data.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '8',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-exadfas', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Templates' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The IP address whitelist template ID.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'TemplateName' => ['description' => 'The IP address whitelist template name.', 'type' => 'string', 'example' => 'demo_template', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The comma-separated IP addresses in the whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ ],
+ 'description' => 'An IP address whitelist template.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of IP address whitelist templates.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The response data.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'The response object.',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]',
- 'title' => 'CreateBackupPolicy',
- ],
- 'DescribeBackups' => [
- 'summary' => 'Queries the backup sets of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'ListInstanceLinkedWhitelistTemplates',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ListInstanceLinkedWhitelistTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListWhitelistTemplates' => [
+ 'summary' => 'Queries the whitelist templates associated with an instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '206399',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseIL81EM',
- ],
+ 'abilityTreeCode' => '185639',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
- 'name' => 'DBInstanceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp1v9kq45u0o80cvh',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'TemplateName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The whitelist template name. Fuzzy search is supported.', 'type' => 'string', 'example' => 'default', 'title' => '', 'required' => false],
],
[
- 'name' => 'BackupId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '117403****',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false],
],
[
- 'name' => 'StartTime',
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'default' => '25', 'title' => '', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2021-11-21T16:00Z',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => 'The total number of templates.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'CurrPageNumbers' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalPageNumbers' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'HasPrev' => ['description' => 'Whether a previous page exists.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'HasNext' => ['description' => 'Whether a next page exists.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Templates' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The whitelist template ID.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'TemplateName' => ['description' => 'The whitelist template name.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
+ 'DbInstances' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cc-asdfwef', 'title' => ''],
+ ],
+ 'description' => 'The details of an associated instance.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of associated instances.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The details of a whitelist template.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of whitelist templates.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The query results.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The data returned.',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'ListWhitelistTemplates',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ListWhitelistTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 30,\\n \\"PageSize\\": 20,\\n \\"CurrPageNumbers\\": 1,\\n \\"TotalPageNumbers\\": 2,\\n \\"HasPrev\\": false,\\n \\"HasNext\\": true,\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"g-asdfwem\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyAccountAuthority' => [
+ 'summary' => 'Modifies the permissions of a database account.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'EndTime',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185304',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2021-11-25T16:00Z',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '30',
- 'example' => '30',
- 'default' => '30',
- ],
+ 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Account',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
+ ],
+ [
+ 'name' => 'DmlAuthSetting',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
+ 'description' => 'The information about permissions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DmlAuthority' => [
+ 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n"
+ .'* **1**: The account only has the permissions to read data from the database.'."\n"
+ .'* **2**: The account only has the permissions to read data from the database and modify the settings of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '0',
+ 'enum' => ['0', '1', '2'],
+ 'title' => '',
+ ],
+ 'DdlAuthority' => ['description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The account has the permissions to execute DDL statements.'."\n"
+ .'* **false**: The account does not have the permissions to execute DDL statements.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''],
+ 'AllowDictionaries' => [
+ 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'db1,db2', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AllowDatabases' => [
+ 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'db1,db2', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -5724,110 +5771,56 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '30',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Items' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc-bp179i5956tih2m93',
- ],
- 'BackupStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'BackupType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'IncrementalBackup',
- ],
- 'BackupStartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-11-22T18:28:22Z',
- ],
- 'BackupSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '131072',
- ],
- 'BackupEndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-11-22T18:28:41Z',
- ],
- 'BackupSetInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"shard_count"：4}',
- ],
- 'BackupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '117403****',
- ],
- 'BackupMethod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Physical',
- ],
- 'ExpireDate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-07-22T18:28:41Z',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'],
+ 'Data' => [
+ 'description' => 'The result returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'Account' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-bp179i5956tih2m93\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeBackups',
- ],
- 'ModifyDBInstanceConfig' => [
- 'summary' => '修改实例参数配置',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'ModifyAccountAuthority',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyAccountAuthority',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyAccountDescription' => [
+ 'summary' => 'Modifies the description of a database account.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5836,167 +5829,383 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '206399',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseFBPCH8',
- ],
+ 'abilityTreeCode' => '185303',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-uf6lkzf*****',
- ],
+ 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc-bp1anv7jo84t****', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Account',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testuser', 'title' => ''],
],
[
- 'name' => 'Parameters',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"max_concurrent_queries":"100"}',
- ],
+ 'schema' => ['description' => 'The description of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '05321590-BB65-4720-8C***********',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7FFC9EBE-5023-5D5D-A5F0-1607E0F2****'],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.'."\n",
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc-uf6lkzf*****'."\n",
- ],
+ 'DBInstanceId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'cc-bp1anv7jo84t****', 'title' => ''],
+ 'Account' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'testuser', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8C***********\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-uf6lkzf*****\\\\n\\"\\n }\\n}","type":"json"}]',
- ],
- 'DescribeDBInstanceConfigChangeLog' => [
- 'summary' => '查询实例参数配置记录',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'ModifyAccountDescription',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyAccountDescription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FFC9EBE-5023-5D5D-A5F0-1607E0F2****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp1anv7jo84t****\\",\\n \\"Account\\": \\"testuser\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyBackupPolicy' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '206401',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseFBPCH8',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '206399',
+ 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-uf6lkzf*****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'PreferredBackupTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The backup time.', 'type' => 'string', 'required' => true, 'example' => '15:00Z-16:00Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'PreferredBackupPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The backup cycle.', 'type' => 'string', 'required' => true, 'example' => 'Monday', 'title' => ''],
+ ],
+ [
+ 'name' => 'BackupRetentionPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of days to retain backups.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-shanghai',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'StorageTypeDoNotSupportBackup', 'errorMessage' => 'Current StorageType Does Not Support Backup.', 'description' => 'The current storage type does not support backup'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'ModifyBackupPolicy',
+ 'summary' => 'Modifies the backup policy of an ApsaraDB for ClickHouse cluster.',
+ 'description' => '> Data backup is supported only for ApsaraDB for ClickHouse clusters that run version 20.3, 20.8, or 21.8.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDBInstanceAttribute' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'StartTime',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-xxxxx'],
+ ],
+ [
+ 'name' => 'AttributeType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The type of attribute to modify. Valid values:'."\n"
+ ."\n"
+ .'- MaintainTime: Modify the O\\&M window.'."\n"
+ ."\n"
+ .'- DBInstanceDescription: Modify the instance name.',
'type' => 'string',
'required' => true,
- 'example' => '2025-01-01 10:00:00',
+ 'enumValueTitles' => [],
+ 'enum' => ['MaintainTime', 'DBInstanceDescription'],
+ 'title' => '',
+ 'example' => 'DBInstanceDescription',
],
],
[
- 'name' => 'EndTime',
+ 'name' => 'AttributeValue',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new value for the attribute.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Product',
'in' => 'query',
+ 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'default' => 'clickhouse', 'title' => '', 'example' => 'clickhouse'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025-01-01 10:00:00'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'The details of the returned parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxx-xxx-xxx'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'ModifyDBInstanceAttribute',
+ 'summary' => 'You can call the ModifyDBInstanceAttribute operation to modify the configuration of a cluster.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDBInstanceClass' => [
+ 'summary' => 'Use `ModifyDBInstanceClass` to modify the scaling configuration of a cluster.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PageSize',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '188578',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-gs5j3sua77*******', 'title' => ''],
+ ],
+ [
+ 'name' => 'ScaleMin',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The minimum capacity for serverless autoscaling.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'ScaleMax',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum capacity for serverless autoscaling.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'NodeScaleMax',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum capacity per node for serverless autoscaling. Valid values: 4 to 32. This value must be greater than the minimum value.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '128', 'minimum' => '4', 'example' => '4', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'NodeScaleMin',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The minimum capacity per node for serverless autoscaling. Valid values: 4 to 32.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '128', 'minimum' => '4', 'example' => '32', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'NodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of nodes. Valid values: 2 to 16.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '64', 'minimum' => '1', 'example' => '2', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'StorageQuota',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The pre-purchased storage capacity in GB.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '0', 'example' => '100', 'required' => false, 'title' => ''],
+ ],
+ [
+ 'name' => 'StorageType',
'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The storage type.',
+ 'type' => 'string',
+ 'example' => 'OSS',
+ 'enum' => ['oss', 'ESSD_L1', 'ESSD_L2', 'ESSD_L3', 'SSD', 'ESSD_L0'],
+ 'title' => '',
'required' => false,
- 'example' => '30',
- 'default' => '30',
],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ComputingGroupId',
'in' => 'query',
+ 'schema' => ['description' => 'The compute group ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cc-gs5j3sua77*******-clickhouse'],
+ ],
+ [
+ 'name' => 'AutoScaleConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Specifies whether to enable or disable autoscaling. Valid values: `enable` and `disable`.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'enable',
+ 'enum' => ['enable', 'disable'],
+ 'title' => '',
+ ],
+ 'BurstNum' => ['description' => 'The number of burstable nodes for autoscaling.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '64', 'minimum' => '1', 'example' => '2', 'title' => '', 'required' => false],
+ 'VSwitchInfos' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-XXX', 'title' => '', 'required' => false],
+ 'VSwitchIds' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'A VSwitch ID.', 'type' => 'string', 'example' => 'vsw-XXXXX', 'title' => '', 'required' => false],
+ 'description' => 'The VSwitch IDs.',
+ 'title' => '',
+ 'example' => '',
+ 'required' => false,
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ 'required' => false,
+ ],
+ 'minItems' => 0,
+ 'description' => 'Information about the VSwitches.',
+ 'title' => '',
+ 'example' => '',
+ 'required' => false,
+ ],
+ ],
+ 'description' => 'The autoscaling configuration for the compute group.',
+ 'title' => '',
+ 'example' => '',
'required' => false,
- 'example' => '1',
- 'default' => '1',
],
],
],
@@ -6004,451 +6213,352 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '780DE414-*********-88BE-A2E21B862B57',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxx-xxx-xxx'],
'Data' => [
- 'description' => '',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'ParamChangeLogs' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ID' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'max_concurrent_queries',
- ],
- 'OldValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50',
- ],
- 'NewValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'Applied' => [
- 'description' => '',
- 'type' => 'boolean',
- ],
- 'GmtCreated' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-06-25 13:46:06',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-06-25 13:46:06'."\n",
- ],
- ],
- ],
- ],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000****', 'title' => ''],
+ 'ScaleMin' => ['description' => 'The minimum capacity for serverless autoscaling.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'ScaleMax' => ['description' => 'The maximum capacity for serverless autoscaling.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''],
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-gs5j3sua77*******', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cc-gs5j3sua77*******', 'title' => ''],
+ 'ComputingGroupId' => ['description' => 'The compute group ID.', 'type' => 'string', 'example' => 'cc-gs5j3sua77*******-clickhouse', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidSpecification', 'errorMessage' => 'Specification parameter is not valid.', 'description' => 'The specification parameter is invalid.'],
+ ['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance state does not allow the current operation.'],
+ ['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'The operation is not permitted due to there is an order in processing of cluster.', 'description' => 'There is an outstanding order, please try again later.'],
+ ['errorCode' => 'OperationDenied.NothingChanged', 'errorMessage' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.', 'description' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.'],
+ ['errorCode' => 'ForbiddenRegisterAutoScaleConfig', 'errorMessage' => 'Can\'t register autoScale config', 'description' => ''],
+ ['errorCode' => 'InvalidAutoScaleConfig', 'errorMessage' => 'The autoScale config is invalid, param error', 'description' => ''],
+ ['errorCode' => 'UnsupportedAutoScaleZone', 'errorMessage' => 'ZoneId is null or the specified zone is not supported for autoScale', 'description' => ''],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"780DE414-*********-88BE-A2E21B862B57\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"ParamChangeLogs\\": [\\n {\\n \\"ID\\": 1,\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"OldValue\\": \\"50\\",\\n \\"NewValue\\": \\"100\\",\\n \\"Applied\\": true,\\n \\"GmtCreated\\": \\"2025-06-25 13:46:06\\",\\n \\"GmtModified\\": \\"2025-06-25 13:46:06\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- ],
- 'DescribeDBInstanceConfig' => [
- 'summary' => '查询实例参数配置',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"ScaleMin\\": 2,\\n \\"ScaleMax\\": 32,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-gs5j3sua77*******\\",\\n \\"ComputingGroupId\\": \\"cc-gs5j3sua77*******-clickhouse\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'ModifyDBInstanceClass',
+ 'description' => 'Before you call this API, make sure that you understand the billing method and [pricing](~~167450~~) of ApsaraDB for ClickHouse.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyDBInstanceConfig' => [
+ 'summary' => 'Modifies the parameter settings for a DB instance.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '204414',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseFBPCH8',
- ],
+ 'abilityTreeCode' => '206399',
+ 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-wz9go4x*****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-uf6lkzf*****'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The API data parameter settings in JSON format.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{"max_concurrent_queries":"100"}'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n",
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05321590-BB65-4720-8C***********'],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc-bp100p4q1g9z3****',
- ],
- 'Params' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'IsDynamic' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'IsUserModifiable' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DefaultValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'max_concurrent_queries',
- ],
- 'Optional' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[0-100]',
- ],
- 'Comment' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Maximum number of concurrently executed queries. Zero means unlimited.',
- ],
- 'ParamRelyRule' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- ],
- ],
- ],
+ 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-uf6lkzf*****'."\n"],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Params\\": [\\n {\\n \\"IsDynamic\\": 1,\\n \\"IsUserModifiable\\": 1,\\n \\"DefaultValue\\": \\"1\\",\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"Optional\\": \\"[0-100]\\",\\n \\"Comment\\": \\"Maximum number of concurrently executed queries. Zero means unlimited.\\",\\n \\"ParamRelyRule\\": \\"0\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- ],
- 'ChangeResourceGroup' => [
- 'summary' => '资源转组',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ModifyDBInstanceConfig',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8C***********\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-uf6lkzf*****\\\\n\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyDBInstanceConnectionString' => [
+ 'summary' => 'Modifies the connection string of a cluster.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'riskType' => 'none',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeCode' => '163948',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '186649',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'EnterpriseDBCluster',
- 'default' => 'EnterpriseDBCluster',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '资源Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-bp1i43033051****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', 'title' => ''],
],
[
- 'name' => 'ResourceRegionId',
+ 'name' => 'ConnectionString',
'in' => 'query',
- 'schema' => [
- 'title' => '地域Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The connection string.', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'ConnectionStringPrefix',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The connection string prefix.', 'type' => 'string', 'required' => false, 'example' => 'cc-****-clickhouse', 'title' => ''],
+ ],
+ [
+ 'name' => 'DisablePorts',
+ 'in' => 'query',
+ 'schema' => ['description' => '- The database ports to disable. You can specify multiple ports, separated by commas.'."\n"
+ ."\n"
+ .'- This parameter is supported only for clusters with a kernel version of 24.10.1.11098\\_1 or later.'."\n"
+ ."\n\n"
+ .' ><notice>'."\n"
+ ."\n"
+ .' This parameter is not supported for clusters that were upgraded to kernel version 24.10.1.11098\\_1 or later from an earlier version.'."\n"
+ ."\n"
+ .' ></notice>', 'type' => 'string', 'required' => false, 'example' => '9001,8123', 'title' => ''],
+ ],
+ [
+ 'name' => 'DBInstanceNetType',
'in' => 'query',
'schema' => [
- 'title' => '目标资源组',
- 'description' => '',
+ 'description' => 'The network type. Valid values:'."\n"
+ ."\n"
+ .'- `Vpc`: VPC'."\n"
+ ."\n"
+ .'- `Public`: public network',
+ 'enumValueTitles' => ['Vpc' => 'VPC', 'Public' => 'public network'],
'type' => 'string',
- 'required' => true,
- 'example' => 'rg-4690g37929****',
+ 'enum' => ['Public'],
+ 'required' => false,
+ 'example' => 'Public',
+ 'title' => '',
],
],
+ [
+ 'name' => 'ComputingGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The computing group ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze34****-clickhouse', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'C342F3DD-1FF7-55E9-A1A1-098D*******',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxx-xxx-xxx'],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxxx', 'title' => ''],
+ 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cc-xxxxx', 'title' => ''],
+ 'DisabledPorts' => ['description' => 'The disabled database ports.', 'type' => 'string', 'example' => '9001,8123', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'NoPermission.ChangeResourceGroup',
- 'errorMessage' => 'You are not authorized to change resourcegroup',
- ],
- [
- 'errorCode' => 'MissingParameter.ResourceRegionId',
- 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing',
- ],
- [
- 'errorCode' => 'MissingParameter.ResourceId',
- 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing',
- ],
- [
- 'errorCode' => 'MissingParameter.ResourceGroupId',
- 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing',
- ],
- [
- 'errorCode' => 'InvalidResourceGroup',
- 'errorMessage' => 'The specified ResourceGroupId is invalid',
- ],
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => 'A system error occurred while processing your request',
- ],
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => ' The specified resource is not found',
- ],
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098D*******\\"\\n}","type":"json"}]',
- ],
- 'ListClickHouseDBTimezones' => [
- 'summary' => '列举ClickHouse时区参数枚举值',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"ConnectionString\\": \\"cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"cc-xxxxx\\",\\n \\"DisabledPorts\\": \\"9001,8123\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'ModifyDBInstanceConnectionString',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceConnectionString',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyLangfuseOrgMembership' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseFBPCH8',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'PageSize',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrganizationId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'Role',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The role of the user in the organization.', 'type' => 'string', 'required' => true, 'example' => 'ADMIN', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC',
- ],
- 'TimeZones' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Asia/Shanghai',
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
+ 'Data' => [
+ 'description' => 'The response data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => ['description' => 'The role of the user in the organization.', 'type' => 'string', 'example' => 'ADMIN', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"TimeZones\\": [\\n {\\n \\"ZoneId\\": \\"Asia/Shanghai\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Modify user permissions in a langfuse organization',
+ 'summary' => 'Modifies the permissions of a user in a Langfuse organization.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"Role\\": \\"ADMIN\\",\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]',
],
- 'DeleteWhitelistTemplate' => [
- 'summary' => '删除白名单模板',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ModifyLangfuseProjectMembership' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6457,299 +6567,194 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185379',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'TemplateId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单模板Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '98a6d3db05984dca',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'OrganizationId',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单模板Id',
- 'type' => 'string',
- 'example' => '98a6d3db05984dca',
- ],
+ 'schema' => ['description' => 'The Langfuse organization ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Langfuse project ID.', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'Role',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The role of the user in the project.', 'type' => 'string', 'required' => true, 'example' => 'VIEWER', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'],
'Data' => [
- 'title' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'Templates' => [
- 'title' => '白名单模板列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '模板详情',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
- 'DbInstances' => [
- 'title' => '关联的实例列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例详情',
- 'type' => 'object',
- 'properties' => [
- 'DbInstanceName' => [
- 'title' => '实例ID',
- 'type' => 'string',
- 'example' => 'asdfwef',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Role' => ['description' => 'The role of the user in the project.', 'type' => 'string', 'example' => 'VIEWER', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplateId',
- 'errorMessage' => 'Invalid Whitelist templateId.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission',
- 'errorMessage' => 'No permission to operate the whitelist template.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'No valid instance found'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => null,
+ 'title' => 'Modify user permissions in a langfuse project',
+ 'summary' => 'Modifies the permissions of a user in a Langfuse project.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"Role\\": \\"VIEWER\\",\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]',
],
- 'CreateWhitelistTemplate' => [
- 'summary' => '新增白名单模板',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ModifySecurityIPList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单模板名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'InvoiceTemplate',
- ],
+ 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the whitelist whose settings you want to modify.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SecurityIPList',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '白名单列表. 逗号分隔，数量不超过100个。',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '192.168.1.1,10.0.0.1',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.0.0/24,172.16.0.0/24', 'title' => ''],
+ ],
+ [
+ 'name' => 'ModifyMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The modification mode.'."\n"
+ ."\n"
+ .'* 0: overwrites the original IP addresses and CIDR blocks in the whitelist.'."\n"
+ .'* 1: adds the IP addresses and CIDR blocks to the whitelist.'."\n"
+ .'* 2: removes the IP addresses and CIDR blocks from the whitelist.'."\n"
+ ."\n"
+ .'> We recommend that you set the value to 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'xxx-xxx-xxx'],
'Data' => [
- 'title' => '',
- 'description' => '',
+ 'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
- 'Templates' => [
- 'title' => '白名单模板列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '模板详情',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'TemplateName' => [
- 'title' => '白名单模板名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'demo_template',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'description' => '',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
- ],
- ],
- ],
+ 'GroupName' => ['description' => 'The name of the whitelist.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'SecurityIPType' => ['description' => 'The IP address type.'."\n", 'type' => 'string', 'example' => 'ipv4', 'title' => ''],
+ 'GroupTag' => ['description' => 'The tag of the whitelist.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", 'type' => 'string', 'example' => '192.168.0.0/24,172.16.0.0/24', 'title' => ''],
+ 'DBInstanceID' => ['description' => 'The cluster ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxx', 'title' => ''],
+ 'WhitelistNetType' => ['description' => 'The network type of the whitelist.'."\n", 'type' => 'string', 'example' => 'mix', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'cc-xxxx', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidSecurityIPs.Malformed',
- 'errorMessage' => 'Specified IPList is not valid.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplateName.Duplicated',
- 'errorMessage' => 'Whitelist template name duplicated.',
- ],
- [
- 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded',
- 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.',
- ],
- [
- 'errorCode' => 'InvalidSecurityIPList.Format',
- 'errorMessage' => 'Specified security IP list format is not valid.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplateName.CreateLimit',
- 'errorMessage' => 'Created Whitelist template name exceeded limit.',
- ],
- [
- 'errorCode' => 'InvalidIpWhitelistTemplateName.Malformed',
- 'errorMessage' => 'The templateName is not valid.',
- ],
- [
- 'errorCode' => 'InvalidSecurityIPList.Duplicate',
- 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list',
- ],
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'Specified user does not exist.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- ],
- 'DetachWhitelistTemplateToInstance' => [
- 'summary' => '取消白名单模板和实例关联关系',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'ModifySecurityIPList',
+ 'summary' => 'Modifies the whitelist settings of an ApsaraDB for ClickHouse cluster.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifySecurityIPList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"TaskId\\": 1,\\n \\"SecurityIPList\\": \\"192.168.0.0/24,172.16.0.0/24\\",\\n \\"DBInstanceID\\": 0,\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"cc-xxxx\\"\\n }\\n}","type":"json"}]',
+ 'operationType' => 'readAndWrite',
+ ],
+ 'ResetAccountPassword' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6761,185 +6766,97 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '185276',
+ 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'],
],
'parameters' => [
[
+ 'name' => 'DBInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'TemplateId',
+ 'name' => 'Account',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单模板Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '98a6d3db05984dca',
- ],
+ 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
],
[
- 'name' => 'DBInstanceId',
+ 'name' => 'Password',
'in' => 'query',
- 'schema' => [
- 'title' => '数据库实例名。逗号分隔，一次关联变更不超过20个',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s',
- ],
+ 'schema' => ['description' => 'The password of the database account. The password must meet the following requirements:'."\n"
+ ."\n"
+ .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
+ .'- The following special characters are supported: ! @ # $ % ^ & * ( ) _ + - ='."\n"
+ .'- The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => '123456Aa', 'title' => ''],
+ ],
+ [
+ 'name' => 'Product',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5A6A077A-577C-536E-AC13-8E715D7A34C8'],
'Data' => [
- 'title' => '',
+ 'description' => 'The result returned.'."\n",
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '操作状态。ok',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'DetachFailList' => [
- 'title' => '解绑失败实例',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例解绑失败详情',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'example' => 'my-database',
- ],
- 'Reason' => [
- 'title' => '解绑失败原因',
- 'type' => 'string',
- 'example' => '处理异常',
- ],
- ],
- ],
- ],
- 'DetachSuccessedList' => [
- 'title' => '绑定成功模板',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例绑定成功详情',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'example' => 'my-database',
- ],
- 'Templates' => [
- 'title' => '白名单模板列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '模板详情',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'TemplateName' => [
- 'title' => '白名单模板名称',
- 'type' => 'string',
- 'example' => 'demo_template',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
- 'DbInstances' => [
- 'title' => '关联的实例列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例详情',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例ID',
- 'type' => 'string',
- 'example' => 'asdfwef',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'DBInstanceId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'Account' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplateId',
- 'errorMessage' => 'Invalid Whitelist templateId.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission',
- 'errorMessage' => 'No permission to operate the whitelist template.',
- ],
- [
- 'errorCode' => 'InvalidDBInstanceId.TooManyItems',
- 'errorMessage' => 'The number of DBInstanceId should be no more than 20.',
- ],
- [
- 'errorCode' => 'InvalidParameter.DBInstanceId',
- 'errorMessage' => 'The specified parameter DBInstanceId is not valid.',
- ],
+ 403 => [
+ ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The passed instance ID does not exist.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- ],
- 'UpdateWhitelistTemplate' => [
- 'summary' => '更新白名单模板',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'ResetAccountPassword',
+ 'summary' => 'Resets the password of a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ResetAccountPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6A077A-577C-536E-AC13-8E715D7A34C8\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ResetLangfuseUserPassword' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6950,888 +6867,1249 @@
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '182031',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'TemplateId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单模板Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '98a6d3db05984dca',
- ],
+ 'schema' => ['description' => 'The Langfuse instance ID.', 'type' => 'string', 'required' => true, 'example' => 'lfs-****', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'Email',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单模板Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '98a6d3db05984dca',
- ],
+ 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'john@company.com', 'title' => ''],
],
[
- 'name' => 'SecurityIPList',
+ 'name' => 'NewPassword',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单列表. 逗号分隔，数量不超过100个。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '192.168.1.1,10.0.0.1',
- ],
+ 'schema' => ['description' => 'The new user password. The password must meet the following rules:'."\n"
+ ."\n"
+ .'The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
+ ."\n"
+ .'The supported special characters are !@#$%^&*()_+-=.'."\n"
+ ."\n"
+ .'The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => '2F9e9@******', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'],
'Data' => [
'title' => '',
+ 'description' => 'The response result.',
'type' => 'object',
'properties' => [
- 'Templates' => [
- 'title' => '白名单模板列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '模板详情',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
- 'DbInstances' => [
- 'title' => '关联的实例列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例详情',
- 'type' => 'object',
- 'properties' => [
- 'DbInstanceName' => [
- 'title' => '实例ID',
- 'type' => 'string',
- 'example' => 'asdfwef',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Email' => ['description' => 'The email address of the user.', 'type' => 'string', 'example' => 'john@company.com', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidSecurityIPs.Malformed',
- 'errorMessage' => 'Specified IPList is not valid.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplateId',
- 'errorMessage' => 'Invalid Whitelist templateId.',
- ],
- [
- 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded',
- 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission',
- 'errorMessage' => 'No permission to operate the whitelist template.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- ],
- 'GetWhitelistTemplate' => [
- 'summary' => '查询白名单模板详情',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
+ 'title' => 'Reset langfuse user password',
+ 'summary' => 'Resets the password of a Langfuse user.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'RestartDBInstance' => [
+ 'summary' => 'Restarts an ApsaraDB for ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '192305',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'TemplateId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '白名单模板Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '98a6d3db05984dca',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'],
'Data' => [
- 'title' => '',
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'Templates' => [
- 'title' => '白名单模板列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '模板详情',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'TemplateName' => [
- 'title' => '白名单模板名称',
- 'type' => 'string',
- 'example' => 'demo_template',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
- 'DbInstances' => [
- 'title' => '关联的实例列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例详情',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例ID',
- 'type' => 'string',
- 'example' => 'cc-asdfwef',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100001080', 'title' => ''],
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Enterprise edition cluster test', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplateId',
- 'errorMessage' => 'Invalid Whitelist templateId.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission',
- 'errorMessage' => 'No permission to operate the whitelist template.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- ],
- 'AttachWhitelistTemplateToInstance' => [
- 'summary' => '白名单模板关联实例',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100001080,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Enterprise edition cluster test\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'RestartDBInstance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:RestartDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'StartDBInstance' => [
+ 'summary' => 'Starts an ApsaraDB for ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeCode' => '189351',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'description' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'TemplateId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '白名单模板Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '98a6d3db05984dca',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76'],
+ 'Data' => [
+ 'description' => 'The data returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000837', 'title' => ''],
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Enterprise edition cluster test', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000837,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Enterprise edition cluster test\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'StartDBInstance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:StartDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'translator' => 'manual',
+ ],
+ 'StopDBInstance' => [
+ 'summary' => 'Stops an ApsaraDB for ClickHouse Enterprise Edition cluster.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '189348',
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
[
'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '数据库实例。逗号分隔，一次关联变更不超过20个',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'],
'Data' => [
- 'title' => '',
- 'description' => '',
+ 'description' => 'The data returned.',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '操作状态。ok',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'AttachFailList' => [
- 'title' => '解绑失败实例',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例解绑失败详情',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'my-database',
- ],
- 'Reason' => [
- 'title' => '解绑失败原因',
- 'description' => '',
- 'type' => 'string',
- 'example' => '处理异常',
- ],
- ],
- ],
- ],
- 'AttachSuccessedList' => [
- 'title' => '绑定成功模板',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例绑定成功详情',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'my-database',
- ],
- 'Templates' => [
- 'title' => '白名单模板列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '模板详情',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'TemplateName' => [
- 'title' => '白名单模板名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'demo_template',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'description' => '',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
- 'DbInstances' => [
- 'title' => '关联的实例列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '实例详情',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'asdfwef',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000785', 'title' => ''],
+ 'DBInstanceID' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****', 'title' => ''],
+ 'DBInstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Enterprise edition cluster test', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplateId',
- 'errorMessage' => 'Invalid Whitelist templateId.',
- ],
- [
- 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission',
- 'errorMessage' => 'No permission to operate the whitelist template.',
- ],
- [
- 'errorCode' => 'InvalidDBInstanceId.TooManyItems',
- 'errorMessage' => 'The number of DBInstanceId should be no more than 20.',
- ],
- [
- 'errorCode' => 'InvalidParameter.DBInstanceId',
- 'errorMessage' => 'The specified parameter DBInstanceId is not valid.',
- ],
- [
- 'errorCode' => 'InvalidAttachTemplate.QuotaExceeded',
- 'errorMessage' => 'Exceed the upper limit of the template that the instance can bind.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"AttachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"AttachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
- ],
- 'ListWhitelistTemplates' => [
- 'summary' => '查询白名单模板清单',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000785,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Enterprise edition cluster test\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'StopDBInstance',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:StopDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'UpdateWhitelistTemplate' => [
+ 'summary' => 'Updates a whitelist template.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'TemplateId',
'in' => 'query',
- 'schema' => [
- 'title' => '模板名称，支持模糊查询',
- 'type' => 'string',
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The whitelist template ID.', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'TemplateName',
'in' => 'query',
- 'schema' => [
- 'title' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The whitelist template name.', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SecurityIPList',
'in' => 'query',
- 'schema' => [
- 'title' => '每页记录数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '25',
- 'default' => '25',
- ],
+ 'schema' => ['description' => 'The IP address whitelist. You can add up to 100 IP addresses, separated by commas.', 'type' => 'string', 'required' => true, 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''],
'Data' => [
- 'title' => '白名单模板清单结果',
+ 'title' => '',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageSize' => [
- 'title' => '分页数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CurrPageNumbers' => [
- 'title' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalPageNumbers' => [
- 'title' => '总页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'HasPrev' => [
- 'title' => '是否有前一页',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'HasNext' => [
- 'title' => '是否有后一页',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'Templates' => [
- 'title' => '白名单模板列表',
'type' => 'array',
'items' => [
- 'title' => '模板详情',
'type' => 'object',
'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'TemplateName' => [
- 'title' => '白名单模板ID',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
+ 'TemplateId' => ['description' => 'The whitelist template ID.', 'type' => 'string', 'example' => 'g-asdfwem', 'title' => ''],
+ 'SecurityIPList' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', 'title' => ''],
'DbInstances' => [
- 'title' => '关联的实例列表',
'type' => 'array',
'items' => [
- 'title' => '实例详情',
'type' => 'object',
'properties' => [
- 'DBInstanceId' => [
- 'title' => '实例ID',
- 'type' => 'string',
- 'example' => 'cc-asdfwef',
- ],
+ 'DbInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'asdfwef', 'title' => ''],
],
+ 'description' => 'The details of an instance.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The list of associated instances.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'The details of a template.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The list of whitelist templates.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'The details of the whitelist template.',
+ 'example' => '',
],
],
+ 'description' => 'The returned data.',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
+ ['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'Specified IPList is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''],
+ ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => ''],
+ ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- ],
- 'ListInstanceLinkedWhitelistTemplates' => [
- 'summary' => '查询实例关联的白名单模板清单',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'UpdateWhitelistTemplate',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:UpdateWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DbInstanceName\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'UpgradeMinorVersion' => [
+ 'summary' => 'Updates the minor engine version of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '185639',
- 'abilityTreeNodes' => [
- 'FEATUREclickhouseCVENTL',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '196979',
+ 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'DBInstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => 'RegionId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc-bp1jyis8p15we****'],
],
[
- 'name' => 'DBInstanceId',
+ 'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => [
- 'title' => '实例名称',
+ 'title' => '',
+ 'description' => 'Specifies whether to update the minor engine version of the cluster immediately. Valid values:'."\n"
+ ."\n"
+ .'* **Immediate**: The system immediately performs the update.'."\n"
+ .'* **MaintainTime**: The system performs the update during the specified maintenance window.'."\n"
+ .'* **SpecifyTime**: The system performs the update at a specified time.'."\n",
'type' => 'string',
- 'required' => true,
- 'example' => 'cc-exadfas',
+ 'required' => false,
+ 'example' => 'Immediate',
+ 'default' => 'Immediate',
+ 'enum' => ['Immediate', 'MaintainTime', 'SpecifyTime'],
],
],
+ [
+ 'name' => 'SwitchTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n"
+ ."\n"
+ .'> If you set SwitchTimeMode to SpecifyTime, you must configure this parameter to specify the update time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-01-09T05:00:00Z'],
+ ],
+ [
+ 'name' => 'TargetMinorVersion',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The minor engine version to which you want to update.'."\n"
+ ."\n"
+ .'> By default, TargetMinorVersion is not set and the minor engine version of the cluster is updated to the latest version.'."\n", 'type' => 'string', 'required' => false, 'example' => '23.8.1.41495_6'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7'],
'Data' => [
- 'title' => '白名单模板清单结果',
+ 'description' => 'The returned result.'."\n",
'type' => 'object',
'properties' => [
- 'Templates' => [
- 'title' => '白名单模板列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '模板详情',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '白名单模板ID',
- 'type' => 'string',
- 'example' => 'g-asdfwem',
- ],
- 'TemplateName' => [
- 'title' => '白名单模板名称',
- 'type' => 'string',
- 'example' => 'demo_template',
- ],
- 'SecurityIPList' => [
- 'title' => 'ip白名单列表',
- 'type' => 'string',
- 'example' => '192.168.1.1,10.0.0.1',
- ],
- ],
- ],
- ],
+ 'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'cc-uf6x229yeq166****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Invalid parameter.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
+ 'title' => 'UpgradeMinorVersion',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:UpgradeMinorVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"cc-uf6x229yeq166****\\"\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-6',
- 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-central-1',
- 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'clickhouse.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'clickhouse.aliyuncs.com',
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-qingdao.aliyuncs.com', 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-hongkong.aliyuncs.com', 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.ap-northeast-1.aliyuncs.com', 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-chengdu.aliyuncs.com', 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.ap-southeast-1.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.ap-southeast-5.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.ap-southeast-6.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-6.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'clickhouse.us-east-1.aliyuncs.com', 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'clickhouse.eu-west-1.aliyuncs.com', 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.eu-west-1.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'clickhouse.us-west-1.aliyuncs.com', 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'clickhouse.eu-central-1.aliyuncs.com', 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'clickhouse.me-central-1.aliyuncs.com', 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.me-central-1.aliyuncs.com'],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou-finance.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'Account is not found.', 'http_code' => 404, 'description' => 'No corresponding account found.'],
+ ['code' => 'ACTION_UNAUTHORIZED', 'message' => 'The account balance is insufficient, and the opening of the public network needs to rely on load balancing service, which requires that the account balance must be greater than 100 yuan.', 'http_code' => 403, 'description' => 'The account balance is insufficient, and the opening of the public network needs to rely on load balancing service, which requires that the account balance must be greater than 100 yuan.'],
+ ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Invalid component for commodity.', 'http_code' => 500, 'description' => 'The order configuration parameters do not meet the verification conditions, please re-match the product.'],
+ ['code' => 'DescribeLorneLogException', 'message' => 'Cannot find taskDetail in Lorne.', 'http_code' => 500, 'description' => 'The task details of the corresponding SLS were not found.'],
+ ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'The account is not granted permission to manipulate the resource'],
+ ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => 'The resource is out of usage.'],
+ ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An error occurred while processing your request.'],
+ ['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => 'An internal system error occurred with this request.'],
+ ['code' => 'InvalidAccountName.NotFound', 'message' => 'Specified account name does not exist.', 'http_code' => 404, 'description' => 'The specified account name does not exist.'],
+ ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter "BackupRetentionPeriod" is not valid.', 'http_code' => 400, 'description' => 'The request parameter BackupRetentionPeriod is invalid.'],
+ ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The DBClusterId provided does not exist in our records.'],
+ ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The passed instance ID does not exist.'],
+ ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The passed instance ID does not exist.'],
+ ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'No valid instance found'],
+ ['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter "PageNumber" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter PageNumber is invalid.'],
+ ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter "PageSize" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter "PageSize" is not valid.'],
+ ['code' => 'InvalidParameter.DBClusterVersion', 'message' => 'The version is invalid. Check whether the DBClusterVersion, MinorVersion, and MajorVersion parameters are correct.', 'http_code' => 400, 'description' => 'The version is invalid. Check whether the DBClusterVersion, MinorVersion, and MajorVersion parameters are correct.'],
+ ['code' => 'InvalidParameter.DBNodeStorage', 'message' => 'The specified parameter "DBNodeStorage" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter "DBNodeStorage" is invalid.'],
+ ['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter "RegionId" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter RegionId is invalid.'],
+ ['code' => 'InvalidSecurityIPs.Exceeded', 'message' => 'The specified parameter "SecurityIps" count is exceeded 200.', 'http_code' => 400, 'description' => 'The total number of security group IP addresses exceeds 200.'],
+ ['code' => 'InvalidVPC.NotFound', 'message' => 'VPC or VSwitch is not valid.', 'http_code' => 404, 'description' => 'The VPC ID passed in does not exist.'],
+ ['code' => 'InvalidVpcId.Malformed', 'message' => 'The specified parameter "VpcId" is not valid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ModifyServerConfigFailed', 'message' => 'Failed to modify server config.', 'http_code' => 500, 'description' => 'Failed to modify instance configuration.'],
+ ['code' => 'OperationDenied.CKNotConnected', 'message' => 'Connect to ClickHouse Cluster Failed.', 'http_code' => 403, 'description' => 'Failed to connect to ClickHouse. Check the ClickHouse status, whitelist, and connectivity.'],
+ ['code' => 'OperationDenied.VirtualWarehouseShardsAlign', 'message' => 'The operation is not permitted due to virtualWarehouse shards align.', 'http_code' => 403, 'description' => 'The operation is not permitted due to virtualWarehouse shards align.'],
+ ['code' => 'PRICE.PRICING_PLAN_RESULT_NOT_FOUND', 'message' => 'Cannot find pricing plan for the commodity.', 'http_code' => 500, 'description' => 'Pricing plan not found.'],
+ ['code' => 'ServiceUnavailable', 'message' => 'An error occurred while processing your request.', 'http_code' => 503, 'description' => 'An error occurred while processing your request.'],
+ ['code' => 'UNAVAILABLE', 'message' => 'Service Unavailable.', 'http_code' => 502, 'description' => 'Service not available.'],
+ ['code' => 'UNKNOWN', 'message' => 'Unknown error.', 'http_code' => 500, 'description' => 'Unknown error.'],
+ ['code' => 'UserNotInBuyWhiteList', 'message' => 'ClickHouse is at the canary release stage. Please apply for use by submitting a ticket.', 'http_code' => 500, 'description' => 'ClickHouse is at the canary release stage. Please apply for use by submitting a ticket.'],
+ ['code' => 'InvalidSpecification', 'message' => 'Specification parameter is not valid.', 'http_code' => 400, 'description' => 'The specification parameter is invalid.'],
+ ['code' => 'InvalidDBInstanceStatus', 'message' => 'The specified instance state does\'t support this operation.', 'http_code' => 400, 'description' => 'The instance state does not allow the current operation.'],
+ ['code' => 'OperationDenied.OrderProcessing', 'message' => 'The operation is not permitted due to there is an order in processing of cluster.', 'http_code' => 400, 'description' => 'There is an outstanding order, please try again later.'],
+ ['code' => 'OperationDenied.NothingChanged', 'message' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.', 'http_code' => 400, 'description' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.'],
+ ['code' => 'StorageTypeDoNotSupportBackup', 'message' => 'Current StorageType Does Not Support Backup.', 'http_code' => 400, 'description' => 'The current storage type does not support backup'],
+ ],
+ 'changeSet' => [],
+ 'ram' => [
+ 'productCode' => 'ClickHouse',
+ 'productName' => 'ApsaraDB for ClickHouse',
+ 'ramCodes' => ['clickhouse'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [
+ [
+ 'name' => 'clickhouse:EncryptionType',
+ 'schema' => ['type' => 'Array<String>', 'description' => '加密类型'],
+ ],
],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com',
+ 'ramActions' => [
+ [
+ 'apiName' => 'DescribeDBInstanceAttribute',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDBInstanceConfigChangeLog',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceConfigChangeLog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopDBInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:StopDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWhitelistTemplate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDBInstanceConnectionString',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceConnectionString',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDBInstanceDataSources',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceDataSources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDB',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateDB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifySecurityIPList',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifySecurityIPList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyAccountAuthority',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyAccountAuthority',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeAccountAuthority',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeAccountAuthority',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ChangeResourceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ChangeResourceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpgradeMinorVersion',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:UpgradeMinorVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstanceLinkedWhitelistTemplates',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ListInstanceLinkedWhitelistTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListClickHouseDBTimezones',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ListClickHouseDBTimezones',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSlowLogTrend',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeSlowLogTrend',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyBackupPolicy',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteEndpoint',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DetachWhitelistTemplateToInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DetachWhitelistTemplateToInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeAccounts',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeAccounts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteBackupPolicy',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResetAccountPassword',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ResetAccountPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'KillProcess',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:KillProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDBInstanceClass',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceClass',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDBInstance',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDB',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteDB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWhitelistTemplates',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ListWhitelistTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateEndpoint',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackups',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeBackups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestartDBInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:RestartDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDBInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartDBInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:StartDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSlowLogRecords',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeSlowLogRecords',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateBackupPolicy',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeEndpoints',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeEndpoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRegions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeRegions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackupPolicy',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWhitelistTemplate',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyAccountDescription',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyAccountDescription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeProcessList',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeProcessList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSecurityIPList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeSecurityIPList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWhitelistTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:GetWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDBInstanceAttribute',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDBInstanceConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DescribeDBInstanceConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDBInstanceConfig',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'clickhouse:ModifyDBInstanceConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAccount',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'clickhouse:CreateAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AttachWhitelistTemplateToInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:AttachWhitelistTemplateToInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAccount',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDBInstance',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'clickhouse:DeleteDBInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWhitelistTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'clickhouse:UpdateWhitelistTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'clickhouse.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:42:43 +0000