'1.0',
'info' => [
'style' => 'RPC',
'product' => 'polardbx',
'version' => '2020-02-02',
],
'directories' => [
[
'id' => 119060,
'title' => null,
'type' => 'directory',
'children' => [
'CreateDBInstance',
'DeleteDBInstance',
'DescribeDBInstanceAttribute',
'DescribeDBInstanceConfig',
'DescribeDBInstances',
'DescribeDBInstanceSSL',
'DescribeDBInstanceTDE',
'DescribeDBInstanceTopology',
'DescribeDBInstanceViaEndpoint',
'ModifyDBInstanceConfig',
'ModifyDBInstanceDescription',
'ReleaseInstancePublicConnection',
'RestartDBInstance',
'UpgradeDBInstanceKernelVersion',
'ModifyDBInstanceClass',
'DescribeDBInstanceHA',
'UpdatePolarDBXInstanceNode',
'ChangeResourceGroup',
'DescribeTransformStatus',
'DescribePolarxDataNodes',
'ModifyDBInstanceMaintainTime',
'ModifyDBInstanceVip',
'DescribeRdsVpcs',
'DescribeRdsVswitches',
'DescribeShowStorageInfo',
'DescribeStoragePoolInfo',
'CreateStoragePool',
'CreateCustomEndpoint',
'DescribeCustomEndpointList',
'ModifyCustomEndpointNet',
'DeleteCustomEndpoint',
'ModifyCustomEndpoint',
'ModifyDBInstanceConnectionString',
'AllocateInstancePublicConnection',
'AllocateColdDataVolume',
'ReleaseColdDataVolume',
'DescribeColdDataBasicInfo',
],
],
[
'id' => 201174,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeSlowLogRecords',
'DescribeDBNodePerformance',
'DescribeSqlAuditInfo',
'EnableSqlAudit',
'DisableSqlAudit',
'CheckSqlAuditSlsStatus',
'DescribeEvents',
'DescribeActiveOperationMaintainConf',
'DescribeActiveOperationTasks',
'DescribeActiveOperationTaskCount',
'ModifyActiveOperationMaintainConf',
],
],
[
'id' => 119019,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeTasks',
'DescribeScaleOutMigrateTaskList',
'CreateTransformOperation',
'DescribeRplInspectionTask',
'SkipCurrentStep',
'CreateRplInspectionTask',
'CancelActiveOperationTasks',
'ModifyActiveOperationTasks',
],
],
[
'id' => 119022,
'title' => null,
'type' => 'directory',
'children' => [
'UpdateDBInstanceSSL',
],
],
[
'id' => 119025,
'title' => null,
'type' => 'directory',
'children' => [
'ModifyParameter',
'DescribeParameterTemplates',
'DescribeParameters',
'DescribeParameterGroups',
],
],
[
'id' => 119029,
'title' => null,
'type' => 'directory',
'children' => [
'CreateBackup',
'DescribeBackupPolicy',
'DescribeBackupSetList',
'DescribeBinaryLogList',
'UpdateBackupPolicy',
'DescribeOpenBackupSet',
'DescribeBackupSet',
],
],
[
'id' => 119037,
'title' => null,
'type' => 'directory',
'children' => [
'UpdateDBInstanceTDE',
'ModifySecurityIps',
'DescribeUserEncryptionKeyList',
'DescribeSecurityIps',
'CheckCloudResourceAuthorized',
'EnableRightsSeparation',
'DisableRightsSeparation',
],
],
[
'id' => 119043,
'title' => null,
'type' => 'directory',
'children' => [
'ResetAccountPassword',
'CreateAccount',
'CreateSuperAccount',
'DeleteAccount',
'DescribeAccountList',
'ModifyAccountDescription',
'ResetAccountPasswordRestrict',
'ModifyAccountPrivilege',
],
],
[
'id' => 119049,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeRegions',
'MigrateDBInstance',
'DescribeAvailableCrossRegions',
'DescribeEnabledCrossRegions',
'AlignStoragePrimaryAzone',
'SwitchDBInstanceHA',
],
],
[
'id' => 119051,
'title' => null,
'type' => 'directory',
'children' => [
'CreateDB',
'DeleteDB',
'DescribeCharacterSet',
'DescribeDbList',
'DescribeDistributeTableList',
'ModifyDatabaseDescription',
'StartSwitchDatabase',
'DescribeComponentPropeties',
'ModifyEngineMigration',
'DescribeArchiveTableList',
],
],
[
'id' => 277496,
'title' => null,
'type' => 'directory',
'children' => [
'UpgradeCDCVersion',
'DescribeCdcInfo',
'DescribeCdcVersionList',
'DescribeCdcClassList',
'ModifyCdcClass',
],
],
[
'id' => 280912,
'title' => null,
'type' => 'directory',
'children' => [
'AttachColumnarInstance',
'UpgradeColumnarVersion',
'ModifyColumnarClass',
'DescribeColumnarVersionList',
'DescribeColumnarInfo',
'DescribeColumnarClassList',
],
],
[
'id' => 275483,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeEvaluateAndImportTask',
'DescribeEvaluateAndImportTasks',
'DeleteEvaluateAndImportTask',
'CreateSQLEvaluateTask',
'CreateStructureImportTask',
'DescribeDataImportTaskInfo',
'CloseEngineMigration',
'ConfirmNoConnection',
'RestartDataImportTask',
'StopDataImportTask',
'CreateDataImportTask',
'DescribeStructureImportTaskInfo',
'RefreshImportMeta',
],
],
[
'id' => 285585,
'title' => null,
'type' => 'directory',
'children' => [
'DeleteGdnInstance',
'DescribeGdnInstances',
'SwitchGdnMemberRole',
'CreateGdnInstance',
],
],
[
'id' => 285586,
'title' => null,
'type' => 'directory',
'children' => [
'SubmitSqlFlashbackTask',
'PreCheckSqlFlashbackTask',
'DescribeSqlFlashbackTaskList',
],
],
[
'id' => 189406,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeTags',
'ListTagResources',
'TagResources',
'UntagResources',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateDBInstance' => [
'summary' => 'Creates a PolarDB-X instance.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '86227',
'abilityTreeNodes' => [
'FEATUREdrdsIT76F2',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'PREPAY',
],
],
[
'name' => 'DBNodeCount',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '2',
'maximum' => '99',
'minimum' => '0',
],
],
[
'name' => 'DBNodeClass',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'polarx.x4.2xlarge.2d',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'xxxxxx-xxx',
],
],
[
'name' => 'NetworkType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vpc',
],
],
[
'name' => 'VPCId',
'in' => 'query',
'schema' => [
'description' => 'VPC ID。'."\n",
'type' => 'string',
'required' => false,
'example' => 'vpc-*****',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vsw-*********',
],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Month',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'null',
],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2.0',
],
],
[
'name' => 'IsReadDBInstance',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PrimaryDBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-*********',
],
],
[
'name' => 'TopologyType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '3azones',
],
],
[
'name' => 'PrimaryZone',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-shenzhen-e',
],
],
[
'name' => 'SecondaryZone',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-shenzhen-a',
],
],
[
'name' => 'TertiaryZone',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-shenzhen-e',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou-a',
],
],
[
'name' => 'CnClass',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'DnClass',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'CNNodeCount',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'maximum' => '99',
'minimum' => '0',
],
],
[
'name' => 'DNNodeCount',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'maximum' => '99',
'minimum' => '0',
],
],
[
'name' => 'IsColumnarReadDBInstance',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'Series',
'in' => 'query',
'schema' => [
'title' => '企业版: enterprise'."\n"
.'标准版: standard',
'type' => 'string',
'required' => false,
'default' => 'enterprise',
'enum' => [
'enterprise',
'standard',
],
],
],
[
'name' => 'DnStorageSpace',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ExtraParams',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
],
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-*********',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '12345',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"OrderId\\": \\"12345\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pxc-*********\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n 12345\\n","errorExample":""}]',
'title' => 'CreateDBInstance',
],
'DeleteDBInstance' => [
'summary' => '释放实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdrdsD0NTUP',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n","errorExample":""}]',
],
'DescribeDBInstanceAttribute' => [
'summary' => '获取实例详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '86240',
'abilityTreeNodes' => [
'FEATUREdrds9ED9RQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-aekzaxhezhs5***',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'DBInstance' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'ReadWrite',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Running',
],
'RightsSeparationStatus' => [
'description' => '',
'type' => 'string',
'example' => 'disabled',
],
'DBNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Expired' => [
'description' => '',
'type' => 'string',
'example' => 'false',
],
'CreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-08-31T08:56:25.000+0000',
],
'PayType' => [
'description' => '',
'type' => 'string',
'example' => 'Postpaid',
],
'Port' => [
'description' => '',
'type' => 'string',
'example' => '3306',
],
'LockMode' => [
'description' => '',
'type' => 'string',
'example' => 'Unlock',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'test instance',
],
'ConnectionString' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'StorageUsed' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '17042505728',
],
'ExpireDate' => [
'description' => '',
'type' => 'string',
'example' => '2022-08-31T16:00:00.000+0000',
],
'CommodityCode' => [
'description' => '',
'type' => 'string',
'example' => 'drds_polarxpost_public_cn',
],
'MaintainStartTime' => [
'description' => '',
'type' => 'string',
'example' => '06:00',
],
'DBInstanceType' => [
'description' => '',
'type' => 'string',
'example' => 'ReadWrite',
],
'DBNodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'LatestMinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805',
],
'MaintainEndTime' => [
'description' => '',
'type' => 'string',
'example' => '06:00',
],
'DBType' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'RightsSeparationEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'VPCId' => [
'description' => 'VPC ID。',
'type' => 'string',
'example' => 'vpc-xxxxx',
],
'MinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'Network' => [
'description' => '',
'type' => 'string',
'example' => 'VPC',
],
'DBVersion' => [
'description' => '',
'type' => 'string',
'example' => '5.5',
],
'VSwitchId' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-a',
],
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'KindCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '18',
],
'Id' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-zkralxpc5d****',
],
'DBNodes' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ComputeNodeId' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'NodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'DataNodeId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xdb-xxxxxx',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-a',
],
'Id' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
],
],
],
'ConnAddrs' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'VPC',
],
'VSwitchId' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Port' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3306',
],
'VPCId' => [
'description' => 'VPC ID。',
'type' => 'string',
'example' => 'vpc-xxxxxx',
],
'ConnectionString' => [
'description' => '',
'type' => 'string',
'example' => 'polardbx-xxx.aliyuncs.com',
],
'VpcInstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-zkralxpc5d****',
],
],
],
],
'ReadDBInstances' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'ColumnarReadDBInstances' => [
'type' => 'array',
'items' => [
'title' => '',
'type' => 'string',
],
],
'ResourceGroupId' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'example' => 'rg-xxxx',
],
'TagSet' => [
'title' => '标签集合',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签名称',
'description' => '',
'type' => 'string',
'example' => 'key2',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'example' => 'value2',
],
],
],
],
'CnNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'DnNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'CnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.xlarge.2e',
],
'DnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'mysql.x8.large.25',
],
'Series' => [
'description' => '',
'type' => 'string',
'example' => 'enterprise',
],
'LTSVersions' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'X.X.X.X',
],
'required' => true,
],
'TopologyType' => [
'title' => '拓扑类型:'."\n"
."\n"
.'- **3azones**:三可用区;'."\n"
.'- **1azone**:单可用区。',
'description' => '拓扑类型:'."\n"
."\n"
.'- **3azones**:三可用区;'."\n"
.'- **1azone**:单可用区。',
'type' => 'string',
'deprecated' => false,
'required' => true,
'pattern' => '',
'default' => '3azones',
],
'PrimaryZone' => [
'title' => '主可用区。',
'description' => '主可用区。',
'type' => 'string',
'deprecated' => false,
'required' => true,
'pattern' => '',
'default' => '',
],
'SecondaryZone' => [
'title' => '次可用区。',
'description' => '次可用区。',
'type' => 'string',
'deprecated' => false,
'pattern' => '',
'default' => '',
],
'TertiaryZone' => [
'title' => '第三可用区。',
'description' => '第三可用区。',
'type' => 'string',
'deprecated' => false,
'pattern' => '',
'default' => '',
],
'DifferentDNSpec' => [
'type' => 'boolean',
],
'ColumnarInstanceName' => [
'type' => 'string',
],
'CanNotCreateColumnar' => [
'type' => 'boolean',
],
'GdnInstanceName' => [
'type' => 'string',
],
'GdnMemberList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Role' => [
'type' => 'string',
],
'MemberName' => [
'type' => 'string',
],
'Status' => [
'type' => 'string',
],
],
],
],
'SpecCategory' => [
'type' => 'string',
],
'GdnRole' => [
'type' => 'string',
],
'PrimaryInstanceId' => [
'type' => 'string',
],
'StorageType' => [
'type' => 'string',
],
'CpuType' => [
'type' => 'string',
],
'EngineVersion' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-*********\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ],\\n \\"TopologyType\\": \\"3azones\\",\\n \\"PrimaryZone\\": \\"cn-shenzhen-e\\",\\n \\"SecondaryZone\\": \\"cn-shenzhen-a\\",\\n \\"TertiaryZone\\": \\"cn-shenzhen-e\\",\\n \\"DifferentDNSpec\\": false,\\n \\"ColumnarInstanceName\\": \\"xxxx\\",\\n \\"CanNotCreateColumnar\\": true,\\n \\"GdnInstanceName\\": \\"\\",\\n \\"GdnMemberList\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"SpecCategory\\": \\"\\",\\n \\"GdnRole\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n \\n ReadWrite\\n Running\\n disabled\\n 2\\n false\\n 2021-08-31T08:56:25.000+0000\\n Postpaid\\n 3306\\n Unlock\\n test instance\\n pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\n 17042505728\\n 2022-08-31T16:00:00.000+0000\\n drds_polarxpost_public_cn\\n 06:00\\n ReadWrite\\n polarx.x4.large.2e\\n polarx-kernel_5.4.11-16301083_xcluster-20210805\\n 06:00\\n polarx\\n false\\n vpc-xxxxx\\n polarx-kernel_5.4.11-16301083_xcluster-20210805\\n cn-hangzhou\\n VPC\\n 5.5\\n vsw-********\\n cn-hangzhou-a\\n polarx\\n 18\\n pxc-zkralxpc5d****\\n \\n pxc-i-********\\n polarx.x4.large.2e\\n pxc-xdb-xxxxxx\\n cn-hangzhou-a\\n pxi-*********\\n cn-hangzhou\\n \\n \\n VPC\\n vsw-*********\\n 3306\\n vpc-xxxxxx\\n polardbx-xxx.aliyuncs.com\\n pxc-zkralxpc5d****\\n \\n pxr-*********\\n rg-*********\\n \\n key2\\n value2\\n \\n 2\\n 2\\n polarx.x4.xlarge.2e\\n mysql.x8.large.25\\n enterprise\\n X.X.X.X\\n 3azones\\n cn-shenzhen-e\\n cn-shenzhen-a\\n cn-shenzhen-e\\n \\n","errorExample":""}]',
'title' => 'DescribeDBInstanceAttribute',
],
'DescribeDBInstanceConfig' => [
'summary' => '查询实例配置信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '86241',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-*********',
],
],
[
'name' => 'ConfigName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'htap',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ConfigName' => [
'description' => '',
'type' => 'string',
'example' => 'htap',
],
'DbInstanceName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ConfigValue' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ConfigName\\": \\"htap\\",\\n \\"DbInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"ConfigValue\\": \\"{\\\\\\\\\\\\\\"attendHtapList\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"pxc-hzruyzes08****\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"autoAttendHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"delayExecutionStrategy\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"enableConsistentReplicaRead\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"enableHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"masterReadWeight\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"storageDelayThreshold\\\\\\\\\\\\\\":3}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n htap\\n pxc-sprcym7g7w****\\n {\\\\\\"attendHtapList\\\\\\":[\\\\\\"pxc-hzruyzes08****\\\\\\"],\\\\\\"autoAttendHtap\\\\\\":\\\\\\"true\\\\\\",\\\\\\"delayExecutionStrategy\\\\\\":1,\\\\\\"enableConsistentReplicaRead\\\\\\":true,\\\\\\"enableHtap\\\\\\":\\\\\\"true\\\\\\",\\\\\\"masterReadWeight\\\\\\":100,\\\\\\"storageDelayThreshold\\\\\\":3}\\n \\n","errorExample":""}]',
'title' => 'DescribeDBInstanceConfig',
],
'DescribeDBInstances' => [
'summary' => '获取PolarDB-X实例列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '86242',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
'enum' => [
'cn-shenzhen',
'cn-beijing',
'cn-wulanchabu',
'cn-shenzhen-finance-1',
'cn-north-2-gov-1',
'cn-qingdao',
'cn-shanghai',
'cn-shanghai-finance-1',
'cn-hongkong',
'cn-hangzhou-finance',
'ap-southeast-1',
'eu-central-1',
'cn-huhehaote',
'ap-southeast-5',
'us-east-1',
'cn-zhangjiakou',
'us-west-1',
'cn-hangzhou',
'ap-northeast-1',
'cn-zhengzhou-jva',
'cn-shanghai-cloudspe',
'ap-southeast-6',
'ap-southeast-7',
],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '20',
'pattern' => '^\\d+$',
'default' => '30',
'enum' => [
'30',
'50',
'100',
],
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-acfmyst47hjw***',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'title' => '标签过滤条件',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[{\\"TagKey\\":\\"test\\",\\"TagValue\\":\\"test-value\\"}]',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '实例名称',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dinga93c84f4d***',
],
],
[
'name' => 'Series',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'enterprise',
],
],
[
'name' => 'MustHasCdc',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'DbVersion',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'TotalNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'DBInstances' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'ReadWrite',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Running',
],
'CommodityCode' => [
'description' => '',
'type' => 'string',
'example' => 'drds_polarxpre_public_cn',
],
'ExpireTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-12-01T16:00:00.000+0000',
],
'Expired' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-11-01T03:49:50.000+0000',
],
'PayType' => [
'description' => '',
'type' => 'string',
'example' => 'Prepaid',
],
'LockReason' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'DBType' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'LockMode' => [
'description' => '',
'type' => 'string',
'example' => 'Unlock',
],
'VPCId' => [
'description' => 'VPC ID。',
'type' => 'string',
'example' => 'VPCID',
],
'MinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'Network' => [
'description' => '',
'type' => 'string',
'example' => 'VPC',
],
'DBVersion' => [
'description' => '',
'type' => 'string',
'example' => '5.7',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'NodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'StorageUsed' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '40658534400',
],
'NodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-g',
],
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'Id' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzr2yeov9jmg3z',
],
'Nodes' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-g',
],
'Id' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-g-aliyun',
],
'ClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'Name' => [
'type' => 'string',
],
],
],
],
'ReadDBInstances' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'pxr-hzr2yeov9jmg3z',
],
],
'ColumnarReadDBInstances' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'ResourceGroupId' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'example' => 'rg-xxxxxx',
],
'TagSet' => [
'title' => '标签集合',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签名称',
'description' => '',
'type' => 'string',
'example' => 'key1',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'example' => 'value1',
],
],
],
],
'DBInstanceName' => [
'title' => '数据库实例名称',
'description' => '',
'type' => 'string',
'example' => 'pxc-xxxxx',
],
'DnNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'CnNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'CnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'DnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'mysql.n4.medium.25',
],
'Series' => [
'description' => '',
'type' => 'string',
'example' => 'enterprise',
],
'ContainBinlogX' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'SupportBinlogX' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'CdcInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-c-dmlgit****',
],
'TopologyType' => [
'title' => '拓扑类型:'."\n"
."\n"
.'- **3azones**:三可用区;'."\n"
.'- **1azone**:单可用区。',
'description' => '拓扑类型:'."\n"
."\n"
.'- **3azones**:三可用区;'."\n"
.'- **1azone**:单可用区。',
'type' => 'string',
'deprecated' => false,
'required' => true,
'pattern' => '',
'default' => '3azones',
],
'TertiaryZone' => [
'title' => '第三可用区。',
'description' => '第三可用区。',
'type' => 'string',
'deprecated' => false,
'pattern' => '',
'default' => '',
],
'PrimaryZone' => [
'title' => '主可用区。',
'description' => '主可用区。',
'type' => 'string',
'deprecated' => false,
'required' => true,
'pattern' => '',
'default' => '',
],
'SecondaryZone' => [
'title' => '次可用区。',
'description' => '次可用区。',
'type' => 'string',
'deprecated' => false,
'pattern' => '',
'default' => '',
],
'ColumnarInstanceName' => [
'type' => 'string',
],
'isInGdn' => [
'type' => 'boolean',
],
'gdnRole' => [
'type' => 'string',
],
'CpuType' => [
'type' => 'string',
],
'PrimaryInstanceId' => [
'type' => 'string',
],
'StorageType' => [
'type' => 'string',
],
'EngineVersion' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 30,\\n \\"DBInstances\\": [\\n {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"ExpireTime\\": \\"2021-12-01T16:00:00.000+0000\\",\\n \\"Expired\\": false,\\n \\"CreateTime\\": \\"2021-11-01T03:49:50.000+0000\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"VPCId\\": \\"VPCID\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.12-16349923_xcluster-20210926\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.7\\",\\n \\"Description\\": \\"测试\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"StorageUsed\\": 40658534400,\\n \\"NodeCount\\": 5,\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"Id\\": \\"pxc-hzr2yeov******\\",\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Id\\": \\"pxi-zd89wrzqh******\\",\\n \\"RegionId\\": \\"cn-hangzhou-g-aliyun\\",\\n \\"ClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-hzr2yeov******\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxxxxxxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"DBInstanceName\\": \\"pxc-xxxxx\\",\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"ContainBinlogX\\": true,\\n \\"SupportBinlogX\\": true,\\n \\"CdcInstanceName\\": \\"pxc-c-dmlgit****\\",\\n \\"TopologyType\\": \\"3azones\\",\\n \\"TertiaryZone\\": \\"cn-hangzhou-k\\",\\n \\"PrimaryZone\\": \\"cn-hangzhou-j\\",\\n \\"SecondaryZone\\": \\"cn-hangzhou-l\\",\\n \\"ColumnarInstanceName\\": \\"xxxxxxxx\\",\\n \\"isInGdn\\": true,\\n \\"gdnRole\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n 1\\n 30\\n 30\\n \\n ReadWrite\\n Running\\n drds_polarxpre_public_cn\\n 2021-12-01T16:00:00.000+0000\\n false\\n 2021-11-01T03:49:50.000+0000\\n Prepaid\\n 欠费\\n polarx\\n Unlock\\n VPCID\\n polarx-kernel_5.4.12-16349923_xcluster-20210926\\n cn-hangzhou\\n VPC\\n 5.7\\n 测试\\n polarx.x4.large.2e\\n 40658534400\\n 5\\n cn-hangzhou-g\\n polarx\\n pxc-hzr2yeov******\\n \\n cn-hangzhou-g\\n pxi-zd89wrzqh******\\n polarx.x4.large.2e\\n cn-hangzhou-g-aliyun\\n \\n pxr-hzr2yeov******\\n rg-xxxxxx\\n \\n key1\\n value1\\n \\n pxc-xxxxx\\n 2\\n 2\\n polarx.x4.large.2e\\n mysql.n4.medium.25\\n enterprise\\n true\\n true\\n pxc-c-dmlgit****\\n 3azones\\n cn-hangzhou-k\\n cn-hangzhou-j\\n cn-hangzhou-l\\n xxxxx\\n \\n","errorExample":""}]',
'title' => 'DescribeDBInstances',
],
'DescribeDBInstanceSSL' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86243',
'abilityTreeNodes' => [
'FEATUREdrdsUULYZA',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-*********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SSLEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'SSLExpiredTime' => [
'description' => '',
'type' => 'string',
'example' => '2022-11-04T09:39:07Z',
],
'CertCommonName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
[
'errorCode' => 'InvalidAction',
'errorMessage' => 'The specified Action is invalid.',
],
],
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"SSLEnabled\\": false,\\n \\"SSLExpiredTime\\": \\"2022-11-04T09:39:07Z\\",\\n \\"CertCommonName\\": \\"pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n false\\n 2022-11-04T09:39:07Z\\n pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com\\n \\n","errorExample":""}]',
'title' => 'DescribeDBInstanceSSL',
],
'DescribeDBInstanceTDE' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86244',
'abilityTreeNodes' => [
'FEATUREdrds9HBOA5',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TDEStatus' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IncorrectEngineVersion',
'errorMessage' => 'The current engine version does not support the operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"TDEStatus\\": \\"0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n 0\\n \\n","errorExample":""}]',
'title' => 'DescribeDBInstanceTDE',
],
'DescribeDBInstanceTopology' => [
'summary' => '查询实例拓扑',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '86245',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'MinuteSimple',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'LogicInstanceTopology' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-sprcym7g7w****',
],
'DBInstanceCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-10-21T10:30:45Z 04:00:00',
],
'MaintainStartTime' => [
'description' => '',
'type' => 'string',
'example' => '04:00:00',
],
'MaintainEndTime' => [
'description' => '',
'type' => 'string',
'example' => '05:00:00',
],
'LockReason' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'DBInstanceStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'LockMode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'EngineVersion' => [
'description' => '',
'type' => 'string',
'example' => '2.0',
],
'DBInstanceStorage' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DBInstanceConnType' => [
'description' => '',
'type' => 'string',
'example' => 'lvs',
],
'DBInstanceId' => [
'description' => '',
'type' => 'string',
'example' => '304726047',
],
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'DBInstanceDescription' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-sprcym7g7wj7k',
],
'DBInstanceStatusDescription' => [
'description' => '',
'type' => 'string',
'example' => 'TDE_MODIFYING',
],
'Items' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-10-21T10:30:45Z',
],
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-i-tk6t4z****',
],
'CharacterType' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'MaintainStartTime' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'DiskSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3145728',
],
'MaintainEndTime' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'LockReason' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'DBInstanceStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'LockMode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'EngineVersion' => [
'description' => '',
'type' => 'string',
'example' => '5.7',
],
'DBInstanceConnType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '',
],
'MaxConnections' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '4000',
],
'DBInstanceId' => [
'description' => '',
'type' => 'string',
'example' => '304726049',
],
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'mysql',
],
'MaxIops' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '7000',
],
'DBInstanceDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'DBInstanceStatusDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ConnectionIp' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Port' => [
'description' => '',
'type' => 'string',
'example' => '3306',
],
'DBInstanceNetType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ConnectionString' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com',
],
],
],
],
'Region' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'Azone' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-a',
],
'Role' => [
'description' => '',
'type' => 'string',
'example' => 'master',
],
'Activated' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'AzoneRoleList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Azone' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-a',
],
'Role' => [
'description' => '',
'type' => 'string',
'example' => 'leader',
],
],
],
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'NodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'Version' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-cdc-kernel-2.0.0-3985896',
],
'PhyInstanceName' => [
'type' => 'string',
],
'StorageUsed' => [
'type' => 'string',
],
],
],
],
'HistoryItems' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CharacterType' => [
'type' => 'string',
],
'Role' => [
'type' => 'string',
],
'DBInstanceName' => [
'type' => 'string',
],
'DBInstanceId' => [
'type' => 'string',
],
'Region' => [
'type' => 'string',
],
'Azone' => [
'type' => 'string',
],
'Activated' => [
'type' => 'boolean',
],
'PhyInstanceName' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'RAM.Permission.Denied',
'errorMessage' => 'RAM authentication failed.',
],
],
[
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"LogicInstanceTopology\\": {\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z 04:00:00\\",\\n \\"MaintainStartTime\\": \\"04:00:00\\",\\n \\"MaintainEndTime\\": \\"05:00:00\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"DBInstanceStorage\\": 1,\\n \\"DBInstanceConnType\\": \\"lvs\\",\\n \\"DBInstanceId\\": \\"304726047\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"DBInstanceDescription\\": \\"pxc-sprcym7******\\",\\n \\"DBInstanceStatusDescription\\": \\"TDE_MODIFYING\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z\\",\\n \\"DBInstanceName\\": \\"pxc-i-tk6t4z****\\",\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"MaintainStartTime\\": \\"不展示\\",\\n \\"DiskSize\\": 3145728,\\n \\"MaintainEndTime\\": \\"不展示\\",\\n \\"LockReason\\": \\"不展示\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DBInstanceConnType\\": 0,\\n \\"MaxConnections\\": 4000,\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"MaxIops\\": 7000,\\n \\"DBInstanceDescription\\": \\"不展示\\",\\n \\"DBInstanceStatusDescription\\": \\"不展示\\",\\n \\"ConnectionIp\\": [\\n {\\n \\"Port\\": \\"3306\\",\\n \\"DBInstanceNetType\\": 1,\\n \\"ConnectionString\\": \\"pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com\\"\\n }\\n ],\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"master\\",\\n \\"Activated\\": true,\\n \\"AzoneRoleList\\": [\\n {\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"leader\\"\\n }\\n ],\\n \\"Status\\": \\"0\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"Version\\": \\"polarx-cdc-kernel-2.0.0-3985896\\",\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\",\\n \\"StorageUsed\\": \\"16681\\"\\n }\\n ],\\n \\"HistoryItems\\": [\\n {\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"Role\\": \\"master\\",\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Activated\\": true,\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n \\n pxc-sprcym7g7w****\\n 2021-10-21T10:30:45Z 04:00:00\\n 04:00:00\\n 05:00:00\\n 欠费\\n 8\\n 0\\n 2.0\\n 1\\n lvs\\n 304726047\\n polarx\\n pxc-sprcym7******\\n TDE_MODIFYING\\n \\n 2021-10-21T10:30:45Z\\n pxc-i-tk6t4z****\\n 节点角色\\n 不展示\\n 3145728\\n 不展示\\n 不展示\\n 8\\n 0\\n 5.7\\n 4000\\n 304726049\\n mysql\\n 7000\\n 不展示\\n 不展示\\n \\n 3306\\n 1\\n pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com\\n \\n cn-hangzhou\\n cn-hangzhou-a\\n master\\n true\\n \\n cn-hangzhou-a\\n leader\\n \\n 0\\n polarx.x4.large.2e\\n polarx-cdc-kernel-2.0.0-3985896\\n pxc-unrbk8oyz**********\\n \\n \\n 节点角色\\n master\\n pxc-sprcym7g7w****\\n 304726049\\n cn-hangzhou\\n cn-hangzhou-a\\n true\\n pxc-unrbk8oyz**********\\n \\n \\n \\n","errorExample":""}]',
'title' => 'DescribeDBInstanceTopology',
],
'DescribeDBInstanceViaEndpoint' => [
'summary' => '通过Endpoint查询实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '163711',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'Endpoint',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hz*******.polarx.rds.aliyuncs.com',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC',
],
'DBInstance' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'ReadWrite',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Running',
],
'RightsSeparationStatus' => [
'description' => '',
'type' => 'string',
'example' => 'disabled',
],
'DBNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Expired' => [
'description' => '',
'type' => 'string',
'example' => 'false',
],
'CreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-08-31T08:56:25.000+0000',
],
'PayType' => [
'description' => '',
'type' => 'string',
'example' => 'Postpaid',
],
'Port' => [
'description' => '',
'type' => 'string',
'example' => '3306',
],
'LockMode' => [
'description' => '',
'type' => 'string',
'example' => 'Unlock',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'test instance',
],
'ConnectionString' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com',
],
'StorageUsed' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '17042505728',
],
'ExpireDate' => [
'description' => '',
'type' => 'string',
'example' => '2022-08-31T16:00:00.000+0000',
],
'CommodityCode' => [
'description' => '',
'type' => 'string',
'example' => 'drds_polarxpost_public_cn',
],
'MaintainStartTime' => [
'description' => '',
'type' => 'string',
'example' => '06:00',
],
'DBInstanceType' => [
'description' => '',
'type' => 'string',
'example' => 'ReadWrite',
],
'DBNodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'LatestMinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805',
],
'MaintainEndTime' => [
'description' => '',
'type' => 'string',
'example' => '06:00',
],
'DBType' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'RightsSeparationEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'VPCId' => [
'description' => 'VPC ID。',
'type' => 'string',
'example' => 'vpc-xxxxx',
],
'MinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'Network' => [
'description' => '',
'type' => 'string',
'example' => 'VPC',
],
'DBVersion' => [
'description' => '',
'type' => 'string',
'example' => '5.5',
],
'VSwitchId' => [
'description' => '',
'type' => 'string',
'example' => 'vsw-********',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-a',
],
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'MySQL',
],
'KindCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '18',
],
'Id' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-zkralxpc5d****',
],
'DBNodes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ComputeNodeId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-i-********',
],
'NodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e',
],
'DataNodeId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xdb-xxxxxx',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-a',
],
'Id' => [
'description' => '',
'type' => 'string',
'example' => 'pxi-*********',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
],
],
],
'ConnAddrs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'VPC',
],
'VSwitchId' => [
'description' => '',
'type' => 'string',
'example' => 'vsw-*********',
],
'Port' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3306',
],
'VPCId' => [
'description' => 'VPC ID。',
'type' => 'string',
'example' => 'vpc-xxxxxx',
],
'ConnectionString' => [
'description' => '',
'type' => 'string',
'example' => 'polardbx-xxx.aliyuncs.com',
],
'VpcInstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-zkralxpc5d****',
],
],
],
],
'ReadDBInstances' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'pxr-*********',
],
],
'ResourceGroupId' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'example' => 'rg-xxxx',
],
'TagSet' => [
'title' => '标签集合',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签名称',
'description' => '',
'type' => 'string',
'example' => 'key2',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'example' => 'value2',
],
],
],
],
'CnNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'DnNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'CnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.xlarge.2e',
],
'DnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'mysql.x8.large.25',
],
'Series' => [
'description' => '',
'type' => 'string',
'example' => 'enterprise',
],
'LTSVersions' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'X.X.X.X',
],
'required' => true,
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ]\\n }\\n}","type":"json"}]',
],
'ModifyDBInstanceConfig' => [
'summary' => '修改实例配置',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86279',
'abilityTreeNodes' => [
'FEATUREdrdsTQTDLY',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'ConfigName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ENABLE_CONSISTENT_REPLICA_READ',
],
],
[
'name' => 'ConfigValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]',
'title' => 'ModifyDBInstanceConfig',
],
'ModifyDBInstanceDescription' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]',
'title' => ' ModifyDBInstanceDescription',
],
'ReleaseInstancePublicConnection' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86286',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'CurrentConnectionString',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasdyuoo.polarx.rds.aliyuncs.com',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]',
'title' => ' ReleaseInstancePublicConnection',
],
'RestartDBInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]',
'title' => ' RestartDBInstance',
],
'UpgradeDBInstanceKernelVersion' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'SwitchMode',
'in' => 'query',
'schema' => [
'title' => '切换模式: 0:立刻执行,1:运维时间执行',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
[
'name' => 'MinorVersion',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzjasd****',
],
'TargetMinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-kernel_5.4.7-16001481_xcluster-20200910',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => '422922413',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TargetMinorVersion\\": \\"polarx-kernel_5.4.7-16001481_xcluster-20200910\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pxc-hzjasd****\\n polarx-kernel_5.4.7-16001481_xcluster-20200910\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n 422922413\\n","errorExample":""}]',
'title' => 'UpgradeDBInstanceKernelVersion',
],
'ModifyDBInstanceClass' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '86278',
'abilityTreeNodes' => [
'FEATUREdrds0SX279',
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'TargetDBInstanceClass',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'polarx.x4.xlarge.2e',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
[
'name' => 'CnClass',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'DnClass',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'SpecifiedDNScale',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'type' => 'boolean',
'default' => 'false',
],
],
[
'name' => 'SpecifiedDNSpecMapJson',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'DnStorageSpace',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '20211103105558',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 20211103105558\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]',
'title' => ' ModifyDBInstanceClass',
],
'DescribeDBInstanceHA' => [
'summary' => '查询实例的HA信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132465',
'abilityTreeNodes' => [
'FEATUREdrdsHIZOSR',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'TopologyType' => [
'type' => 'string',
],
'PrimaryRegionId' => [
'type' => 'string',
],
'PrimaryAzoneId' => [
'type' => 'string',
],
'SecondaryRegionId' => [
'type' => 'string',
],
'SecondaryAzoneId' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => null,
],
'UpdatePolarDBXInstanceNode' => [
'summary' => '扩缩容实例节点数',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREdrdsDBGOD6',
'FEATUREdrds0SX279',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasdyuoo',
],
],
[
'name' => 'DbInstanceNodeCount',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'integer',
'required' => false,
'docRequired' => false,
'example' => '3',
'format' => 'int32',
'maximum' => '99',
'minimum' => '0',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
[
'name' => 'CNNodeCount',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'integer',
'required' => false,
'example' => '2',
'format' => 'int32',
'maximum' => '99',
'minimum' => '0',
],
],
[
'name' => 'DNNodeCount',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'integer',
'required' => false,
'example' => '2',
'format' => 'int32',
'maximum' => '99',
'minimum' => '0',
],
],
[
'name' => 'StoragePoolName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'DeleteDNIds',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AddDNSpec',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '20211103105558',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 20211103105558\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]',
'title' => 'UpdatePolarDBXInstanceNode',
],
'ChangeResourceGroup' => [
'summary' => '修改实例所在资源组.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '116109',
'abilityTreeNodes' => [
'FEATUREdrdsJGJ3OD',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PolarDBXInstance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'title' => '资源ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-szrwrbp693****',
'maxItems' => 51,
],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => [
'title' => '新资源组ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rg-acfmwolx3j4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\n","errorExample":""}]',
'title' => 'ChangeResourceGroup',
],
'DescribeTransformStatus' => [
'summary' => '查询标准版迁移到企业版的任务状态',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '196927',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxx',
],
],
[
'name' => 'QueryReport',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'EnterpriseInsName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-*****',
],
'StandardInsName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-*****',
],
'Phase' => [
'description' => '',
'type' => 'string',
'example' => 'none',
],
'CanSwitch' => [
'description' => '',
'type' => 'boolean',
],
'CanUndoSwitch' => [
'description' => '',
'type' => 'boolean',
],
'CanCancel' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'CanFinish' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ReportTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2025-09-02 16:52:47.0'."\n",
],
'ReportSummary' => [
'description' => '',
'type' => 'object',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IncorrectDBInstance',
'errorMessage' => 'Current DB instance does not support this operation.',
],
[
'errorCode' => 'IncorrectDBInstanceState',
'errorMessage' => 'Current DB instance state does not support this operation.',
],
[
'errorCode' => 'InvalidParam',
'errorMessage' => 'Invalid Parameter.',
],
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist or is not supported.',
],
[
'errorCode' => 'Transform.UnSupportedDbVersion',
'errorMessage' => 'Only database engine version 5.7 is supported.',
],
],
403 => [
[
'errorCode' => 'Transform.IncorrectEngineVersion',
'errorMessage' => 'The current engine version is not the latest. Please upgrade to the latest version.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"EnterpriseInsName\\": \\"pxc-*****\\",\\n \\"StandardInsName\\": \\"pxc-*****\\",\\n \\"Phase\\": \\"none\\",\\n \\"CanSwitch\\": true,\\n \\"CanUndoSwitch\\": true,\\n \\"CanCancel\\": true,\\n \\"CanFinish\\": true,\\n \\"ReportTime\\": 0,\\n \\"ReportSummary\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]',
],
'DescribePolarxDataNodes' => [
'summary' => '查询数据节点列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '86255',
'abilityTreeNodes' => [
'FEATUREdrds0SX279',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '30',
'pattern' => '^\\d+$',
'default' => '30',
'enum' => [
'30',
'50',
'100',
],
],
],
[
'name' => 'NodeType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'title' => '查询节点类型'."\n"
.'- all: 表示同时查询 dn 与 gms 节点'."\n"
.'- gms: 表示只查询 gms 节点'."\n"
.'- dn: 表示只查询 dn 节点',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dn',
'default' => 'all',
'enum' => [
'all',
'dn',
'gms',
],
],
],
[
'name' => 'SearchKey',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'title' => '关键词',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pc-bp1c5w4fx****2274',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'BD99340C-4A45-548B-****-27584B0BCFFF',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TotalNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DBInstanceDataNodes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzrp5m****04w4',
],
'DBInstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzrlcjc****sz9',
],
'DBInstanceDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidPageSize.Malformed',
'errorMessage' => 'The specified parameter PageSize is not valid.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD99340C-4A45-548B-****-27584B0BCFFF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 0,\\n \\"TotalNumber\\": 0,\\n \\"DBInstanceDataNodes\\": [\\n {\\n \\"DBInstanceName\\": \\"pxc-hzrp5m****04w4\\",\\n \\"DBInstanceId\\": \\"pxc-hzrlcjc****sz9\\",\\n \\"DBInstanceDescription\\": \\"pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ModifyDBInstanceMaintainTime' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-htri0ori2r4k9p',
],
],
[
'name' => 'MaintainTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '19:00Z-20:00Z',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n","errorExample":""}]',
'title' => ' ModifyDBInstanceMaintainTime',
],
'ModifyDBInstanceVip' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '232184',
'abilityTreeNodes' => [
'FEATUREdrds7CT80F',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'vpc-********',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'vsw-*********',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'MigrateDBInstanceResponse',
'description' => 'MigrateDBInstanceResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]',
'description' => '****',
],
'DescribeRdsVpcs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '97702',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-zhangjiakou',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing-h',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Vpcs' => [
'description' => '',
'type' => 'object',
'properties' => [
'Vpc' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'True',
],
'VpcName' => [
'description' => '',
'type' => 'string',
'example' => 'cloud_auto_test',
],
'VpcId' => [
'description' => '',
'type' => 'string',
'example' => 'vpc-2zekldxxy28nobay7o1f3',
],
'IsDefault' => [
'description' => '',
'type' => 'boolean',
'example' => 'False',
],
'CidrBlock' => [
'description' => '',
'type' => 'string',
'example' => '47.121.246.0/24',
],
'RegionNo' => [
'description' => '',
'type' => 'string',
'example' => 'cn-shanghai',
],
'GmtCreate' => [
'description' => '',
'type' => 'string',
'example' => 'Mon May 12 10:13:14 CST 2025',
],
'AliUid' => [
'description' => '',
'type' => 'string',
'example' => '314****36',
],
'VSwitchs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Available',
],
'VSwitchId' => [
'description' => '',
'type' => 'string',
'example' => 'vsw-8vbkwmpn****4nrd639ih',
],
'IsDefault' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CidrBlock' => [
'description' => '',
'type' => 'string',
'example' => '10.0.0.0/24',
],
'GmtCreate' => [
'description' => '',
'type' => 'string',
'example' => '1574156944000',
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '2025-09-03T19:19:13+08:00',
],
'IzNo' => [
'description' => '',
'type' => 'string',
'example' => 'cn-beijing-g',
],
'VSwitchName' => [
'description' => '',
'type' => 'string',
'example' => 'cloud_auto_g',
],
],
],
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '2024-09-29 17:47:56',
],
'Bid' => [
'description' => '',
'type' => 'string',
'example' => '26842',
],
],
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '4C1A7CFB-9F73-5041-8C74-27626E58985A',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"True\\",\\n \\"VpcName\\": \\"cloud_auto_test\\",\\n \\"VpcId\\": \\"vpc-2zekldxxy28nobay7o1f3\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"47.121.246.0/24\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"GmtCreate\\": \\"Mon May 12 10:13:14 CST 2025\\",\\n \\"AliUid\\": \\"314****36\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-8vbkwmpn****4nrd639ih\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"10.0.0.0/24\\",\\n \\"GmtCreate\\": \\"1574156944000\\",\\n \\"GmtModified\\": \\"2025-09-03T19:19:13+08:00\\",\\n \\"IzNo\\": \\"cn-beijing-g\\",\\n \\"VSwitchName\\": \\"cloud_auto_g\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2024-09-29 17:47:56\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4C1A7CFB-9F73-5041-8C74-27626E58985A\\"\\n}","type":"json"}]',
],
'DescribeRdsVswitches' => [
'summary' => '查询Vswitch信息',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '232624',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou-a',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vpc-bp1ndou****twoedlmru0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'VswitchList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => 'babac91eff704edf9bdccfaa6ba4efce',
],
'VpcInstanceId' => [
'description' => 'vpc id。',
'type' => 'string',
'example' => 'vpc-uf6lis7xmm****t9wrxb5',
],
'IzNo' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-j',
],
'CidrBlock' => [
'description' => '',
'type' => 'string',
'example' => '172.16.0.0/24',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'describe',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'szt-backup',
],
'AvailabeIpCount' => [
'description' => '',
'type' => 'string',
'example' => '16378',
],
'IsDefault' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'drdshbgae0han226',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"VswitchList\\": [\\n {\\n \\"Id\\": 0,\\n \\"VpcInstanceId\\": \\"vpc-uf6lis7xmm****t9wrxb5\\",\\n \\"IzNo\\": \\"cn-hangzhou-j\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"describe\\",\\n \\"Name\\": \\"szt-backup\\",\\n \\"AvailabeIpCount\\": \\"16378\\",\\n \\"IsDefault\\": \\"true\\",\\n \\"InstanceId\\": \\"drdshbgae0han226\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeShowStorageInfo' => [
'summary' => '查询 PolarDB-X 存储节点信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '207374',
'abilityTreeNodes' => [
'FEATUREdrdsHFP8VD',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-**************',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-xxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'StorageInfos' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Class' => [
'description' => '',
'type' => 'string',
'example' => 'polar.mysql.x4.large',
],
'DbCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'Deletable' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'GroupCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'InstKind' => [
'description' => '',
'type' => 'string',
'example' => 'MASTER',
],
'IsHealthy' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'LeaderNode' => [
'description' => '',
'type' => 'string',
'example' => '11.117.237.205:3029',
],
'Status' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'StorageInstName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xdb-m-pxcbjrylg49skcxb17394',
],
],
],
],
],
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"StorageInfos\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DbCount\\": 3,\\n \\"Deletable\\": true,\\n \\"GroupCount\\": 12,\\n \\"InstKind\\": \\"MASTER\\",\\n \\"IsHealthy\\": true,\\n \\"LeaderNode\\": \\"11.117.237.205:3029\\",\\n \\"Status\\": 0,\\n \\"StorageInstName\\": \\"pxc-xdb-m-pxcbjrylg49skcxb17394\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'DescribeStoragePoolInfo' => [
'summary' => '查询 PolarDB-X 存储资源池信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-*********',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-xxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'StoragePools' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Class' => [
'description' => '',
'type' => 'string',
'example' => 'polar.mysql.x4.large',
],
'DnIdList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '[]',
],
'example' => '[pxc-xdb-s-pxcbj****xxnwp0wac2c4\\",\\"pxc-xdb-s-pxcbjr3b8****p0wa1589\\"]',
],
'DnIdString' => [
'description' => 'DN id',
'type' => 'string',
'example' => 'pxc-xdb-s-pxcshr****rh7fn2654fc',
],
'Extra' => [
'description' => '',
'type' => 'string',
'example' => '{\\"appId\\":\\"APP_ETLUP1E5FMI5ND5IFO8W\\"}',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2025-08-27 23:19:52.0',
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '2025-09-02 16:52:47.0',
],
'IdleDNIdList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '[]',
],
'example' => 'none',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'test-cacheapi',
],
'UnDeletableDNId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xdb-s-hzr*****6j4se284344',
],
],
],
],
],
],
'RequestId' => [
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"StoragePools\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DnIdList\\": [\\n \\"[]\\"\\n ],\\n \\"DnIdString\\": \\"pxc-xdb-s-pxcshr****rh7fn2654fc\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"appId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APP_ETLUP1E5FMI5ND5IFO8W\\\\\\\\\\\\\\"}\\",\\n \\"GmtCreated\\": \\"2025-08-27 23:19:52.0\\",\\n \\"GmtModified\\": \\"2025-09-02 16:52:47.0\\",\\n \\"IdleDNIdList\\": [\\n \\"[]\\"\\n ],\\n \\"Name\\": \\"test-cacheapi\\",\\n \\"UnDeletableDNId\\": \\"pxc-xdb-s-hzr*****6j4se284344\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'CreateStoragePool' => [
'summary' => '创建 PolarDB-X 存储资源池',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '201295',
'abilityTreeNodes' => [
'FEATUREdrdsUWIQBY',
'FEATUREdrdsVN1FAR',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-bjxxxxxxxx',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-xxxxx',
],
],
[
'name' => 'StoragePoolName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'StoragePoolDNList',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'node6'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'CreateCustomEndpoint' => [
'summary' => '创建自定义endpoint',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '236560',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ext-win-live-17',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'vpc-bp1ndoug37dtwoedlmru0',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'vsw-*********',
],
],
[
'name' => 'NodeIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'r-bp1l5kfgw8****c3iv',
],
],
[
'name' => 'NodeAutoEnter',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
[
'name' => 'NodeRole',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'READONLY',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CustomEndpointId' => [
'description' => '',
'type' => 'string',
'example' => 'pxe-c4gkgqg****7sgyg',
],
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-*********',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'CustomEndpoint.ExceedLimit',
'errorMessage' => 'the count of custom endpoints can not exceed limiting value.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"Data\\": {\\n \\"CustomEndpointId\\": \\"pxe-c4gkgqg****7sgyg\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\"\\n }\\n}","type":"json"}]',
],
'DescribeCustomEndpointList' => [
'summary' => '查询自定义连接信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '236590',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'title' => '实例名称',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-xxx',
],
],
[
'name' => 'CustomEndpointIds',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'title' => '自定义连接ID,多个ID使用英文逗号分隔',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxe-b6e****no4pfap1s',
],
],
[
'name' => 'CheckDeleteCN',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'title' => '',
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '6352AC16-76BF-5135-B1EA-ED49293526E6',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanDeleteCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Endpoints' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'CustomEndpointId' => [
'description' => '',
'type' => 'string',
'example' => 'pxe-b6e****o4pfap1s',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'Name',
],
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hz****zoxherr7',
],
'ConnectionString' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-shra****zq0j01.polarx.rds.aliyuncs.com',
],
'Port' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3306',
],
'VpcId' => [
'description' => '',
'type' => 'string',
'example' => 'vpc-uf61h****dj1zg5fqp5x7',
],
'VSwitchId' => [
'description' => '',
'type' => 'string',
'example' => 'vsw-8vbkw****5yh4nrd639ih',
],
'NodeAutoEnter' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'NodeRole' => [
'description' => '',
'type' => 'string',
'example' => 'same_azone_as_last',
],
'CnNames' => [
'description' => '[\\"pxc-i-vb1sqa7llp\\",\\"pxc-i-bemprx50ad\\"]',
'type' => 'array',
'items' => [
'description' => 'string',
'type' => 'string',
'example' => 'string',
],
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'created',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Data\\": {\\n \\"CanDeleteCount\\": 0,\\n \\"Endpoints\\": [\\n {\\n \\"CustomEndpointId\\": \\"pxe-b6e****o4pfap1s\\",\\n \\"Name\\": \\"Name\\",\\n \\"DBInstanceName\\": \\"pxc-hz****zoxherr7\\",\\n \\"ConnectionString\\": \\"pxc-shra****zq0j01.polarx.rds.aliyuncs.com\\",\\n \\"Port\\": 3306,\\n \\"VpcId\\": \\"vpc-uf61h****dj1zg5fqp5x7\\",\\n \\"VSwitchId\\": \\"vsw-8vbkw****5yh4nrd639ih\\",\\n \\"NodeAutoEnter\\": \\"true\\",\\n \\"NodeRole\\": \\"same_azone_as_last\\",\\n \\"CnNames\\": [\\n \\"string\\"\\n ],\\n \\"Status\\": \\"created\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ModifyCustomEndpointNet' => [
'summary' => '修复自定连接的网络信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '236587',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'CustomEndpointId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cep-002',
],
],
[
'name' => 'ConnPrefix',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-****',
],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3306',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vpc-bp1ndoug37dtwoedlmru0',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vsw-*********',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]',
],
'DeleteCustomEndpoint' => [
'summary' => '删除自定义endpoint',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '236568',
'abilityTreeNodes' => [
'FEATUREdrds0SX279',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzravgpt8q****',
],
],
[
'name' => 'CustomEndpointId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxe-8if3zrfsu****hgw',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-****-475C-B269-2D5C3A31797C',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]',
],
'ModifyCustomEndpoint' => [
'summary' => '修复自定连接基本信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '236585',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-zhangjiakou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'mydatabase',
],
],
[
'name' => 'CustomEndpointId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cep-002',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'secondary-endpoint',
],
],
[
'name' => 'NodeIds',
'in' => 'query',
'schema' => [
'description' => 'node ids',
'type' => 'string',
'required' => false,
'example' => 'node3',
],
],
[
'name' => 'NodeAutoEnter',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'NodeRole',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'master',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\"\\n}","type":"json"}]',
],
'ModifyDBInstanceConnectionString' => [
'summary' => '修改实例链接串',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '115860',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-unrf5ssig0ecg8',
],
],
[
'name' => 'NewPrefix',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test2',
],
],
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-unrf5ssig0ecg8.polarx.huhehaote.rds.aliyuncs.com',
],
],
[
'name' => 'NewPort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3300',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ConnectionString' => [
'description' => '',
'type' => 'string',
'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com',
],
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-unrf5ssig0ecg8',
],
'DBInstanceNetType' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'Port' => [
'description' => '',
'type' => 'string',
'example' => '3300',
],
],
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'c3cf535c-a585-11ea-8263-00163e04d3a7',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"pxc-unrf5ssig0ecg8\\",\\n \\"DBInstanceNetType\\": \\"1\\",\\n \\"Port\\": \\"3300\\"\\n },\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"c3cf535c-a585-11ea-8263-00163e04d3a7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n \\n test2.polarx.huhehaote.rds.aliyuncs.com\\n pxc-unrf5ssig0ecg8\\n 1\\n 3300\\n \\n 200\\n c3cf535c-a585-11ea-8263-00163e04d3a7\\n","errorExample":""}]',
],
'AllocateInstancePublicConnection' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-**************',
],
],
[
'name' => 'ConnectionStringPrefix',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-**************',
],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3306',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n","errorExample":""}]',
'title' => ' AllocateInstancePublicConnection',
],
'AllocateColdDataVolume' => [
'summary' => '开通冷存储',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '137133',
'abilityTreeNodes' => [
'FEATUREdrdsONAWER',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzravgpt8q****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'D6A4256F-7B83-5BD7-9AC0-72E1FAC05330',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\n","errorExample":""}]',
'title' => 'AllocateColdDataVolume',
],
'ReleaseColdDataVolume' => [
'summary' => '关闭冷存储',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '137137',
'abilityTreeNodes' => [
'FEATUREdrdsONAWER',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzravgpt8q****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'EA330983-C895-57C0-AE82-5A63106EBB10',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA330983-C895-57C0-AE82-5A63106EBB10\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EA330983-C895-57C0-AE82-5A63106EBB10\\n","errorExample":""}]',
'title' => 'ReleaseColdDataVolume',
],
'DescribeColdDataBasicInfo' => [
'summary' => '冷存储基础信息',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '137149',
'abilityTreeNodes' => [
'FEATUREdrdsONAWER',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'requestId',
'type' => 'string',
],
'Data' => [
'title' => '详情信息',
'type' => 'object',
'properties' => [
'EnableStatus' => [
'title' => '是否开启冷存储',
'type' => 'boolean',
],
'CloudProduct' => [
'title' => '底层存储云产品',
'type' => 'string',
],
'VolumeName' => [
'title' => '存储卷名',
'type' => 'string',
],
'BackupSetSpaceSize' => [
'title' => '有效备份集数据大小',
'type' => 'number',
'format' => 'double',
],
'BackupSetCount' => [
'title' => '备份集个数',
'type' => 'integer',
'format' => 'int32',
],
'CurrentSpaceSize' => [
'title' => '冷存储数据大小',
'type' => 'number',
'format' => 'double',
],
'DataRedundancyType' => [
'type' => 'string',
],
'WriteAccessNum' => [
'type' => 'number',
'format' => 'double',
],
'ReadAccessNum' => [
'type' => 'integer',
'format' => 'int64',
],
'RegionId' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => null,
],
'DescribeSlowLogRecords' => [
'summary' => '慢SQL明细',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '246562',
'abilityTreeNodes' => [
'FEATUREdrdsSFVKQ0',
],
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
'default' => '100',
],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2024-10-09T02:26',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2024-11-22T02:22Z',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-bjxxxxxxxx',
],
],
[
'name' => 'DBNodeIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-i-mezcj4ejdz',
],
],
[
'name' => 'CharacterType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'polarx_dn' => 'polarx_dn',
'polarx_cn' => 'polarx_cn',
],
'example' => 'polarx_cn',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'testdb',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'DBInstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-********',
],
'PageNumber' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'PageRecordCount' => [
'description' => '',
'type' => 'string',
'example' => '30',
],
'TotalCount' => [
'description' => '',
'type' => 'string',
'example' => '3',
],
'Items' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'SQLHash' => [
'description' => '',
'type' => 'string',
'example' => 'c8df07e5d45cd68da8b4771c2016e20b',
],
'SQLText' => [
'description' => '',
'type' => 'string',
'example' => 'select * from test ',
],
'QueryStartTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-11-22T02:22:22.444Z',
],
'QueryTime' => [
'description' => '',
'type' => 'string',
'example' => '3.000',
],
'QueryTimeMS' => [
'description' => '',
'type' => 'string',
'example' => '3000.000',
],
'LockTimeMS' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'ParseRowCounts' => [
'description' => '',
'type' => 'string',
'example' => '10',
],
'ReturnRowCounts' => [
'description' => '',
'type' => 'string',
'example' => '20',
],
'HostAddress' => [
'description' => '',
'type' => 'string',
'example' => '****[****] @ [1XX.XX.XX.XX]'."\n",
],
'DBName' => [
'description' => '',
'type' => 'string',
'example' => 'dcdev',
],
'CNname' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-i-xxxx',
],
'Extension' => [
'description' => '',
'type' => 'string',
'example' => 'tddl:5.4.19-20240927',
],
'Fail' => [
'description' => '',
'type' => 'string',
'enumValueTitles' => [
'0',
2 => '2',
],
'example' => '0',
],
'InsName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xdb-s-xxxx',
],
'IsBind' => [
'description' => '',
'type' => 'string',
'enumValueTitles' => [
'0',
'1',
],
'example' => '0',
],
'WT' => [
'description' => '',
'type' => 'string',
'enumValueTitles' => [
'TP' => 'TP',
'AP' => 'AP',
],
'example' => 'TP',
],
'Params' => [
'description' => '',
'type' => 'string',
'example' => '["1"]',
],
'Frows' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'Rows' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'SCNT' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'SqlType' => [
'description' => '',
'type' => 'string',
'example' => 'select',
],
'TooLong' => [
'description' => '',
'type' => 'string',
'enumValueTitles' => [
'0',
'1',
],
'example' => '0',
],
'TraceId' => [
'description' => '',
'type' => 'string',
'example' => '17a5c5c840006000',
],
'TransactionPolicy' => [
'description' => '',
'type' => 'string',
'example' => 'XA',
],
'TrxId' => [
'description' => '',
'type' => 'string',
'example' => '17a5c5c840006000',
],
'TemplateId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidStartTime.Malformed',
'errorMessage' => 'The specified parameter StartTime is not valid.',
],
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist or is not supported.',
],
],
404 => [
[
'errorCode' => 'InvalidDBInstanceId.NotFound',
'errorMessage' => 'The specified DBInstanceId does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"DBInstanceId\\": \\"pxc-********\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"Items\\": [\\n {\\n \\"SQLHash\\": \\"c8df07e5d45cd68da8b4771c2016e20b\\",\\n \\"SQLText\\": \\"select * from test \\",\\n \\"QueryStartTime\\": \\"2024-11-22T02:22:22.444Z\\",\\n \\"QueryTime\\": \\"3.000\\",\\n \\"QueryTimeMS\\": \\"3000.000\\",\\n \\"LockTimeMS\\": \\"1\\",\\n \\"ParseRowCounts\\": \\"10\\",\\n \\"ReturnRowCounts\\": \\"20\\",\\n \\"HostAddress\\": \\"****[****] @ [1XX.XX.XX.XX]\\\\n\\",\\n \\"DBName\\": \\"dcdev\\",\\n \\"CNname\\": \\"pxc-i-xxxx\\",\\n \\"Extension\\": \\"tddl:5.4.19-20240927\\",\\n \\"Fail\\": \\"0\\",\\n \\"InsName\\": \\"pxc-xdb-s-xxxx\\",\\n \\"IsBind\\": \\"0\\",\\n \\"WT\\": \\"TP\\",\\n \\"Params\\": \\"[\\\\\\"1\\\\\\"]\\",\\n \\"Frows\\": \\"1\\",\\n \\"Rows\\": \\"1\\",\\n \\"SCNT\\": \\"1\\",\\n \\"SqlType\\": \\"select\\",\\n \\"TooLong\\": \\"0\\",\\n \\"TraceId\\": \\"17a5c5c840006000\\",\\n \\"TransactionPolicy\\": \\"XA\\",\\n \\"TrxId\\": \\"17a5c5c840006000\\",\\n \\"TemplateId\\": \\"af33ffee\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n pxc-********\\n 1\\n 30\\n 3\\n \\n c8df07e5d45cd68da8b4771c2016e20b\\n select * from test \\n 2024-11-22T02:22:22.444Z\\n 3.000\\n 3000.000\\n 1\\n 10\\n 20\\n ****[****] @ [1XX.XX.XX.XX]\\n\\n dcdev\\n pxc-i-xxxx\\n tddl:5.4.19-20240927\\n 0\\n pxc-xdb-s-xxxx\\n 0\\n TP\\n [\\"1\\"]\\n 1\\n 1\\n 1\\n select\\n 0\\n 17a5c5c840006000\\n XA\\n 17a5c5c840006000\\n af33ffee\\n \\n","errorExample":""}]',
],
'DescribeDBNodePerformance' => [
'summary' => '性能监控数据接口',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '101459',
'abilityTreeNodes' => [
'FEATUREdrdsD0NTUP',
],
],
'parameters' => [
[
'name' => 'Key',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Cpu_Usage,Mem_Usage',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2012-06-08T15:00Z',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-*******',
],
],
[
'name' => 'DBNodeIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-i-******,pxc-i-*******',
],
],
[
'name' => 'CharacterType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'polarx_cn',
],
],
[
'name' => 'DBNodeRole',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'master',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2012-06-18T15:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-10-20T02:00Z',
],
'StartTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-10-20T00:00Z',
],
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-********',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'EFB5E10B-5268-170F-A378-9AF86CCEACC8',
],
'PerformanceKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PerformanceItem' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MetricName' => [
'description' => '',
'type' => 'string',
'example' => 'logic_tps',
],
'DBNodeId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-i-********',
],
'Measurement' => [
'description' => '',
'type' => 'string',
'example' => 'Logic_TPS',
],
'Points' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PerformanceItemValue' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Value' => [
'description' => '',
'type' => 'string',
'example' => '42.38',
],
'Timestamp' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1600822800000',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-10-20T02:00Z\\",\\n \\"StartTime\\": \\"2021-10-20T00:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"RequestId\\": \\"EFB5E10B-5268-170F-A378-9AF86CCEACC8\\",\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"logic_tps\\",\\n \\"DBNodeId\\": \\"pxc-i-********\\",\\n \\"Measurement\\": \\"Logic_TPS\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2021-10-20T02:00Z\\n 2021-10-20T00:00Z\\n pxc-********\\n EFB5E10B-5268-170F-A378-9AF86CCEACC8\\n \\n logic_tps\\n pxc-i-********\\n Logic_TPS\\n \\n 42.38\\n 1600822800000\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeDBNodePerformance',
],
'DescribeSqlAuditInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86262',
'abilityTreeNodes' => [
'FEATUREdrdsB0CUNV',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-****************',
],
],
[
'name' => 'AuditAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test_daa',
],
],
[
'name' => 'AuditAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Pw@11111',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SLSLogStore' => [
'description' => '',
'type' => 'string',
'example' => 'polardbx-sqlaudit-log',
],
'SLSProject' => [
'description' => '',
'type' => 'string',
'example' => 'polardbx-sqlaudit-cn-hangzhou-123456789',
],
'IsEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"Data\\": {\\n \\"SLSLogStore\\": \\"polardbx-sqlaudit-log\\",\\n \\"SLSProject\\": \\"polardbx-sqlaudit-cn-hangzhou-1852045029120897\\",\\n \\"IsEnabled\\": true\\n }\\n}","type":"json"}]',
'title' => 'DescribeSqlAuditInfo',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'EnableSqlAudit' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86272',
'abilityTreeNodes' => [
'FEATUREdrdsD0NTUP',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-****************',
],
],
[
'name' => 'ExpireAfterDays',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '365',
'minimum' => '1',
'example' => '45',
'default' => '45',
],
],
[
'name' => 'AuditAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'test_daa',
],
],
[
'name' => 'AuditAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Pw@11111',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'DC3ABA3E-0F8A-4596-9104-F5167C******',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]',
'title' => 'EnableSqlAudit',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DisableSqlAudit' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-****************',
],
],
[
'name' => 'AuditAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test_daa',
],
],
[
'name' => 'AuditAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Pw@11111',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'DC3DAE3E-0F8A-4596-9104-F5167C******',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3DAE3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]',
'title' => 'DisableSqlAudit',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckSqlAuditSlsStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86221',
'abilityTreeNodes' => [
'FEATUREdrdsB0CUNV',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'enabled',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"enabled\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\"\\n}","type":"json"}]',
],
'DescribeEvents' => [
'summary' => '历史事件',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '103087',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '区域ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'title' => '开始时间',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2021-10-18T03:07:25Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'title' => '结束时间',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2021-10-18T03:07:25Z',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '页面大小',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'title' => '页面下标',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '4748127A-6D50-432C-B635-433467074C27',
],
'TotalRecordCount' => [
'title' => '总页数',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'EventItems' => [
'title' => '事件体',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventId' => [
'title' => '事件ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '50421290',
],
'EventName' => [
'title' => '事件名称',
'description' => '',
'type' => 'string',
'example' => 'ModifySecurityIps',
],
'EventPayload' => [
'title' => '补充信息',
'description' => '',
'type' => 'string',
'example' => '{\\"Domain\\": \\"rds-cn-hangzhou.aliyuncs.com\\"}',
],
'EventReason' => [
'title' => '原因',
'description' => '',
'type' => 'string',
'example' => 'FROM_USER',
],
'EventRecordTime' => [
'title' => '记录时间',
'description' => '',
'type' => 'string',
'example' => '2021-10-15T06:39:49Z',
],
'EventTime' => [
'title' => '事件时间',
'description' => '',
'type' => 'string',
'example' => '2021-10-15T06:35:00Z',
],
'EventType' => [
'title' => '事件类型',
'description' => '',
'type' => 'string',
'example' => 'SecurityManagement',
],
'EventUserType' => [
'title' => '事件用户类型',
'description' => '',
'type' => 'string',
'example' => 'USRE',
],
'RegionId' => [
'title' => '区域ID',
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ResourceName' => [
'title' => '资源名',
'description' => '',
'type' => 'string',
'example' => 'px-bp1v8udesc89g156g',
],
'ResourceType' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'example' => 'instance',
],
],
],
],
'PageSize' => [
'title' => '页面大小',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'PageNumber' => [
'title' => '页面下标',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4748127A-6D50-432C-B635-433467074C27\\",\\n \\"TotalRecordCount\\": 20,\\n \\"EventItems\\": [\\n {\\n \\"EventId\\": 50421290,\\n \\"EventName\\": \\"ModifySecurityIps\\",\\n \\"EventPayload\\": \\"{\\\\\\\\\\\\\\"Domain\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"rds-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\"}\\",\\n \\"EventReason\\": \\"FROM_USER\\",\\n \\"EventRecordTime\\": \\"2021-10-15T06:39:49Z\\",\\n \\"EventTime\\": \\"2021-10-15T06:35:00Z\\",\\n \\"EventType\\": \\"SecurityManagement\\",\\n \\"EventUserType\\": \\"USRE\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceName\\": \\"px-bp1v8udesc89g156g\\",\\n \\"ResourceType\\": \\"instance\\"\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 4748127A-6D50-432C-B635-433467074C27\\n 20\\n \\n 50421290\\n ModifySecurityIps\\n {\\\\\\"Domain\\\\\\": \\\\\\"rds-cn-hangzhou.aliyuncs.com\\\\\\"}\\n FROM_USER\\n 2021-10-15T06:39:49Z\\n 2021-10-15T06:35:00Z\\n SecurityManagement\\n USRE\\n cn-hangzhou\\n px-bp1v8udesc89g156g\\n instance\\n \\n 20\\n 1\\n","errorExample":""}]',
'title' => ' DescribeEvents',
],
'DescribeActiveOperationMaintainConf' => [
'summary' => '展示全局运维窗口配置',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '103014',
'abilityTreeNodes' => [
'FEATUREdrdsZVW4NQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '区域ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'requestid',
'description' => '',
'type' => 'string',
'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F',
],
'Config' => [
'title' => '配置信息',
'description' => '',
'type' => 'object',
'properties' => [
'CreatedTime' => [
'title' => '创建时间',
'description' => '',
'type' => 'string',
'example' => '2021-08-11T10:08:27Z',
],
'CycleTime' => [
'title' => '循环时间',
'description' => '',
'type' => 'string',
'example' => '1,2,3,4,5,6,7',
],
'CycleType' => [
'title' => '循环类型',
'description' => '',
'type' => 'string',
'example' => 'Week',
],
'MaintainEndTime' => [
'title' => '运维结束时间',
'description' => '',
'type' => 'string',
'example' => '04:00:00Z',
],
'MaintainStartTime' => [
'title' => '运维开始时间',
'description' => '',
'type' => 'string',
'example' => '04:00:00Z',
],
'ModifiedTime' => [
'title' => '修改时间',
'description' => '',
'type' => 'string',
'example' => '2021-08-11T10:08:27Z',
],
'Status' => [
'title' => '状态',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
'HasConfig' => [
'title' => '用户是否配置:1:已经配置。 0.未配置',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\",\\n \\"Config\\": {\\n \\"CreatedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"CycleTime\\": \\"1,2,3,4,5,6,7\\",\\n \\"CycleType\\": \\"Week\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"MaintainStartTime\\": \\"04:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"Status\\": 1\\n },\\n \\"HasConfig\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\n \\n 2021-08-11T10:08:27Z\\n 1,2,3,4,5,6,7\\n Week\\n 04:00:00Z\\n 04:00:00Z\\n 2021-08-11T10:08:27Z\\n 1\\n \\n 1\\n","errorExample":""}]',
'title' => 'DescribeActiveOperationMaintainConf',
],
'DescribeActiveOperationTasks' => [
'summary' => '获取待执行自动运维任务列表',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '102988',
'abilityTreeNodes' => [
'FEATUREdrdsZVW4NQ',
],
],
'parameters' => [
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'all',
],
],
[
'name' => 'ProductId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'polarx',
],
],
[
'name' => 'DbType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'polarx',
],
],
[
'name' => 'InsName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxxxx',
],
],
[
'name' => 'ChangeLevel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'all',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '25',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'AllowChange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'AllowCancel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'xxxx',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalRecordCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'Items' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AllowCancel' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'AllowChange' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'ChangeLevel' => [
'description' => '',
'type' => 'string',
'example' => 'Risk',
],
'ChangeLevelEn' => [
'description' => '',
'type' => 'string',
'example' => 'Risk repairment',
],
'ChangeLevelZh' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'CreatedTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-06-15T16:00:00Z',
],
'CurrentAVZ' => [
'description' => '',
'type' => 'string',
'example' => 'cn-shanghai-et-a',
],
'DbType' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'DbVersion' => [
'description' => '',
'type' => 'string',
'example' => '2.0',
],
'Deadline' => [
'description' => '',
'type' => 'string',
'example' => '2021-06-15T16:00:00Z',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Impact' => [
'description' => '',
'type' => 'string',
'example' => '--',
],
'ImpactEn' => [
'description' => '',
'type' => 'string',
'example' => 'Transient instance disconnection',
],
'ImpactZh' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'InsComment' => [
'description' => '',
'type' => 'string',
'example' => 'xxx',
],
'InsName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-dd',
],
'ModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-06-15T16:00:00Z',
],
'PrepareInterval' => [
'description' => '',
'type' => 'string',
'example' => '03:00:00',
],
'Region' => [
'description' => '',
'type' => 'string',
'example' => 'cn-shanghai-et15-b01',
],
'ResultInfo' => [
'description' => '',
'type' => 'string',
'example' => '--',
],
'StartTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-06-15T16:00:00Z',
],
'Status' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'SubInsNames' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xx',
],
],
'SwitchTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-06-15T16:00:00Z',
],
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'rds_apsaradb_transfer',
],
'TaskTypeEn' => [
'description' => '',
'type' => 'string',
'example' => '--',
],
'TaskTypeZh' => [
'description' => '',
'type' => 'string',
'example' => '--',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 12,\\n \\"RequestId\\": \\"xxxx\\",\\n \\"PageNumber\\": 1,\\n \\"TotalRecordCount\\": 23,\\n \\"Items\\": [\\n {\\n \\"AllowCancel\\": \\"0\\",\\n \\"AllowChange\\": \\"0\\",\\n \\"ChangeLevel\\": \\"Risk\\",\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"ChangeLevelZh\\": \\"风险修复\\",\\n \\"CreatedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-shanghai-et-a\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"2.0\\",\\n \\"Deadline\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Id\\": 1,\\n \\"Impact\\": \\"--\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"ImpactZh\\": \\"中断\\",\\n \\"InsComment\\": \\"xxx\\",\\n \\"InsName\\": \\"pxc-dd\\",\\n \\"ModifiedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"PrepareInterval\\": \\"03:00:00\\",\\n \\"Region\\": \\"cn-shanghai-et15-b01\\",\\n \\"ResultInfo\\": \\"--\\",\\n \\"StartTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Status\\": 3,\\n \\"SubInsNames\\": [\\n \\"pxc-xx\\"\\n ],\\n \\"SwitchTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"TaskType\\": \\"rds_apsaradb_transfer\\",\\n \\"TaskTypeEn\\": \\"--\\",\\n \\"TaskTypeZh\\": \\"--\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 12\\n xxxx\\n 1\\n 23\\n \\n 0\\n 0\\n Risk\\n Risk repairment\\n 风险修复\\n 2021-06-15T16:00:00Z\\n cn-shanghai-et-a\\n polarx\\n 2.0\\n 2021-06-15T16:00:00Z\\n 1\\n --\\n Transient instance disconnection\\n 中断\\n xxx\\n pxc-dd\\n 2021-06-15T16:00:00Z\\n 03:00:00\\n cn-shanghai-et15-b01\\n --\\n 2021-06-15T16:00:00Z\\n 3\\n pxc-xx\\n 2021-06-15T16:00:00Z\\n rds_apsaradb_transfer\\n --\\n --\\n \\n","errorExample":""}]',
'title' => 'DescribeActiveOperationTasks',
],
'DescribeActiveOperationTaskCount' => [
'summary' => '获取主动运维任务数量',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '103006',
'abilityTreeNodes' => [
'FEATUREdrdsZVW4NQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Product',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'polarx',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Category',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'EC7E27FC-58F8-4722-89BB-D1B6D0971956',
],
'NeedPop' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TaskCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC7E27FC-58F8-4722-89BB-D1B6D0971956\\",\\n \\"NeedPop\\": 1,\\n \\"TaskCount\\": 20\\n}","errorExample":""},{"type":"xml","example":"\\n EC7E27FC-58F8-4722-89BB-D1B6D0971956\\n 1\\n 20\\n","errorExample":""}]',
'title' => 'DescribeActiveOperationTaskCount',
],
'ModifyActiveOperationMaintainConf' => [
'summary' => '修改全局运维窗口信息',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '103016',
'abilityTreeNodes' => [
'FEATUREdrdsZVW4NQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'CycleType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Week',
],
],
[
'name' => 'CycleTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1,2,3,4,5,6,7',
],
],
[
'name' => 'MaintainStartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '02:00:00Z',
],
],
[
'name' => 'MaintainEndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '02:00:00Z',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '4035409E-7297-4115-ABC9-C1C3942BC069',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4035409E-7297-4115-ABC9-C1C3942BC069\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4035409E-7297-4115-ABC9-C1C3942BC069\\n","errorExample":""}]',
'title' => 'ModifyActiveOperationMaintainConf',
],
'DescribeTasks' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2021-11-01',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2021-11-04',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '30',
'example' => '',
'default' => '30',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '30',
'default' => '1',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'D6045D78-C119-5A17-9DEA-0F810394E008',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageRecordCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'TotalRecordCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Items' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'RUNNING',
],
'FinishTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-10-20T20:00:00Z',
],
'Progress' => [
'description' => '',
'type' => 'string',
'example' => '80',
],
'BeginTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-10-20T19:40:00Z',
],
'TaskErrorCode' => [
'description' => '',
'type' => 'string',
'example' => 'TaskErrorCode',
],
'DBName' => [
'description' => '',
'type' => 'string',
'example' => 'DBName',
],
'ProgressInfo' => [
'description' => '',
'type' => 'string',
'example' => 'ProgressInfo',
],
'ScaleOutToken' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => '20089398',
],
'TaskErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'TaskErrorMessage',
],
'TaskAction' => [
'description' => '',
'type' => 'string',
'example' => 'multi_scale_out',
],
],
],
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6045D78-C119-5A17-9DEA-0F810394E008\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"FinishTime\\": \\"2021-10-20T20:00:00Z\\",\\n \\"Progress\\": \\"80\\",\\n \\"BeginTime\\": \\"2021-10-20T19:40:00Z\\",\\n \\"TaskErrorCode\\": \\"TaskErrorCode\\",\\n \\"DBName\\": \\"DBName\\",\\n \\"ProgressInfo\\": \\"ProgressInfo\\",\\n \\"ScaleOutToken\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"20089398\\",\\n \\"TaskErrorMessage\\": \\"TaskErrorMessage\\",\\n \\"TaskAction\\": \\"multi_scale_out\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n D6045D78-C119-5A17-9DEA-0F810394E008\\n 1\\n 30\\n 2\\n \\n RUNNING\\n 2021-10-20T20:00:00Z\\n \\n 2021-10-20T19:40:00Z\\n TaskErrorCode\\n DBName\\n ProgressInfo\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n 20089398\\n TaskErrorMessage\\n multi_scale_out\\n \\n","errorExample":""}]',
'title' => 'DescribeTasks',
],
'DescribeScaleOutMigrateTaskList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86260',
'abilityTreeNodes' => [
'FEATUREdrds0SX279',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '32',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Progress\\": 32,\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n C458B1E8-1683-3645-B154-6BA32080EEA\\n","errorExample":""}]',
'title' => 'DescribeScaleOutMigrateTaskList',
],
'CreateTransformOperation' => [
'summary' => '创建标准版迁移到企业版的操作任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '196930',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxx',
],
],
[
'name' => 'Operation',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'finish',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IncorrectDBInstance',
'errorMessage' => 'Current DB instance does not support this operation.',
],
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist or is not supported.',
],
[
'errorCode' => 'InvalidParam',
'errorMessage' => 'Invalid Parameter.',
],
[
'errorCode' => 'IncorrectDBInstanceState',
'errorMessage' => 'Current DB instance state does not support this operation.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]',
],
'DescribeRplInspectionTask' => [
'summary' => '查询预检任务结果',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '104354',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FailPageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'FailPageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '10',
'pattern' => '^\\d+$',
'default' => '30',
],
],
[
'name' => 'SuccessPageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'SuccessPageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '15',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'InspectionTaskList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2025-09-25T02:36:20.000+0000',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more, please use show sequence to check them.',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10142',
],
'SlinkTaskId' => [
'description' => 'slinktaskid。',
'type' => 'string',
'example' => 'etx-hzrez23btmb6aq',
],
'Stage' => [
'description' => '',
'type' => 'string',
'example' => 'CONNECTIVITY',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'SUCCEEDED',
],
'UpdateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2025-09-23T03:25:21.000+0000',
],
],
],
],
'SlinkStage' => [
'description' => '',
'type' => 'string',
'example' => 'PRE_CHECK',
],
],
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": {\\n \\"InspectionTaskList\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more, please use show sequence to check them.\\",\\n \\"Id\\": 10142,\\n \\"SlinkTaskId\\": \\"etx-hzrez23btmb6aq\\",\\n \\"Stage\\": \\"CONNECTIVITY\\",\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"UpdateTime\\": 0\\n }\\n ],\\n \\"SlinkStage\\": \\"PRE_CHECK\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SkipCurrentStep' => [
'summary' => '跳过评估迁移的当前步骤',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '200597',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'CurrentStep',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PRE_CHECK',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'CreateRplInspectionTask' => [
'summary' => '创建评估预检任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '104276',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SrcUserName',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'bbt_ump',
],
],
[
'name' => 'SrcPassword',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '******',
],
],
[
'name' => 'DstResId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-zkrc1****l54rc',
],
],
[
'name' => 'DstDb',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'transfer_test3',
],
],
[
'name' => 'DstUserName',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'bbt_item',
],
],
[
'name' => 'DstPassword',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'CancelActiveOperationTasks' => [
'summary' => '取消主动运维任务',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '102580',
'abilityTreeNodes' => [
'FEATUREdrdsZVW4NQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Ids',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '111',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305',
],
'Ids' => [
'description' => '',
'type' => 'string',
'example' => '111,1223',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Ids\\": \\"111,1223\\"\\n}","errorExample":""},{"type":"xml","example":"\\n AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\n 111,1223\\n","errorExample":""}]',
'title' => ' CancelActiveOperationTasks',
],
'ModifyActiveOperationTasks' => [
'summary' => '修改主动运维任务',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '103010',
'abilityTreeNodes' => [
'FEATUREdrdsZVW4NQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Ids',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2021-08-15T12:00:00Z',
],
],
[
'name' => 'ImmediateStart',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '8C9CC90A-9532-4752-B59F-580112C5A45B',
],
'Ids' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8C9CC90A-9532-4752-B59F-580112C5A45B\\",\\n \\"Ids\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8C9CC90A-9532-4752-B59F-580112C5A45B\\n 1\\n","errorExample":""}]',
'title' => ' ModifyActiveOperationTasks',
],
'UpdateDBInstanceSSL' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86293',
'abilityTreeNodes' => [
'FEATUREdrdsUULYZA',
],
],
'parameters' => [
[
'name' => 'EnableSSL',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
[
'name' => 'CertCommonName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'pxc-hzrqjarxdocd4t.polarx.rds.aliyuncs.com',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2209883',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n 2209883\\n \\n","errorExample":""}]',
'title' => ' UpdateDBInstanceSSL',
],
'ModifyParameter' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86282',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasdyuoo',
],
],
[
'name' => 'ParamLevel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'compute',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '{"CONN_POOL_BLOCK_TIMEOUT":6000}',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
[
'name' => 'ParameterGroupId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]',
'title' => 'ModifyParameter',
],
'DescribeParameterTemplates' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86254',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'ParamLevel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'compute',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'EngineVersion' => [
'description' => '',
'type' => 'string',
'example' => '2.0',
],
'ParameterCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '218',
],
'Parameters' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CheckingCode' => [
'description' => '',
'type' => 'string',
'example' => '[0|1]',
],
'ParameterName' => [
'description' => '',
'type' => 'string',
'example' => 'loose_enable_gts',
],
'Dynamic' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ParameterValue' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'ParameterDescription' => [
'description' => '',
'type' => 'string',
'example' => 'polarx hatp addition param',
],
'Revisable' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"ParameterCount\\": 218,\\n \\"Parameters\\": [\\n {\\n \\"CheckingCode\\": \\"[0|1]\\",\\n \\"ParameterName\\": \\"loose_enable_gts\\",\\n \\"Dynamic\\": 0,\\n \\"ParameterValue\\": \\"1\\",\\n \\"ParameterDescription\\": \\"polarx hatp addition param\\",\\n \\"Revisable\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n polarx\\n 2.0\\n 218\\n \\n [0|1]\\n loose_enable_gts\\n 0\\n 1\\n polarx hatp addition param\\n 0\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeParameterTemplates',
],
'DescribeParameters' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86253',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'ParamLevel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'compute',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'EngineVersion' => [
'description' => '',
'type' => 'string',
'example' => '2.0',
],
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'ConfigParameters' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ParameterDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ParameterName' => [
'description' => '',
'type' => 'string',
'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT',
],
'ParameterValue' => [
'description' => '',
'type' => 'string',
'example' => '-1',
],
],
],
],
'RunningParameters' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ParameterDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ParameterName' => [
'description' => '',
'type' => 'string',
'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT',
],
'ParameterValue' => [
'description' => '',
'type' => 'string',
'example' => '-1',
],
],
],
],
'DBInstanceId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidDBInstance.NotFound',
'errorMessage' => 'The specified DB instance does not exist.',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"ConfigParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭,0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"RunningParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭,0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"DBInstanceId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6BA32080EEA\\n \\n 2.0\\n polarx\\n \\n 存储节点私有协议开关(-1关闭,0开启)\\n CONN_POOL_XPROTO_STORAGE_DB_PORT\\n -1\\n \\n \\n 存储节点私有协议开关(-1关闭,0开启)\\n CONN_POOL_XPROTO_STORAGE_DB_PORT\\n -1\\n \\n \\n","errorExample":""}]',
'title' => ' DescribeParameters',
],
'DescribeParameterGroups' => [
'summary' => '查询参数模版列表',
'methods' => [
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '230979',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '1E5DCFFC-A00D-****-836E-73318F8CA577',
],
'ParameterGroups' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ParameterGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'rpg-s1y1xy06****fqs7y',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2024-12-19T16:41:31+08:00',
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '1605079985000',
],
'DbType' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'DbVersion' => [
'description' => '',
'type' => 'string',
'example' => '5.7',
],
'DnParamCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'DnForceRestart' => [
'description' => '',
'type' => 'boolean',
],
'CnParamCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'CnForceRestart' => [
'description' => '',
'type' => 'boolean',
],
'Series' => [
'description' => '',
'type' => 'string',
'example' => 'enterprise',
],
'ParameterGroupName' => [
'description' => '',
'type' => 'string',
'example' => 'dstest_api_new',
],
'ParameterGroupType' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"1E5DCFFC-A00D-****-836E-73318F8CA577\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"ParameterGroupId\\": \\"rpg-s1y1xy06****fqs7y\\",\\n \\"GmtCreated\\": \\"2024-12-19T16:41:31+08:00\\",\\n \\"GmtModified\\": \\"1605079985000\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"5.7\\",\\n \\"DnParamCount\\": 10,\\n \\"DnForceRestart\\": true,\\n \\"CnParamCount\\": 10,\\n \\"CnForceRestart\\": true,\\n \\"Series\\": \\"enterprise\\",\\n \\"ParameterGroupName\\": \\"dstest_api_new\\",\\n \\"ParameterGroupType\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'CreateBackup' => [
'methods' => [
'post',
'get',
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86225',
'abilityTreeNodes' => [
'FEATUREdrdsE1M93A',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-**************',
],
],
[
'name' => 'BackupType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'items' => [
'type' => 'object',
'properties' => [
'BackupSetId' => [
'name' => 'BackupSetId',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '627833',
'backendName' => 'backupSetId',
],
],
'extendType' => 'true',
],
'properties' => [
'BackupSetId' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BackupSetId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n \\n 627833\\n \\n","errorExample":""}]',
],
'DescribeBackupPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86236',
'abilityTreeNodes' => [
'FEATUREdrdsE1M93A',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'LogLocalRetentionSpace' => [
'name' => 'LogLocalRetentionSpace',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'logLocalRetentionSpace',
],
'DBInstanceName' => [
'name' => 'DBInstanceName',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'pxc-xxxxxx',
'backendName' => 'dbInstanceName',
],
'BackupWay' => [
'name' => 'BackupWay',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'P',
'backendName' => 'backupWay',
],
'BackupPeriod' => [
'name' => 'BackupPeriod',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '1001000',
'backendName' => 'backupPeriod',
],
'ForceCleanOnHighSpaceUsage' => [
'name' => 'ForceCleanOnHighSpaceUsage',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'forceCleanOnHighSpaceUsage',
],
'BackupType' => [
'name' => 'BackupType',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'backupType',
],
'LocalLogRetention' => [
'name' => 'LocalLogRetention',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'localLogRetention',
],
'RemoveLogRetention' => [
'name' => 'RemoveLogRetention',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
'backendName' => 'removeLogRetention',
],
'BackupPlanBegin' => [
'name' => 'BackupPlanBegin',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '03:00Z',
'backendName' => 'backupPlanBegin',
],
'BackupSetRetention' => [
'name' => 'BackupSetRetention',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
'backendName' => 'backupSetRetention',
],
'IsEnabled' => [
'name' => 'IsEnabled',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'isEnabled',
],
'ColdDataBackupInterval' => [
'name' => 'ColdDataBackupInterval',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'coldDataBackupInterval',
],
'ColdDataBackupRetention' => [
'name' => 'ColdDataBackupRetention',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'coldDataBackupRetention',
],
],
'extendType' => 'true',
],
'properties' => [
'LogLocalRetentionSpace' => [
'type' => 'integer',
'format' => 'int32',
],
'DBInstanceName' => [
'type' => 'string',
],
'BackupWay' => [
'type' => 'string',
],
'BackupPeriod' => [
'type' => 'string',
],
'ForceCleanOnHighSpaceUsage' => [
'type' => 'integer',
'format' => 'int32',
],
'BackupType' => [
'type' => 'string',
],
'LocalLogRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'RemoveLogRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'BackupPlanBegin' => [
'type' => 'string',
],
'BackupSetRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'IsEnabled' => [
'type' => 'integer',
'format' => 'int32',
],
'ColdDataBackupInterval' => [
'type' => 'integer',
'format' => 'int32',
],
'ColdDataBackupRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'LocalLogRetentionNumber' => [
'type' => 'integer',
'format' => 'int32',
],
'IsCrossRegionDataBackupEnabled' => [
'type' => 'boolean',
],
'IsCrossRegionLogBackupEnabled' => [
'type' => 'boolean',
],
'DestCrossRegion' => [
'type' => 'string',
],
'CrossRegionDataBackupRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'CrossRegionLogBackupRetention' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B87E2AB3-B7C9-4394-9160-7F639F732031\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": true,\\n \\"IsCrossRegionLogBackupEnabled\\": true,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n B87E2AB3-B7C9-4394-9160-7F639F732031\\n true\\n \\n 30\\n pxc-xxxxxx\\n P\\n 1001000\\n 1\\n 0\\n 30\\n 7\\n 03:00Z\\n 7\\n 1\\n 30\\n 30\\n 60\\n false\\n false\\n cn-shanghai\\n 30\\n 30\\n \\n","errorExample":""}]',
'title' => 'DescribeBackupPolicy',
],
'DescribeBackupSetList' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86237',
'abilityTreeNodes' => [
'FEATUREdrdsE1M93A',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-xxxxxx',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1635707845000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1635707845000',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'DestCrossRegion',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1635706960956',
],
'Status' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BackupSetSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '88803195',
],
'BackupSetId' => [
'description' => '',
'type' => 'string',
'format' => 'int64',
'example' => '111',
],
'BackupType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BeginTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1635706960956',
],
'BackupModel' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1635706960956,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": \\"111\\",\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1635706960956,\\n \\"BackupModel\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1A6D328C-84B8-40DC-BF49-6C73984D7494\\n true\\n \\n 1635706960956\\n 1\\n 88803195\\n 111\\n 1\\n 1635706960956\\n 0\\n \\n","errorExample":""}]',
'title' => 'DescribeBackupSetList',
],
'DescribeBinaryLogList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86238',
'abilityTreeNodes' => [
'FEATUREdrdsAS582G',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '30',
'pattern' => '^\\d+$',
'default' => '30',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hz1fds',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-09-09 10:27:46',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-11-09 10:27:46',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'TotalNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'LogList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-11-09 10:27:46',
],
'ModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-11-09 10:27:46',
],
'UploadHost' => [
'description' => '',
'type' => 'string',
'example' => '10.110.88.9',
],
'UploadStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'DownloadLink' => [
'description' => '',
'type' => 'string',
'example' => 'http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D',
],
'BeginTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-09-09 10:27:46',
],
'LogSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '536870912',
],
'FileName' => [
'description' => '',
'type' => 'string',
'example' => 'binlog.000001',
],
'CreatedTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-09-09 10:27:46',
],
'PurgeStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 100,\\n \\"LogList\\": [\\n {\\n \\"EndTime\\": \\"2021-11-09 10:27:46\\",\\n \\"ModifiedTime\\": \\"2021-11-09 10:27:46\\",\\n \\"UploadHost\\": \\"10.110.88.9\\",\\n \\"UploadStatus\\": 2,\\n \\"DownloadLink\\": \\"http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D\\",\\n \\"BeginTime\\": \\"2021-09-09 10:27:46\\",\\n \\"LogSize\\": 536870912,\\n \\"FileName\\": \\"binlog.000001\\",\\n \\"CreatedTime\\": \\"2021-09-09 10:27:46\\",\\n \\"PurgeStatus\\": 0,\\n \\"Id\\": 100\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\n 1\\n 30\\n 100\\n \\n 2021-11-09 10:27:46\\n 2021-11-09 10:27:46\\n 10.110.88.9\\n 2\\n http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D\\n 2021-09-09 10:27:46\\n 536870912\\n binlog.000001\\n 2021-09-09 10:27:46\\n 0\\n 100\\n \\n","errorExample":""}]',
'title' => 'DescribeBinaryLogList',
],
'UpdateBackupPolicy' => [
'methods' => [
'post',
'get',
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86292',
'abilityTreeNodes' => [
'FEATUREdrds8KEOBF',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasdyuoo',
],
],
[
'name' => 'BackupPeriod',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1001000',
],
],
[
'name' => 'BackupPlanBegin',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '03:00Z',
],
],
[
'name' => 'BackupSetRetention',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
[
'name' => 'BackupType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
[
'name' => 'BackupWay',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'P',
],
],
[
'name' => 'ForceCleanOnHighSpaceUsage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'IsEnabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'LocalLogRetention',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '7',
],
],
[
'name' => 'RemoveLogRetention',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '7',
],
],
[
'name' => 'LogLocalRetentionSpace',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
[
'name' => 'ColdDataBackupInterval',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
[
'name' => 'ColdDataBackupRetention',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
[
'name' => 'LocalLogRetentionNumber',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
],
],
[
'name' => 'IsCrossRegionDataBackupEnabled',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'IsCrossRegionLogBackupEnabled',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'DestCrossRegion',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'CrossRegionDataBackupRetention',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
],
],
[
'name' => 'CrossRegionLogBackupRetention',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'items' => [
'type' => 'object',
'properties' => [
'LogLocalRetentionSpace' => [
'name' => 'LogLocalRetentionSpace',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'logLocalRetentionSpace',
],
'DBInstanceName' => [
'name' => 'DBInstanceName',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'pxc-hzjasdyuoo',
'backendName' => 'dbInstanceName',
],
'BackupWay' => [
'name' => 'BackupWay',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'P',
'backendName' => 'backupWay',
],
'BackupPeriod' => [
'name' => 'BackupPeriod',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '1001000',
'backendName' => 'backupPeriod',
],
'ForceCleanOnHighSpaceUsage' => [
'name' => 'ForceCleanOnHighSpaceUsage',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'forceCleanOnHighSpaceUsage',
],
'BackupType' => [
'name' => 'BackupType',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'backupType',
],
'LocalLogRetention' => [
'name' => 'LocalLogRetention',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
'backendName' => 'localLogRetention',
],
'RemoveLogRetention' => [
'name' => 'RemoveLogRetention',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
'backendName' => 'removeLogRetention',
],
'BackupPlanBegin' => [
'name' => 'BackupPlanBegin',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '03:00Z',
'backendName' => 'backupPlanBegin',
],
'BackupSetRetention' => [
'name' => 'BackupSetRetention',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'backupSetRetention',
],
'IsEnabled' => [
'name' => 'IsEnabled',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'isEnabled',
],
'ColdDataBackupInterval' => [
'name' => 'ColdDataBackupInterval',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'coldDataBackupInterval',
],
'ColdDataBackupRetention' => [
'name' => 'ColdDataBackupRetention',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'coldDataBackupRetention',
],
],
'extendType' => 'true',
],
'properties' => [
'LogLocalRetentionSpace' => [
'type' => 'integer',
'format' => 'int32',
],
'DBInstanceName' => [
'type' => 'string',
],
'BackupWay' => [
'type' => 'string',
],
'BackupPeriod' => [
'type' => 'string',
],
'ForceCleanOnHighSpaceUsage' => [
'type' => 'integer',
'format' => 'int32',
],
'BackupType' => [
'type' => 'string',
],
'LocalLogRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'RemoveLogRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'BackupPlanBegin' => [
'type' => 'string',
],
'BackupSetRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'IsEnabled' => [
'type' => 'integer',
'format' => 'int32',
],
'ColdDataBackupInterval' => [
'type' => 'integer',
'format' => 'int32',
],
'ColdDataBackupRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'LocalLogRetentionNumber' => [
'type' => 'integer',
'format' => 'int32',
],
'IsCrossRegionDataBackupEnabled' => [
'type' => 'boolean',
],
'IsCrossRegionLogBackupEnabled' => [
'type' => 'boolean',
],
'DestCrossRegion' => [
'type' => 'string',
],
'CrossRegionDataBackupRetention' => [
'type' => 'integer',
'format' => 'int32',
],
'CrossRegionLogBackupRetention' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": true,\\n \\"IsCrossRegionLogBackupEnabled\\": true,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n \\n 30\\n pxc-hzjasdyuoo\\n P\\n 1001000\\n 1\\n 0\\n 7\\n 7\\n 03:00Z\\n 30\\n 1\\n 30\\n 30\\n 60\\n false\\n false\\n cn-shanghai\\n 30\\n 30\\n \\n","errorExample":""}]',
'title' => 'UpdateBackupPolicy',
],
'DescribeOpenBackupSet' => [
'summary' => '开放商业备份集',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245672',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'RestoreTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2024-10-14T00:00:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Data' => [
'description' => '',
'type' => 'any',
'example' => '{"gmsBackupSet": {"pubFullDownloadUrl": "https://xxxxx","dnName": "pxc-xdb-m-xxxxxx","hostInstanceId": 0001,"binlogs": [],"backupEndTime": "2024-10-21T10:11:56Z","backupLinkExpiredTime": "2024-10-23T06:13:54Z","dnBackupSetId": "00088","notCompletedBinlogs": [],"commitIndex": "15249275","innerFullDownloadUrl": "http://xxxxx","backupStartTime": "2024-10-21T10:09:20Z","backupSetSize": 526118912},"dnBackupSets": [],"insName": "pxc-xxxxx","backupSetId": "cb-xxxxx","canBinlogRecoverToTime": 1729567925000,"backupEndTime": "2024-10-21T10:12:16Z","canBinlogRecoverToTimeUTC": "2024-10-22T03:32:05Z","canBackupMinRecoverToTimeUTC": "2024-10-21T10:11:56Z","pitrInvalid": false,"backupStartTime": "2024-10-21T10:09:16Z","canBackupMinRecoverToTime": 1729505516000}',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": \\"{\\\\\\"gmsBackupSet\\\\\\": {\\\\\\"pubFullDownloadUrl\\\\\\": \\\\\\"https://xxxxx\\\\\\",\\\\\\"dnName\\\\\\": \\\\\\"pxc-xdb-m-xxxxxx\\\\\\",\\\\\\"hostInstanceId\\\\\\": 0001,\\\\\\"binlogs\\\\\\": [],\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"backupLinkExpiredTime\\\\\\": \\\\\\"2024-10-23T06:13:54Z\\\\\\",\\\\\\"dnBackupSetId\\\\\\": \\\\\\"00088\\\\\\",\\\\\\"notCompletedBinlogs\\\\\\": [],\\\\\\"commitIndex\\\\\\": \\\\\\"15249275\\\\\\",\\\\\\"innerFullDownloadUrl\\\\\\": \\\\\\"http://xxxxx\\\\\\",\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:20Z\\\\\\",\\\\\\"backupSetSize\\\\\\": 526118912},\\\\\\"dnBackupSets\\\\\\": [],\\\\\\"insName\\\\\\": \\\\\\"pxc-xxxxx\\\\\\",\\\\\\"backupSetId\\\\\\": \\\\\\"cb-xxxxx\\\\\\",\\\\\\"canBinlogRecoverToTime\\\\\\": 1729567925000,\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:12:16Z\\\\\\",\\\\\\"canBinlogRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-22T03:32:05Z\\\\\\",\\\\\\"canBackupMinRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"pitrInvalid\\\\\\": false,\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:16Z\\\\\\",\\\\\\"canBackupMinRecoverToTime\\\\\\": 1729505516000}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n {\\"gmsBackupSet\\": {\\"pubFullDownloadUrl\\": \\"https://xxxxx\\",\\"dnName\\": \\"pxc-xdb-m-xxxxxx\\",\\"hostInstanceId\\": 0001,\\"binlogs\\": [],\\"backupEndTime\\": \\"2024-10-21T10:11:56Z\\",\\"backupLinkExpiredTime\\": \\"2024-10-23T06:13:54Z\\",\\"dnBackupSetId\\": \\"00088\\",\\"notCompletedBinlogs\\": [],\\"commitIndex\\": \\"15249275\\",\\"innerFullDownloadUrl\\": \\"http://xxxxx\\",\\"backupStartTime\\": \\"2024-10-21T10:09:20Z\\",\\"backupSetSize\\": 526118912},\\"dnBackupSets\\": [],\\"insName\\": \\"pxc-xxxxx\\",\\"backupSetId\\": \\"cb-xxxxx\\",\\"canBinlogRecoverToTime\\": 1729567925000,\\"backupEndTime\\": \\"2024-10-21T10:12:16Z\\",\\"canBinlogRecoverToTimeUTC\\": \\"2024-10-22T03:32:05Z\\",\\"canBackupMinRecoverToTimeUTC\\": \\"2024-10-21T10:11:56Z\\",\\"pitrInvalid\\": false,\\"backupStartTime\\": \\"2024-10-21T10:09:16Z\\",\\"canBackupMinRecoverToTime\\": 1729505516000}\\n","errorExample":""}]',
],
'DescribeBackupSet' => [
'summary' => '备份集详情',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '135043',
'abilityTreeNodes' => [
'FEATUREdrdsE1M93A',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'title' => 'polardb-x实例名',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-htri0ori2r****',
],
],
[
'name' => 'BackupSetId',
'in' => 'query',
'schema' => [
'title' => '备份集ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '111',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '区域',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DestCrossRegion',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'successs',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'title' => '备份结束时间',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1650251308000',
],
'Status' => [
'title' => '状态',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BackupSetSize' => [
'title' => '备份集大小',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '88803195',
],
'BackupSetId' => [
'title' => '备份集ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '111',
],
'BackupType' => [
'title' => '备份类型',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BeginTime' => [
'title' => '备份开始时间',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1650250861754',
],
'BackupModel' => [
'title' => '备份模式',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'OSSList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BackupSetFile' => [
'title' => 'OSS 文件名',
'description' => '',
'type' => 'string',
'example' => 'hins3084_data_20220418110623_qp.xb',
],
'LinkExpiredTime' => [
'title' => '过期时间',
'description' => '',
'type' => 'string',
'example' => '2022-04-20T08:01:37Z',
],
'IntranetDownloadLink' => [
'title' => '内网OSS 下载地址',
'description' => '',
'type' => 'string',
'example' => 'http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?',
],
'DownloadLink' => [
'title' => '外网下载地址',
'description' => '',
'type' => 'string',
'example' => 'https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI5tJEmRFdJ8aBPDR7****&Expires=1650441697&dd=7KJzkUSbXf6dwy',
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successs\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1650251308000,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": 111,\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1650250861754,\\n \\"BackupModel\\": 0,\\n \\"OSSList\\": [\\n {\\n \\"BackupSetFile\\": \\"hins3084_data_20220418110623_qp.xb\\",\\n \\"LinkExpiredTime\\": \\"2022-04-20T08:01:37Z\\",\\n \\"IntranetDownloadLink\\": \\"http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?\\",\\n \\"DownloadLink\\": \\"https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n successs\\n 1A6D328C-84B8-40DC-BF49-6C73984D7494\\n true\\n \\n 1650251308000\\n 1\\n 88803195\\n 111\\n 1\\n 1650250861754\\n 0\\n \\n hins3084_data_20220418110623_qp.xb\\n 2022-04-20T08:01:37Z\\n http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?\\n https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeBackupSet',
],
'UpdateDBInstanceTDE' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86295',
'abilityTreeNodes' => [
'FEATUREdrds9HBOA5',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'TDEStatus',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'EncryptionKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******',
],
],
[
'name' => 'RoleArn',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => '42292****',
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IncorrectEngineVersion',
'errorMessage' => 'The current engine version does not support the operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n 42292****\\n \\n","errorExample":""}]',
'title' => 'UpdateDBInstanceTDE',
],
'ModifySecurityIps' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'default',
],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '127.0.0.1,192.168.0.0',
],
],
[
'name' => 'ModifyMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]',
'title' => 'ModifySecurityIps',
],
'DescribeUserEncryptionKeyList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86265',
'abilityTreeNodes' => [
'FEATUREdrds9HBOA5',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'KeyIds' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******',
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IncorrectEngineVersion',
'errorMessage' => 'The current engine version does not support the operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"KeyIds\\": [\\n \\"RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******\\n \\n","errorExample":""}]',
'title' => 'DescribeUserEncryptionKeyList',
],
'DescribeSecurityIps' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzjasd****',
],
'GroupItems' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '',
'type' => 'string',
'example' => 'defaultGroup',
],
'SecurityIPList' => [
'description' => '',
'type' => 'string',
'example' => '127.0.0.1,172.168.0.0',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"defaultGroup\\",\\n \\"SecurityIPList\\": \\"127.0.0.1,172.168.0.0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\n true\\n \\n pxc-hzjasd****\\n \\n defaultGroup\\n 127.0.0.1,172.168.0.0\\n \\n \\n","errorExample":""}]',
'title' => ' DescribeSecurityIps',
],
'CheckCloudResourceAuthorized' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86218',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'RoleArn',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorizationState' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'RoleArn' => [
'description' => '',
'type' => 'string',
'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole',
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IncorrectEngineVersion',
'errorMessage' => 'The current engine version does not support the operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"AuthorizationState\\": \\"0\\",\\n \\"RoleArn\\": \\"acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A501A191-BD70-5E50-98A9-C2A486A82****\\n \\n 0\\n acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\n \\n","errorExample":""}]',
'title' => 'CheckCloudResourceAuthorized',
],
'EnableRightsSeparation' => [
'summary' => '开启三权分立',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86271',
'abilityTreeNodes' => [
'FEATUREdrdsUFZO07',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-htri0ori2r4k9p',
],
],
[
'name' => 'SecurityAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'account_sec',
],
],
[
'name' => 'SecurityAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '*****',
],
],
[
'name' => 'SecurityAccountDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test123',
],
],
[
'name' => 'AuditAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'account_audit',
],
],
[
'name' => 'AuditAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '******',
],
],
[
'name' => 'AuditAccountDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]',
'title' => ' EnableRightsSeparation',
],
'DisableRightsSeparation' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86266',
'abilityTreeNodes' => [
'FEATUREdrdsUFZO07',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hanghzou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-sprcym7g7w****',
],
],
[
'name' => 'DbaAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'account_1',
],
],
[
'name' => 'DbaAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FE5D94E3-3C93-3594-95D9-AAED2A980915',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FE5D94E3-3C93-3594-95D9-AAED2A980915\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FE5D94E3-3C93-3594-95D9-AAED2A980915\\n true\\n","errorExample":""}]',
'title' => 'DisableRightsSeparation',
],
'ResetAccountPassword' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-htri0ori2r4k9p',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'account',
],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '*****',
],
],
[
'name' => 'SecurityAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'account_sec',
],
],
[
'name' => 'SecurityAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]',
'title' => 'ResetAccountPassword',
],
'CreateAccount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-**************',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testAccount',
],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Test@1111',
],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'testdb',
],
],
[
'name' => 'AccountPrivilege',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ReadWrite',
],
],
[
'name' => 'AccountDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'SecurityAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'securityAccount',
],
],
[
'name' => 'SecurityAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'securityPassword',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]',
'title' => 'CreateAccount',
],
'CreateSuperAccount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-************',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dba',
],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testdbapassword',
],
],
[
'name' => 'AccountDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'testdbadescription',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]',
'title' => 'CreateSuperAccount',
],
'DeleteAccount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86232',
'abilityTreeNodes' => [
'FEATUREdrds0ML0VG',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-*********',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testaccount',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SecurityAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'securityAccount',
],
],
[
'name' => 'SecurityAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'securityPassword',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]',
'title' => 'DeleteAccount',
],
'DescribeAccountList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'testaccount',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2012-06-08T15:00Z',
],
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-*********',
],
'AccountDescription' => [
'description' => '',
'type' => 'string',
'example' => 'testaccount desc',
],
'DBName' => [
'description' => '',
'type' => 'string',
'example' => 'testdb',
],
'AccountPrivilege' => [
'description' => '',
'type' => 'string',
'example' => 'ReadWrite',
],
'AccountType' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'AccountName' => [
'description' => '',
'type' => 'string',
'example' => 'testAccount',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2012-06-08T15:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"AccountDescription\\": \\"testaccount desc\\",\\n \\"DBName\\": \\"testdb\\",\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountType\\": \\"0\\",\\n \\"AccountName\\": \\"testAccount\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n \\n 2012-06-08T15:00Z\\n pxc-*********\\n testaccount desc\\n testdb\\n ReadWrite\\n 0\\n testAccount\\n \\n","errorExample":""}]',
'title' => 'DescribeAccountList',
],
'ModifyAccountDescription' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86275',
'abilityTreeNodes' => [
'FEATUREdrdsJGJ3OD',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'account',
],
],
[
'name' => 'AccountDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'msg',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"msg\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n msg\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]',
'title' => 'ModifyAccountDescription',
],
'ResetAccountPasswordRestrict' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86288',
'abilityTreeNodes' => [
'FEATUREdrds0ML0VG',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testaccount',
],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '*****',
],
],
[
'name' => 'SecurityAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'account_sec',
],
],
[
'name' => 'SecurityAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'description' => '****',
],
'ModifyAccountPrivilege' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-htri0ori2r4k9p',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'account_sec',
],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'sbtest',
],
],
[
'name' => 'AccountPrivilege',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ReadWrite',
],
],
[
'name' => 'SecurityAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'account_audit',
],
],
[
'name' => 'SecurityAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]',
'title' => 'ModifyAccountPrivilege',
],
'DescribeRegions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '86259',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ErrorCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Region' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SupportPolarx10' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'SupportPolarx20' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'ch-hangzhou',
],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-a',
],
'VpcEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"SupportPolarx10\\": true,\\n \\"SupportPolarx20\\": true,\\n \\"RegionId\\": \\"ch-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n 200\\n \\n true\\n true\\n ch-hangzhou\\n \\n cn-hangzhou-a\\n true\\n \\n \\n","errorExample":""}]',
'title' => ' DescribeRegions',
],
'MigrateDBInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '172659',
'abilityTreeNodes' => [
'FEATUREdrds7CT80F',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SwitchMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-xxx',
],
],
[
'name' => 'TopologyType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '3azones',
],
],
[
'name' => 'PrimaryZoneId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-zhangjiakou-b',
],
],
[
'name' => 'SecondaryZoneId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing-l',
],
],
[
'name' => 'TertiaryZoneId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing-h',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vpc-****',
],
],
[
'name' => 'VswitchId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vsw-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'MigrateDBInstanceResponse',
'description' => 'MigrateDBInstanceResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]',
],
'DescribeAvailableCrossRegions' => [
'summary' => '获取已开启跨地域备份的地域',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '193733',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Regions' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '[]',
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeEnabledCrossRegions' => [
'summary' => '获取已开启跨地域备份的地域',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '193730',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-bjxxxxxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Regions' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]',
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'AlignStoragePrimaryAzone' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '132459',
'abilityTreeNodes' => [
'FEATUREdrds7CT80F',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'StorageInstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
],
'SwitchDBInstanceHA' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '132469',
'abilityTreeNodes' => [
'FEATUREdrds7CT80F',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'TargetPrimaryRegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'TargetPrimaryAzoneId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
],
'CreateDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-**************',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testaccount',
],
],
[
'name' => 'Charset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'utf8mb4',
],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testdb',
],
],
[
'name' => 'AccountPrivilege',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ReadWrite',
],
],
[
'name' => 'DbDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'db for test',
],
],
[
'name' => 'SecurityAccountName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'securityAccount',
],
],
[
'name' => 'SecurityAccountPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'securityPassword',
],
],
[
'name' => 'Mode',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'title' => 'drds/auto 用来区分所建库为自动拆分模式,还是手动拆分模式',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'auto',
'enum' => [
'drds',
'auto',
],
],
],
[
'name' => 'StoragePoolName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]',
'title' => 'CreateDB',
],
'DeleteDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testdb',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]',
'title' => 'DeleteDB',
],
'DescribeCharacterSet' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-*********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '709C1E40-092D-4A3D-9958-6D7438******',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '',
'type' => 'string',
'example' => 'polarx',
],
'CharacterSet' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'utf8',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"709C1E40-092D-4A3D-9958-6D7438******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"CharacterSet\\": [\\n \\"utf8\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 709C1E40-092D-4A3D-9958-6D7438******\\n true\\n \\n polarx\\n utf8\\n \\n","errorExample":""}]',
'title' => 'DescribeCharacterSet',
],
'DescribeDbList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'db_name',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DBName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'DBDescription' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-********',
],
'CharacterSetName' => [
'description' => '',
'type' => 'string',
'example' => 'utf8mb4',
],
'Accounts' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AccountPrivilege' => [
'description' => '',
'type' => 'string',
'example' => 'ReadWrite',
],
'AccountName' => [
'description' => '',
'type' => 'string',
'example' => 'root4test',
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DBName\\": \\"test\\",\\n \\"DBDescription\\": \\"test\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountName\\": \\"root4test\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n \\n test\\n test\\n pxc-********\\n utf8mb4\\n \\n ReadWrite\\n root4test\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeDbList',
],
'DescribeDistributeTableList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '86248',
'abilityTreeNodes' => [
'FEATUREdrdsTIBR6Q',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sbtest1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Tables' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TableName' => [
'description' => '',
'type' => 'string',
'example' => 'sbtest1',
],
'TableType' => [
'description' => '',
'type' => 'string',
'example' => 'multi',
],
'TbKey' => [
'description' => '',
'type' => 'string',
'example' => '“”',
],
'DbKey' => [
'description' => '',
'type' => 'string',
'example' => 'id',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"sbtest1\\",\\n \\"TableType\\": \\"multi\\",\\n \\"TbKey\\": \\"“”\\",\\n \\"DbKey\\": \\"id\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n \\n \\n sbtest1\\n multi\\n “”\\n id\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeDistributeTableList',
],
'ModifyDatabaseDescription' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testDB',
],
],
[
'name' => 'DbDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]',
'title' => 'ModifyDatabaseDescription',
],
'StartSwitchDatabase' => [
'summary' => '开始评估迁移切换',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '201840',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxx',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
[
'name' => 'IsModifyEndpoint',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'SrcMainConnectString',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rm-*********.mysql.rds.aliyuncs.com',
],
],
[
'name' => 'DstMainConnectString',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-*********.polarx.rds.aliyuncs.com',
],
],
[
'name' => 'SrcMainPort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '3308',
],
],
[
'name' => 'DstMainPort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '3313',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'DescribeComponentPropeties' => [
'summary' => '查询PolarDB-X 实例指定组件的属性列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdrds25BO3L',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'CommodityCode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => false,
'example' => 'learn_EasDedicatedPrepay_public_cn',
],
],
[
'name' => 'ComponentName',
'in' => 'query',
'schema' => [
'title' => '资源组ID',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rg-xxxxx',
],
],
[
'name' => 'StorageType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****',
],
'Properties' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'PropertyCode' => [
'description' => '',
'type' => 'string',
'example' => 'dn_node_spec',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'OrderIndex' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'Value' => [
'description' => '',
'type' => 'string',
'example' => '172.27.35.',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Properties\\": [\\n {\\n \\"PropertyCode\\": \\"dn_node_spec\\",\\n \\"Name\\": \\"4核32G\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Value\\": \\"172.27.35.\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ModifyEngineMigration' => [
'summary' => 'ModifyEngineMigration',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '201956',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-shanghai',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-htri0****r4k9p',
],
],
[
'name' => 'SourceDBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'source456',
],
],
[
'name' => 'NewMasterDBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'newmaster789',
],
],
[
'name' => 'SwapConnectionString',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ConnectionStrings',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{\\"pc-bp1m9tt23o5kh834y.rwlb.rds.aliyuncs.com\\":\\"rm-bp1ycl5o6ojs957o0.mysql.rds.aliyuncs.com\\"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'Success',
],
'HttpStatusCode' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'SuccessResponse' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-*********',
],
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => '42292****',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","type":"json"}]',
'description' => '****',
],
'DescribeArchiveTableList' => [
'summary' => '冷存储表列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '137155',
'abilityTreeNodes' => [
'FEATUREdrds9ED9RQ',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '100',
'minimum' => '20',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'title' => '分页下表, 从1开始',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
],
],
[
'name' => 'SchemaName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'requestId',
'type' => 'string',
],
'Data' => [
'title' => '数据',
'type' => 'object',
'properties' => [
'Total' => [
'title' => '总数',
'type' => 'integer',
'format' => 'int64',
],
'PageIndex' => [
'title' => '页面下标',
'type' => 'integer',
'format' => 'int64',
],
'PageSize' => [
'title' => '页面大小',
'type' => 'integer',
'format' => 'int64',
],
'Tables' => [
'type' => 'array',
'items' => [
'title' => '冷存储表信息',
'type' => 'object',
'properties' => [
'SchemaName' => [
'title' => '库名',
'type' => 'string',
],
'TableName' => [
'title' => '表名',
'type' => 'string',
],
'CreatedDate' => [
'title' => '创建时间',
'type' => 'integer',
'format' => 'int64',
],
'SpaceSize' => [
'title' => '占用空间大小',
'type' => 'number',
'format' => 'double',
],
'FileCount' => [
'title' => '文件个数',
'type' => 'integer',
'format' => 'int32',
],
'LastSuccessArchiveTime' => [
'type' => 'integer',
'format' => 'int64',
],
'ArchiveStatus' => [
'type' => 'string',
],
],
],
],
'TobeArchivedConut' => [
'type' => 'integer',
'format' => 'int32',
],
'RunningCount' => [
'type' => 'integer',
'format' => 'int32',
],
'SuccessCount' => [
'type' => 'integer',
'format' => 'int32',
],
'PausedCount' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
'responseDemo' => null,
],
'UpgradeCDCVersion' => [
'summary' => '升级CDC版本',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '134914',
'abilityTreeNodes' => [
'FEATUREdrdsV6IT1E',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzrp****3p72fi',
],
],
[
'name' => 'CdcMinorVersion',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'polarx-cdc-kernel-5.4.19-20240928_17274884',
],
],
[
'name' => 'CdcDbVersion',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2.343',
'default' => '2.343',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-shrvdc****wtf5uk-cdc',
],
],
[
'name' => 'SwitchMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'CB4307F5-3D04-51E8-ABAD-49E0B3F962FC',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'MinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213',
],
'TaskList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DbInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'rm-uf68f345****88zf8',
],
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1861190497624654848',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB4307F5-3D04-51E8-ABAD-49E0B3F962FC\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeCdcInfo' => [
'summary' => '查询CDC信息',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '162461',
'abilityTreeNodes' => [
'FEATUREdrdsAS582G',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-********',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'HttpStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '200',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CdcNewVersion' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'polarx-cdc-kernel-***',
],
'BinlogSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '524288000',
],
'ServerId' => [
'description' => 'server id',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '3014767486',
],
'CheckSumSwitch' => [
'description' => '',
'type' => 'string',
'example' => 'ON',
],
'VersionSupportMultiCdc' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'BinlogPersistTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'InstanceTopologyList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-***',
],
'Comment' => [
'description' => '',
'type' => 'string',
'example' => '***',
],
'PhysicalNodes' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Disk' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '204800',
],
'NodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.large.2e.cdc',
],
'Version' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-cdc-kernel-***',
],
'AZone' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-h',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'ACTIVATION',
],
'NodeId' => [
'description' => '',
'type' => 'string',
'example' => '***',
],
'NodeName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-c-***',
],
],
],
],
'GroupName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'HashLevel' => [
'description' => '',
'type' => 'string',
'example' => 'RECORD',
],
'StreamNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'ClusterType' => [
'description' => '',
'type' => 'string',
'example' => 'BINLOG_X',
],
],
],
],
'EnableCyclicReplication' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CdcNewVersion\\": \\"polarx-cdc-kernel-***\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 3014767486,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"VersionSupportMultiCdc\\": true,\\n \\"BinlogPersistTime\\": 15,\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.x4.large.2e.cdc\\",\\n \\"Version\\": \\"polarx-cdc-kernel-***\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\",\\n \\"NodeName\\": \\"pxc-c-***\\"\\n }\\n ],\\n \\"GroupName\\": \\"test\\",\\n \\"HashLevel\\": \\"RECORD\\",\\n \\"StreamNum\\": 2,\\n \\"ClusterType\\": \\"BINLOG_X\\"\\n }\\n ],\\n \\"EnableCyclicReplication\\": true\\n }\\n}","type":"json"}]',
],
'DescribeCdcVersionList' => [
'summary' => '获取CDC版本列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '167760',
'abilityTreeNodes' => [
'FEATUREdrdsV6IT1E',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-bjrl7****k2vp7',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '97632117-E477-5FE8-B424-F059CBBDD919',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'VersionList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '[{\'Version\': \'2022-07-28\'}]',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97632117-E477-5FE8-B424-F059CBBDD919\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"[{\'Version\': \'2022-07-28\'}]\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeCdcClassList' => [
'summary' => '查询多流规格列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '162466',
'abilityTreeNodes' => [
'FEATUREdrdsAS582G',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-hzjasd****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzrh51fze****pon-cdc',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '6BA32080EEA',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ClassCodeList' => [
'description' => 'array',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'Mem' => [
'description' => '',
'type' => 'string',
'example' => '2048',
],
'ClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.n2.small.2e.cdc',
],
'CpuCore' => [
'description' => '',
'type' => 'string',
'example' => '2',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n2.small.2e.cdc\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ModifyCdcClass' => [
'summary' => 'CDC变配',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '162467',
'abilityTreeNodes' => [
'FEATUREdrdsDBGOD6',
],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzrh51fze****pon-cdc',
],
],
[
'name' => 'CdcClass',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'premium',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'CDCNodeCount',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
'default' => ' ',
],
],
[
'name' => 'SwitchMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2209883',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]',
'description' => '****',
],
'AttachColumnarInstance' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-xxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-xxx',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => '422922413',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"pxc-xxx\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","type":"json"}]',
],
'UpgradeColumnarVersion' => [
'summary' => '升级Columnar版本',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '198143',
'abilityTreeNodes' => [
'FEATUREdrdsV6IT1E',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxx',
],
],
[
'name' => 'ColumnarVersion',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'polarx-col-kernel-5.4.20-20250819_17555906',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzrh51fze****pon-cdc',
],
],
[
'name' => 'SwitchMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'AE4F6C34-****-45AA-B5DC-4B8D816F6305',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'MinorVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213',
],
'TaskList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DbInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'rm-uf68f345****88zf8',
],
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1861190497624654848',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE4F6C34-****-45AA-B5DC-4B8D816F6305\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ModifyColumnarClass' => [
'summary' => 'Columnar变配',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '198145',
'abilityTreeNodes' => [
'FEATUREdrdsDBGOD6',
],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzrh51fze****pon-cdc',
],
],
[
'name' => 'ColumnarClass',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'polarx.n8.large.col',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'ColumnarNodeCount',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '**',
'default' => ' ',
],
],
[
'name' => 'SwitchMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-****-475C-B269-2D5C3A31797C',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '******',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n }\\n}","type":"json"}]',
'description' => '****',
],
'DescribeColumnarVersionList' => [
'summary' => '获取Columnar版本列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '198141',
'abilityTreeNodes' => [
'FEATUREdrdsV6IT1E',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzjasd****',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-****-475C-B269-2D5C3A31797C',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'VersionList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'string',
],
'enumValueTitles' => [
'[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]' => '[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"string\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeColumnarInfo' => [
'summary' => '查询Columnar信息',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '197943',
'abilityTreeNodes' => [
'FEATUREdrdsGUBPOK',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-hzjasd****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '14036EBE-****-44DB-ACE9-AC6157D3A6FC',
],
'HttpStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '200',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ColumnarNewVersion' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'polarx-col-kernel-5.4.20-20250819_17555906',
],
'BinlogSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '524288000',
],
'ServerId' => [
'description' => 'server id',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '53755321',
],
'CheckSumSwitch' => [
'description' => '',
'type' => 'string',
'example' => 'ON',
],
'BinlogPersistTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'ColumnarVersion' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-col-kernel-5.4.20-20250819_17555906',
],
'ClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.n8.medium.col',
],
'InstanceTopologyList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'InstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-***',
],
'Comment' => [
'description' => '',
'type' => 'string',
'example' => '***',
],
'PhysicalNodes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Disk' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '204800',
],
'NodeClass' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.n8.medium.col',
],
'Version' => [
'description' => '',
'type' => 'string',
'example' => 'polarx-col-kernel-5.4.20-20250819_17555906',
],
'AZone' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-h',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'ACTIVATION',
],
'NodeId' => [
'description' => '',
'type' => 'string',
'example' => '***',
],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-****-44DB-ACE9-AC6157D3A6FC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ColumnarNewVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 53755321,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"BinlogPersistTime\\": 30,\\n \\"ColumnarVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"ClassCode\\": \\"polarx.n8.medium.col\\",\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.n8.medium.col\\",\\n \\"Version\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeColumnarClassList' => [
'summary' => '查询列存规格列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '198142',
'abilityTreeNodes' => [
'FEATUREdrdsGUBPOK',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-shrvdc****wtf5uk-cdc',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ClassCodeList' => [
'description' => 'object',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'Mem' => [
'description' => '',
'type' => 'string',
'example' => '2048',
],
'ClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.n8.large.col',
],
'CpuCore' => [
'description' => '',
'type' => 'string',
'example' => '2',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n8.large.col\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeEvaluateAndImportTask' => [
'summary' => '查询单个评估迁移任务详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '111376',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '73559800-****-11ec-bd40-99cfcff3fe1e',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Bid' => [
'description' => '',
'type' => 'string',
'example' => '26842',
],
'Creator' => [
'description' => '',
'type' => 'string',
'example' => '346650',
],
'Deleted' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'GmtCreated' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2025-06-08T15:00Z',
],
'GmtModified' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1605080537000',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '76251',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'SlinkDstResId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzrehc60jz5zye',
],
'SlinkDstUserName' => [
'description' => '',
'type' => 'string',
'example' => 'dts_dtdba',
],
'SlinkSrcResId' => [
'description' => '',
'type' => 'string',
'example' => 'drdshbga69378w4p',
],
'SlinkSrcUserName' => [
'description' => '',
'type' => 'string',
'example' => 'dtdba',
],
'SlinkStage' => [
'description' => '',
'type' => 'string',
'example' => 'DATA_IMPORT_RUNNING',
],
'SlinkStatus' => [
'description' => '',
'type' => 'string',
'example' => 'IMPORT_RUNNING',
],
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
'SlinkType' => [
'description' => '',
'type' => 'string',
'example' => 'evaluate_import',
],
'SlinkSrcDb' => [
'description' => '',
'type' => 'string',
'example' => 'fr_import',
],
'SlinkDstDb' => [
'description' => '',
'type' => 'string',
'example' => 'fr_import',
],
'SlinkTaskDesc' => [
'description' => '',
'type' => 'string',
'example' => 'drdsprod_to_2.0',
],
'Context' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'SlinkSrcResType' => [
'description' => '',
'type' => 'string',
'example' => 'POLARX1',
],
],
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73559800-****-11ec-bd40-99cfcff3fe1e\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": false,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 1605080537000,\\n \\"Id\\": 76251,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc60jz5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_dtdba\\",\\n \\"SlinkSrcResId\\": \\"drdshbga69378w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_RUNNING\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"fr_import\\",\\n \\"SlinkDstDb\\": \\"fr_import\\",\\n \\"SlinkTaskDesc\\": \\"drdsprod_to_2.0\\",\\n \\"Context\\": \\"\\\\\\"{\\\\\\\\\\\\\\"structureImportResult\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"finish\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"finishedNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"totalNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"percentage\\\\\\\\\\\\\\":100},\\\\\\\\\\\\\\"switchTips\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"正向同步延迟较小时才允许开始正向切换\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"autoTableSuggestionSwitch\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"structureAlterationMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"acceptFilterMap\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"fr_import\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"dy_dr_new\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"e3plus_drp_prod_new\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"qbtong_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_account_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_drp_prod\\\\\\\\\\\\\\":[]},\\\\\\\\\\\\\\"structChunkMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"requestId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9380D025-C9B1-51D6-A4B9-733C4879CC4A\\\\\\\\\\\\\\"}\\\\\\",\\",\\n \\"SlinkSrcResType\\": \\"POLARX1\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DescribeEvaluateAndImportTasks' => [
'summary' => '请求评估导入任务列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '103609',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '0',
'pattern' => '^\\d+$',
'default' => '30',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '81519FDE-713B-****-B6F1-231479A4C9DB',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Bid' => [
'description' => '',
'type' => 'string',
'example' => '26842',
],
'Creator' => [
'description' => '',
'type' => 'string',
'example' => '346650',
],
'Deleted' => [
'description' => '',
'type' => 'boolean',
'example' => 'fase',
],
'GmtCreated' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2025-01-08T15:00Z',
],
'GmtModified' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2025-04-02T02:10:59Z',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => 'ap-northeast-1',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-zhangjiakou',
],
'SlinkDstResId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzrehc****5zye',
],
'SlinkDstUserName' => [
'description' => '',
'type' => 'string',
'example' => 'dts_temp_2_23',
],
'SlinkSrcResId' => [
'description' => '',
'type' => 'string',
'example' => 'drdshbga*****w4p',
],
'SlinkSrcUserName' => [
'description' => '',
'type' => 'string',
'example' => 'dtdba',
],
'SlinkStage' => [
'description' => '',
'type' => 'string',
'example' => 'DATA_IMPORT_RUNNING',
],
'SlinkStatus' => [
'description' => '',
'type' => 'string',
'example' => 'IMPORT_NOT_BEGIN',
],
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
'SlinkType' => [
'description' => '',
'type' => 'string',
'example' => 'evaluate_import',
],
'SlinkSrcDb' => [
'description' => '',
'type' => 'string',
'example' => 'stock',
],
'SlinkDstDb' => [
'description' => '',
'type' => 'string',
'example' => 'e3plus_*****_prod',
],
'SlinkTaskDesc' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'SlinkSrcResType' => [
'description' => '',
'type' => 'string',
'example' => 'RDS_MYSQL',
],
],
],
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81519FDE-713B-****-B6F1-231479A4C9DB\\",\\n \\"PageSize\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"TotalNumber\\": 0,\\n \\"Data\\": [\\n {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": true,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 0,\\n \\"Id\\": 0,\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc****5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_temp_2_23\\",\\n \\"SlinkSrcResId\\": \\"drdshbga*****w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"stock\\",\\n \\"SlinkDstDb\\": \\"e3plus_*****_prod\\",\\n \\"SlinkTaskDesc\\": \\"test\\",\\n \\"SlinkSrcResType\\": \\"RDS_MYSQL\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteEvaluateAndImportTask' => [
'summary' => '删除评估导入任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '111383',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'msg',
],
'Data' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"msg\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateSQLEvaluateTask' => [
'summary' => '创建评估升级的兼容性评估任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '103587',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-shr4idrgogti89',
],
],
[
'name' => 'SlinkTaskDesc',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test-drds->auto',
],
],
[
'name' => 'SrcResId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'pxc-shr****rgkh87z',
],
],
[
'name' => 'SrcDb',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'transfer_test3',
],
],
[
'name' => 'SrcUserName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'drds_test',
],
],
[
'name' => 'SrcPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '******',
],
],
[
'name' => 'DstResId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'pxc-zkrc1****l54rc',
],
],
[
'name' => 'DstDb',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'transfer_for_st',
],
],
[
'name' => 'DstUserName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'drds_test',
],
],
[
'name' => 'DstPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '******',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'etx-szr2rr6i*****',
],
],
[
'name' => 'SrcResType',
'in' => 'query',
'schema' => [
'title' => '源实例类型: RDS_MYSQL、POLARX1、POLARX2_STANDARD、POLARX2_ENTERPRISE、POLARDB_M',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'POLARX2',
'maxLength' => 20,
'minLength' => 1,
'default' => 'POLARX1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '6352AC16-76BF-5135-B1EA-ED49293526E6',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'CreateStructureImportTask' => [
'summary' => '创建评估升级的结构迁移任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '154938',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-********',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
[
'name' => 'Config',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[{\\"schemaName\\":\\"transfer_test\\",\\"tableList\\":[]}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '73559800-3c8c-****-bd40-99cfcff3fe1e',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"73559800-3c8c-****-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'DescribeDataImportTaskInfo' => [
'summary' => '导入任务详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '104724',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'FailPageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'FailPageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '10',
'pattern' => '^\\d+$',
'default' => '30',
],
],
[
'name' => 'SuccessPageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'SuccessPageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '15',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'DataImportTaskDetailInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'FsmId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'FsmState' => [
'description' => '',
'type' => 'string',
'example' => 'RECON_FINISHED_CATCH_UP',
],
'FsmStatus' => [
'description' => '',
'type' => 'string',
'example' => 'IMPORT_NOT_BEGIN',
],
'ServiceDetailList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1991609',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'FINISHED',
],
'TaskDetailList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Delay' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '58329',
],
'LastError' => [
'description' => '',
'type' => 'string',
'example' => 'null',
],
'PhysicalDbName' => [
'description' => '',
'type' => 'string',
'example' => 'drds_test',
],
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Statistics' => [
'description' => '',
'type' => 'string',
'example' => '{'."\n"
.' "applyCount": 0,'."\n"
.' "cpuUseRatio": 41,'."\n"
.' "fsmId": 1,'."\n"
.' "fullGcCount": '."\n"
.'}',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'active',
],
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => 'fc3b1568-ad96-****-adca-dfe018b38077',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'FULL_COPY',
],
],
],
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'FULL_COPY',
],
],
],
],
],
],
],
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"DataImportTaskDetailInfo\\": {\\n \\"FsmId\\": 1,\\n \\"FsmState\\": \\"RECON_FINISHED_CATCH_UP\\",\\n \\"FsmStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"ServiceDetailList\\": [\\n {\\n \\"Id\\": 1991609,\\n \\"Status\\": \\"FINISHED\\",\\n \\"TaskDetailList\\": [\\n {\\n \\"Delay\\": 58329,\\n \\"LastError\\": \\"null\\",\\n \\"PhysicalDbName\\": \\"drds_test\\",\\n \\"Progress\\": 0,\\n \\"Statistics\\": \\"{\\\\n \\\\\\"applyCount\\\\\\": 0,\\\\n \\\\\\"cpuUseRatio\\\\\\": 41,\\\\n \\\\\\"fsmId\\\\\\": 1,\\\\n \\\\\\"fullGcCount\\\\\\": \\\\n}\\",\\n \\"Status\\": \\"active\\",\\n \\"TaskId\\": 0,\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ],\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ]\\n }\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\"\\n}","type":"json"}]',
],
'CloseEngineMigration' => [
'summary' => '取消实例迁移',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '201206',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-htri0****r4k9p',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ContinueEnableBinlog',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'HttpStatusCode' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'SuccessResponse' => [
'description' => '',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-hzjasd****',
],
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => '2209883',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"*****\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TaskId\\": \\"2209883\\"\\n }\\n}","type":"json"}]',
],
'ConfirmNoConnection' => [
'summary' => '回滚切换时确认无连接',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '201845',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-hzravgpt8q****',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '6BA32080EEA',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'RestartDataImportTask' => [
'summary' => '重启数据导入任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '111381',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '0',
'pattern' => '^\\d+$',
'default' => '30',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'StopDataImportTask' => [
'summary' => '暂停数据导入任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '111377',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'pattern' => '^\\d+$',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '5',
'example' => '30',
'pattern' => '^\\d+$',
'default' => '30',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'Data' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateDataImportTask' => [
'summary' => '创建评估升级的数据迁移任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '103607',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'SrcResId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'pxc-shrnv****kh87z',
],
],
[
'name' => 'SrcDb',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'transfer_for_st',
],
],
[
'name' => 'SrcUserName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'SrcPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'DstResId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'pxc-shr8****k36vrn',
],
],
[
'name' => 'DstDb',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'transfer_test3',
],
],
[
'name' => 'DstUserName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'DstPassword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'DescribeStructureImportTaskInfo' => [
'summary' => '查询结构迁移任务结果',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '161642',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'StructureImportResult' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'finish',
],
'FinishedNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '118',
],
'TotalNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ExceptionFullTableName' => [
'description' => '',
'type' => 'string',
'example' => 'hash_realtime_new.wm_in_job_et',
],
'ExceptionDetail' => [
'description' => '',
'type' => 'string',
'example' => 'java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement',
],
'Percentage' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
],
],
'SlinkStage' => [
'description' => '',
'type' => 'string',
'example' => 'STRUCTURE_IMPORT',
],
],
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"StructureImportResult\\": {\\n \\"Status\\": \\"finish\\",\\n \\"FinishedNum\\": 118,\\n \\"TotalNum\\": 1,\\n \\"ExceptionFullTableName\\": \\"hash_realtime_new.wm_in_job_et\\",\\n \\"ExceptionDetail\\": \\"java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement\\",\\n \\"Percentage\\": 100\\n },\\n \\"SlinkStage\\": \\"STRUCTURE_IMPORT\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
],
'RefreshImportMeta' => [
'summary' => '刷新评估升级任务的导入元数据',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '161097',
'abilityTreeNodes' => [
'FEATUREdrdsQ69M1H',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxx',
],
],
[
'name' => 'SlinkTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'etx-szr2rr6i*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => '*****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SlinkTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'etx-szr2rr6i*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]',
],
'DeleteGdnInstance' => [
'summary' => '删除GDN实例',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '218653',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'GdnInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'gdn-yq****dorhkzttoi',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '****',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2209883',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]',
],
'DescribeGdnInstances' => [
'summary' => '获取GDN实例列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '218651',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '30',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '50',
],
],
[
'name' => 'FilterType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'gdn_id、'."\n"
.'polarx_id',
],
],
[
'name' => 'FilterValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'gdn-***、'."\n"
.'pxc-***',
],
],
[
'name' => 'GDNId',
'in' => 'query',
'schema' => [
'description' => 'GDN ID。',
'type' => 'string',
'required' => false,
'example' => 'gdn-***',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '7B044BD1-6402-5DE9-9AED-63D15A994E37',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'string',
'example' => '30',
],
'TotalNumber' => [
'description' => '',
'type' => 'string',
'example' => '130',
],
'GdnInstanceList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GdnInstanceName' => [
'description' => '',
'type' => 'string',
'example' => 'gdn-***',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2025-01-02T13:11:10.000+0000',
],
'SwitchHistory' => [
'description' => '',
'type' => 'string',
'example' => '""',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Creating',
],
'MemberList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'MemberName' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-***',
],
'Role' => [
'description' => '',
'type' => 'string',
'example' => 'primary、'."\n"
.'standby',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Creating',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2025-01-02T13:11:10.000+0000',
],
'SecondsBehindMaster' => [
'description' => '',
'type' => 'string',
'example' => '1s',
],
'CommodityCode' => [
'description' => '',
'type' => 'string',
'example' => 'drds_polarxpre_public_cn',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.medium.2e',
],
'PayType' => [
'description' => '',
'type' => 'string',
'example' => 'Prepaid',
],
'ExpireTime' => [
'description' => '',
'type' => 'string',
'example' => '2025-01-02T13:11:10.000+0000',
],
'PrimaryZone' => [
'description' => '',
'type' => 'string',
'example' => 'cn-zhangjiakou-a',
],
'SecondaryZone' => [
'description' => '',
'type' => 'string',
'example' => 'cn-zhangjiakou-a',
],
'TertiaryZone' => [
'description' => '',
'type' => 'string',
'example' => 'cn-zhangjiakou-a',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-zhangjiakou-a',
],
'CnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'polarx.x4.medium.2e',
],
'DnNodeClassCode' => [
'description' => '',
'type' => 'string',
'example' => 'mysql.n4.medium.25',
],
'CnNodeCount' => [
'description' => '',
'type' => 'string',
'example' => '2',
],
'DnNodeCount' => [
'description' => '',
'type' => 'string',
'example' => '2',
],
'TaskStatus' => [
'type' => 'string',
],
'DataSyncStatus' => [
'type' => 'string',
],
'ReadWriteStatus' => [
'type' => 'string',
],
],
],
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'MysqlVersion' => [
'description' => '',
'type' => 'string',
'example' => '5.7',
],
'GdnMode' => [
'type' => 'string',
],
'RplSyncDdl' => [
'type' => 'boolean',
],
'RplDmlStrategy' => [
'type' => 'string',
],
'RplConflictStrategy' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B044BD1-6402-5DE9-9AED-63D15A994E37\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalNumber\\": \\"130\\",\\n \\"GdnInstanceList\\": [\\n {\\n \\"GdnInstanceName\\": \\"gdn-***\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SwitchHistory\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Creating\\",\\n \\"MemberList\\": [\\n {\\n \\"MemberName\\": \\"pxc-***\\",\\n \\"Role\\": \\"primary、\\\\nstandby\\",\\n \\"Status\\": \\"Creating\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SecondsBehindMaster\\": \\"1s\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"ExpireTime\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"PrimaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"SecondaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"TertiaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"ZoneId\\": \\"cn-zhangjiakou-a\\",\\n \\"CnNodeClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"CnNodeCount\\": \\"2\\",\\n \\"DnNodeCount\\": \\"2\\",\\n \\"TaskStatus\\": \\"prepared:参数初始化完毕\\\\nset_old_primary_readonly:原主实例已禁写\\\\nset_new_primary_read_write:已切换\\\\ntimeout:任务超时\\\\nrollback:已回滚\\\\n\\",\\n \\"DataSyncStatus\\": \\"\\",\\n \\"ReadWriteStatus\\": \\"\\"\\n }\\n ],\\n \\"Description\\": \\"test\\",\\n \\"MysqlVersion\\": \\"5.7\\",\\n \\"GdnMode\\": \\"\\",\\n \\"RplSyncDdl\\": true,\\n \\"RplDmlStrategy\\": \\"\\",\\n \\"RplConflictStrategy\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'SwitchGdnMemberRole' => [
'summary' => 'GDN主备切换',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '218654',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'SwitchMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
],
[
'name' => 'TaskTimeout',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2209883',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]',
],
'CreateGdnInstance' => [
'summary' => '创建GDN实例',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '219398',
'abilityTreeNodes' => [
'FEATUREdrdsBRC5LQ',
],
],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'pxc-********',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FASTJSON 2.0.x has been released, faster and more secure, recommend you upgrade.',
],
],
[
'name' => 'GdnMode',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'RplSyncDdl',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'RplDmlStrategy',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'RplConflictStrategy',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '0DBA1657-7607-56D6-BB6D-641BF17CCFDB',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '****',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2209883',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DBA1657-7607-56D6-BB6D-641BF17CCFDB\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]',
],
'SubmitSqlFlashbackTask' => [
'summary' => '提交SQL闪回任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '121601',
'abilityTreeNodes' => [
'FEATUREdrds73QXOU',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'PolardbxInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-*********',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-09-10 20:23:23',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-09-10 23:23:23',
],
],
[
'name' => 'RecallRestoreType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0',
],
],
[
'name' => 'TraceId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ase*****',
],
],
[
'name' => 'TableName',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'test',
],
],
[
'name' => 'SqlType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'INSERT,UPDATE',
],
],
[
'name' => 'SqlPk',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '1111',
],
],
[
'name' => 'RecallType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => '1111',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"1111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n true\\n \\n 1111\\n \\n","errorExample":""}]',
'title' => 'SubmitSqlFlashbackTask',
],
'PreCheckSqlFlashbackTask' => [
'summary' => 'SQL闪回任务预检',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '121682',
'abilityTreeNodes' => [
'FEATUREdrds73QXOU',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PolardbxInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-*********',
],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2025-09-21 14:35:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2025-09-21 14:41:00',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'successs',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CheckResult' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanUpgradeSupportBinlogRowQueryEvents' => [
'description' => '',
'type' => 'boolean',
],
'BinlogRowQueryEventEnabled' => [
'description' => '',
'type' => 'boolean',
],
'SupportBinlogRowQueryEvents' => [
'description' => '',
'type' => 'boolean',
],
'BinlogExists' => [
'description' => '',
'type' => 'boolean',
],
'HasTable' => [
'description' => '',
'type' => 'boolean',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"successs\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CheckResult\\": {\\n \\"CanUpgradeSupportBinlogRowQueryEvents\\": true,\\n \\"BinlogRowQueryEventEnabled\\": true,\\n \\"SupportBinlogRowQueryEvents\\": true,\\n \\"BinlogExists\\": true,\\n \\"HasTable\\": true\\n }\\n }\\n}","type":"json"}]',
],
'DescribeSqlFlashbackTaskList' => [
'summary' => 'SQL闪回任务列表查询',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '121676',
'abilityTreeNodes' => [
'FEATUREdrds73QXOU',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PolardbxInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'pxc-**********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SqlFlashbackTasks' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '1568611469000',
],
'SearchEndTime' => [
'description' => '',
'type' => 'string',
'example' => '1568609597000',
],
'RecallStatus' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'SqlPk' => [
'description' => '',
'type' => 'string',
'example' => 'id',
],
'RecallRestoreType' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'TableName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'GmtCreate' => [
'description' => '',
'type' => 'string',
'example' => '1568611408000',
],
'InstId' => [
'description' => '',
'type' => 'string',
'example' => 'pxc-********',
],
'SearchStartTime' => [
'description' => '',
'type' => 'string',
'example' => '1568609597000',
],
'RecallType' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'TraceId' => [
'description' => '',
'type' => 'string',
'example' => '13ed05705f801000',
],
'DbName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'SqlType' => [
'description' => '',
'type' => 'string',
'example' => 'INSERT,UPDATE',
],
'Id' => [
'description' => '',
'type' => 'string',
'example' => '111',
],
'ExpireTime' => [
'description' => '',
'type' => 'string',
'example' => '1569216270000',
],
'SqlCounter' => [
'description' => '',
'type' => 'string',
'example' => '100',
],
'RecallProgress' => [
'description' => '',
'type' => 'string',
'example' => '10',
],
'DownloadUrl' => [
'description' => '',
'type' => 'string',
'example' => 'http://...',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SqlFlashbackTasks\\": [\\n {\\n \\"GmtModified\\": \\"1568611469000\\",\\n \\"SearchEndTime\\": \\"1568609597000\\",\\n \\"RecallStatus\\": \\"1\\",\\n \\"SqlPk\\": \\"id\\",\\n \\"RecallRestoreType\\": \\"0\\",\\n \\"TableName\\": \\"test\\",\\n \\"GmtCreate\\": \\"1568611408000\\",\\n \\"InstId\\": \\"pxc-********\\",\\n \\"SearchStartTime\\": \\"1568609597000\\",\\n \\"RecallType\\": \\"0\\",\\n \\"TraceId\\": \\"13ed05705f801000\\",\\n \\"DbName\\": \\"test\\",\\n \\"SqlType\\": \\"INSERT,UPDATE\\",\\n \\"Id\\": \\"111\\",\\n \\"ExpireTime\\": \\"1569216270000\\",\\n \\"SqlCounter\\": \\"100\\",\\n \\"RecallProgress\\": \\"10\\",\\n \\"DownloadUrl\\": \\"http://...\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n OK\\n true\\n \\n \\n 1568611469000\\n 1568609597000\\n 1\\n id\\n 0\\n test\\n 1568611408000\\n pxc-********\\n 1568609597000\\n 0\\n 13ed05705f801000\\n test\\n INSERT,UPDATE\\n 111\\n 1569216270000\\n 100\\n 10\\n http://...\\n \\n \\n","errorExample":""}]',
'title' => 'DescribeSqlFlashbackTaskList',
],
'DescribeTags' => [
'summary' => '标签列表查询',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '117148',
'abilityTreeNodes' => [
'FEATUREdrdsJGJ3OD',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => [
'title' => '实例名称',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxx',
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'schema' => [
'title' => '标签Key',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'requestid',
],
'TagInfos' => [
'title' => '标签信息列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'TagKey' => [
'title' => '标签Key',
'description' => '',
'type' => 'string',
'example' => 'testKey',
],
'TagValue' => [
'title' => '标签Value',
'description' => '',
'type' => 'string',
'example' => 'testValue',
],
'DBInstanceIds' => [
'title' => '标签关联数据库实例列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '数据库实例',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"requestid\\",\\n \\"TagInfos\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\",\\n \\"DBInstanceIds\\": [\\n \\"数据库实例\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListTagResources' => [
'summary' => '查标签接口',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '115498',
'abilityTreeNodes' => [
'FEATUREdrdsJGJ3OD',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'title' => '下一个查询开始Token',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'xxdds',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PolarDBXInstance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxxx',
],
'required' => false,
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'title' => '下一个查询开始Token,NextToken为空说明没有下一个',
'description' => '',
'type' => 'string',
'example' => 'xxdd',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'xxxx-xxxxxx',
],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'title' => '资源列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ResourceType' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'example' => 'PolarDBXInstance',
],
'TagValue' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'example' => '1',
],
'ResourceId' => [
'title' => '资源ID',
'description' => '',
'type' => 'string',
'example' => 'pxc-xxxx',
],
'TagKey' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'example' => '1',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"xxdd\\",\\n \\"RequestId\\": \\"xxxx-xxxxxx\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"PolarDBXInstance\\",\\n \\"TagValue\\": \\"1\\",\\n \\"ResourceId\\": \\"pxc-xxxx\\",\\n \\"TagKey\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => '打标签接口',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '115494',
'abilityTreeNodes' => [
'FEATUREdrdsJGJ3OD',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PolarDBXInstance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxxxx',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '22',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'requestId',
'type' => 'string',
'example' => 'xxxx-xxxx',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx\\"\\n}","type":"json"}]',
],
'UntagResources' => [
'summary' => '删标签接口',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '115497',
'abilityTreeNodes' => [
'FEATUREdrdsJGJ3OD',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'title' => '地域',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PolarDBXInstance',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'title' => '是否全部删除,只针对TagKey.N为空时有效。 取值范围: true false True False 默认是 false',
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多50个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pxc-xxxxx',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签键,最多20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'RequestId',
'type' => 'string',
'example' => 'xxxxxx',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxxx\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2-pop',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'ap-south-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-2',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-pop',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-gov-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-nu16-b01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-edge-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-fujian',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-haidian-cm12-c01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-bj-b01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-prod-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-2',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-3',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-test-306',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong-finance-pop',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote-nebula-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-north-2-gov-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao-nebula',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et15-b01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et2-b01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-inner',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-internal-test-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-inner',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-st4-d01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-su18-b01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-wuhan',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-wulanchabu',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-yushanfang',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei-na61-b01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou-na62-a01',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-zhengzhou-nebula-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'eu-west-1-oxs',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'rus-west-1-pop',
'endpoint' => 'polardbx.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'polardbx.cn-qingdao.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'polardbx.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'polardbx.cn-zhangjiakou.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'polardbx.cn-huhehaote.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'polardbx.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'polardbx.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'polardbx.cn-hongkong.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'polardbx.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'polardbx.cn-chengdu.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'polardbx.us-east-1.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'polardbx.us-west-1.aliyuncs.com',
],
],
];