summaryrefslogtreecommitdiff
path: root/data/en_us/cassandra
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/cassandra
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/cassandra')
-rw-r--r--data/en_us/cassandra/2019-01-01/api-docs.php6134
1 files changed, 2207 insertions, 3927 deletions
diff --git a/data/en_us/cassandra/2019-01-01/api-docs.php b/data/en_us/cassandra/2019-01-01/api-docs.php
index 6c96097..6922a76 100644
--- a/data/en_us/cassandra/2019-01-01/api-docs.php
+++ b/data/en_us/cassandra/2019-01-01/api-docs.php
@@ -1,148 +1,60 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Cassandra',
- 'version' => '2019-01-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Cassandra', 'version' => '2019-01-01'],
'directories' => [
[
- 'id' => 58458,
- 'title' => null,
+ 'children' => ['CreateDataCenter', 'ModifyInstanceType', 'DescribeClusterStatus', 'DescribeDeletedClusters', 'DescribeDataCenter', 'DescribeInstanceType', 'GetCmsUrl', 'PurgeCluster', 'RebootCluster', 'ResizeDiskSize', 'ResizeNodeCount', 'UpgradeClusterVersion'],
'type' => 'directory',
- 'children' => [
- 'CreateCluster',
- 'CreateDataCenter',
- 'DeleteCluster',
- 'ModifyCluster',
- 'ModifyInstanceMaintainTime',
- 'ModifyInstanceType',
- 'DescribeCluster',
- 'DescribeClusters',
- 'DescribeClusterStatus',
- 'DescribeDeletedClusters',
- 'DescribeDataCenter',
- 'DescribeInstanceType',
- 'GetCmsUrl',
- 'PurgeCluster',
- 'RebootCluster',
- 'ResizeDiskSize',
- 'ResizeNodeCount',
- 'UpgradeClusterVersion',
- ],
+ 'title' => 'Instance management',
],
[
- 'id' => 58477,
- 'title' => null,
+ 'children' => ['ModifyIpWhitelist', 'ModifyIpWhitelistGroup', 'ModifySecurityGroups', 'DescribeIpWhitelist', 'DescribeIpWhitelistGroups'],
'type' => 'directory',
- 'children' => [
- 'ModifyIpWhitelist',
- 'ModifyIpWhitelistGroup',
- 'ModifySecurityGroups',
- 'DescribeIpWhitelist',
- 'DescribeIpWhitelistGroups',
- 'DescribeSecurityGroups',
- ],
+ 'title' => 'Security management',
],
[
- 'id' => 58484,
- 'title' => null,
+ 'children' => ['DeleteDataCenter', 'ModifyDataCenter', 'DescribeDataCenters'],
'type' => 'directory',
- 'children' => [
- 'ModifyAccountPassword',
- 'DescribeAccounts',
- ],
+ 'title' => 'Zone management',
],
[
- 'id' => 58487,
- 'title' => null,
+ 'children' => ['CreateBackupPlan', 'DeleteBackupPlan', 'ModifyBackupPlan', 'DescribeBackup', 'DescribeBackupPlan', 'DescribeBackupPlans'],
'type' => 'directory',
- 'children' => [
- 'DeleteDataCenter',
- 'ModifyDataCenter',
- 'DescribeRegions',
- 'DescribeDataCenters',
- ],
+ 'title' => 'Backup management',
],
[
- 'id' => 58492,
- 'title' => null,
+ 'children' => ['DescribeContactPoints', 'AllocatePublicContactPoints', 'ReleasePublicContactPoints'],
'type' => 'directory',
- 'children' => [
- 'CreateBackupPlan',
- 'DeleteBackupPlan',
- 'ModifyBackupPlan',
- 'DescribeBackup',
- 'DescribeBackupPlan',
- 'DescribeBackups',
- 'DescribeBackupPlans',
- ],
+ 'title' => 'Endpoint management',
],
[
- 'id' => 58500,
- 'title' => null,
+ 'children' => ['DeleteNodeToolExecutionHistory', 'DescribeNodeToolExecutionHistory', 'DescribeNodeToolExecutionHistories', 'ExecuteNodeTool'],
'type' => 'directory',
- 'children' => [
- 'DescribeContactPoints',
- 'AllocatePublicContactPoints',
- 'ReleasePublicContactPoints',
- ],
- ],
- [
- 'id' => 58504,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'DeleteNodeToolExecutionHistory',
- 'DescribeNodeToolExecutionHistory',
- 'DescribeNodeToolExecutionHistories',
- 'ExecuteNodeTool',
- ],
+ 'title' => 'Nodetool',
],
[
- 'id' => 58509,
- 'title' => null,
+ 'children' => ['DescribeParameterModificationHistories'],
'type' => 'directory',
- 'children' => [
- 'ModifyParameter',
- 'DescribeParameterModificationHistories',
- 'DescribeParameters',
- ],
+ 'title' => 'Parameter management',
],
[
- 'id' => 58513,
- 'title' => null,
+ 'children' => ['DescribeClusterDashboard'],
'type' => 'directory',
- 'children' => [
- 'DescribeClusterDashboard',
- ],
+ 'title' => 'Dashboard management',
],
[
- 'id' => 58515,
- 'title' => null,
+ 'children' => ['CreateCluster', 'DeleteCluster', 'DescribeAccounts', 'DescribeBackups', 'DescribeCluster', 'DescribeClusters', 'DescribeParameters', 'DescribeRegions', 'DescribeSecurityGroups', 'ListTagResources', 'ListTags', 'ModifyAccountPassword', 'ModifyCluster', 'ModifyInstanceMaintainTime', 'ModifyParameter', 'MoveResourceGroup', 'TagResources', 'UnTagResources'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'ListTagResources',
- 'ListTags',
- 'UnTagResources',
- 'MoveResourceGroup',
- 'TagResources',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AllocatePublicContactPoints' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -150,223 +62,275 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'PayType',
+ 'name' => 'ClusterId',
'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1hy2i****2z46l', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the data center in the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Subscription',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'title' => 'Allocate public points of contact',
+ 'summary' => 'Allocates public points of contact by calling AllocatePublicContactPoints.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'CreateBackupPlan' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PeriodUnit',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the cluster to back up.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp11tjzh50****7b', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the data center of the cluster to back up.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' cn-hangzhou-g', 'title' => ''],
+ ],
+ [
+ 'name' => 'BackupTime',
'in' => 'query',
+ 'schema' => ['description' => 'The time when the backup starts each day. The time is in UTC and is indicated by the Z suffix.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '00:30Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'BackupPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.', 'type' => 'string', 'required' => false, 'example' => 'Monday', 'title' => ''],
+ ],
+ [
+ 'name' => 'RetentionPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of days to retain the backup. Valid values: 1 to 7.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
+ ],
+ [
+ 'name' => 'Active',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to activate the backup plan.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Year',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'title' => 'Create a backup plan',
+ 'summary' => 'Calls CreateBackupPlan to create a backup plan.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\"\\n}","type":"json"}]',
+ ],
+ 'CreateCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'- Subscription: subscription.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.'."\n"
+ ."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unit of the subscription duration for the instance. Valid values:'."\n"
+ ."\n"
+ .'- Year: year.'."\n"
+ .'- Month: month.'."\n"
+ ."\n"
+ .'> This parameter is required if PayType is set to Subscription.', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''],
+ ],
[
'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '12',
- ],
+ 'schema' => ['description' => 'The subscription duration. This parameter is required if PayType is set to Subscription. Unit: months. Valid values: 1 to 9, 12, 24, and 36.'."\n"
+ ."\n"
+ .'> This parameter is not supported if PayType is set to PayAsYouGo.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'title' => ''],
],
[
'name' => 'AutoRenew',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n"
+ ."\n"
+ .'- true: enables auto-renewal.'."\n"
+ .'- false: does not enable auto-renewal.'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The auto-renewal epoch. Unit: months. Valid values:'."\n"
+ ."\n"
+ .'- 1'."\n"
+ .'- 2'."\n"
+ .'- 3'."\n"
+ .'- 6'."\n"
+ .'- 12'."\n"
+ ."\n"
+ .'> This parameter is required if AutoRenew is set to true.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'example' => '3',
'default' => '',
- 'enum' => [
- '1',
- '2',
- '3',
- '6',
- '12',
- ],
+ 'enum' => ['1', '2', '3', '6', '12'],
+ 'example' => '3',
+ 'title' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-h',
- ],
+ 'schema' => ['description' => 'The zone ID. You can call the DescribeRegions operation to query available zone IDs. Use this parameter to specify the zone in which to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-h', 'title' => ''],
],
[
'name' => 'ClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'apitest',
- ],
+ 'schema' => ['description' => 'The cluster name.'."\n"
+ ."\n"
+ .'The name must be 2 to 128 characters in length and must start with an uppercase letter, a lowercase letter, or a Chinese character. The name can contain digits, periods (.), underscores (_), or hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''],
],
[
'name' => 'DataCenterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'apitest',
- ],
+ 'schema' => ['description' => 'The data center name.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''],
],
[
'name' => 'MajorVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3.11',
- ],
+ 'schema' => ['description' => 'The major version number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3.11', 'title' => ''],
],
[
'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cassandra.c.xlarge',
- ],
+ 'schema' => ['description' => 'The instance type of the cluster. Examples of valid values:'."\n"
+ ."\n"
+ .'- cassandra.c.large: 2 vCPUs, 4 GB memory.'."\n"
+ .'- cassandra.c.xlarge: 4 vCPUs, 8 GB memory.'."\n"
+ .'- cassandra.c.2xlarge: 8 vCPUs, 16 GB memory.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cassandra.c.xlarge', 'title' => ''],
],
[
'name' => 'NodeCount',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3',
- ],
+ 'schema' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3', 'title' => ''],
],
[
'name' => 'DiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The storage type of the cloud disk. Examples of valid values:'."\n"
+ ."\n"
+ .'- cloud_ssd: standard SSD.'."\n"
+ .'- cloud_essd: Enterprise SSD (ESSD).'."\n"
+ .'- cloud_efficiency: ultra cloud disk.'."\n"
+ .'- local_ssd_pro: local SSD.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
],
[
'name' => 'DiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '160',
- ],
+ 'schema' => ['description' => 'The storage size per node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '160', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vpc-bp1oxxxxxxxxxxgzv26cd',
- ],
+ 'schema' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1oxxxxxxxxxxgzv26cd', 'title' => ''],
],
[
'name' => 'VswitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-oqscxxxxxxxxxxxxx5e8c',
- ],
+ 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-oqscxxxxxxxxxxxxx5e8c', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Alibaba****!@#',
- ],
+ 'schema' => ['description' => 'The password.'."\n"
+ ."\n"
+ .'The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !@#$%^&*()_+-=.', 'type' => 'string', 'required' => false, 'example' => 'Alibaba****!@#', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-xxxxxx',
- ],
+ 'schema' => ['description' => 'The ID of the resource group. If this parameter is not specified, the instance is added to the default resource group. You can view the resource group ID in the Resource Management console.', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxxx', 'title' => ''],
],
],
'responses' => [
@@ -374,37 +338,30 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1hy2ip****z46g',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3E19E345-101D-4014-946C-A2055AEE1F26',
- ],
+ 'ClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cds-bp1hy2ip****z46g', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E19E345-101D-4014-946C-A2055AEE1F26', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClusterId\\": \\"cds-bp1hy2ip****z46g\\",\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-A2055AEE1F26\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateClusterResponse>\\n<ClusterId>hb-bp16o0pd5****582s</ClusterId>\\n<RequestId>728C7EAF-4844-4D42-9BBE-DFFFBB77CF33</RequestId>\\n</CreateClusterResponse>","errorExample":""}]',
- 'title' => 'Create Instance',
- 'summary' => 'Create a Cassandra instance.',
+ 'title' => 'Create an instance',
+ 'summary' => 'Creates a Cassandra instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterId\\": \\"cds-bp1hy2ip****z46g\\",\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-A2055AEE1F26\\"\\n}","type":"json"}]',
],
'CreateDataCenter' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -412,212 +369,145 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'PayType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Subscription',
- ],
+ 'schema' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'- Subscription: subscription.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.'."\n"
+ ."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription', 'title' => ''],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Year',
- ],
+ 'schema' => ['description' => 'The unit of the subscription duration. Valid values:'."\n"
+ ."\n"
+ .'- Year: year.'."\n"
+ .'- Month: month.'."\n"
+ ."\n"
+ .'> This parameter is required if PayType is set to Subscription.', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The subscription duration. This parameter is required if PayType is set to Subscription. Unit: months. Valid values: 1 to 9, 12, 24, and 36.'."\n"
+ ."\n"
+ .'> This parameter is not supported if PayType is set to PayAsYouGo.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
+ 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8', '9', '12', '24', '36'],
'example' => '12',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- '9',
- '12',
- '24',
- '36',
- ],
+ 'title' => '',
],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n"
+ ."\n"
+ .'- true: enables auto-renewal.'."\n"
+ .'- false: does not enable auto-renewal.'."\n"
+ ."\n"
+ .'Default value: false.',
'type' => 'boolean',
'required' => false,
- 'example' => 'true',
'default' => 'false',
- 'enum' => [
- 'true',
- 'false',
- ],
+ 'enum' => ['true', 'false'],
+ 'example' => 'true',
+ 'title' => '',
],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The auto-renewal epoch. Unit: months. Valid values:'."\n"
+ ."\n"
+ .'- 1'."\n"
+ .'- 2'."\n"
+ .'- 3'."\n"
+ .'- 6'."\n"
+ .'- 12'."\n"
+ ."\n"
+ .'> This parameter is required if AutoRenew is set to true.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
+ 'enum' => ['1', '2', '3', '4', '5', '6', '12'],
'example' => '12',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '12',
- ],
+ 'title' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'ETnLKlblzczshOTUbOC***ioIUBoiB',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ETnLKlblzczshOTUbOC***ioIUBoiB', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-h',
- ],
+ 'schema' => ['description' => 'The zone ID. You can call the DescribeRegions operation to query available zones. Use this parameter to specify the zone in which to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-h', 'title' => ''],
],
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp113rmn****2uy9',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp113rmn****2uy9', 'title' => ''],
],
[
'name' => 'DataCenterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'apitest',
- ],
+ 'schema' => ['description' => 'The name of the data center.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''],
],
[
'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cassandra.c.large',
- ],
+ 'schema' => ['description' => 'The instance type of the cluster. Example valid values:'."\n"
+ ."\n"
+ .'- cassandra.c.large: 2 vCPUs, 4 GB memory.'."\n"
+ .'- cassandra.c.xlarge: 4 vCPUs, 8 GB memory.'."\n"
+ .'- cassandra.c.2xlarge: 8 vCPUs, 16 GB memory.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cassandra.c.large', 'title' => ''],
],
[
'name' => 'NodeCount',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
[
'name' => 'DiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The storage type of the cloud disk. Example valid values:'."\n"
+ ."\n"
+ .'- cloud_ssd: standard SSD.'."\n"
+ .'- cloud_essd: Enterprise SSD (ESSD).'."\n"
+ .'- cloud_efficiency: ultra cloud disk.'."\n"
+ .'- local_ssd_pro: local SSD.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
],
[
'name' => 'DiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '160',
- ],
+ 'schema' => ['description' => 'The storage size per node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '160', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vpc-bp1oxxxxxxxxxxgzv26cf',
- ],
+ 'schema' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1oxxxxxxxxxxgzv26cf', 'title' => ''],
],
[
'name' => 'VswitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-oqscxxxxxxxxxxxxx5e8c',
- ],
+ 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-oqscxxxxxxxxxxxxx5e8c', 'title' => ''],
],
],
'responses' => [
@@ -625,36 +515,30 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-g',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3E19E345-101D-4014-946C-A2055AEE1F26',
- ],
+ 'DataCenterId' => ['description' => 'The ID of the data center in the cluster.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E19E345-101D-4014-946C-A2055AEE1F26', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\",\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-A2055AEE1F26\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDataCenterResponse>\\n<DataCenterId>cn-hangzhou-g</DataCenterId>\\n<RequestId>728C7EAF-4844-4D42-9BBE-DFFFBB77CF33</RequestId>\\n</CreateDataCenterResponse>","errorExample":""}]',
- 'title' => 'CreateDataCenter',
+ 'title' => 'Add a data center to a cluster',
+ 'summary' => 'Adds a data center to a cluster by calling CreateDataCenter.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\",\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-A2055AEE1F26\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteBackupPlan' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -662,20 +546,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1hy2ipk****46k',
- ],
+ 'schema' => ['description' => 'The ID of the cluster to back up.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp11tjzh50****7c', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the data center of the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' cn-hangzhou-g', 'title' => ''],
],
],
'responses' => [
@@ -683,31 +564,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EC9C10D0-B12F-41B0-A237-968848BBC167',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC9C10D0-B12F-41B0-A237-968848BBC167\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteClusterResponse>\\r\\n <RequestId>EC9C10D0-B12F-41B0-A237-968848BBC167</RequestId>\\r\\n</DeleteClusterResponse>","errorExample":""}]',
- 'title' => 'DeleteCluster',
+ 'title' => 'Delete a backup plan',
+ 'summary' => 'Calls DeleteBackupPlan to delete a backup plan.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -715,38 +594,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => ' cds-bp1b136j****5d58',
- ],
- ],
- [
- 'name' => 'ClusterName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cassandra_test',
- ],
- ],
- [
- 'name' => 'ConfirmProductOffline',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1hy2ipk****46k', 'title' => ''],
],
],
'responses' => [
@@ -754,30 +607,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '39F3F7DF-435B-47C1-832C-369BF9661A67',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EC9C10D0-B12F-41B0-A237-968848BBC167', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"39F3F7DF-435B-47C1-832C-369BF9661A67\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyClusterResponse>\\r\\n<RequestId>39F3F7DF-435B-47C1-832C-369BF9661A67</RequestId>\\r\\n</ModifyClusterResponse>","errorExample":""}]',
- 'title' => 'ModifyCluster',
+ 'errorCodes' => [],
+ 'title' => 'Delete a cluster with a specified ID',
+ 'summary' => 'Calls DeleteCluster to delete a cluster with a specified ID.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyInstanceMaintainTime' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC9C10D0-B12F-41B0-A237-968848BBC167\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteDataCenter' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -785,42 +637,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b**6jco895****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp11tjzh50****7d', 'title' => ''],
],
[
- 'name' => 'MaintainStartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2:00',
- ],
- ],
- [
- 'name' => 'MaintainEndTime',
+ 'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4:00',
- ],
+ 'schema' => ['description' => 'The cluster data center ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''],
],
],
'responses' => [
@@ -828,31 +655,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C9085433-A56A-4089-B49A-DF5A4E2B7B06',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2B7B06\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceMaintainTimeResponse>\\r\\n<RequestId>C9085433-A56A-4089-B49A-DF5A4E2B7B06</RequestId>\\r\\n</ModifyInstanceMaintainTimeResponse>","errorExample":""}]',
- 'title' => 'ModifyInstanceMaintainTime',
+ 'title' => 'Delete a cluster data center',
+ 'summary' => 'Calls DeleteDataCenter to delete a cluster data center.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyInstanceType' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteNodeToolExecutionHistory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -860,42 +685,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-uf6ig2gf****7pw7',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-3872l6py****n4ug', 'title' => ''],
],
[
- 'name' => 'DataCenterId',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai-e',
- ],
+ 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-QdKa51s****U0gHf', 'title' => ''],
],
[
- 'name' => 'InstanceType',
+ 'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cassandra.g.xlarge',
- ],
+ 'schema' => ['description' => 'The ID of the data center in the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-f', 'title' => ''],
],
],
'responses' => [
@@ -903,31 +708,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BC262FE3-91ED-4FE7-BD75-190B62D8BABC',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D72B6BAC-BB95-48DA-99A9-A9903CD02498', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC262FE3-91ED-4FE7-BD75-190B62D8BABC\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceTypeResponse>\\r\\n<RequestId>BC262FE3-91ED-4FE7-BD75-190B62D8BABC</RequestId>\\r\\n</ModifyInstanceTypeResponse>","errorExample":""}]',
- 'title' => 'ModifyInstanceType',
+ 'title' => 'Delete nodetool execution history',
+ 'summary' => 'Calls DeleteNodeToolExecutionHistory to delete a nodetool execution history record.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D72B6BAC-BB95-48DA-99A9-A9903CD02498\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeAccounts' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -935,20 +738,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d58',
- ],
+ 'schema' => ['description' => 'The ID of the instance to which the accounts belong.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136jco79****', 'title' => ''],
],
],
'responses' => [
@@ -956,146 +751,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '17E2B462-5FD3-4A0C-AF13-225C66E47BD5',
- ],
- 'Cluster' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9BA1F8A4-12CC-4638-A7EC-D8FA2768D223', 'title' => ''],
+ 'Accounts' => [
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-20T16:02:34Z',
- ],
- 'MaintainStartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2:00Z',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PayAsYouGo',
- ],
- 'MaintainEndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4:00Z',
- ],
- 'LockMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'AutoRenewPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'MinorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3.11.7',
- ],
- 'DataCenterCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'IsLatestVersion' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'AutoRenewal' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-xxxxxxxxxxx',
- ],
- 'ClusterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cassandra-test',
- ],
- 'ConfirmProductOffline' => [
- 'type' => 'boolean',
- ],
- 'MajorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3.11',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-09-20T16:02:34Z',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1b136j****5d56',
- ],
- 'Tags' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Tag' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-key',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-value',
- ],
- ],
- ],
+ 'Account' => [
+ 'description' => 'The collection of account information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17E2B462-5FD3-4A0C-AF13-225C66E47BD5\\",\\n \\"Cluster\\": {\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2019-10-20T16:02:34Z\\",\\n \\"MaintainStartTime\\": \\"2:00Z\\",\\n \\"PayType\\": \\"PayAsYouGo\\",\\n \\"MaintainEndTime\\": \\"4:00Z\\",\\n \\"LockMode\\": \\"None\\",\\n \\"AutoRenewPeriod\\": 12,\\n \\"MinorVersion\\": \\"3.11.7\\",\\n \\"DataCenterCount\\": 1,\\n \\"IsLatestVersion\\": true,\\n \\"AutoRenewal\\": true,\\n \\"ResourceGroupId\\": \\"rg-xxxxxxxxxxx\\",\\n \\"ClusterName\\": \\"Cassandra-test\\",\\n \\"MajorVersion\\": \\"3.11\\",\\n \\"CreatedTime\\": \\"2019-09-20T16:02:34Z\\",\\n \\"ClusterId\\": \\"cds-bp1b136j****5d56\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>17E2B462-5FD3-4A0C-AF13-225C66E47BD5</RequestId>\\n<Cluster>\\n <Status>Running</Status>\\n <MajorVersion>3.11</MajorVersion>\\n <AutoRenewPeriod>12</AutoRenewPeriod>\\n <CreatedTime>2019-09-20T16:02:34Z</CreatedTime>\\n <ClusterId>cds-bp1b136j****5d56</ClusterId>\\n <MinorVersion>3.11.7</MinorVersion>\\n <PayType>PayAsYouGo</PayType>\\n <LockMode>None</LockMode>\\n <IsLatestVersion>true</IsLatestVersion>\\n <MaintainEndTime>4:00Z</MaintainEndTime>\\n <AutoRenewal>true</AutoRenewal>\\n <DataCenterCount>1</DataCenterCount>\\n <ClusterName>Cassandra-test</ClusterName>\\n <ExpireTime>2019-10-20T16:02:34Z</ExpireTime>\\n <MaintainStartTime>2:00Z</MaintainStartTime>\\n <ResourceGroupId>rg-xxxxxxxxxxx</ResourceGroupId>\\n <Tags>\\n <Tag>\\n <Value>test-value</Value>\\n <Key>test-key</Key>\\n </Tag>\\n </Tags>\\n</Cluster>","errorExample":""}]',
- 'title' => 'DescribeCluster',
+ 'errorCodes' => [],
+ 'title' => 'Query account list of an instance',
+ 'summary' => 'Queries the account list of a specified instance by instance ID.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeClusters' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BA1F8A4-12CC-4638-A7EC-D8FA2768D223\\",\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeBackup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1103,90 +805,30 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp11tjzh50****78', 'title' => ''],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'ClusterName',
+ 'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The ID of the data center in the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' cn-hangzhou-g', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'BackupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-xxxxxxxxx',
- ],
+ 'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020010121****', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'BackupType',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => 'The backup type. Valid values:'."\n"
+ ."\n"
+ .'- full: full backup'."\n"
+ .'- Incremental: incremental backup.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Incremental', 'title' => ''],
],
],
'responses' => [
@@ -1194,156 +836,52 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4EA95B55-58AB-469E-BD8E-5B1F9EEB1683',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Clusters' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D', 'title' => ''],
+ 'Backup' => [
+ 'description' => 'The backup plan summary information.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Cluster' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-20T16:02:34Z',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PayAsYouGo',
- ],
- 'LockMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'MinorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3.11.5',
- ],
- 'AutoRenewPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'DataCenterCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AutoRenewal' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-xxxxxxxxxxx',
- ],
- 'ClusterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cassandra-test',
- ],
- 'MajorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3.11',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-09-20T16:02:34Z',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1e4e32****z75c',
- ],
- 'Tags' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Tag' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-key',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-value',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'EndTime' => ['description' => 'The end time of the backup. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2020-01-01 21:48:54Z', 'title' => ''],
+ 'Status' => ['description' => 'The backup status. Valid values include:'."\n"
+ ."\n"
+ .'- Succeeded: The backup succeeded.'."\n"
+ .'- Failed: The backup failed.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time of the backup. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2020-01-01 21:48:40Z', 'title' => ''],
+ 'Size' => ['description' => 'The backup size.', 'type' => 'integer', 'format' => 'int64', 'example' => '149016650', 'title' => ''],
+ 'BackupType' => ['description' => 'The backup type. Valid values:'."\n"
+ ."\n"
+ .'- full: full backup'."\n"
+ .'- Incremental: incremental backup.', 'type' => 'string', 'example' => 'Incremental', 'title' => ''],
+ 'BackupId' => ['description' => 'The backup ID.', 'type' => 'string', 'example' => '2020010121****', 'title' => ''],
+ 'Details' => ['description' => 'The backup details.', 'type' => 'string', 'example' => '{"name": "cds-uf6m0bod****6159-20200226", "start": "2020-02-26 01:57:05", "end": "2020-02-26 02:12:50", "completeNodes": ["cds-uf6m0bod4****159-1-core-002.cassandra.rds.aliyuncs.com", "cds-uf6m0bo****v6159-1-core-001.cassandra.rds.aliyuncs.com", "cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com"], "incompleteNodes": [], "missingNodes": [], "files": 923, "size": 149016650}', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The ID of the data center in the backup cluster.', 'type' => 'string', 'example' => ' cn-hangzhou-g', 'title' => ''],
+ 'ClusterId' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'example' => 'cds-bp11tjzh50****7v', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"4EA95B55-58AB-469E-BD8E-5B1F9EEB1683\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"Clusters\\": {\\n \\"Cluster\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2019-10-20T16:02:34Z\\",\\n \\"PayType\\": \\"PayAsYouGo\\",\\n \\"LockMode\\": \\"None\\",\\n \\"MinorVersion\\": \\"3.11.5\\",\\n \\"AutoRenewPeriod\\": 12,\\n \\"DataCenterCount\\": 1,\\n \\"AutoRenewal\\": true,\\n \\"ResourceGroupId\\": \\"rg-xxxxxxxxxxx\\",\\n \\"ClusterName\\": \\"Cassandra-test\\",\\n \\"MajorVersion\\": \\"3.11\\",\\n \\"CreatedTime\\": \\"2019-09-20T16:02:34Z\\",\\n \\"ClusterId\\": \\"cds-bp1e4e32****z75c\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClustersResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>4EA95B55-58AB-469E-BD8E-5B1F9EEB1683</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Clusters>\\n <Cluster>\\n <Status>Running</Status>\\n <MajorVersion>3.11</MajorVersion>\\n <AutoRenewPeriod>12</AutoRenewPeriod>\\n <CreatedTime>2019-09-20T16:02:34Z</CreatedTime>\\n <AutoRenewal>true</AutoRenewal>\\n <ClusterId>cds-bp1e4e32****z75c</ClusterId>\\n <DataCenterCount>1</DataCenterCount>\\n <ClusterName>Cassandra-test</ClusterName>\\n <MinorVersion>3.11.5</MinorVersion>\\n <PayType>PayAsYouGo</PayType>\\n <LockMode>None</LockMode>\\n <ExpireTime>2019-10-20T16:02:34Z</ExpireTime>\\n </Cluster>\\n <Cluster>\\n <Tags>\\n <Tag>\\n <Value>test-value</Value>\\n <Key>test-key</Key>\\n </Tag>\\n </Tags>\\n </Cluster>\\n </Clusters>\\n</DescribeClustersResponse>","errorExample":""}]',
- 'title' => 'DescribeClusters',
+ 'title' => 'Retrieve backup summary information',
+ 'summary' => 'Calls DescribeBackup to retrieve backup summary information.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeClusterStatus' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\",\\n \\"Backup\\": {\\n \\"EndTime\\": \\"2020-01-01 21:48:54Z\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"StartTime\\": \\"2020-01-01 21:48:40Z\\",\\n \\"Size\\": 149016650,\\n \\"BackupType\\": \\"Incremental\\",\\n \\"BackupId\\": \\"2020010121****\\",\\n \\"Details\\": \\"{\\\\\\"name\\\\\\": \\\\\\"cds-uf6m0bod****6159-20200226\\\\\\", \\\\\\"start\\\\\\": \\\\\\"2020-02-26 01:57:05\\\\\\", \\\\\\"end\\\\\\": \\\\\\"2020-02-26 02:12:50\\\\\\", \\\\\\"completeNodes\\\\\\": [\\\\\\"cds-uf6m0bod4****159-1-core-002.cassandra.rds.aliyuncs.com\\\\\\", \\\\\\"cds-uf6m0bo****v6159-1-core-001.cassandra.rds.aliyuncs.com\\\\\\", \\\\\\"cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com\\\\\\"], \\\\\\"incompleteNodes\\\\\\": [], \\\\\\"missingNodes\\\\\\": [], \\\\\\"files\\\\\\": 923, \\\\\\"size\\\\\\": 149016650}\\",\\n \\"DataCenterId\\": \\" cn-hangzhou-g\\",\\n \\"ClusterId\\": \\"cds-bp11tjzh50****7v\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeBackupPlan' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1351,20 +889,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d59',
- ],
+ 'schema' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-uf6m0bo****6158', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the data center in the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-e', 'title' => ''],
],
],
'responses' => [
@@ -1372,41 +907,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3AC5F451-8B0F-47B4-9733-4A09C8838AD4',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-02-26T01:30:40Z',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0EA95AA2-860C-42CB-97CF-78CA3937E0D5', 'title' => ''],
+ 'BackupPlan' => [
+ 'description' => 'The list of backup plan details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Active' => ['description' => 'Indicates whether the backup plan is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'BackupPeriod' => ['description' => 'The backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.', 'type' => 'string', 'example' => 'Monday', 'title' => ''],
+ 'RetentionPeriod' => ['description' => 'The retention period of the backup plan. Valid values: 1 to 7. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the backup plan was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-02-26T01:56Z', 'title' => ''],
+ 'BackupTime' => ['description' => 'The time when the daily backup starts. The time is displayed in UTC.', 'type' => 'string', 'example' => '00:30Z', 'title' => ''],
+ 'ClusterId' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'example' => 'cds-uf6m0b****7v6159', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The ID of the data center in the backup cluster.', 'type' => 'string', 'example' => 'cn-shanghai-e', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Running\\",\\n \\"RequestId\\": \\"3AC5F451-8B0F-47B4-9733-4A09C8838AD4\\",\\n \\"CreatedTime\\": \\"2020-02-26T01:30:40Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterStatusResponse>\\n<Status>Running</Status>\\n<CreatedTime>2020-02-26T01:30:40Z</CreatedTime>\\n<RequestId>BEEDFA38-213F-4DF8-810D-702DFF5FF2A6</RequestId>\\n</DescribeClusterStatusResponse>","errorExample":""}]',
- 'title' => 'DescribeClusterStatus',
+ 'title' => 'Retrieve a backup plan',
+ 'summary' => 'Calls DescribeBackupPlan to describe a backup plan.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeDeletedClusters' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EA95AA2-860C-42CB-97CF-78CA3937E0D5\\",\\n \\"BackupPlan\\": {\\n \\"Active\\": true,\\n \\"BackupPeriod\\": \\"Monday\\",\\n \\"RetentionPeriod\\": 7,\\n \\"CreatedTime\\": \\"2020-02-26T01:56Z\\",\\n \\"BackupTime\\": \\"00:30Z\\",\\n \\"ClusterId\\": \\"cds-uf6m0b****7v6159\\",\\n \\"DataCenterId\\": \\"cn-shanghai-e\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeBackupPlans' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1414,41 +952,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1yt5g0****7f48', 'title' => ''],
],
],
'responses' => [
@@ -1456,110 +965,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '018F3C6E-2F9F-4181-8602-4AB4FB86F4ED',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Clusters' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D', 'title' => ''],
+ 'BackupPlans' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Cluster' => [
- 'description' => '',
+ 'BackupPlan' => [
+ 'description' => 'The list of backup plans.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Deleted',
- ],
- 'DataCenterCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-09T20:29:27Z',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PayAsYouGo',
- ],
- 'ClusterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cassandra-test-wjk',
- ],
- 'MajorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3.11',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-09T14:59:31Z',
- ],
- 'MinorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3.11.5',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1hy2ip****z46g',
- ],
+ 'Active' => ['description' => 'Indicates whether the backup plan is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'BackupPeriod' => ['description' => 'The backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.', 'type' => 'string', 'example' => 'Monday', 'title' => ''],
+ 'RetentionPeriod' => ['description' => 'The retention period of the backup plan. Valid values: 1 to 7. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the backup plan was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).', 'type' => 'string', 'example' => '2020-02-26T01:56Z', 'title' => ''],
+ 'BackupTime' => ['description' => 'The time when the daily backup starts. The time is in the HH:mmZ format (UTC).', 'type' => 'string', 'example' => ' 00:30Z', 'title' => ''],
+ 'ClusterId' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'example' => 'cds-uf6m0bod****6159', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The data center ID of the backup cluster.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"018F3C6E-2F9F-4181-8602-4AB4FB86F4ED\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"Clusters\\": {\\n \\"Cluster\\": [\\n {\\n \\"Status\\": \\"Deleted\\",\\n \\"DataCenterCount\\": 1,\\n \\"ExpireTime\\": \\"2019-10-09T20:29:27Z\\",\\n \\"PayType\\": \\"PayAsYouGo\\",\\n \\"ClusterName\\": \\"Cassandra-test-wjk\\",\\n \\"MajorVersion\\": \\"3.11\\",\\n \\"CreatedTime\\": \\"2019-10-09T14:59:31Z\\",\\n \\"MinorVersion\\": \\"3.11.5\\",\\n \\"ClusterId\\": \\"cds-bp1hy2ip****z46g\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDeletedClustersResponse>\\n<PageNumber>1</PageNumber>\\n<TotalCount>3</TotalCount>\\n<Clusters>\\n <Cluster>\\n <Status>Deleted</Status>\\n <CreatedTime>2019-10-09T14:59:31Z</CreatedTime>\\n <MinorVersion>3.11.5</MinorVersion>\\n <ClusterName>Cassandra-test-wjk</ClusterName>\\n <ClusterId>cds-bp1hy2ip****z46g</ClusterId>\\n <ExpireTime>2019-10-09T20:29:27Z</ExpireTime>\\n <DataCenterCount>1</DataCenterCount>\\n <PayType>PayAsYouGo</PayType>\\n <MajorVersion>3.11</MajorVersion>\\n </Cluster>\\n <Cluster>\\n <Status>Deleted</Status>\\n <CreatedTime>2019-09-24T20:37:17Z</CreatedTime>\\n <MinorVersion>3.11.5</MinorVersion>\\n <ClusterName>baitu-resize-disk-size</ClusterName>\\n <ClusterId>cds-bp1354yf****35bw</ClusterId>\\n <ExpireTime>2019-10-08T20:16:22Z</ExpireTime>\\n <DataCenterCount>1</DataCenterCount>\\n <PayType>PayAsYouGo</PayType>\\n <MajorVersion>3.11</MajorVersion>\\n </Cluster>\\n <Cluster>\\n <Status>Deleted</Status>\\n <CreatedTime>2019-09-23T11:45:48Z</CreatedTime>\\n <MinorVersion>3.11.5</MinorVersion>\\n <ClusterName>baitu-4c16gaaa</ClusterName>\\n <ClusterId>cds-bp1ia8ui****8dle</ClusterId>\\n <ExpireTime>2019-10-08T20:16:19Z</ExpireTime>\\n <DataCenterCount>1</DataCenterCount>\\n <PayType>PayAsYouGo</PayType>\\n <MajorVersion>3.11</MajorVersion>\\n </Cluster>\\n</Clusters>\\n<PageSize>10</PageSize>\\n<RequestId>018F3C6E-2F9F-4181-8602-4AB4FB86F4ED</RequestId>\\n</DescribeDeletedClustersResponse>","errorExample":""}]',
- 'title' => 'DescribeDeletedClusters',
+ 'title' => 'Query backup plans',
+ 'summary' => 'Calls DescribeBackupPlans to query a list of backup plans.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeDataCenter' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\",\\n \\"BackupPlans\\": {\\n \\"BackupPlan\\": [\\n {\\n \\"Active\\": true,\\n \\"BackupPeriod\\": \\"Monday\\",\\n \\"RetentionPeriod\\": 5,\\n \\"CreatedTime\\": \\"2020-02-26T01:56Z\\",\\n \\"BackupTime\\": \\" 00:30Z\\",\\n \\"ClusterId\\": \\"cds-uf6m0bod****6159\\",\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeBackups' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1567,31 +1025,25 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-t4n98w89z77*****',
- ],
+ 'schema' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-uf6m0bod****6158', 'title' => ''],
],
[
'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ap-southeast-1a',
- ],
+ 'schema' => ['description' => 'The ID of the data center in the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-e', 'title' => ''],
+ ],
+ [
+ 'name' => 'BackupType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The backup type. Valid values:'."\n"
+ ."\n"
+ .'- full: full backup'."\n"
+ .'- Incremental: incremental backup.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Incremental', 'title' => ''],
],
],
'responses' => [
@@ -1599,128 +1051,66 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp1qitxqe1m5r****4mng',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-17T00:00:00Z',
- ],
- 'VswitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp13e9ynz3jpy****hqlm',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Subscription',
- ],
- 'DiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '160',
- ],
- 'DiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_ssd',
- ],
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cassandra.c.large',
- ],
- 'LockMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'AutoRenewPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1',
- ],
- 'AutoRenewal' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504',
- ],
- 'CommodityInstance' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-t4n98w89z77*****',
- ],
- 'NodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'DataCenterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_name',
- ],
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1a',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-16T11:27:20Z',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-t4n98w89z77*****',
- ],
- 'DataCenterId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA', 'title' => ''],
+ 'Backups' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Backup' => [
+ 'description' => 'The list of backup task information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EndTime' => ['description' => 'The end time of the backup. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2020-02-26T02:12:50Z', 'title' => ''],
+ 'Status' => ['description' => 'The backup status. Example valid values:'."\n"
+ ."\n"
+ .'- Succeeded: The backup succeeded.'."\n"
+ .'- Failed: The backup failed.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time of the backup. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2020-02-26T01:57:00Z', 'title' => ''],
+ 'Size' => ['description' => 'The backup size.', 'type' => 'integer', 'format' => 'int64', 'example' => '149016650', 'title' => ''],
+ 'BackupType' => ['description' => 'The backup type. Valid values:'."\n"
+ ."\n"
+ .'- full: full backup'."\n"
+ .'- Incremental: incremental backup.', 'type' => 'string', 'example' => 'Incremental', 'title' => ''],
+ 'BackupId' => ['description' => 'The backup ID.', 'type' => 'string', 'example' => '20200***', 'title' => ''],
+ 'ClusterId' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'example' => 'cds-uf6m0bod****6159', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The ID of the data center in the backup cluster.', 'type' => 'string', 'example' => ' cn-shanghai-e', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1a',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcId\\": \\"vpc-bp1qitxqe1m5r****4mng\\",\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2020-11-17T00:00:00Z\\",\\n \\"VswitchId\\": \\"vsw-bp13e9ynz3jpy****hqlm\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"DiskSize\\": 160,\\n \\"DiskType\\": \\"cloud_ssd\\",\\n \\"InstanceType\\": \\"cassandra.c.large\\",\\n \\"LockMode\\": \\"None\\",\\n \\"AutoRenewPeriod\\": 1,\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"AutoRenewal\\": true,\\n \\"RequestId\\": \\"A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504\\",\\n \\"CommodityInstance\\": \\"cds-t4n98w89z77*****\\",\\n \\"NodeCount\\": 2,\\n \\"DataCenterName\\": \\"test_name\\",\\n \\"ZoneId\\": \\"ap-southeast-1a\\",\\n \\"CreatedTime\\": \\"2020-10-16T11:27:20Z\\",\\n \\"ClusterId\\": \\"cds-t4n98w89z77*****\\",\\n \\"DataCenterId\\": \\"ap-southeast-1a\\"\\n}","errorExample":""},{"type":"xml","example":"<AutoRenewPeriod>1</AutoRenewPeriod>\\n<Status>Running</Status>\\n<DataCenterId>ap-southeast-1a</DataCenterId>\\n<CommodityInstance>cds-t4n98w89z77*****</CommodityInstance>\\n<CreatedTime>2020-10-16T11:27:20Z</CreatedTime>\\n<NodeCount>2</NodeCount>\\n<ZoneId>ap-southeast-1a</ZoneId>\\n<RequestId>A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504</RequestId>\\n<ClusterId>cds-t4n98w89z77*****</ClusterId>\\n<LockMode>None</LockMode>\\n<PayType>Subscription</PayType>\\n<VswitchId>vsw-bp13e9ynz3jpy****hqlm</VswitchId>\\n<DataCenterName>test_name</DataCenterName>\\n<DiskType>cloud_ssd</DiskType>\\n<AutoRenewal>true</AutoRenewal>\\n<VpcId>vpc-bp1qitxqe1m5r****4mng</VpcId>\\n<DiskSize>160</DiskSize>\\n<RegionId>ap-southeast-1</RegionId>\\n<ExpireTime>2020-11-17T00:00:00Z</ExpireTime>\\n<InstanceType>cassandra.c.large</InstanceType>","errorExample":""}]',
- 'title' => 'DescribeDataCenter',
+ 'errorCodes' => [],
+ 'title' => 'Obtain cluster backup list',
+ 'summary' => 'Calls DescribeBackups to obtain the backup list of a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeInstanceType' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA\\",\\n \\"Backups\\": {\\n \\"Backup\\": [\\n {\\n \\"EndTime\\": \\"2020-02-26T02:12:50Z\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"StartTime\\": \\"2020-02-26T01:57:00Z\\",\\n \\"Size\\": 149016650,\\n \\"BackupType\\": \\"Incremental\\",\\n \\"BackupId\\": \\"20200***\\",\\n \\"ClusterId\\": \\"cds-uf6m0bod****6159\\",\\n \\"DataCenterId\\": \\" cn-shanghai-e\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1728,20 +1118,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'InstanceType',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cassandra.c.2xlarge',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d58', 'title' => ''],
],
],
'responses' => [
@@ -1749,62 +1131,102 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4B989A12-FB9A-4D9A-A824-2E9267C911C7',
- ],
- 'InstanceTypeSpecList' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '17E2B462-5FD3-4A0C-AF13-225C66E47BD5', 'title' => ''],
+ 'Cluster' => [
+ 'description' => 'The cluster information.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'InstanceTypeSpec' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cassandra.c.large',
- ],
- 'CpuSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'MemSize' => [
+ 'Status' => ['description' => 'The running status of the cluster. Valid values:'."\n"
+ ."\n"
+ .'- Creating: being created'."\n"
+ .'- CreateFailed: failed to be created'."\n"
+ .'- Running: running'."\n"
+ .'- Deleting: being deleted'."\n"
+ .'- DeleteFailed: failed to be deleted'."\n"
+ .'- Deleted: deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time of the cluster. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2019-10-20T16:02:34Z', 'title' => ''],
+ 'MaintainStartTime' => ['description' => 'The start time of the O&M window for the instance. Format: HH:mmZ (UTC).', 'type' => 'string', 'example' => '2:00Z', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'- Subscription: subscription.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.'."\n"
+ ."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'string', 'example' => 'PayAsYouGo', 'title' => ''],
+ 'MaintainEndTime' => ['description' => 'The end time of the O&M window for the instance. Format: HH:mmZ (UTC).', 'type' => 'string', 'example' => '4:00Z', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock mode. Valid values:'."\n"
+ ."\n"
+ .'- None: not locked.'."\n"
+ .'- Expired: locked because the cluster subscription has expired.'."\n"
+ .'- DiskFull: locked because the disk is full.', 'type' => 'string', 'example' => 'None', 'title' => ''],
+ 'AutoRenewPeriod' => ['description' => 'The Unified Auto Renewal Cycle.'."\n"
+ ."\n"
+ .'- If the cluster is purchased on a monthly basis, the auto-renewal epoch is 1 month.'."\n"
+ .'- If the cluster is purchased on a yearly basis, the auto-renewal epoch is 1 year (12 months).'."\n"
+ ."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'MinorVersion' => ['description' => 'The minor version number of the cluster.', 'type' => 'string', 'example' => '3.11.7', 'title' => ''],
+ 'DataCenterCount' => ['description' => 'The number of data centers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'IsLatestVersion' => ['description' => 'Indicates whether the current minor version is the latest version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled. Valid values: true/false.'."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the resource belongs.', 'type' => 'string', 'example' => 'rg-xxxxxxxxxxx', 'title' => ''],
+ 'ClusterName' => ['description' => 'The cluster name.'."\n"
+ ."\n"
+ .'The name must be 2 to 128 characters in length and must start with an uppercase letter, a lowercase letter, or a Chinese character. The name can contain digits, periods (.), underscores (_), or hyphens (-).', 'type' => 'string', 'example' => 'Cassandra-test', 'title' => ''],
+ 'ConfirmProductOffline' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'MajorVersion' => ['description' => 'The major version number of the cluster.', 'type' => 'string', 'example' => '3.11', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the cluster was created. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2019-09-20T16:02:34Z', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cds-bp1b136j****5d56', 'title' => ''],
+ 'Tags' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Tag' => [
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test-key', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test-value', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B989A12-FB9A-4D9A-A824-2E9267C911C7\\",\\n \\"InstanceTypeSpecList\\": {\\n \\"InstanceTypeSpec\\": [\\n {\\n \\"InstanceType\\": \\"cassandra.c.large\\",\\n \\"CpuSize\\": 4,\\n \\"MemSize\\": 8\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceTypeResponse>\\n<RequestId>4B989A12-FB9A-4D9A-A824-2E9267C911C7</RequestId>\\n<InstanceTypeSpecList>\\n <InstanceTypeSpec>\\n <CpuSize>4</CpuSize>\\n <MemSize>16</MemSize>\\n <InstanceType>cassandra.c.large</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>4</CpuSize>\\n <MemSize>32</MemSize>\\n <InstanceType>cassandra.c.large</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>4</CpuSize>\\n <MemSize>8</MemSize>\\n <InstanceType>cassandra.c.large</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>8</CpuSize>\\n <MemSize>16</MemSize>\\n <InstanceType>cassandra.c.2xlarge</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>8</CpuSize>\\n <MemSize>32</MemSize>\\n <InstanceType>cassandra.c.2xlarge</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>8</CpuSize>\\n <MemSize>32</MemSize>\\n <InstanceType>cassandra.c.2xlarge</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>2</CpuSize>\\n <MemSize>4</MemSize>\\n <InstanceType>cassandra.c.large</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>2</CpuSize>\\n <MemSize>8</MemSize>\\n <InstanceType>cassandra.c.large</InstanceType>\\n </InstanceTypeSpec>\\n <InstanceTypeSpec>\\n <CpuSize>4</CpuSize>\\n <MemSize>8</MemSize>\\n <InstanceType>cassandra.c.xlarge</InstanceType>\\n </InstanceTypeSpec>\\n</InstanceTypeSpecList>\\n</DescribeInstanceTypeResponse>","errorExample":""}]',
- 'title' => 'DescribeInstanceType',
+ 'title' => 'Query instance details',
+ 'summary' => 'Queries the details of a Cassandra instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetCmsUrl' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17E2B462-5FD3-4A0C-AF13-225C66E47BD5\\",\\n \\"Cluster\\": {\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2019-10-20T16:02:34Z\\",\\n \\"MaintainStartTime\\": \\"2:00Z\\",\\n \\"PayType\\": \\"PayAsYouGo\\",\\n \\"MaintainEndTime\\": \\"4:00Z\\",\\n \\"LockMode\\": \\"None\\",\\n \\"AutoRenewPeriod\\": 12,\\n \\"MinorVersion\\": \\"3.11.7\\",\\n \\"DataCenterCount\\": 1,\\n \\"IsLatestVersion\\": true,\\n \\"AutoRenewal\\": true,\\n \\"ResourceGroupId\\": \\"rg-xxxxxxxxxxx\\",\\n \\"ClusterName\\": \\"Cassandra-test\\",\\n \\"ConfirmProductOffline\\": false,\\n \\"MajorVersion\\": \\"3.11\\",\\n \\"CreatedTime\\": \\"2019-09-20T16:02:34Z\\",\\n \\"ClusterId\\": \\"cds-bp1b136j****5d56\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeClusterDashboard' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1812,20 +1234,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d57',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp14****135h', 'title' => ''],
],
],
'responses' => [
@@ -1833,36 +1247,99 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Url' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://cloudmonitor.console.aliyun.com?instanceId=cds-bp1l5ys68z98wzrc#/group/groupId=14680829&groupName=17926974****3449-cassandra/groupdashboard/cds//',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6453F432-0141-4D35-B2BF-ADF199B39B07',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9339F598-0560-43CE-9F57-CD7B6B385DBB', 'title' => ''],
+ 'Dashboard' => [
+ 'description' => 'The dashboard data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cds-bp1syjlt****q976', 'title' => ''],
+ 'DataCenters' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DataCenter' => [
+ 'description' => 'The list of data centers.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataCenterId' => ['description' => 'The data center ID of the cluster.', 'type' => 'string', 'example' => 'cn-shanghai-e', 'title' => ''],
+ 'Nodes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Node' => [
+ 'description' => 'The list of nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Address' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '192.***.12.3', 'title' => ''],
+ 'Status' => ['description' => 'The current node status. Valid values:'."\n"
+ ."\n"
+ .'- UpNormal: The node is running. The node status relative to the cluster is normal.'."\n"
+ .'- UpLeaving: The node is running. The node is leaving the cluster.'."\n"
+ .'- UpJoining: The node is running. The node is joining the cluster.'."\n"
+ .'- UpMovving: The node is running. The node is being removed from the cluster.'."\n"
+ .'- DownNormal: The node is stopped. The node status relative to the cluster is normal.'."\n"
+ .'- DownLeaving: The node is stopped. The node is leaving the cluster.'."\n"
+ .'- DownJoining: The node is stopped. The node is joining the cluster.'."\n"
+ .'- DownMovving: The node is stopped. The node is being removed from the cluster.'."\n"
+ ."\n"
+ .'If "?N" is displayed, the nodes most likely cannot communicate with each other. Check for network issues or firewall configurations.', 'type' => 'string', 'example' => 'UpNormal', 'title' => ''],
+ 'Load' => ['description' => 'The load.', 'type' => 'string', 'example' => '54.4 MiB', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"https://cloudmonitor.console.aliyun.com?instanceId=cds-bp1l5ys68z98wzrc#/group/groupId=14680829&groupName=17926974****3449-cassandra/groupdashboard/cds//\\",\\n \\"RequestId\\": \\"6453F432-0141-4D35-B2BF-ADF199B39B07\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCmsUrlResponse>\\n<Url>https://cloudmonitor.console.aliyun.com?instanceId=cds-bp1l5ys68z98wzrc#/group/groupId=14680829&amp;groupName=17926974****3449-cassandra/groupdashboard/cds//</Url>\\n<RequestId>6453F432-0141-4D35-B2BF-ADF199B39B07</RequestId>\\n</GetCmsUrlResponse>","errorExample":""}]',
- 'title' => 'GetCmsUrl',
+ 'title' => 'Query dashboard data',
+ 'summary' => 'Queries dashboard data by calling DescribeClusterDashboard.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'PurgeCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9339F598-0560-43CE-9F57-CD7B6B385DBB\\",\\n \\"Dashboard\\": {\\n \\"ClusterId\\": \\"cds-bp1syjlt****q976\\",\\n \\"DataCenters\\": {\\n \\"DataCenter\\": [\\n {\\n \\"DataCenterId\\": \\"cn-shanghai-e\\",\\n \\"Nodes\\": {\\n \\"Node\\": [\\n {\\n \\"Address\\": \\"192.***.12.3\\",\\n \\"Status\\": \\"UpNormal\\",\\n \\"Load\\": \\"54.4 MiB\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeClusterStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1870,18 +1347,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1hy2ip****z465',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d59', 'title' => ''],
],
],
'responses' => [
@@ -1889,31 +1360,38 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '317BF5F0-2575-4158-9493-6DA83465491B',
- ],
+ 'Status' => ['description' => 'The running status of the cluster. Valid values:'."\n"
+ ."\n"
+ .'- Creating: The cluster is being created.'."\n"
+ .'- CreateFailed: The cluster failed to be created.'."\n"
+ .'- Running: The cluster is running.'."\n"
+ .'- Deleting: The cluster is being deleted.'."\n"
+ .'- DeleteFailed: The cluster failed to be deleted.'."\n"
+ .'- Deleted: The cluster is deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3AC5F451-8B0F-47B4-9733-4A09C8838AD4', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the cluster was created. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2020-02-26T01:30:40Z', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"317BF5F0-2575-4158-9493-6DA83465491B\\"\\n}","errorExample":""},{"type":"xml","example":"<PurgeClusterResponse>\\r\\n<RequestId>317BF5F0-2575-4158-9493-6DA83465491B</RequestId>\\r\\n</PurgeClusterResponse>","errorExample":""}]',
- 'title' => 'PurgeCluster',
+ 'title' => 'Query the running status of a cluster',
+ 'summary' => 'Queries the running status of a cluster by calling DescribeClusterStatus.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'RebootCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Running\\",\\n \\"RequestId\\": \\"3AC5F451-8B0F-47B4-9733-4A09C8838AD4\\",\\n \\"CreatedTime\\": \\"2020-02-26T01:30:40Z\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeClusters' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1921,102 +1399,57 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d51',
- ],
+ 'schema' => ['description' => 'The region ID, such as ap-southeast-1.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DataCenterId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-g',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '033F5CDA-EF5E-4893-93C3-7EA5DCB76AF3',
- ],
- ],
- ],
+ 'schema' => ['description' => 'The page number. Valid values: greater than 0 and not exceeding the maximum value of Integer.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
- ],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"033F5CDA-EF5E-4893-93C3-7EA5DCB76AF3\\"\\n}","errorExample":""},{"type":"xml","example":"<RebootClusterResponse>\\r\\n<RequestId> 033F5CDA-EF5E-4893-93C3-7EA5DCB76AF3</RequestId>\\r\\n</RebootClusterResponse>","errorExample":""}]',
- 'title' => 'RebootCluster',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ResizeDiskSize' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'ClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d51',
- ],
+ 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'DataCenterId',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-g',
- ],
+ 'schema' => ['description' => 'The resource group ID. You can view available resource groups in the Resource Group console.', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'DiskSize',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '240',
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The custom tag key.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''],
+ 'Value' => ['description' => 'The custom tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 21,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -2025,31 +1458,116 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4EA95B55-58AB-469E-BD8E-5B1F9EEB1683', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number. Valid values: greater than 0 and not exceeding the maximum value of Integer.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of clusters returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
+ 'Clusters' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Cluster' => [
+ 'description' => 'The list of cluster query results.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The running status of the cluster. Valid values:'."\n"
+ .'- Creating: being created.'."\n"
+ .'- CreateFailed: creation failed.'."\n"
+ .'- Running: running.'."\n"
+ .'- Deleting: being deleted.'."\n"
+ .'- DeleteFailed: deletion failed.'."\n"
+ .'- Deleted: deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time of the cluster. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).'."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'string', 'example' => '2019-10-20T16:02:34Z', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'- Subscription: subscription.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.'."\n"
+ ."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'string', 'example' => 'PayAsYouGo', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock mode. Valid values:'."\n"
+ ."\n"
+ .'- None: not locked.'."\n"
+ .'- Expired: locked because the cluster subscription has expired.'."\n"
+ .'- DiskFull: locked because the disk is full.', 'type' => 'string', 'example' => 'None', 'title' => ''],
+ 'MinorVersion' => ['description' => 'The minor version number.', 'type' => 'string', 'example' => '3.11.5', 'title' => ''],
+ 'AutoRenewPeriod' => ['description' => 'The Unified Auto Renewal Cycle.'."\n"
+ .'- Monthly subscription: the auto-renewal epoch is 1 month.'."\n"
+ .'- Yearly subscription: the auto-renewal epoch is 1 year (12 months).'."\n"
+ ."\n"
+ .'> This parameter is not returned for pay-as-you-go instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'DataCenterCount' => ['description' => 'The number of data centers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled. Valid values: true and false.'."\n"
+ .'> This parameter is not returned for pay-as-you-go instances.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the resource belongs.', 'type' => 'string', 'example' => 'rg-xxxxxxxxxxx', 'title' => ''],
+ 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Cassandra-test', 'title' => ''],
+ 'MajorVersion' => ['description' => 'The major version number.', 'type' => 'string', 'example' => '3.11', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the cluster was created. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2019-09-20T16:02:34Z', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cds-bp1e4e32****z75c', 'title' => ''],
+ 'Tags' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Tag' => [
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test-key', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test-value', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '5C37DF4E-54D6-4AFA-A1F9-79ADC148F8AD',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5C37DF4E-54D6-4AFA-A1F9-79ADC148F8AD\\"\\n}","errorExample":""},{"type":"xml","example":"<ResizeDiskSizeResponse>\\r\\n<RequestId>5C37DF4E-54D6-4AFA-A1F9-79ADC148F8AD</RequestId>\\r\\n</ResizeDiskSizeResponse>","errorExample":""}]',
- 'title' => 'ResizeDiskSize',
+ 'title' => 'DescribeClusters',
+ 'summary' => 'Queries information about all clusters in a specified region by calling DescribeClusters.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ResizeNodeCount' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"4EA95B55-58AB-469E-BD8E-5B1F9EEB1683\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"Clusters\\": {\\n \\"Cluster\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2019-10-20T16:02:34Z\\",\\n \\"PayType\\": \\"PayAsYouGo\\",\\n \\"LockMode\\": \\"None\\",\\n \\"MinorVersion\\": \\"3.11.5\\",\\n \\"AutoRenewPeriod\\": 12,\\n \\"DataCenterCount\\": 1,\\n \\"AutoRenewal\\": true,\\n \\"ResourceGroupId\\": \\"rg-xxxxxxxxxxx\\",\\n \\"ClusterName\\": \\"Cassandra-test\\",\\n \\"MajorVersion\\": \\"3.11\\",\\n \\"CreatedTime\\": \\"2019-09-20T16:02:34Z\\",\\n \\"ClusterId\\": \\"cds-bp1e4e32****z75c\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeContactPoints' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2057,41 +1575,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d59',
- ],
- ],
- [
- 'name' => 'DataCenterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => ' cn-hangzhou-g',
- ],
- ],
- [
- 'name' => 'NodeCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d57', 'title' => ''],
],
],
'responses' => [
@@ -2099,31 +1588,86 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '467F786B-C765-40C4-8493-89F4CE95F1B6', 'title' => ''],
+ 'ContactPoints' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ContactPoint' => [
+ 'description' => 'The collection of cluster connection information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Port' => ['description' => 'The CQL port.', 'type' => 'integer', 'format' => 'int32', 'example' => '9042', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The data center ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''],
+ 'PublicAddresses' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PublicAddress' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The public network connection point.', 'type' => 'string', 'example' => 'cds-proxy-pub-bp1b136j****5d56-1-core-002.cassandra.rds.aliyuncs.com', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PrivateAddresses' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PrivateAddress' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The private endpoint.', 'type' => 'string', 'example' => 'cds-bp1b136****5d56-1-core-001.cassandra.rds.aliyuncs.com', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'D7D3088F-AA4F-49C3-BB46-B04F3E35041A',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7D3088F-AA4F-49C3-BB46-B04F3E35041A\\"\\n}","errorExample":""},{"type":"xml","example":"<ResizeNodeCountResponse>\\r\\n<RequestId>D7D3088F-AA4F-49C3-BB46-B04F3E35041A</RequestId>\\r\\n</ResizeNodeCountResponse>","errorExample":""}]',
- 'title' => 'ResizeNodeCount',
+ 'title' => 'Obtain cluster database connection information',
+ 'summary' => 'Calls DescribeContactPoints to obtain the database connection information of a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UpgradeClusterVersion' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"467F786B-C765-40C4-8493-89F4CE95F1B6\\",\\n \\"ContactPoints\\": {\\n \\"ContactPoint\\": [\\n {\\n \\"Port\\": 9042,\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\",\\n \\"PublicAddresses\\": {\\n \\"PublicAddress\\": [\\n \\"cds-proxy-pub-bp1b136j****5d56-1-core-002.cassandra.rds.aliyuncs.com\\"\\n ]\\n },\\n \\"PrivateAddresses\\": {\\n \\"PrivateAddress\\": [\\n \\"cds-bp1b136****5d56-1-core-001.cassandra.rds.aliyuncs.com\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeDataCenter' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2131,18 +1675,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => ' cds-bp1u2n43****n115',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-t4n98w89z77*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data center ID. You can call the DescribeDataCenters operation to obtain the data center ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ap-southeast-1a', 'title' => ''],
],
],
'responses' => [
@@ -2150,31 +1693,68 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BC262FE3-91ED-4FE7-BD75-190B62D8BABC',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC262FE3-91ED-4FE7-BD75-190B62D8BABC\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeClusterVersionResponse>\\r\\n<RequestId>BC262FE3-91ED-4FE7-BD75-190B62D8BABC</RequestId>\\r\\n</UpgradeClusterVersionResponse>","errorExample":""}]',
- 'title' => 'UpgradeClusterVersion',
+ 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp1qitxqe1m5r****4mng', 'title' => ''],
+ 'Status' => ['description' => 'The running status of the cluster. Valid values:'."\n"
+ .'Creating: The cluster is being created.'."\n"
+ .'CreateFailed: The cluster failed to be created.'."\n"
+ .'Running: The cluster is running.'."\n"
+ .'Deleting: The cluster is being deleted.'."\n"
+ .'DeleteFailed: The cluster failed to be deleted.'."\n"
+ .'Deleted: The cluster has been deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time of the cluster subscription. Format: HH:mmZ (UTC).', 'type' => 'string', 'example' => '2020-11-17T00:00:00Z', 'title' => ''],
+ 'VswitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp13e9ynz3jpy****hqlm', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method. Valid values:'."\n"
+ .'Subscription: subscription.'."\n"
+ .'PayAsYouGo: pay-as-you-go.'."\n"
+ .'<note>Pay-as-you-go instances do not have an expiration time.</note>.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''],
+ 'DiskSize' => ['description' => 'The disk storage size per node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '160', 'title' => ''],
+ 'DiskType' => ['description' => 'The disk storage type. Valid values:'."\n"
+ .'cloud_ssd: standard SSD.'."\n"
+ .'cloud_essd: Enterprise SSD (ESSD).'."\n"
+ .'cloud_efficiency: ultra cloud disk.'."\n"
+ .'local_ssd_pro: local SSD.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type of the cluster. Valid values:'."\n"
+ .'cassandra.c.large: 2 vCPUs, 4 GB memory.'."\n"
+ .'cassandra.c.xlarge: 4 vCPUs, 8 GB memory.'."\n"
+ .'cassandra.c.2xlarge: 8 vCPUs, 16 GB memory.', 'type' => 'string', 'example' => 'cassandra.c.large', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock mode. Valid values:'."\n"
+ .'None: not locked.'."\n"
+ .'Expired: locked due to cluster subscription expiration.'."\n"
+ .'DiskFull: locked due to full disk.', 'type' => 'string', 'example' => 'None', 'title' => ''],
+ 'AutoRenewPeriod' => ['description' => 'The auto-renewal period. This parameter is returned only when PayType is set to Subscription and AutoRenewal is set to true. Unit: months. Valid values: 1 to 9, 12, 24, and 36.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID. You can call the DescribeRegions operation to query available region IDs.', 'type' => 'string', 'example' => 'ap-southeast-1', 'title' => ''],
+ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled. This parameter is returned only when PayType is set to Subscription. Valid values:'."\n"
+ .'true: Auto-renewal is enabled.'."\n"
+ .'false: Auto-renewal is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504', 'title' => ''],
+ 'CommodityInstance' => ['description' => 'The commodity instance ID of the cluster.', 'type' => 'string', 'example' => 'cds-t4n98w89z77*****', 'title' => ''],
+ 'NodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'DataCenterName' => ['description' => 'The name of the data center in the cluster.', 'type' => 'string', 'example' => 'test_name', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID. You can call the DescribeRegions operation to query available zones. Use this parameter to specify the zone in which to create the instance.', 'type' => 'string', 'example' => 'ap-southeast-1a', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the cluster was created. Format: HH:mmZ (UTC).', 'type' => 'string', 'example' => '2020-10-16T11:27:20Z', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cds-t4n98w89z77*****', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The data center ID of the cluster.', 'type' => 'string', 'example' => 'ap-southeast-1a', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'title' => 'Get data center details',
+ 'summary' => 'Retrieves the details of a specific data center.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyIpWhitelist' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp1qitxqe1m5r****4mng\\",\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2020-11-17T00:00:00Z\\",\\n \\"VswitchId\\": \\"vsw-bp13e9ynz3jpy****hqlm\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"DiskSize\\": 160,\\n \\"DiskType\\": \\"cloud_ssd\\",\\n \\"InstanceType\\": \\"cassandra.c.large\\",\\n \\"LockMode\\": \\"None\\",\\n \\"AutoRenewPeriod\\": 1,\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"AutoRenewal\\": true,\\n \\"RequestId\\": \\"A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504\\",\\n \\"CommodityInstance\\": \\"cds-t4n98w89z77*****\\",\\n \\"NodeCount\\": 2,\\n \\"DataCenterName\\": \\"test_name\\",\\n \\"ZoneId\\": \\"ap-southeast-1a\\",\\n \\"CreatedTime\\": \\"2020-10-16T11:27:20Z\\",\\n \\"ClusterId\\": \\"cds-t4n98w89z77*****\\",\\n \\"DataCenterId\\": \\"ap-southeast-1a\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDataCenters' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2182,31 +1762,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d51',
- ],
- ],
- [
- 'name' => 'IpList',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '192.***.0.23,30.15.***.133',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d57', 'title' => ''],
],
],
'responses' => [
@@ -2214,31 +1775,96 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C8CA4D25-47FE-47D9-A34F-69B554A3A069', 'title' => ''],
+ 'DataCenters' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DataCenter' => [
+ 'description' => 'The list of data center information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp1qitxqe1m5r****4mng', 'title' => ''],
+ 'Status' => ['description' => 'The running status of the cluster. Valid values:'."\n"
+ ."\n"
+ .'- Creating: being created'."\n"
+ .'- CreateFailed: creation failed'."\n"
+ .'- Running: running'."\n"
+ .'- Deleting: being deleted'."\n"
+ .'- DeleteFailed: deletion failed'."\n"
+ .'- Deleted: deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The subscription expiration time of the cluster. Format: HH:mmZ (UTC).', 'type' => 'string', 'example' => '2020-03-22T00:00:00Z', 'title' => ''],
+ 'VswitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp13e9ynz3jpy****hqlm', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'- Subscription: subscription.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.'."\n"
+ ."\n"
+ .'<note>Pay-as-you-go instances do not have an expiration time.</note>.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''],
+ 'DiskSize' => ['description' => 'The disk storage size per node, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '22000', 'title' => ''],
+ 'DiskType' => ['description' => 'The disk storage type. Valid values:'."\n"
+ ."\n"
+ .'- cloud_ssd: standard SSD'."\n"
+ .'- cloud_essd: ESSD'."\n"
+ .'- cloud_efficiency: ultra cloud disk'."\n"
+ .'- local_ssd_pro: local SSD.', 'type' => 'string', 'example' => 'local_ssd_pro', 'title' => ''],
+ 'InstanceType' => ['description' => 'The instance type of the cluster. Valid values:'."\n"
+ ."\n"
+ .'- cassandra.c.large: 2 vCPUs, 4 GB memory'."\n"
+ .'- cassandra.c.xlarge: 4 vCPUs, 8 GB memory'."\n"
+ .'- cassandra.c.2xlarge: 8 vCPUs, 16 GB memory.', 'type' => 'string', 'example' => 'cassandra.c5.xlarge', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock mode. Valid values:'."\n"
+ ."\n"
+ .'- None: not locked.'."\n"
+ .'- Expired: locked due to cluster subscription expiration.'."\n"
+ .'- DiskFull: locked due to full disk.', 'type' => 'string', 'example' => 'None', 'title' => ''],
+ 'AutoRenewPeriod' => ['description' => 'The auto-renewal cycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID. You can call the DescribeRegions operation to query available region IDs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'CommodityInstance' => ['description' => 'The commodity instance ID of the cluster.', 'type' => 'string', 'example' => 'cds-bp1syjlt****q976', 'title' => ''],
+ 'NodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'DataCenterName' => ['description' => 'The name of the data center.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID. You can call the DescribeRegions operation to query available zone IDs.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the cluster was created. Format: HH:mmZ (UTC).', 'type' => 'string', 'example' => '2019-09-20T16:02:34Z', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cds-bp1syjlt****q976', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The ID of the data center.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '11B95AE4-BB1A-4B62-9655-C43395C0B234',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"11B95AE4-BB1A-4B62-9655-C43395C0B234\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyIpWhitelistResponse>\\r\\n<RequestId>11B95AE4-BB1A-4B62-9655-C43395C0B234</RequestId>\\r\\n</ModifyIpWhitelistResponse>","errorExample":""}]',
- 'title' => 'ModifyIpWhitelist',
+ 'title' => 'DescribeDataCenters',
+ 'summary' => 'Calls DescribeDataCenters to retrieve data center information.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyIpWhitelistGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8CA4D25-47FE-47D9-A34F-69B554A3A069\\",\\n \\"DataCenters\\": {\\n \\"DataCenter\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1qitxqe1m5r****4mng\\",\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2020-03-22T00:00:00Z\\",\\n \\"VswitchId\\": \\"vsw-bp13e9ynz3jpy****hqlm\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"DiskSize\\": 22000,\\n \\"DiskType\\": \\"local_ssd_pro\\",\\n \\"InstanceType\\": \\"cassandra.c5.xlarge\\",\\n \\"LockMode\\": \\"None\\",\\n \\"AutoRenewPeriod\\": 12,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AutoRenewal\\": false,\\n \\"CommodityInstance\\": \\"cds-bp1syjlt****q976\\",\\n \\"NodeCount\\": 2,\\n \\"DataCenterName\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"CreatedTime\\": \\"2019-09-20T16:02:34Z\\",\\n \\"ClusterId\\": \\"cds-bp1syjlt****q976\\",\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeDeletedClusters' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2246,54 +1872,24 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-uf6ig2gf****7pw9',
- ],
- ],
- [
- 'name' => 'IpList',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '218.30.***.40,192.***.0.23',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query available region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'GroupName',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The page number. Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'IpVersion',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '6',
- ],
+ 'schema' => ['description' => 'The number of rows per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
@@ -2301,31 +1897,78 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '018F3C6E-2F9F-4181-8602-4AB4FB86F4ED', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number. Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cluster records returned by the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
+ 'Clusters' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Cluster' => [
+ 'description' => 'The list of deleted clusters.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The cluster status. Example valid values:'."\n"
+ ."\n"
+ .'- Creating: being created.'."\n"
+ .'- CreateFailed: creation failed.'."\n"
+ .'- Running: running.'."\n"
+ .'- Deleting: being deleted.'."\n"
+ .'- DeleteFailed: deletion failed.'."\n"
+ .'- Deleted: deleted.', 'type' => 'string', 'example' => 'Deleted', 'title' => ''],
+ 'DataCenterCount' => ['description' => 'The number of data centers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time of the cluster. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2019-10-09T20:29:27Z', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method. Valid values:'."\n"
+ ."\n"
+ .'- Subscription: subscription.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.'."\n"
+ ."\n"
+ .'> Pay-as-you-go instances do not have an expiration time.', 'type' => 'string', 'example' => 'PayAsYouGo', 'title' => ''],
+ 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'Cassandra-test-wjk', 'title' => ''],
+ 'MajorVersion' => ['description' => 'The major version number of the cluster.', 'type' => 'string', 'example' => '3.11', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the cluster was created. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2019-10-09T14:59:31Z', 'title' => ''],
+ 'MinorVersion' => ['description' => 'The minor version number of the cluster.', 'type' => 'string', 'example' => '3.11.5', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cds-bp1hy2ip****z46g', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyIpWhitelistGroupResponse>\\r\\n<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>\\r\\n</ModifyIpWhitelistGroupResponse>","errorExample":""}]',
- 'title' => 'ModifyIpWhitelistGroup',
+ 'title' => 'Query deleted clusters',
+ 'summary' => 'Queries the list of deleted clusters by calling DescribeDeletedClusters.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifySecurityGroups' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"018F3C6E-2F9F-4181-8602-4AB4FB86F4ED\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"Clusters\\": {\\n \\"Cluster\\": [\\n {\\n \\"Status\\": \\"Deleted\\",\\n \\"DataCenterCount\\": 1,\\n \\"ExpireTime\\": \\"2019-10-09T20:29:27Z\\",\\n \\"PayType\\": \\"PayAsYouGo\\",\\n \\"ClusterName\\": \\"Cassandra-test-wjk\\",\\n \\"MajorVersion\\": \\"3.11\\",\\n \\"CreatedTime\\": \\"2019-10-09T14:59:31Z\\",\\n \\"MinorVersion\\": \\"3.11.5\\",\\n \\"ClusterId\\": \\"cds-bp1hy2ip****z46g\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeInstanceType' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2333,31 +1976,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp142mt7****136k',
- ],
- ],
- [
- 'name' => 'SecurityGroupIds',
+ 'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sg-t4ng4yyc916o81nua6**,sg-******',
- ],
+ 'schema' => ['description' => 'The instance type name. Example values:'."\n"
+ .'- cassandra.c.large: 2 cores, 4 GB'."\n"
+ .'- cassandra.c.xlarge: 4 cores, 8 GB'."\n"
+ .'- cassandra.c.2xlarge: 8 cores, 16 GB'."\n"
+ ."\n"
+ .'If InstanceType is left empty, all instance types are returned.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cassandra.c.2xlarge', 'title' => ''],
],
],
'responses' => [
@@ -2365,31 +1994,58 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4B989A12-FB9A-4D9A-A824-2E9267C911C7', 'title' => ''],
+ 'InstanceTypeSpecList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'InstanceTypeSpec' => [
+ 'description' => 'The list of instance types.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceType' => ['description' => 'The cluster instance type. Example values:'."\n"
+ ."\n"
+ .'- cassandra.c.large: 2 cores, 4 GB'."\n"
+ .'- cassandra.c.xlarge: 4 cores, 8 GB'."\n"
+ .'- cassandra.c.2xlarge: 8 cores, 16 GB', 'type' => 'string', 'example' => 'cassandra.c.large', 'title' => ''],
+ 'CpuSize' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
+ 'MemSize' => ['description' => 'The memory size. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '4EC521F2-5E15-41F8-92C2-0C454EA02434',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4EC521F2-5E15-41F8-92C2-0C454EA02434\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifySecurityGroupsResponse>\\r\\n<RequestId>4EC521F2-5E15-41F8-92C2-0C454EA02434</RequestId>\\r\\n</ModifySecurityGroupsResponse>","errorExample":""}]',
- 'title' => 'ModifySecurityGroups',
+ 'title' => 'Query instance types',
+ 'summary' => 'Queries the specifications of instance types, such as CPU and memory.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B989A12-FB9A-4D9A-A824-2E9267C911C7\\",\\n \\"InstanceTypeSpecList\\": {\\n \\"InstanceTypeSpec\\": [\\n {\\n \\"InstanceType\\": \\"cassandra.c.large\\",\\n \\"CpuSize\\": 4,\\n \\"MemSize\\": 8\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeIpWhitelist' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2397,20 +2053,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => ' cds-bp1b136j****5d59',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' cds-bp1b136j****5d59', 'title' => ''],
],
],
'responses' => [
@@ -2418,45 +2066,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '070CAB1F-0F38-4EA8-8FD9-CA129F22409D',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '070CAB1F-0F38-4EA8-8FD9-CA129F22409D', 'title' => ''],
'IpList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IP' => [
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '192.***.0.23,30.15.***.133',
- ],
+ 'items' => ['description' => 'The access whitelist. Multiple IP addresses are separated by commas (,).', 'type' => 'string', 'example' => '192.***.0.23,30.15.***.133', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"070CAB1F-0F38-4EA8-8FD9-CA129F22409D\\",\\n \\"IpList\\": {\\n \\"IP\\": [\\n \\"192.***.0.23,30.15.***.133\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpWhitelistResponse>\\n<RequestId>070CAB1F-0F38-4EA8-8FD9-CA129F22409D</RequestId>\\n<IpList>\\n <IP>192.***.0.23</IP>\\n <IP>30.15.***.133</IP>\\n</IpList>\\n</DescribeIpWhitelistResponse>","errorExample":""}]',
- 'title' => 'DescribeIpWhitelist',
+ 'title' => 'Query cluster network access whitelist',
+ 'summary' => 'Retrieves the whitelist information of a cluster by cluster ID.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"070CAB1F-0F38-4EA8-8FD9-CA129F22409D\\",\\n \\"IpList\\": {\\n \\"IP\\": [\\n \\"192.***.0.23,30.15.***.133\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeIpWhitelistGroups' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2464,20 +2112,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-j6c1zij80****9939',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-j6c1zij80****9939', 'title' => ''],
],
],
'responses' => [
@@ -2485,71 +2125,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '391A6933-0D4A-42EB-BCE7-03DA59D69ED4',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '391A6933-0D4A-42EB-BCE7-03DA59D69ED4', 'title' => ''],
'Groups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Group' => [
- 'description' => '',
+ 'description' => 'The list of whitelist groups.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'IpVersion' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'GroupName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'group_one',
- ],
+ 'IpVersion' => ['description' => 'The IP version. Valid values: 4 and 6.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'GroupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'group_one', 'title' => ''],
'IpList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IP' => [
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '127.0.0.1,192.***.0.1',
- ],
+ 'items' => ['description' => 'The whitelist. Multiple IP addresses are separated by commas (,).', 'type' => 'string', 'example' => '127.0.0.1,192.***.0.1', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"391A6933-0D4A-42EB-BCE7-03DA59D69ED4\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"IpVersion\\": 4,\\n \\"GroupName\\": \\"group_one\\",\\n \\"IpList\\": {\\n \\"IP\\": [\\n \\"127.0.0.1,192.***.0.1\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpWhitelistGroupsResponse>\\n<Groups>\\n <Group>\\n <GroupName>default</GroupName>\\n <IpVersion>4</IpVersion>\\n <IpList>\\n <IP>42.***.74.126</IP>\\n <IP>127.0.0.2</IP>\\n </IpList>\\n </Group>\\n <Group>\\n <GroupName>default_jy</GroupName>\\n <IpVersion>4</IpVersion>\\n <IpList>\\n <IP>42.***.74.126</IP>\\n <IP>127.0.0.1</IP>\\n </IpList>\\n </Group>\\n</Groups>\\n<RequestId>391A6933-0D4A-42EB-BCE7-03DA59D69ED4</RequestId>\\n</DescribeIpWhitelistGroupsResponse>","errorExample":""}]',
- 'title' => 'DescribeIpWhitelistGroups',
+ 'title' => 'Query IP address whitelist groups',
+ 'summary' => 'Queries the list of IP address whitelist groups by calling DescribeIpWhitelistGroups.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeSecurityGroups' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"391A6933-0D4A-42EB-BCE7-03DA59D69ED4\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"IpVersion\\": 4,\\n \\"GroupName\\": \\"group_one\\",\\n \\"IpList\\": {\\n \\"IP\\": [\\n \\"127.0.0.1,192.***.0.1\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeNodeToolExecutionHistories' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2557,20 +2196,24 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1u2n43****n118',
- ],
+ 'schema' => ['description' => 'The Cassandra cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-3872l6py****n9ul', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -2578,45 +2221,67 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C300D7C1-C45C-45F3-965C-9C4C0B7CB266',
- ],
- 'SecurityGroupIds' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FDC6EF03-8B7D-470D-AB81-BD9C9713A9E3', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number. Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ ."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'Histories' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'SecurityGroupId' => [
+ 'History' => [
+ 'description' => 'The list of nodetool execution histories.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Nodes' => ['description' => 'The execution nodes.', 'type' => 'string', 'example' => 'core-1,core-2', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error details if an error occurs.', 'type' => 'string', 'example' => 'See \\"nodetool help\\" or \\"nodetool help', 'title' => ''],
+ 'IsEnded' => ['description' => 'Indicates whether the execution is complete. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the cluster was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1576725956000', 'title' => ''],
+ 'JobId' => ['description' => 'The job ID. Format: job-xxxx.', 'type' => 'string', 'example' => 'job-C3zcrKtZ****qapO', 'title' => ''],
+ 'Command' => ['description' => 'The nodetool command.', 'type' => 'string', 'example' => 'settimeout misc', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The data center ID of the cluster.', 'type' => 'string', 'example' => 'cn-shanghai-f', 'title' => ''],
+ 'Arguments' => ['description' => 'The arguments of the nodetool command.', 'type' => 'string', 'example' => '10093', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1576725689000', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'sg-t4ng4yyc916o81nua6**,sg-****',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C300D7C1-C45C-45F3-965C-9C4C0B7CB266\\",\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-t4ng4yyc916o81nua6**,sg-****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSecurityGroupsResponse>\\n<SecurityGroupIds>\\n <SecurityGroupIds>sg-t4ng4yyc916o81nua6**</SecurityGroupIds>\\n <SecurityGroupIds>sg-****</SecurityGroupIds>\\n</SecurityGroupIds>\\n<RequestId>C300D7C1-C45C-45F3-965C-9C4C0B7CB266</RequestId>\\n</DescribeSecurityGroupsResponse>","errorExample":""}]',
- 'title' => 'DescribeSecurityGroups',
+ 'title' => 'Query nodetool execution histories by page',
+ 'summary' => 'Queries nodetool execution histories by page.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyAccountPassword' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FDC6EF03-8B7D-470D-AB81-BD9C9713A9E3\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Histories\\": {\\n \\"History\\": [\\n {\\n \\"Nodes\\": \\"core-1,core-2\\",\\n \\"ErrorMessage\\": \\"See \\\\\\\\\\\\\\"nodetool help\\\\\\\\\\\\\\" or \\\\\\\\\\\\\\"nodetool help\\",\\n \\"IsEnded\\": true,\\n \\"CreateTime\\": 1576725956000,\\n \\"JobId\\": \\"job-C3zcrKtZ****qapO\\",\\n \\"Command\\": \\"settimeout misc\\",\\n \\"DataCenterId\\": \\"cn-shanghai-f\\",\\n \\"Arguments\\": \\"10093\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"ModifyTime\\": 1576725689000\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeNodeToolExecutionHistory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2624,42 +2289,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1l5ys6****wzrx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-t4n98w89z77*****', 'title' => ''],
],
[
- 'name' => 'Account',
+ 'name' => 'DcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cassandra_test',
- ],
+ 'schema' => ['description' => 'The data center ID. You can call DescribeDataCenters to obtain the data center ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ap-southeast-1a', 'title' => ''],
],
[
- 'name' => 'Password',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Alibaba@#￥**',
- ],
+ 'schema' => ['description' => 'The ID of a specific execution job. You can call DescribeNodeToolExecutionHistories to obtain the job ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-y0edwqo993m*****', 'title' => ''],
],
],
'responses' => [
@@ -2667,31 +2312,39 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- ],
+ 'Nodes' => ['description' => 'The names of the nodes on which the command was executed.', 'type' => 'string', 'example' => 'core-1', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error details if an error occurs.', 'type' => 'string', 'example' => 'Error: The keyspace ap-southeast-1a, does not exist', 'title' => ''],
+ 'Result' => ['description' => 'The result of the command execution.', 'type' => 'string', 'example' => 'result', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603103307000', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'ap-southeast-1', 'title' => ''],
+ 'Arguments' => ['description' => 'The arguments of the nodetool command.', 'type' => 'string', 'example' => 'ap-southeast-1a', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94D5E0BE-F383-4BBB-B768-7FA3414E95A3', 'title' => ''],
+ 'IsEnded' => ['description' => 'Indicates whether the execution is complete. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'JobId' => ['description' => 'The ID of the execution job.', 'type' => 'string', 'example' => 'job-y0edwqo993m*****', 'title' => ''],
+ 'Command' => ['description' => 'The nodetool command.', 'type' => 'string', 'example' => 'status', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The time when the execution was completed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603103312000', 'title' => ''],
+ 'DataCenterId' => ['description' => 'The data center ID of the cluster.', 'type' => 'string', 'example' => 'ap-southeast-1a', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccountPasswordResponse>\\r\\n<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>\\r\\n</ModifyAccountPasswordResponse>","errorExample":""}]',
- 'title' => 'ModifyAccountPassword',
+ 'title' => 'DescribeNodeToolExecutionHistory',
+ 'summary' => 'Retrieves information about a single command execution, including the execution result.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeAccounts' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Nodes\\": \\"core-1\\",\\n \\"ErrorMessage\\": \\"Error: The keyspace ap-southeast-1a, does not exist\\",\\n \\"Result\\": \\"result\\",\\n \\"CreateTime\\": 1603103307000,\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"Arguments\\": \\"ap-southeast-1a\\",\\n \\"RequestId\\": \\"94D5E0BE-F383-4BBB-B768-7FA3414E95A3\\",\\n \\"IsEnded\\": true,\\n \\"JobId\\": \\"job-y0edwqo993m*****\\",\\n \\"Command\\": \\"status\\",\\n \\"ModifyTime\\": 1603103312000,\\n \\"DataCenterId\\": \\"ap-southeast-1a\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeParameterModificationHistories' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2699,20 +2352,25 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136jco79****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp18si70****10s2', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number of the parameter modification history list.'."\n"
+ ."\n"
+ .'Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page in the parameter modification history list.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -2720,115 +2378,62 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9BA1F8A4-12CC-4638-A7EC-D8FA2768D223',
- ],
- 'Accounts' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CD8CFEE-879B-42FF-BCE5-A339C36E77DF', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the parameter modification history list.'."\n"
+ ."\n"
+ .'Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page in the parameter modification history.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''],
+ 'Histories' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Account' => [
- 'description' => '',
+ 'History' => [
+ 'description' => 'The collection of parameter modification history entries.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
+ 'Time' => ['description' => 'The time when the parameter was changed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1576758805000', 'title' => ''],
+ 'OldValue' => ['description' => 'The old parameter value.', 'type' => 'string', 'example' => '1000', 'title' => ''],
+ 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'cas_contention_timeout_in_ms', 'title' => ''],
+ 'NewValue' => ['description' => 'The new parameter value.', 'type' => 'string', 'example' => '2000', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9BA1F8A4-12CC-4638-A7EC-D8FA2768D223\\",\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountsResponse>\\n <Accounts>\\n <Account>\\n <Name>test</Name>\\n </Account>\\n </Accounts>\\n <RequestId>9BA1F8A4-12CC-4638-A7EC-D8FA2768D223</RequestId>\\n</DescribeAccountsResponse>","errorExample":""}]',
- 'title' => 'DescribeAccounts',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteDataCenter' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp11tjzh50****7d',
- ],
- ],
- [
- 'name' => 'DataCenterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-g',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
'description' => '',
- 'type' => 'string',
- 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDataCenterResponse>\\r\\n <RequestId>200FB963-9359-4CAD-90B7-96395C88FD9D</RequestId>\\r\\n</DeleteDataCenterResponse>","errorExample":""}]',
- 'title' => 'DeleteDataCenter',
+ 'title' => 'View parameter modification history',
+ 'summary' => 'Queries the modification history of parameters by calling DescribeParameterModificationHistories.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyDataCenter' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0CD8CFEE-879B-42FF-BCE5-A339C36E77DF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 18,\\n \\"Histories\\": {\\n \\"History\\": [\\n {\\n \\"Time\\": 1576758805000,\\n \\"OldValue\\": \\"1000\\",\\n \\"Name\\": \\"cas_contention_timeout_in_ms\\",\\n \\"NewValue\\": \\"2000\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeParameters' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2836,41 +2441,25 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d57',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-j6c1zij8****994s', 'title' => ''],
],
[
- 'name' => 'DataCenterId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-g',
- ],
+ 'schema' => ['description' => 'The page number of the list.'."\n"
+ ."\n"
+ .'Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'DataCenterName',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cassandra_test',
- ],
+ 'schema' => ['description' => 'The number of rows per page in a paged query. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -2878,31 +2467,64 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '863163EC-69DA-41B3-AB78-37C123114307', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the list.'."\n"
+ ."\n"
+ .'Valid values: greater than 0 and does not exceed the maximum value of Integer.'."\n"
+ .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of rows per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''],
+ 'Parameters' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Parameter' => [
+ 'description' => 'The list of parameters.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Value' => ['description' => 'The running parameter value.', 'type' => 'string', 'example' => '1000', 'title' => ''],
+ 'DataType' => ['description' => 'The parameter unit.', 'type' => 'string', 'example' => 'INT', 'title' => ''],
+ 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'How long the coordinator should wait for seq or index scans to complete.', 'title' => ''],
+ 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'range_request_timeout_in_ms', 'title' => ''],
+ 'DefaultValue' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => '1000', 'title' => ''],
+ 'AllowedValues' => ['description' => 'The modifiable parameter values.', 'type' => 'string', 'example' => 'R[1000, 60000]', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'FAE9E7A4-0E75-46F7-9710-D2E0B41AF9F5',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FAE9E7A4-0E75-46F7-9710-D2E0B41AF9F5\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDataCenterResponse>\\r\\n<RequestId>FAE9E7A4-0E75-46F7-9710-D2E0B41AF9F5</RequestId>\\r\\n</ModifyDataCenterResponse>","errorExample":""}]',
- 'title' => 'ModifyDataCenter',
+ 'title' => 'Query all parameters in parameter settings',
+ 'summary' => 'Invokes DescribeParameters to query all query parameters in the parameter settings.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"863163EC-69DA-41B3-AB78-37C123114307\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 9,\\n \\"Parameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"Value\\": \\"1000\\",\\n \\"DataType\\": \\"INT\\",\\n \\"Description\\": \\"How long the coordinator should wait for seq or index scans to complete.\\",\\n \\"Name\\": \\"range_request_timeout_in_ms\\",\\n \\"DefaultValue\\": \\"1000\\",\\n \\"AllowedValues\\": \\"R[1000, 60000]\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeRegions' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2910,19 +2532,16 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => 'The supported language. Valid values:'."\n"
+ ."\n"
+ .'- zh-CN: Chinese (default)'."\n"
+ .'- en-US: English'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''],
],
],
'responses' => [
@@ -2930,80 +2549,78 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F20BBD34-681D-4613-8EFA-259DF510A897',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F20BBD34-681D-4613-8EFA-259DF510A897', 'title' => ''],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Region' => [
- 'description' => '',
+ 'description' => 'The list of regions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'RegionEndpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cassandra.aliyuncs.com',
- ],
- 'LocalName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'cassandra.aliyuncs.com', 'title' => ''],
+ 'LocalName' => ['description' => 'The region name.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID, such as ap-southeast-1.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
- 'description' => '',
+ 'description' => 'The list of zones.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-b',
- ],
+ 'Id' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F20BBD34-681D-4613-8EFA-259DF510A897\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"cassandra.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionId\\": \\"华东1（杭州）\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"Id\\": \\"cn-hangzhou-b\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F20BBD34-681D-4613-8EFA-259DF510A897</RequestId>\\n<Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>cassandra.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1（杭州）</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-hangzhou-h</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-i</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-e</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-f</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-g</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>cassandra.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2（上海）</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-shanghai-g</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-e</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-f</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-a</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-c</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-d</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>cassandra.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北1（青岛）</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-qingdao-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-qingdao-c</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>cassandra.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2（北京）</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-beijing-h</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-g</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-f</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-a</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-c</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-d</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-e</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>cassandra.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-shenzhen-d</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-e</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-a</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-c</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-hongkong</RegionId>\\n <RegionEndpoint>cassandra.aliyuncs.com</RegionEndpoint>\\n <LocalName>中国（香港）</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-hongkong-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hongkong-c</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-1</RegionId>\\n <RegionEndpoint>cassandra.aliyuncs.com</RegionEndpoint>\\n <LocalName>新加坡</LocalName>\\n <Zones>\\n <Zone>\\n <Id>ap-southeast-1c</Id>\\n </Zone>\\n <Zone>\\n <Id>ap-southeast-1a</Id>\\n </Zone>\\n <Zone>\\n <Id>ap-southeast-1b</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n</Regions>","errorExample":""}]',
- 'title' => 'DescribeRegions',
+ 'title' => 'Query available regions',
+ 'summary' => 'Queries available regions by calling DescribeRegions.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeDataCenters' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F20BBD34-681D-4613-8EFA-259DF510A897\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"cassandra.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionId\\": \\"华东1（杭州）\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"Id\\": \\"cn-hangzhou-b\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeSecurityGroups' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3011,20 +2628,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d57',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1u2n43****n118', 'title' => ''],
],
],
'responses' => [
@@ -3032,144 +2641,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C8CA4D25-47FE-47D9-A34F-69B554A3A069',
- ],
- 'DataCenters' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C300D7C1-C45C-45F3-965C-9C4C0B7CB266', 'title' => ''],
+ 'SecurityGroupIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'DataCenter' => [
- 'description' => '',
+ 'SecurityGroupId' => [
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp1qitxqe1m5r****4mng',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-22T00:00:00Z',
- ],
- 'VswitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp13e9ynz3jpy****hqlm',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Subscription',
- ],
- 'DiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22000',
- ],
- 'DiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'local_ssd_pro',
- ],
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cassandra.c5.xlarge',
- ],
- 'LockMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'AutoRenewPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'AutoRenewal' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CommodityInstance' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1syjlt****q976',
- ],
- 'NodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'DataCenterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-g',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-09-20T16:02:34Z',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1syjlt****q976',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-g',
- ],
- ],
- ],
+ 'items' => ['description' => 'The collection of security group IDs.', 'type' => 'string', 'example' => 'sg-t4ng4yyc916o81nua6**,sg-****', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C8CA4D25-47FE-47D9-A34F-69B554A3A069\\",\\n \\"DataCenters\\": {\\n \\"DataCenter\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1qitxqe1m5r****4mng\\",\\n \\"Status\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2020-03-22T00:00:00Z\\",\\n \\"VswitchId\\": \\"vsw-bp13e9ynz3jpy****hqlm\\",\\n \\"PayType\\": \\"Subscription\\",\\n \\"DiskSize\\": 22000,\\n \\"DiskType\\": \\"local_ssd_pro\\",\\n \\"InstanceType\\": \\"cassandra.c5.xlarge\\",\\n \\"LockMode\\": \\"None\\",\\n \\"AutoRenewPeriod\\": 12,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AutoRenewal\\": false,\\n \\"CommodityInstance\\": \\"cds-bp1syjlt****q976\\",\\n \\"NodeCount\\": 2,\\n \\"DataCenterName\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"CreatedTime\\": \\"2019-09-20T16:02:34Z\\",\\n \\"ClusterId\\": \\"cds-bp1syjlt****q976\\",\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataCentersResponse>\\n<DataCenters>\\n <DataCenter>\\n <Status>Running</Status>\\n <DataCenterId>cn-hangzhou-g</DataCenterId>\\n <CreatedTime>2020-02-21T10:29:45Z</CreatedTime>\\n <CommodityInstance>cds-bp1syjlt****q976</CommodityInstance>\\n <ZoneId>cn-hangzhou-g</ZoneId>\\n <NodeCount>2</NodeCount>\\n <ClusterId>cds-bp1syjlt****q976</ClusterId>\\n <PayType>Subscription</PayType>\\n <LockMode>None</LockMode>\\n <DataCenterName>test</DataCenterName>\\n <VswitchId>vsw-bp1nm66r36goq****2thl</VswitchId>\\n <DiskType>local_ssd_pro</DiskType>\\n <VpcId>vpc-bp120k6ixs4eo****vu6x</VpcId>\\n <DiskSize>22000</DiskSize>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceType>cassandra.c.2xlarge</InstanceType>\\n <ExpireTime>2020-03-22T00:00:00Z</ExpireTime>\\n </DataCenter>\\n</DataCenters>\\n<RequestId>5AA67458-E8E8-419C-873A-D211CE2C7D31</RequestId>\\n</DescribeDataCentersResponse>","errorExample":""}]',
- 'title' => 'DescribeDataCenters',
+ 'title' => 'Query security groups',
+ 'summary' => 'Queries security groups by calling DescribeSecurityGroups.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateBackupPlan' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C300D7C1-C45C-45F3-965C-9C4C0B7CB266\\",\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-t4ng4yyc916o81nua6**,sg-****\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ExecuteNodeTool' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3177,81 +2687,32 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp11tjzh50****7b',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-3872l6py****n4u1', 'title' => ''],
],
[
- 'name' => 'DataCenterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => ' cn-hangzhou-g',
- ],
- ],
- [
- 'name' => 'BackupTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '00:30Z',
- ],
- ],
- [
- 'name' => 'BackupPeriod',
+ 'name' => 'Command',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Monday',
- ],
+ 'schema' => ['description' => 'The command that follows nodetool.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'settimeout misc', 'title' => ''],
],
[
- 'name' => 'RetentionPeriod',
+ 'name' => 'Arguments',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['description' => 'The arguments that follow the nodetool command.', 'type' => 'string', 'required' => false, 'example' => '10056', 'title' => ''],
],
[
- 'name' => 'Active',
+ 'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The ID of the data center in the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-f', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ExecuteNodes',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The details of the nodes on which the command is executed.', 'type' => 'string', 'required' => false, 'example' => 'core-2', 'title' => ''],
],
],
'responses' => [
@@ -3259,31 +2720,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DCF0CD20-0F85-4FD2-8F75-73636D1331F7', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBackupPlanResponse>\\r\\n <RequestId>200FB963-9359-4CAD-90B7-96395C88FD9D</RequestId>\\r\\n</CreateBackupPlanResponse>","errorExample":""}]',
- 'title' => 'CreateBackupPlan',
+ 'title' => 'ExecuteNodeTool',
+ 'summary' => 'Executes a nodetool command on a specified data center (DC).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteBackupPlan' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DCF0CD20-0F85-4FD2-8F75-73636D1331F7\\"\\n}","type":"json"}]',
+ ],
+ 'GetCmsUrl' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3291,31 +2750,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp11tjzh50****7c',
- ],
- ],
- [
- 'name' => 'DataCenterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => ' cn-hangzhou-g',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d57', 'title' => ''],
],
],
'responses' => [
@@ -3323,31 +2763,30 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D',
- ],
+ 'Url' => ['description' => 'The URL of the CloudMonitor console.', 'type' => 'string', 'example' => 'https://cloudmonitor.console.aliyun.com?instanceId=cds-bp1l5ys68z98wzrc#/group/groupId=14680829&groupName=17926974****3449-cassandra/groupdashboard/cds//', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6453F432-0141-4D35-B2BF-ADF199B39B07', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBackupPlanResponse>\\r\\n <RequestId>200FB963-9359-4CAD-90B7-96395C88FD9D</RequestId>\\r\\n</DeleteBackupPlanResponse>","errorExample":""}]',
- 'title' => 'DeleteBackupPlan',
+ 'title' => 'Redirect to cloudMonitor console',
+ 'summary' => 'Calls GetCmsUrl to redirect to the CloudMonitor console.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyBackupPlan' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"https://cloudmonitor.console.aliyun.com?instanceId=cds-bp1l5ys68z98wzrc#/group/groupId=14680829&groupName=17926974****3449-cassandra/groupdashboard/cds//\\",\\n \\"RequestId\\": \\"6453F432-0141-4D35-B2BF-ADF199B39B07\\"\\n}","type":"json"}]',
+ ],
+ 'ListTagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3355,72 +2794,54 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-uf6m0bod****6158',
- ],
- ],
- [
- 'name' => 'DataCenterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai-e',
- ],
- ],
- [
- 'name' => 'BackupTime',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '00:30Z',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'BackupPeriod',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Monday,Tuesday',
- ],
+ 'schema' => ['description' => 'The token used to retrieve the next page of results. If the response contains a large amount of data, a NextToken is returned.', 'type' => 'string', 'required' => false, 'example' => 'NextToken', 'title' => ''],
],
[
- 'name' => 'RetentionPeriod',
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The ID of resource N. In this context, the resource ID is the cluster ID. You can query multiple resources at a time by specifying ResourceId.2, ResourceId.3, and so on. N is a positive integer.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
- 'example' => '7',
+ 'example' => 'cds-wz9p9ccq****92as',
+ 'maxItems' => 51,
+ 'title' => '',
],
],
[
- 'name' => 'Active',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'boolean',
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the tag to query. You can specify multiple keys. N is a positive integer.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''],
+ 'Value' => ['description' => 'The value of the tag to query. You can specify multiple values. N is a positive integer.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 21,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -3429,31 +2850,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'NextToken' => ['description' => 'The token used to start the next page. If NextToken is empty, no more pages exist.', 'type' => 'string', 'example' => '1d2db86sca4384811e0b5e8707e68181f', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '74F02441-9A8D-48F6-933F-E317AEB28DBF', 'title' => ''],
+ 'TagResources' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TagResource' => [
+ 'description' => 'The list of resources.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'v1', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ALIYUN::CASSANDRA::CLUSTER', 'title' => ''],
+ 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'cds-wz9p9ccq****92as', 'title' => ''],
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'k1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyBackupPlanResponse>\\r\\n<RequestId>FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C</RequestId>\\r\\n</ModifyBackupPlanResponse>","errorExample":""}]',
- 'title' => 'ModifyBackupPlan',
+ 'title' => 'ListTagResources',
+ 'summary' => 'Retrieves a list of tags by ResourceId or Tag (by key only, or by both key and value).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"RequestId\\": \\"74F02441-9A8D-48F6-933F-E317AEB28DBF\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"v1\\",\\n \\"ResourceType\\": \\"ALIYUN::CASSANDRA::CLUSTER\\",\\n \\"ResourceId\\": \\"cds-wz9p9ccq****92as\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListTags' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3461,53 +2907,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp11tjzh50****78',
- ],
- ],
- [
- 'name' => 'DataCenterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => ' cn-hangzhou-g',
- ],
- ],
- [
- 'name' => 'BackupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020010121****',
- ],
- ],
- [
- 'name' => 'BackupType',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Incremental',
- ],
+ 'schema' => ['description' => 'The region ID. You can call DescribeRegions to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
],
'responses' => [
@@ -3515,83 +2920,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D',
- ],
- 'Backup' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36D1BE9B-3C4A-425B-947A-69E3D77999C4', 'title' => ''],
+ 'Tags' => [
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-01-01 21:48:54Z',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-01-01 21:48:40Z',
- ],
- 'Size' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '149016650',
- ],
- 'BackupType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Incremental',
- ],
- 'BackupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020010121****',
- ],
- 'Details' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"name": "cds-uf6m0bod****6159-20200226", "start": "2020-02-26 01:57:05", "end": "2020-02-26 02:12:50", "completeNodes": ["cds-uf6m0bod4****159-1-core-002.cassandra.rds.aliyuncs.com", "cds-uf6m0bo****v6159-1-core-001.cassandra.rds.aliyuncs.com", "cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com"], "incompleteNodes": [], "missingNodes": [], "files": 923, "size": 149016650}',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => ' cn-hangzhou-g',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp11tjzh50****7v',
+ 'Tag' => [
+ 'description' => 'The list of labels.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagValue' => ['description' => 'The label value.', 'type' => 'string', 'example' => 'v2', 'title' => ''],
+ 'TagKey' => ['description' => 'The label key.', 'type' => 'string', 'example' => 'k1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\",\\n \\"Backup\\": {\\n \\"EndTime\\": \\"2020-01-01 21:48:54Z\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"StartTime\\": \\"2020-01-01 21:48:40Z\\",\\n \\"Size\\": 149016650,\\n \\"BackupType\\": \\"Incremental\\",\\n \\"BackupId\\": \\"2020010121****\\",\\n \\"Details\\": \\"{\\\\\\"name\\\\\\": \\\\\\"cds-uf6m0bod****6159-20200226\\\\\\", \\\\\\"start\\\\\\": \\\\\\"2020-02-26 01:57:05\\\\\\", \\\\\\"end\\\\\\": \\\\\\"2020-02-26 02:12:50\\\\\\", \\\\\\"completeNodes\\\\\\": [\\\\\\"cds-uf6m0bod4****159-1-core-002.cassandra.rds.aliyuncs.com\\\\\\", \\\\\\"cds-uf6m0bo****v6159-1-core-001.cassandra.rds.aliyuncs.com\\\\\\", \\\\\\"cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com\\\\\\"], \\\\\\"incompleteNodes\\\\\\": [], \\\\\\"missingNodes\\\\\\": [], \\\\\\"files\\\\\\": 923, \\\\\\"size\\\\\\": 149016650}\\",\\n \\"DataCenterId\\": \\" cn-hangzhou-g\\",\\n \\"ClusterId\\": \\"cds-bp11tjzh50****7v\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupResponse>\\n <RequestId>FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C</RequestId>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <Details>{\\"name\\": \\"cds-uf6m0bod****6159-20200226\\", \\"start\\": \\"2020-02-26 01:57:05\\", \\"end\\": \\"2020-02-26 02:12:50\\", \\"completeNodes\\": [\\"cds-uf6m0bod****6159-1-core-002.cassandra.rds.aliyuncs.com\\", \\"cds-uf6m0bod****6159-1-core-001.cassandra.rds.aliyuncs.com\\", \\"cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com\\"], \\"incompleteNodes\\": [], \\"missingNodes\\": [], \\"files\\": 923, \\"size\\": 149016650}\\n </Details>\\n <EndTime>2020-02-26T02:12:50Z</EndTime>\\n <ClusterId>cds-uf6m0bo****v6159</ClusterId>\\n <Size>149016650</Size>\\n <StartTime>2020-02-26T01:57:00Z</StartTime>\\n <BackupId>20200226</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n</DescribeBackupResponse>","errorExample":""}]',
- 'title' => 'DescribeBackup',
+ 'title' => 'Retrieve all labels in a specified region',
+ 'summary' => 'Retrieves all labels in a specified region.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackupPlan' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36D1BE9B-3C4A-425B-947A-69E3D77999C4\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagValue\\": \\"v2\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyAccountPassword' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3599,31 +2974,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-uf6m0bo****6158',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1l5ys6****wzrx', 'title' => ''],
],
[
- 'name' => 'DataCenterId',
+ 'name' => 'Account',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai-e',
- ],
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cassandra_test', 'title' => ''],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The password of the account. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alibaba@#￥**', 'title' => ''],
],
],
'responses' => [
@@ -3631,73 +2997,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0EA95AA2-860C-42CB-97CF-78CA3937E0D5',
- ],
- 'BackupPlan' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Active' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'BackupPeriod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Monday',
- ],
- 'RetentionPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-02-26T01:56Z',
- ],
- 'BackupTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00:30Z',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-uf6m0b****7v6159',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai-e',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0EA95AA2-860C-42CB-97CF-78CA3937E0D5\\",\\n \\"BackupPlan\\": {\\n \\"Active\\": true,\\n \\"BackupPeriod\\": \\"Monday\\",\\n \\"RetentionPeriod\\": 7,\\n \\"CreatedTime\\": \\"2020-02-26T01:56Z\\",\\n \\"BackupTime\\": \\"00:30Z\\",\\n \\"ClusterId\\": \\"cds-uf6m0b****7v6159\\",\\n \\"DataCenterId\\": \\"cn-shanghai-e\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupPlanResponse>\\n <RequestId>0EA95AA2-860C-42CB-97CF-78CA3937E0D5</RequestId>\\n <BackupPlan>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <BackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</BackupPeriod>\\n <Active>true</Active>\\n <CreatedTime>2020-02-26T01:56Z</CreatedTime>\\n <ClusterId>cds-uf6m0bo****v6159</ClusterId>\\n <BackupTime>00:30Z</BackupTime>\\n <RetentionPeriod>7</RetentionPeriod>\\n </BackupPlan>\\n</DescribeBackupPlanResponse>","errorExample":""}]',
- 'title' => 'DescribeBackupPlan',
+ 'title' => 'Modify account password',
+ 'summary' => 'Modifies the password of a database account.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackups' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyBackupPlan' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3705,42 +3027,39 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-uf6m0bod****6158',
- ],
+ 'schema' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-uf6m0bod****6158', 'title' => ''],
],
[
'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai-e',
- ],
+ 'schema' => ['description' => 'The ID of the cluster data center.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-e', 'title' => ''],
],
[
- 'name' => 'BackupType',
+ 'name' => 'BackupTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Incremental',
- ],
+ 'schema' => ['description' => 'The time when the backup starts each day. The time is in UTC and indicated by the Z suffix.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '00:30Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'BackupPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The backup cycle.'."\n"
+ ."\n"
+ .'Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.', 'type' => 'string', 'required' => false, 'example' => 'Monday,Tuesday', 'title' => ''],
+ ],
+ [
+ 'name' => 'RetentionPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of days for which the backup plan is retained.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''],
+ ],
+ [
+ 'name' => 'Active',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the backup plan is active.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -3748,87 +3067,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA',
- ],
- 'Backups' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Backup' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-02-26T02:12:50Z',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-02-26T01:57:00Z',
- ],
- 'Size' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '149016650',
- ],
- 'BackupType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Incremental',
- ],
- 'BackupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20200***',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-uf6m0bod****6159',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => ' cn-shanghai-e',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA\\",\\n \\"Backups\\": {\\n \\"Backup\\": [\\n {\\n \\"EndTime\\": \\"2020-02-26T02:12:50Z\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"StartTime\\": \\"2020-02-26T01:57:00Z\\",\\n \\"Size\\": 149016650,\\n \\"BackupType\\": \\"Incremental\\",\\n \\"BackupId\\": \\"20200***\\",\\n \\"ClusterId\\": \\"cds-uf6m0bod****6159\\",\\n \\"DataCenterId\\": \\" cn-shanghai-e\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupsResponse>\\n <RequestId>A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA</RequestId>\\n <Backups>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-02-26T02:12:50Z</EndTime>\\n <ClusterId>cds-uf6m0bo****6159</ClusterId>\\n <Size>149016650</Size>\\n <StartTime>2020-02-26T01:57:00Z</StartTime>\\n <BackupId>20200226</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-02-27T01:01:28Z</EndTime>\\n <ClusterId>cds-uf6m0bod****6159</ClusterId>\\n <Size>149494577</Size>\\n <StartTime>2020-02-27T01:01:00Z</StartTime>\\n <BackupId>20200227</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-02-28T01:01:23Z</EndTime>\\n <ClusterId>cds-uf6m0bo****v6159</ClusterId>\\n <Size>149282931</Size>\\n <StartTime>2020-02-28T01:01:00Z</StartTime>\\n <BackupId>20200228</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-02-29T01:00:56Z</EndTime>\\n <ClusterId>cds-uf6m0bod****6159</ClusterId>\\n <Size>149454625</Size>\\n <StartTime>2020-02-29T00:25:28Z</StartTime>\\n <BackupId>20200229</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-03-02T22:12:41Z</EndTime>\\n <ClusterId>cds-uf6m0bo****v6159</ClusterId>\\n <Size>149364202</Size>\\n <StartTime>2020-03-01T00:30:00Z</StartTime>\\n <BackupId>20200301</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-03-02T00:30:13Z</EndTime>\\n <ClusterId>cds-uf6m0bod****6159</ClusterId>\\n <Size>149356372</Size>\\n <StartTime>2020-03-02T00:30:00Z</StartTime>\\n <BackupId>20200302</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-03-04T02:11:59Z</EndTime>\\n <ClusterId>cds-uf6m0bo****v6159</ClusterId>\\n <Size>149359298</Size>\\n <StartTime>2020-03-03T00:30:00Z</StartTime>\\n <BackupId>20200303</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-03-04T02:12:09Z</EndTime>\\n <ClusterId>cds-uf6m0bod****6159</ClusterId>\\n <Size>149267899</Size>\\n <StartTime>2020-03-04T00:30:00Z</StartTime>\\n <BackupId>20200304</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-03-06T15:52:58Z</EndTime>\\n <ClusterId>cds-uf6m0bod****6159</ClusterId>\\n <Size>149188148</Size>\\n <StartTime>2020-03-05T00:30:00Z</StartTime>\\n <BackupId>20200305</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n <Backup>\\n <Status>Succeeded</Status>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <EndTime>2020-03-06T15:53:06Z</EndTime>\\n <ClusterId>cds-uf6m0bod****6159</ClusterId>\\n <Size>149188280</Size>\\n <StartTime>2020-03-06T00:30:00Z</StartTime>\\n <BackupId>20200306</BackupId>\\n <BackupType>Incremental</BackupType>\\n </Backup>\\n </Backups>\\n</DescribeBackupsResponse>","errorExample":""}]',
- 'title' => 'DescribeBackups',
+ 'title' => 'Modify a backup plan',
+ 'summary' => 'Calls ModifyBackupPlan to modify a backup plan.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackupPlans' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3836,20 +3097,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1yt5g0****7f48',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' cds-bp1b136j****5d58', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClusterName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'Cassandra_test', 'title' => ''],
+ ],
+ [
+ 'name' => 'ConfirmProductOffline',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -3857,82 +3120,28 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200FB963-9359-4CAD-90B7-96395C88FD9D',
- ],
- 'BackupPlans' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'BackupPlan' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Active' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'BackupPeriod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Monday',
- ],
- 'RetentionPeriod' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-02-26T01:56Z',
- ],
- 'BackupTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => ' 00:30Z',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-uf6m0bod****6159',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-g',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '39F3F7DF-435B-47C1-832C-369BF9661A67', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"200FB963-9359-4CAD-90B7-96395C88FD9D\\",\\n \\"BackupPlans\\": {\\n \\"BackupPlan\\": [\\n {\\n \\"Active\\": true,\\n \\"BackupPeriod\\": \\"Monday\\",\\n \\"RetentionPeriod\\": 5,\\n \\"CreatedTime\\": \\"2020-02-26T01:56Z\\",\\n \\"BackupTime\\": \\" 00:30Z\\",\\n \\"ClusterId\\": \\"cds-uf6m0bod****6159\\",\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupPlansResponse>\\n <RequestId>DBADCCEE-0E07-4DBD-9343-C7F312B23979</RequestId>\\n <BackupPlans>\\n <BackupPlan>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <BackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</BackupPeriod>\\n <Active>true</Active>\\n <CreatedTime>2020-02-26T01:56Z</CreatedTime>\\n <ClusterId>cds-uf6m0bod****6159</ClusterId>\\n <BackupTime>00:30Z</BackupTime>\\n <RetentionPeriod>7</RetentionPeriod>\\n </BackupPlan>\\n </BackupPlans>\\n</DescribeBackupPlansResponse>","errorExample":""}]',
- 'title' => 'DescribeBackupPlans',
+ 'title' => 'Modify cluster name',
+ 'summary' => 'Calls ModifyCluster to modify the name of a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeContactPoints' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39F3F7DF-435B-47C1-832C-369BF9661A67\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDataCenter' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3940,20 +3149,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d57',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d57', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data center ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new name of the data center.', 'type' => 'string', 'required' => false, 'example' => 'Cassandra_test', 'title' => ''],
],
],
'responses' => [
@@ -3961,85 +3172,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '467F786B-C765-40C4-8493-89F4CE95F1B6',
- ],
- 'ContactPoints' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ContactPoint' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Port' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '9042',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-g',
- ],
- 'PublicAddresses' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'PublicAddress' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-proxy-pub-bp1b136j****5d56-1-core-002.cassandra.rds.aliyuncs.com',
- ],
- ],
- ],
- ],
- 'PrivateAddresses' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'PrivateAddress' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1b136****5d56-1-core-001.cassandra.rds.aliyuncs.com',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FAE9E7A4-0E75-46F7-9710-D2E0B41AF9F5', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"467F786B-C765-40C4-8493-89F4CE95F1B6\\",\\n \\"ContactPoints\\": {\\n \\"ContactPoint\\": [\\n {\\n \\"Port\\": 9042,\\n \\"DataCenterId\\": \\"cn-hangzhou-g\\",\\n \\"PublicAddresses\\": {\\n \\"PublicAddress\\": [\\n \\"cds-proxy-pub-bp1b136j****5d56-1-core-002.cassandra.rds.aliyuncs.com\\"\\n ]\\n },\\n \\"PrivateAddresses\\": {\\n \\"PrivateAddress\\": [\\n \\"cds-bp1b136****5d56-1-core-001.cassandra.rds.aliyuncs.com\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactPointsResponse>\\n<RequestId>467F786B-C765-40C4-8493-89F4CE95F1B6</RequestId>\\n<ContactPoints>\\n <ContactPoint>\\n <Port>9042</Port>\\n <DataCenterId>cn-hangzhou-g</DataCenterId>\\n <PrivateAddresses>\\n <PrivateAddress>cds-bp1b136j****5d56-1-core-001.cassandra.rds.aliyuncs.com</PrivateAddress>\\n <PrivateAddress>cds-bp1b136j****5d56-1-core-002.cassandra.rds.aliyuncs.com</PrivateAddress>\\n </PrivateAddresses>\\n <PublicAddresses>\\n <PublicAddress>cds-proxy-pub-bp1b136j****5d56-1-core-001.cassandra.rds.aliyuncs.com</PublicAddress>\\n <PublicAddress>cds-proxy-pub-bp1b136j****5d56-1-core-002.cassandra.rds.aliyuncs.com</PublicAddress>\\n </PublicAddresses>\\n </ContactPoint>\\n</ContactPoints>\\n</DescribeContactPointsResponse>","errorExample":""}]',
- 'title' => 'DescribeContactPoints',
+ 'title' => 'Modify data center name',
+ 'summary' => 'Calls ModifyDataCenter to modify the name of a data center.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'AllocatePublicContactPoints' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAE9E7A4-0E75-46F7-9710-D2E0B41AF9F5\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceMaintainTime' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4047,37 +3202,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1hy2i****2z46l',
- ],
+ 'schema' => ['description' => 'The ID of the cluster for which you want to modify the O&M window.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b**6jco895****', 'title' => ''],
],
[
- 'name' => 'DataCenterId',
+ 'name' => 'MaintainStartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-g',
- ],
+ 'schema' => ['description' => 'The start time of the instance O&M window. The time is in the HH:mm format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2:00', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'MaintainEndTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The end time of the instance O&M window. The time is in the HH:mm format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4:00', 'title' => ''],
],
],
'responses' => [
@@ -4085,31 +3225,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C9085433-A56A-4089-B49A-DF5A4E2B7B06', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocatePublicContactPointsResponse>\\r\\n <RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>\\r\\n</AllocatePublicContactPointsResponse>","errorExample":""}]',
- 'title' => 'AllocatePublicContactPoints',
+ 'title' => 'Modify instance O&M window start time',
+ 'summary' => 'Calls ModifyInstanceMaintainTime to modify the O&M window start time of an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ReleasePublicContactPoints' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2B7B06\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceType' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4117,29 +3255,26 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1b136j****5d51',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-uf6ig2gf****7pw7', 'title' => ''],
],
[
'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-g',
- ],
+ 'schema' => ['description' => 'The data center ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-e', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance type of the cluster. Examples of valid values:'."\n"
+ ."\n"
+ .'- cassandra.c.large: 2 vCPUs, 4 GB memory'."\n"
+ .'- cassandra.c.xlarge: 4 vCPUs, 8 GB memory'."\n"
+ .'- cassandra.c.2xlarge: 8 vCPUs, 16 GB memory.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cassandra.g.xlarge', 'title' => ''],
],
],
'responses' => [
@@ -4147,31 +3282,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DE71CDCF-97AF-4D69-A327-5F4B23184B9A',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BC262FE3-91ED-4FE7-BD75-190B62D8BABC', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DE71CDCF-97AF-4D69-A327-5F4B23184B9A\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleasePublicContactPointsResponse>\\r\\n<RequestId>DE71CDCF-97AF-4D69-A327-5F4B23184B9A</RequestId>\\r\\n</ReleasePublicContactPointsResponse>","errorExample":""}]',
- 'title' => 'ReleasePublicContactPoints',
+ 'title' => 'Modify instance type',
+ 'summary' => 'Modifies the instance type of a cluster by calling ModifyInstanceType.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteNodeToolExecutionHistory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC262FE3-91ED-4FE7-BD75-190B62D8BABC\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyIpWhitelist' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4179,42 +3312,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-3872l6py****n4ug',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d51', 'title' => ''],
],
[
- 'name' => 'JobId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'job-QdKa51s****U0gHf',
- ],
- ],
- [
- 'name' => 'DataCenterId',
+ 'name' => 'IpList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai-f',
- ],
+ 'schema' => ['description' => 'The list of IP addresses.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '192.***.0.23,30.15.***.133', 'title' => ''],
],
],
'responses' => [
@@ -4222,31 +3330,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D72B6BAC-BB95-48DA-99A9-A9903CD02498',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11B95AE4-BB1A-4B62-9655-C43395C0B234', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D72B6BAC-BB95-48DA-99A9-A9903CD02498\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteNodeToolExecutionHistoryResponse>\\r\\n <RequestId>D72B6BAC-BB95-48DA-99A9-A9903CD02498</RequestId>\\r\\n</DeleteNodeToolExecutionHistoryResponse>","errorExample":""}]',
- 'title' => 'DeleteNodeToolExecutionHistory',
+ 'title' => 'Modify cluster network access whitelist',
+ 'summary' => 'Modifies the network access whitelist of a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeNodeToolExecutionHistory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11B95AE4-BB1A-4B62-9655-C43395C0B234\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyIpWhitelistGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4254,42 +3360,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-t4n98w89z77*****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-uf6ig2gf****7pw9', 'title' => ''],
],
[
- 'name' => 'DcId',
+ 'name' => 'IpList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ap-southeast-1a',
- ],
+ 'schema' => ['description' => 'The whitelist.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '218.30.***.40,192.***.0.23', 'title' => ''],
],
[
- 'name' => 'JobId',
+ 'name' => 'GroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'job-y0edwqo993m*****',
- ],
+ 'schema' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'IpVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IP version. Valid values: ipV4 and ipV6.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '6', 'title' => ''],
],
],
'responses' => [
@@ -4297,87 +3388,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Nodes' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'core-1',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Error: The keyspace ap-southeast-1a, does not exist',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'result',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1603103307000',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1',
- ],
- 'Arguments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1a',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '94D5E0BE-F383-4BBB-B768-7FA3414E95A3',
- ],
- 'IsEnded' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'job-y0edwqo993m*****',
- ],
- 'Command' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'status',
- ],
- 'ModifyTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1603103312000',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1a',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Nodes\\": \\"core-1\\",\\n \\"ErrorMessage\\": \\"Error: The keyspace ap-southeast-1a, does not exist\\",\\n \\"Result\\": \\"result\\",\\n \\"CreateTime\\": 1603103307000,\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"Arguments\\": \\"ap-southeast-1a\\",\\n \\"RequestId\\": \\"94D5E0BE-F383-4BBB-B768-7FA3414E95A3\\",\\n \\"IsEnded\\": true,\\n \\"JobId\\": \\"job-y0edwqo993m*****\\",\\n \\"Command\\": \\"status\\",\\n \\"ModifyTime\\": 1603103312000,\\n \\"DataCenterId\\": \\"ap-southeast-1a\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTime>1603103312000</ModifyTime>\\n<DataCenterId>ap-southeast-1a</DataCenterId>\\n<RequestId>94D5E0BE-F383-4BBB-B768-7FA3414E95A3</RequestId>\\n<CreateTime>1603103307000</CreateTime>\\n<Arguments>ap-southeast-1a</Arguments>\\n<Nodes>core-1</Nodes>\\n<Result>result</Result>\\n<IsEnded>true</IsEnded>\\n<Command>status</Command>\\n<RegionId>ap-southeast-1</RegionId>\\n<ErrorMessage>Error: The keyspace ap-southeast-1a, does not exist</ErrorMessage>\\n<JobId>job-y0edwqo993m*****</JobId>","errorExample":""}]',
- 'title' => 'DescribeNodeToolExecutionHistory',
+ 'errorCodes' => [],
+ 'title' => 'Modify cluster whitelist group',
+ 'summary' => 'Modifies the whitelist group of a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeNodeToolExecutionHistories' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyParameter' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4385,42 +3418,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-3872l6py****n9ul',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1l5ys6****wzr5', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cas_contention_timeout_in_ms', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The parameter value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2000', 'title' => ''],
],
],
'responses' => [
@@ -4428,116 +3441,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FDC6EF03-8B7D-470D-AB81-BD9C9713A9E3',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'Histories' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'History' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Nodes' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'core-1,core-2',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'See \\"nodetool help\\" or \\"nodetool help',
- ],
- 'IsEnded' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1576725956000',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'job-C3zcrKtZ****qapO',
- ],
- 'Command' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'settimeout misc',
- ],
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai-f',
- ],
- 'Arguments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10093',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'ModifyTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1576725689000',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BC262FE3-91ED-4FE7-BD75-190B62D8BABC', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FDC6EF03-8B7D-470D-AB81-BD9C9713A9E3\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Histories\\": {\\n \\"History\\": [\\n {\\n \\"Nodes\\": \\"core-1,core-2\\",\\n \\"ErrorMessage\\": \\"See \\\\\\\\\\\\\\"nodetool help\\\\\\\\\\\\\\" or \\\\\\\\\\\\\\"nodetool help\\",\\n \\"IsEnded\\": true,\\n \\"CreateTime\\": 1576725956000,\\n \\"JobId\\": \\"job-C3zcrKtZ****qapO\\",\\n \\"Command\\": \\"settimeout misc\\",\\n \\"DataCenterId\\": \\"cn-shanghai-f\\",\\n \\"Arguments\\": \\"10093\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"ModifyTime\\": 1576725689000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeNodeToolExecutionHistoriesResponse>\\n<TotalCount>2</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>FDC6EF03-8B7D-470D-AB81-BD9C9713A9E3</RequestId>\\n<PageNumber>1</PageNumber>\\n<Histories>\\n <History>\\n <ModifyTime>1576725953000</ModifyTime>\\n <DataCenterId>cn-shanghai-f</DataCenterId>\\n <Command>settimeout misc</Command>\\n <CreateTime>1576725956000</CreateTime>\\n <Arguments>10093</Arguments>\\n <RegionId>cn-shanghai</RegionId>\\n <JobId>job-0XDBTwhOxelqFikQ</JobId>\\n <Nodes>core-1,core-2</Nodes>\\n </History>\\n <History>\\n <ModifyTime>1576725689000</ModifyTime>\\n <DataCenterId>cn-shanghai-f</DataCenterId>\\n <Command>settimeout misc</Command>\\n <CreateTime>1576725692000</CreateTime>\\n <Arguments>10039</Arguments>\\n <RegionId>cn-shanghai</RegionId>\\n <JobId>job-C3zcrKtZijSyqapO</JobId>\\n <Nodes>core-1,core-2</Nodes>\\n </History>\\n</Histories>\\n</DescribeNodeToolExecutionHistoriesResponse>","errorExample":""}]',
- 'title' => 'DescribeNodeToolExecutionHistories',
+ 'title' => 'Modify a parameter in parameter settings',
+ 'summary' => 'Calls ModifyParameter to modify a parameter in the parameter settings.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ExecuteNodeTool' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC262FE3-91ED-4FE7-BD75-190B62D8BABC\\"\\n}","type":"json"}]',
+ ],
+ 'ModifySecurityGroups' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4545,60 +3471,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-3872l6py****n4u1',
- ],
- ],
- [
- 'name' => 'Command',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'settimeout misc',
- ],
- ],
- [
- 'name' => 'Arguments',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10056',
- ],
- ],
- [
- 'name' => 'DataCenterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai-f',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp142mt7****136k', 'title' => ''],
],
[
- 'name' => 'ExecuteNodes',
+ 'name' => 'SecurityGroupIds',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'core-2',
- ],
+ 'schema' => ['description' => 'The IDs of the security groups. Separate multiple IDs with commas (,). You can specify up to three security group IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sg-t4ng4yyc916o81nua6**,sg-******', 'title' => ''],
],
],
'responses' => [
@@ -4606,31 +3489,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DCF0CD20-0F85-4FD2-8F75-73636D1331F7',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4EC521F2-5E15-41F8-92C2-0C454EA02434', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DCF0CD20-0F85-4FD2-8F75-73636D1331F7\\"\\n}","errorExample":""},{"type":"xml","example":"<ExecuteNodeToolResponse>\\r\\n<RequestId>DCF0CD20-0F85-4FD2-8F75-73636D1331F7</RequestId>\\r\\n</ExecuteNodeToolResponse>","errorExample":""}]',
- 'title' => 'ExecuteNodeTool',
+ 'title' => 'Modify security groups',
+ 'summary' => 'Calls ModifySecurityGroups to modify security groups.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyParameter' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EC521F2-5E15-41F8-92C2-0C454EA02434\\"\\n}","type":"json"}]',
+ ],
+ 'MoveResourceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4638,42 +3519,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp1l5ys6****wzr5',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-k6g0e3l9h****', 'title' => ''],
],
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cas_contention_timeout_in_ms',
- ],
- ],
- [
- 'name' => 'Value',
+ 'name' => 'NewResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2000',
- ],
+ 'schema' => ['description' => 'The ID of the new resource group. You can view available resource groups in the resource group console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-a4f9jl8u4e****', 'title' => ''],
],
],
'responses' => [
@@ -4681,31 +3537,28 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BC262FE3-91ED-4FE7-BD75-190B62D8BABC',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF520A14-0247-47C2-B5CA-7E01D34E9C8A', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC262FE3-91ED-4FE7-BD75-190B62D8BABC\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyParameterResponse>\\r\\n<RequestId>BC262FE3-91ED-4FE7-BD75-190B62D8BABC</RequestId>\\r\\n</ModifyParameterResponse>","errorExample":""}]',
- 'title' => 'ModifyParameter',
+ 'title' => 'Move a resource to a different resource group',
+ 'summary' => 'Moves a resource to a different resource group.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeParameterModificationHistories' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FF520A14-0247-47C2-B5CA-7E01D34E9C8A\\"\\n}","type":"json"}]',
+ ],
+ 'PurgeCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4713,42 +3566,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp18si70****10s2',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The ID of the deleted cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1hy2ip****z465', 'title' => ''],
],
],
'responses' => [
@@ -4756,85 +3579,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0CD8CFEE-879B-42FF-BCE5-A339C36E77DF',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '18',
- ],
- 'Histories' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'History' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Time' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1576758805000',
- ],
- 'OldValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1000',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cas_contention_timeout_in_ms',
- ],
- 'NewValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2000',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '317BF5F0-2575-4158-9493-6DA83465491B', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0CD8CFEE-879B-42FF-BCE5-A339C36E77DF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 18,\\n \\"Histories\\": {\\n \\"History\\": [\\n {\\n \\"Time\\": 1576758805000,\\n \\"OldValue\\": \\"1000\\",\\n \\"Name\\": \\"cas_contention_timeout_in_ms\\",\\n \\"NewValue\\": \\"2000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeParameterModificationHistoriesResponse>\\n<Histories>\\n <History>\\n <Name>cas_contention_timeout_in_ms</Name>\\n <Time>1576758805000</Time>\\n <NewValue>1100</NewValue>\\n <OldValue>1000</OldValue>\\n </History>\\n <History>\\n <Name>cas_contention_timeout_in_ms</Name>\\n <Time>1576759085000</Time>\\n <NewValue>1000</NewValue>\\n <OldValue>1100</OldValue>\\n </History>\\n</Histories>\\n<PageNumber>1</PageNumber>\\n<TotalCount>2</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>0CD8CFEE-879B-42FF-BCE5-A339C36E77DF</RequestId>\\n</DescribeParameterModificationHistoriesResponse>","errorExample":""}]',
- 'title' => 'DescribeParameterModificationHistories',
+ 'title' => 'Purge a deleted cluster',
+ 'summary' => 'Purges a deleted cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeParameters' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"317BF5F0-2575-4158-9493-6DA83465491B\\"\\n}","type":"json"}]',
+ ],
+ 'RebootCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4842,42 +3609,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-j6c1zij8****994s',
- ],
+ 'schema' => ['description' => 'The ID of the cluster to restart.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d51', 'title' => ''],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The ID of the data center.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''],
],
],
'responses' => [
@@ -4885,94 +3627,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '863163EC-69DA-41B3-AB78-37C123114307',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9',
- ],
- 'Parameters' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Parameter' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1000',
- ],
- 'DataType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'INT',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'How long the coordinator should wait for seq or index scans to complete.',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'range_request_timeout_in_ms',
- ],
- 'DefaultValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1000',
- ],
- 'AllowedValues' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'R[1000, 60000]',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '033F5CDA-EF5E-4893-93C3-7EA5DCB76AF3', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863163EC-69DA-41B3-AB78-37C123114307\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 9,\\n \\"Parameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"Value\\": \\"1000\\",\\n \\"DataType\\": \\"INT\\",\\n \\"Description\\": \\"How long the coordinator should wait for seq or index scans to complete.\\",\\n \\"Name\\": \\"range_request_timeout_in_ms\\",\\n \\"DefaultValue\\": \\"1000\\",\\n \\"AllowedValues\\": \\"R[1000, 60000]\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeParametersResponse>\\n<Parameters>\\n <Parameter>\\n <Name>cas_contention_timeout_in_ms</Name>\\n <Description>How long a coordinator should continue to retry a CAS operation that contends with other proposals for the same row.</Description>\\n <AllowedValues>R[1000, 60000]</AllowedValues>\\n <Value>1000</Value>\\n <DataType>INT</DataType>\\n <DefaultValue>1000</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>counter_write_request_timeout_in_ms</Name>\\n <Description>How long the coordinator should wait for counter writes to complete.</Description>\\n <AllowedValues>R[1000, 60000]</AllowedValues>\\n <Value>5000</Value>\\n <DataType>INT</DataType>\\n <DefaultValue>5000</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>enable_materialized_views</Name>\\n <Description>Enables materialized view creation on this node.</Description>\\n <AllowedValues>G[true|false]</AllowedValues>\\n <Value>true</Value>\\n <DataType>STR</DataType>\\n <DefaultValue>true</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>enable_sasi_indexes</Name>\\n <Description>Enables SASI index creation on this node.</Description>\\n <AllowedValues>G[true|false]</AllowedValues>\\n <Value>true</Value>\\n <DataType>STR</DataType>\\n <DefaultValue>true</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>range_request_timeout_in_ms</Name>\\n <Description>How long the coordinator should wait for seq or index scans to complete.</Description>\\n <AllowedValues>R[1000, 60000]</AllowedValues>\\n <Value>10000</Value>\\n <DataType>INT</DataType>\\n <DefaultValue>10000</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>read_request_timeout_in_ms</Name>\\n <Description>How long the coordinator should wait for read operations to complete.</Description>\\n <AllowedValues>R[1000, 60000]</AllowedValues>\\n <Value>5000</Value>\\n <DataType>INT</DataType>\\n <DefaultValue>5000</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>request_timeout_in_ms</Name>\\n <Description>The default timeout for other, miscellaneous operations.</Description>\\n <AllowedValues>R[1000, 60000]</AllowedValues>\\n <Value>10000</Value>\\n <DataType>INT</DataType>\\n <DefaultValue>10000</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>truncate_request_timeout_in_ms</Name>\\n <Description>How long the coordinator should wait for truncates to complete.</Description>\\n <AllowedValues>R[1000, 60000]</AllowedValues>\\n <Value>60000</Value>\\n <DataType>INT</DataType>\\n <DefaultValue>60000</DefaultValue>\\n </Parameter>\\n <Parameter>\\n <Name>write_request_timeout_in_ms</Name>\\n <Description>How long the coordinator should wait for writes to complete.</Description>\\n <AllowedValues>R[1000, 60000]</AllowedValues>\\n <Value>2000</Value>\\n <DataType>INT</DataType>\\n <DefaultValue>2000</DefaultValue>\\n </Parameter>\\n</Parameters>\\n<PageNumber>1</PageNumber>\\n<TotalCount>9</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>863163EC-69DA-41B3-AB78-37C123114307</RequestId>\\n</DescribeParametersResponse>","errorExample":""}]',
- 'title' => 'DescribeParameters',
+ 'title' => 'RebootCluster',
+ 'summary' => 'Restarts a cluster by calling RebootCluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeClusterDashboard' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"033F5CDA-EF5E-4893-93C3-7EA5DCB76AF3\\"\\n}","type":"json"}]',
+ ],
+ 'ReleasePublicContactPoints' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4980,20 +3657,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-bp14****135h',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d51', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data center ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''],
],
],
'responses' => [
@@ -5001,92 +3675,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9339F598-0560-43CE-9F57-CD7B6B385DBB',
- ],
- 'Dashboard' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-bp1syjlt****q976',
- ],
- 'DataCenters' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'DataCenter' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DataCenterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai-e',
- ],
- 'Nodes' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Node' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Address' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '192.***.12.3',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UpNormal',
- ],
- 'Load' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '54.4 MiB',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DE71CDCF-97AF-4D69-A327-5F4B23184B9A', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9339F598-0560-43CE-9F57-CD7B6B385DBB\\",\\n \\"Dashboard\\": {\\n \\"ClusterId\\": \\"cds-bp1syjlt****q976\\",\\n \\"DataCenters\\": {\\n \\"DataCenter\\": [\\n {\\n \\"DataCenterId\\": \\"cn-shanghai-e\\",\\n \\"Nodes\\": {\\n \\"Node\\": [\\n {\\n \\"Address\\": \\"192.***.12.3\\",\\n \\"Status\\": \\"UpNormal\\",\\n \\"Load\\": \\"54.4 MiB\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterDashboardResponse>\\n <RequestId>9339F598-0560-43CE-9F57-CD7B6B385DBB</RequestId>\\n <Dashboard>\\n <DataCenters>\\n <DataCenter>\\n <DataCenterId>cn-shanghai-e</DataCenterId>\\n <Nodes>\\n <Node>\\n <Status>UpNormal</Status>\\n <Load>54.4 MiB</Load>\\n <Address>192.***.0.208</Address>\\n </Node>\\n <Node>\\n <Status>UpNormal</Status>\\n <Load>49.99 MiB</Load>\\n <Address>192.***.0.209</Address>\\n </Node>\\n <Node>\\n <Status>UpNormal</Status>\\n <Load>37.8 MiB</Load>\\n <Address>192.***.0.211</Address>\\n </Node>\\n </Nodes>\\n </DataCenter>\\n </DataCenters>\\n <ClusterId>cds-uf6m0bod4***6159</ClusterId>\\n </Dashboard>\\n</DescribeClusterDashboardResponse>","errorExample":""}]',
- 'title' => 'DescribeClusterDashboard',
+ 'title' => 'Release public network connection points',
+ 'summary' => 'Releases public network connection points by calling ReleasePublicContactPoints.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListTagResources' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE71CDCF-97AF-4D69-A327-5F4B23184B9A\\"\\n}","type":"json"}]',
+ ],
+ 'ResizeDiskSize' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5094,75 +3705,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d51', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'DataCenterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NextToken',
- ],
+ 'schema' => ['description' => 'The ID of the data center in the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''],
],
[
- 'name' => 'ResourceId',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'required' => false,
- 'example' => 'cds-wz9p9ccq****92as',
- 'maxItems' => 51,
- ],
- ],
- [
- 'name' => 'Tag',
+ 'name' => 'DiskSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key1',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => 'The new cloud disk size after modification. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '240', 'title' => ''],
],
],
'responses' => [
@@ -5170,70 +3728,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1d2db86sca4384811e0b5e8707e68181f',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '74F02441-9A8D-48F6-933F-E317AEB28DBF',
- ],
- 'TagResources' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'TagResource' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'ResourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALIYUN::CASSANDRA::CLUSTER',
- ],
- 'ResourceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cds-wz9p9ccq****92as',
- ],
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5C37DF4E-54D6-4AFA-A1F9-79ADC148F8AD', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"RequestId\\": \\"74F02441-9A8D-48F6-933F-E317AEB28DBF\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"v1\\",\\n \\"ResourceType\\": \\"ALIYUN::CASSANDRA::CLUSTER\\",\\n \\"ResourceId\\": \\"cds-wz9p9ccq****92as\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>74F02441-9A8D-48F6-933F-E317AEB28DBF</RequestId>\\n<NextToken>1d2db86sca4384811e0b5e8707e68181f</NextToken>\\n<TagResources>\\n <TagResource>\\n <ResourceId>cds-wz9p9ccq****92as</ResourceId>\\n <TagKey>k1</TagKey>\\n <ResourceType>ALIYUN::CASSANDRA::CLUSTER</ResourceType>\\n <TagValue>v1</TagValue>\\n </TagResource>\\n</TagResources>","errorExample":""}]',
- 'title' => 'ListTagResources',
+ 'errorCodes' => [],
+ 'title' => 'Expand or resize a cloud disk',
+ 'summary' => 'Expands a cloud disk.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListTags' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C37DF4E-54D6-4AFA-A1F9-79ADC148F8AD\\"\\n}","type":"json"}]',
+ ],
+ 'ResizeNodeCount' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5241,20 +3758,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cds-bp1b136j****5d59', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataCenterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data center ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' cn-hangzhou-g', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of nodes in the data center.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3', 'title' => ''],
],
],
'responses' => [
@@ -5262,55 +3781,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '36D1BE9B-3C4A-425B-947A-69E3D77999C4',
- ],
- 'Tags' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Tag' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v2',
- ],
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D7D3088F-AA4F-49C3-BB46-B04F3E35041A', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36D1BE9B-3C4A-425B-947A-69E3D77999C4\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagValue\\": \\"v2\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagsResponse>\\n<Tags>\\n <Tag>\\n <TagValue/>\\n <TagKey>k1</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v1</TagValue>\\n <TagKey>k1</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v2</TagValue>\\n <TagKey>k1</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v2</TagValue>\\n <TagKey>k2</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v3</TagValue>\\n <TagKey>k3</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>single</TagValue>\\n <TagKey>type</TagKey>\\n </Tag>\\n</Tags>\\n<RequestId>36D1BE9B-3C4A-425B-947A-69E3D77999C4</RequestId>\\n</ListTagsResponse>","errorExample":""}]',
- 'title' => 'ListTags',
+ 'errorCodes' => [],
+ 'title' => 'Scale out data center nodes',
+ 'summary' => 'Calls ResizeNodeCount to scale out the nodes of a data center.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UnTagResources' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D7D3088F-AA4F-49C3-BB46-B04F3E35041A\\"\\n}","type":"json"}]',
+ ],
+ 'TagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5318,59 +3811,49 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shenzhen',
- ],
- ],
- [
- 'name' => 'All',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The Nth resource ID, which is the cluster ID. If you have multiple resource IDs, you can pass parameters such as ResourceId.2 and ResourceId.3. Tags specified in the Tag parameter are added to all specified resource IDs. N is a positive integer.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'required' => true,
'example' => 'cds-wz92o754****7779',
'maxItems' => 51,
+ 'title' => '',
],
],
[
- 'name' => 'TagKey',
+ 'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of tags.',
'type' => 'array',
'items' => [
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the Nth tag. N is a positive integer.', 'type' => 'string', 'required' => false, 'example' => 'k1', 'title' => ''],
+ 'Value' => ['description' => 'The value of the Nth tag.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- 'example' => 'key',
+ 'required' => true,
'maxItems' => 21,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -5379,27 +3862,29 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB59286',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2656FA19-6059-40C8-A157-3FFBEAEC2369', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB59286\\"\\n}","errorExample":""},{"type":"xml","example":"<UnTagResourcesResponse>\\r\\n<RequestId>9CBF8DF0-4931-4A54-9B60-4C6E1AB59286</RequestId>\\r\\n</UnTagResourcesResponse>","errorExample":""}]',
- 'title' => 'UnTagResources',
- ],
- 'MoveResourceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Add tags to instances',
+ 'summary' => 'Calls the TagResources operation to add tags to instances.',
+ 'description' => '****.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2656FA19-6059-40C8-A157-3FFBEAEC2369\\"\\n}","type":"json"}]',
+ ],
+ 'UnTagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5407,30 +3892,44 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''],
+ ],
+ [
+ 'name' => 'All',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to delete all labels. If TagKey is specified, labels are deleted only by TagKey. Valid values: true and false. If this parameter is set to true and TagKey is not specified, all labels are deleted.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The ID of the Nth resource to delete. The resource ID is the cluster ID. If you want to specify multiple resource IDs, pass parameter names such as ResourceId.2 and ResourceId.3. N is a positive integer.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
- 'docRequired' => true,
- 'example' => 'cds-k6g0e3l9h****',
+ 'example' => 'cds-wz92o754****7779',
+ 'maxItems' => 51,
+ 'title' => '',
],
],
[
- 'name' => 'NewResourceGroupId',
+ 'name' => 'TagKey',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'rg-a4f9jl8u4e****',
+ 'description' => 'The key of the Nth label to delete. You can specify multiple keys, such as TagKey.2 and TagKey.3. N is a positive integer.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'required' => false,
+ 'example' => 'key',
+ 'maxItems' => 21,
+ 'title' => '',
],
],
],
@@ -5439,30 +3938,25 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FF520A14-0247-47C2-B5CA-7E01D34E9C8A',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB59286', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF520A14-0247-47C2-B5CA-7E01D34E9C8A\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FF520A14-0247-47C2-B5CA-7E01D34E9C8A</RequestId>","errorExample":""}]',
- 'title' => 'MoveResourceGroup',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'TagResources' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Delete resource labels',
+ 'summary' => 'Calls the UnTagResources operation to delete resource labels. This is the counterpart to the TagResources operation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB59286\\"\\n}","type":"json"}]',
+ ],
+ 'UpgradeClusterVersion' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5470,65 +3964,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shenzhen',
- ],
- ],
- [
- 'name' => 'ResourceId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'required' => true,
- 'example' => 'cds-wz92o754****7779',
- 'maxItems' => 51,
- ],
- ],
- [
- 'name' => 'Tag',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' cds-bp1u2n43****n115', 'title' => ''],
],
],
'responses' => [
@@ -5536,238 +3977,77 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2656FA19-6059-40C8-A157-3FFBEAEC2369',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BC262FE3-91ED-4FE7-BD75-190B62D8BABC', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2656FA19-6059-40C8-A157-3FFBEAEC2369\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\r\\n<RequestId>2656FA19-6059-40C8-A157-3FFBEAEC2369</RequestId>\\r\\n</TagResourcesResponse>","errorExample":""}]',
- 'description' => '****',
+ 'errorCodes' => [],
+ 'title' => 'Upgrade cluster minor version',
+ 'summary' => 'Calls UpgradeClusterVersion to upgrade the minor version of a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC262FE3-91ED-4FE7-BD75-190B62D8BABC\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2-pop',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-pop',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-gov-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-nu16-b01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-edge-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-fujian',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-haidian-cm12-c01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-bj-b01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-prod-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-2',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'cassandra.aliyuncs.com',
- ],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cassandra.aliyuncs.com', 'endpoint' => 'cassandra.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Cluster.InvalidStatus', 'message' => 'The specified cluster status is invalid. %s', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Cluster.LatestVersion', 'message' => 'The current version of the cluster is up to date.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Cluster.NotFound', 'message' => 'The specified cluster does not exist. %s', 'http_code' => 404, 'description' => ''],
+ ['code' => 'DataCenter.InvalidStatus', 'message' => 'The specified data center status is invalid. %s', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DataCenter.NotFound', 'message' => 'The specified data center does not exist. %s', 'http_code' => 404, 'description' => ''],
+ ['code' => 'Forbidden', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'InternalError', 'message' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid: %s', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid. %s', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'You must specify the parameter: [%s]', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'You must specify the parameter. %s', 'http_code' => 400, 'description' => ''],
+ ['code' => 'NotFound', 'message' => 'The specified item does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'Security.InvalidIpList', 'message' => 'The specified IP list is invalid. %s', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Tags.DuplicateTagKey', 'message' => 'The specified Tag.Key (%s) is duplicated.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Tags.InvalidTagKey', 'message' => 'The specified Tag Key (%s) is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Tags.InvalidTagValue', 'message' => 'The specified Tag (%s) is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Tags.MissParameterTagOrResourceId', 'message' => 'Either Tag or ResourceId must be specified.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Tags.NumberExceed', 'message' => 'The number of Tags exceeds 20.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Tags.ResourceIdsNumberExceed', 'message' => 'The maximum number of ResourceIds is exceeded. The maximum value is 50.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 17:51:24 +0000