diff options
Diffstat (limited to 'data/en_us/cddc')
| -rw-r--r-- | data/en_us/cddc/2020-03-20/api-docs.php | 7375 |
1 files changed, 7375 insertions, 0 deletions
diff --git a/data/en_us/cddc/2020-03-20/api-docs.php b/data/en_us/cddc/2020-03-20/api-docs.php new file mode 100644 index 0000000..7e5a924 --- /dev/null +++ b/data/en_us/cddc/2020-03-20/api-docs.php @@ -0,0 +1,7375 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'cddc', + 'version' => '2020-03-20', + ], + 'directories' => [ + [ + 'id' => 185350, + 'title' => 'Proprietary API', + 'type' => 'directory', + 'children' => [ + 'CreateMyBase', + ], + ], + [ + 'id' => 185352, + 'title' => 'Managed MyBase API', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 101761, + 'title' => 'Region', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 101764, + 'title' => 'Dedicated Clusters', + 'type' => 'directory', + 'children' => [ + 'CreateDedicatedHostGroup', + 'DeleteDedicatedHostGroup', + 'ModifyDedicatedHostGroupAttribute', + 'DescribeDedicatedHostGroups', + ], + ], + [ + 'id' => 101769, + 'title' => 'Hosts', + 'type' => 'directory', + 'children' => [ + 'CreateDedicatedHost', + 'DescribeDedicatedHosts', + 'DescribeDedicatedHostAttribute', + 'DescribeHostEcsLevelInfo', + 'DescribeDedicatedHostDisks', + 'ModifyDedicatedHostAttribute', + 'ReplaceDedicatedHost', + 'RestartDedicatedHost', + 'DescribeHostWebShell', + 'ModifyDedicatedHostClass', + 'TagResources', + 'ListTagResources', + 'UntagResources', + ], + ], + [ + 'id' => 101794, + 'title' => 'Host account management', + 'type' => 'directory', + 'children' => [ + 'CreateDedicatedHostAccount', + 'DeleteDedicatedHostAccount', + 'ModifyDedicatedHostPassword', + 'ModifyDedicatedHostAccount', + ], + ], + [ + 'id' => 101814, + 'title' => 'Instance', + 'type' => 'directory', + 'children' => [ + 'QueryHostInstanceConsoleInfo', + 'QueryHostBaseInfoByInstance', + ], + ], + ], + ], + [ + 'id' => 209190, + 'title' => 'Open API', + 'type' => 'directory', + 'children' => [ + 'AddPrinsInstance', + 'CreatePrinsBackupPlan', + 'DescribePrinsInstance', + 'DescribePrinsBackupPlan', + 'DescribePrinsEcsInstances', + 'GetPrinsEventList', + 'GetPrinsMetricsList', + 'ListPrinsSQLErrorLog', + 'ListPrinsParams', + 'ListPrinsInstances', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateMyBase' => [ + 'summary' => '创建专属集群（包含主机信息，附加服务信息）', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119494', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'ap-southeast-1', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'DedicatedHostGroupDescription', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'docRequired' => false, + 'example' => 'testDedicatedGroupName', + 'required' => false, + 'title' => '集群名称，未传则为空', + 'type' => 'string', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'alisql', + 'required' => true, + 'title' => '引擎类型', + 'type' => 'string', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'sg-t4neld965n89ocvt****', + 'required' => true, + 'title' => '安全组ID', + 'type' => 'string', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'ap-southeast-1a', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'vsw-t4ni3mzqqw98vt317****', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ECSClassList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => '[{"sysDiskCapacity":40,"instanceType":"ecs.d2s.10xlarge","nodeCount":1,"sysDiskType":"cloud_essd"}]', + 'required' => true, + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sysDiskCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '40', + ], + 'instanceType' => [ + 'type' => 'string', + 'required' => true, + ], + 'nodeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + ], + 'sysDiskType' => [ + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'cloud_essd', + 'cloud_ssd', + 'cloud_efficiency', + 'cloud', + ], + ], + 'diskType' => [ + 'type' => 'string', + 'enum' => [ + 'cloud_essd', + 'cloud_ssd', + 'cloud_efficiency', + 'cloud', + ], + ], + 'diskCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'diskCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'dataDiskPerformanceLevel' => [ + 'type' => 'string', + 'enum' => [ + 'PL0', + 'PL1', + 'PL2', + 'PL3', + ], + ], + 'systemDiskPerformanceLevel' => [ + 'type' => 'string', + 'enum' => [ + 'PL0', + 'PL1', + 'PL2', + 'PL3', + ], + ], + 'sysDiskAutoSnapshotPolicyId' => [ + 'type' => 'string', + ], + 'sysDiskEncrypted' => [ + 'type' => 'boolean', + ], + 'sysDiskKMSKeyId' => [ + 'type' => 'string', + ], + 'dataDiskAutoSnapshotPolicyId' => [ + 'type' => 'string', + ], + 'dataDiskEncrypted' => [ + 'type' => 'boolean', + ], + 'dataDiskKMSKeyId' => [ + 'type' => 'string', + ], + ], + 'required' => true, + ], + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'PrePaid', + 'required' => true, + 'type' => 'string', + 'enum' => [ + 'PrePaid', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '1', + 'required' => false, + 'type' => 'string', + 'docRequired' => true, + 'default' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => false, + 'example' => '4ed77dd1-ff52-407e-ac58-dc251822****', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'false', + 'required' => false, + 'type' => 'string', + 'default' => 'false', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '镜像ID', + 'type' => 'string', + ], + ], + [ + 'name' => 'OsPassword', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'example' => 'Test123456', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'dhg-6dx5n9gjs96u****', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'Monthly', + 'required' => false, + 'type' => 'string', + 'default' => 'Monthly', + 'enum' => [ + 'Monthly', + 'Weekly', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'vpc-t4nbtmekgxotv0d3y****', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'PasswordInherit', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'EcsHostName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'EcsInstanceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'EcsDeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'EcsUniqueSuffix', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'false', + ], + ], + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'example' => 'PayByBandwidth', + 'default' => 'PayByBandwidth', + ], + ], + [ + 'name' => 'InternetMaxBandwidthOut', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'UserDataInBase64', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 18, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => '937F6B32-A796-53A0-99C8-F7A9660E****', + 'type' => 'string', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OrderList' => [ + 'type' => 'array', + 'items' => [ + 'properties' => [ + 'OrderId' => [ + 'description' => '', + 'example' => '21767077790****', + 'type' => 'string', + ], + 'CreateTimestamp' => [ + 'description' => '', + 'example' => '1661498032347', + 'format' => 'int64', + 'type' => 'integer', + ], + 'ECSInstanceIds' => [ + 'description' => '', + 'example' => '["i-t4n1tandot8j3axvwhe5"]', + 'type' => 'string', + ], + 'DedicatedHostGroupName' => [ + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'COMMODITY.INVALID_COMPONENT', + 'errorMessage' => 'Invalid component.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Format', + 'errorMessage' => 'The account password format is invalid.', + ], + [ + 'errorCode' => 'InsufficientResourceCapacity', + 'errorMessage' => 'No host is available for the requested instance.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"937F6B32-A796-53A0-99C8-F7A9660E****\\",\\n \\"OrderList\\": {\\n \\"OrderList\\": [\\n {\\n \\"OrderId\\": \\"21767077790****\\",\\n \\"CreateTimestamp\\": 1661498032347,\\n \\"ECSInstanceIds\\": \\"[\\\\\\"i-t4n1tandot8j3axw****\\\\\\",\\\\\\"i-t4n1tandot8j3axv****\\\\\\"]\\",\\n \\"DedicatedHostGroupName\\": \\"dhg-7a9********\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateMyBaseResponse>\\n <RequestId>937F6B32-A796-53A0-99C8-F7A9660E****</RequestId>\\n <OrderList>\\n <OrderId>21767077790****</OrderId>\\n <CreateTimestamp>1661498032347</CreateTimestamp>\\n <ECSInstanceIds>[\\"i-t4n1tandot8j3axv****\\"]</ECSInstanceIds>\\n <DedicatedHostGroupName>dhg-7a9********</DedicatedHostGroupName>\\n </OrderList>\\n</CreateMyBaseResponse>","errorExample":""}]', + 'title' => 'CreateMyBase', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the most recent region list.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74517', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RDSRegion' => [ + 'description' => 'The queried regions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'ap-southeast-1a', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Regions\\": {\\n \\"RDSRegion\\": [\\n {\\n \\"ZoneId\\": \\"ap-southeast-1a\\",\\n \\"RegionId\\": \\"ap-southeast-1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsReponse>\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>\\n<Regions>\\n <RDSRegion>\\n <ZoneId>ap-southeast-1a</ZoneId>\\n <RegionId>ap-southeast-1</RegionId>\\n </RDSRegion>\\n</Regions>\\n</DescribeRegionsReponse>","errorExample":""}]', + 'title' => 'DescribeRegions', + 'description' => 'For more information about region IDs, see [Region IDs](~~198326~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDedicatedHostGroup' => [ + 'summary' => 'Creates a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76545', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine of the dedicated cluster. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **SQL Server**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'CpuAllocationRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CPU overcommit ratio of the dedicated cluster.'."\n" + ."\n" + .'> Unit: %. Valid values: **100** to **300**. Default value: **200**, which specifies that the total amount of CPU resources allocated to all instances is twice the amount of actual CPU resources. This helps you maximize CPU utilization.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'MemAllocationRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum memory usage of each host in the dedicated cluster.'."\n" + ."\n" + .'> Unit: %. Valid values: **0** to **100**. Default value: **100**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'DiskAllocationRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage overcommit ratio of the dedicated cluster.'."\n" + ."\n" + .'> Unit: %. Valid values: **100** to **300**. Default value: **200**, which specifies that the total amount of storage resources allocated to all instances is twice the amount of actual storage resources. This helps you maximize storage usage. This parameter does not take effect for dedicated clusters that run SQL Server.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'AllocationPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy that is used to allocate resources in the dedicated cluster. Valid values:'."\n" + ."\n" + .'* **Evenly** (default): The system preferentially deploys database instances on the hosts where no resources or fewer resources are allocated. This maximizes system stability.'."\n" + .'* **Intensively**: The system preferentially deploys database instances on the hosts that are created earlier and have more allocated resources. This maximizes resource utilization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Evenly', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) where you want to create the dedicated cluster. You can log on to the VPC console and click **VPCs** in the left-side navigation pane to view the VPC ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-t4n7v5m6icc0a4314****', + ], + ], + [ + 'name' => 'HostReplacePolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy that is used to handle host failures. Valid values:'."\n" + ."\n" + .'* **Auto** (default): The system automatically replaces faulty hosts.'."\n" + .'* **Manual**: You must manually replace faulty hosts.'."\n" + ."\n" + .'> When you create a dedicated cluster that runs **MySQL**, you can select a policy based on your business requirements. For dedicated clusters that run other database engines, the default value **Auto** is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Auto', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ETnLKlblzczshOTUbOCz*******', + ], + ], + [ + 'name' => 'OpenPermission', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to grant the host OS permissions. Valid values:'."\n" + ."\n" + .'* **0**: no.'."\n" + .'* **1**: yes.'."\n" + ."\n" + .'> When you create a dedicated cluster that runs **MySQL or SQL Server**, you can grant the host OS permissions based on your business requirements. For dedicated clusters that run other database engines, the default value **0** is used. When you create an ApsaraDB MyBase for SQL Server dedicated cluster, you must set this parameter to 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DedicatedHostGroupDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dedicated cluster. The name must be 1 to 64 characters in length and can contain letters, digits, underscores (\\_), and hyphens (-). The name must start with a letter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mysqlcluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C6592723-09E1-4248-A78E-12AB00D7A79D', + ], + 'DedicatedHostGroupId' => [ + 'description' => 'The dedicated cluster ID.'."\n", + 'type' => 'string', + 'example' => 'dhg-7a9********', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Permission.NotSupport', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'ClustersTemplateNotFound', + 'errorMessage' => 'Key account cluster is not supported for the region.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C6592723-09E1-4248-A78E-12AB00D7A79D\\",\\n \\"DedicatedHostGroupId\\": \\"dhg-7a9********\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDedicatedHostGroupReponse>\\n<RequestId>C6592723-09E1-4248-A78E-12AB00D7A79D</RequestId>\\n<DedicatedHostGroupId>dhg-7a9********</DedicatedHostGroupId>\\n</CreateDedicatedHostGroupReponse>","errorExample":""}]', + 'title' => 'CreateDedicatedHostGroup', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDedicatedHostGroup' => [ + 'summary' => 'Deletes a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74478', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dhg-h5i4p331f509****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the dedicated cluster. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E1765', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Host.Exist', + 'errorMessage' => 'There are hosts in usercluster, can\'t delete it.', + ], + [ + 'errorCode' => 'Custins.Exist', + 'errorMessage' => 'The cluster contains an instance and cannot be deleted.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDedicatedHostGroup.NotFound', + 'errorMessage' => 'Specified DedicatedHostGroup does not exists.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E1765\\"\\n}","type":"json"}]', + 'title' => 'DeleteDedicatedHostGroup', + 'description' => 'You can call this operation to delete a dedicated cluster only after all the instances and hosts in the dedicated cluster are deleted.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDedicatedHostGroupAttribute' => [ + 'summary' => 'Modifies configurations such as the CPU overcommit ratio, memory usage, storage overcommit ratio, and resource allocation policy for a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74529', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the dedicated cluster. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dedicated cluster ID.'."\n" + ."\n" + .'> You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dhg-h5i4p331f509****', + ], + ], + [ + 'name' => 'DedicatedHostGroupDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dedicated cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mysql-cluster', + ], + ], + [ + 'name' => 'CpuAllocationRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CPU overcommit ratio of the dedicated cluster. Valid values: **100** to **300**.'."\n" + ."\n" + .'> If you change the CPU overcommit ratio to **300%**, the total CPU resources of all instances are three times the actual CPU resources. This maximizes the use of CPU resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'MemAllocationRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum memory usage of each host in the dedicated cluster. Valid values: **0** to **100**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'DiskAllocationRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage overcommit ratio of the dedicated cluster. Valid values: **100** to **200**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'AllocationPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy that is used to allocate resources in the dedicated cluster. Valid values:'."\n" + ."\n" + .'* **Evenly**: The system preferentially deploys database instances on the hosts where no resources or fewer resources are allocated. This maximizes system stability.'."\n" + .'* **Intensively**: The system preferentially deploys database instances on the hosts that are created earlier and have more allocated resources. This maximizes resource utilization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Intensively', + ], + ], + [ + 'name' => 'HostReplacePolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy that is used to handle host failures. Valid values:'."\n" + ."\n" + .'* **Auto**: The system automatically replaces faulty hosts.'."\n" + .'* **Manual**: You must manually replace faulty hosts.'."\n" + ."\n" + .'> You can select a policy based on your business requirements only for dedicated clusters that run **MySQL**. For dedicated clusters that run other database engines, the default value Auto is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Auto', + ], + ], + [ + 'name' => 'OpenPermission', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to grant the host OS permissions. Valid values:'."\n" + ."\n" + .'* **0**: no.'."\n" + .'* **1**: yes.'."\n" + ."\n" + .'> You can grant the host OS permissions based on your business requirements only when you create dedicated clusters that run **MySQL, SQL Server, or PostgreSQL**. For dedicated clusters that run other database engines, the default value 0 is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22EEDAS', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The userid have no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDedicatedHostGroup.NotFound', + 'errorMessage' => '找不到目标主机组！', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22EEDAS\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDedicatedHostGroupAttributeResponse>\\r\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22EEDAS</RequestId>\\r\\n</ModifyDedicatedHostGroupAttributeResponse>","errorExample":""}]', + 'title' => 'ModifyDedicatedHostGroupAttribute', + 'description' => 'For more information, see [Manage dedicated clusters](~~182328~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDedicatedHostGroups' => [ + 'summary' => 'Queries the information about hosts in dedicated clusters.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74491', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID.'."\n" + ."\n" + .'* If you leave this parameter empty, the information about all hosts within the region is returned.'."\n" + .'* If you specify a dedicated cluster ID, the information about all hosts in the dedicated cluster within the region is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dhg-872yt76ann7e****', + ], + ], + [ + 'name' => 'ImageCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image of the host. Valid values:'."\n" + ."\n" + .'* **WindowsWithMssqlEntAlwaysonLicense**: SQL'."\n" + ."\n" + .'Server Cluster Edition.'."\n" + ."\n" + .'* **WindowsWithMssqlStdLicense**: SQL'."\n" + ."\n" + .'Server Standard Edition.'."\n" + ."\n" + .'* **WindowsWithMssqlEntLicense**: SQL'."\n" + ."\n" + .'Server Enterprise Edition.'."\n" + ."\n" + .'* **WindowsWithMssqlWebLicense**: SQL'."\n" + ."\n" + .'Server Web Edition.'."\n" + ."\n" + .'* **AliLinux**: other images.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliLinux', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine used to filter hosts. Valid values:'."\n" + ."\n" + .'* MySQL'."\n" + .'* SQL Server'."\n" + .'* PosgreSQL'."\n" + ."\n" + .'* Redis'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E12SD', + ], + 'DedicatedHostGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DedicatedHostGroups' => [ + 'description' => 'The queried hosts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DiskAllocateRation' => [ + 'description' => 'The disk allocation rate of the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'DeployType' => [ + 'description' => 'The instance deployment mode of the host.'."\n", + 'type' => 'string', + 'example' => 'origin', + ], + 'CreateTime' => [ + 'description' => 'The time when the host was created.'."\n", + 'type' => 'string', + 'example' => '2021-05-07T02:00Z', + ], + 'DedicatedHostCountGroupByHostType' => [ + 'description' => 'The number of hosts by storage type.'."\n", + 'type' => 'object', + 'example' => '2', + ], + 'Text' => [ + 'description' => 'The description of the host.'."\n", + 'type' => 'string', + 'example' => 'mysql-host', + ], + 'DedicatedHostGroupId' => [ + 'description' => 'The ID of the dedicated cluster in which the host is created.'."\n", + 'type' => 'string', + 'example' => ' dhg-34639v1jt4y4****', + ], + 'DiskUtility' => [ + 'description' => 'The disk usage of the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'MemUsedAmount' => [ + 'description' => 'The amount of used memory.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'MemAllocatedAmount' => [ + 'description' => 'The amount of memory allocated to the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CpuAllocationRatio' => [ + 'description' => 'The CPU overcommit ratio of the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'MemAllocationRatio' => [ + 'description' => 'The memory overcommit ratio of the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'MemAllocateRation' => [ + 'description' => 'The memory allocation ratio of the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '9.38', + ], + 'MemUtility' => [ + 'description' => 'The memory usage.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CpuAllocatedAmount' => [ + 'description' => 'The number of CPU cores allocated to the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '3', + ], + 'DedicatedHostGroupDesc' => [ + 'description' => 'The name of the dedicated cluster in which the host is created.'."\n", + 'type' => 'string', + 'example' => ' dhg-34639v1jt4y4****', + ], + 'CpuAllocateRation' => [ + 'description' => 'The CPU allocation ratio of the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '9.38', + ], + 'InstanceNumber' => [ + 'description' => 'The number of instances deployed on the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'OpenPermission' => [ + 'description' => 'Indicates whether the host OS permissions are granted. Valid values:'."\n" + ."\n" + .'* **0 or 1**: no.'."\n" + .'* **2 or 3** (default): yes.'."\n" + ."\n" + .'> When you create a dedicated cluster that runs **MySQL**, **SQL Server**, or **PostgreSQL**, you can grant the host OS permissions based on your business requirements.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'VPCId' => [ + 'description' => 'The virtual private cloud (VPC) ID of the dedicated cluster in which the host is created.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1ov7as4yvz4kxei****', + ], + 'DiskAllocatedAmount' => [ + 'description' => 'The disk storage allocated to the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1024', + ], + 'HostNumber' => [ + 'description' => 'The number of hosts.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DiskUsedAmount' => [ + 'description' => 'The disk storage used by the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1024', + ], + 'AllocationPolicy' => [ + 'description' => 'The policy that is used to allocate host resources. Valid values:'."\n" + ."\n" + .'* **Evenly**: The system preferentially deploys database instances on the hosts where no resources or fewer resources are allocated. This maximizes system stability.'."\n" + .'* **Intensively**: The system preferentially deploys database instances on the hosts that are created earlier and have more allocated resources. This maximizes resource utilization.'."\n", + 'type' => 'string', + 'example' => 'Evenly', + ], + 'Engine' => [ + 'description' => 'The database engine of the host.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DiskAllocationRatio' => [ + 'description' => 'The storage overcommit ratio of the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'BastionInstanceId' => [ + 'description' => 'The ID of the primary instance deployed on the host. If no primary instance is deployed on the host, an empty string is returned.'."\n", + 'type' => 'string', + 'example' => 'rm-bp15rszyxs4t3****', + ], + 'HostReplacePolicy' => [ + 'description' => 'The policy that is used for host troubleshooting. Valid values:'."\n" + ."\n" + .'* Auto (default): The system automatically replaces faulty hosts.'."\n" + .'* Manual: You must manually replace faulty hosts.'."\n", + 'type' => 'string', + 'example' => 'Auto', + ], + 'ZoneIDList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneIDList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The zones where the hosts are created.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-f', + ], + ], + ], + ], + 'Category' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Permission.NotSupport', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E12SD\\",\\n \\"DedicatedHostGroups\\": {\\n \\"DedicatedHostGroups\\": [\\n {\\n \\"DiskAllocateRation\\": 100,\\n \\"DeployType\\": \\"origin\\",\\n \\"CreateTime\\": \\"2021-05-07T02:00Z\\",\\n \\"DedicatedHostCountGroupByHostType\\": 2,\\n \\"Text\\": \\"mysql-host\\",\\n \\"DedicatedHostGroupId\\": \\" dhg-34639v1jt4y4****\\",\\n \\"DiskUtility\\": 0,\\n \\"MemUsedAmount\\": 0,\\n \\"MemAllocatedAmount\\": 0,\\n \\"CpuAllocationRatio\\": 200,\\n \\"MemAllocationRatio\\": 100,\\n \\"MemAllocateRation\\": 9.38,\\n \\"MemUtility\\": 0,\\n \\"CpuAllocatedAmount\\": 3,\\n \\"DedicatedHostGroupDesc\\": \\" dhg-34639v1jt4y4****\\",\\n \\"CpuAllocateRation\\": 9.38,\\n \\"InstanceNumber\\": 2,\\n \\"OpenPermission\\": \\"1\\",\\n \\"VPCId\\": \\"vpc-bp1ov7as4yvz4kxei****\\",\\n \\"DiskAllocatedAmount\\": 1024,\\n \\"HostNumber\\": 2,\\n \\"DiskUsedAmount\\": 1024,\\n \\"AllocationPolicy\\": \\"Evenly\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"DiskAllocationRatio\\": 200,\\n \\"BastionInstanceId\\": \\"rm-bp15rszyxs4t3****\\",\\n \\"HostReplacePolicy\\": \\"Auto\\",\\n \\"ZoneIDList\\": {\\n \\"ZoneIDList\\": [\\n \\"cn-hangzhou-f\\"\\n ]\\n },\\n \\"Category\\": \\"Pro\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDedicatedHostGroupsResponse>\\n <RequestId>D6E068C3-25BC-455A-85FE-45F0B22E12SD</RequestId>\\n <DedicatedHostGroups>\\n <DiskAllocateRation>100</DiskAllocateRation>\\n <DeployType>origin</DeployType>\\n <CreateTime>2021-05-07T02:00Z</CreateTime>\\n <Text>mysql-host</Text>\\n <DedicatedHostGroupId> dhg-34639v1jt4y4****</DedicatedHostGroupId>\\n <DiskUtility>0</DiskUtility>\\n <MemUsedAmount>0</MemUsedAmount>\\n <MemAllocatedAmount>0</MemAllocatedAmount>\\n <CpuAllocationRatio>200</CpuAllocationRatio>\\n <MemAllocationRatio>100</MemAllocationRatio>\\n <MemAllocateRation>9.38</MemAllocateRation>\\n <MemUtility>0</MemUtility>\\n <CpuAllocatedAmount>3</CpuAllocatedAmount>\\n <DedicatedHostGroupDesc> dhg-34639v1jt4y4****</DedicatedHostGroupDesc>\\n <CpuAllocateRation>9.38</CpuAllocateRation>\\n <InstanceNumber>2</InstanceNumber>\\n <OpenPermission>1</OpenPermission>\\n <VPCId>vpc-bp1ov7as4yvz4kxei****</VPCId>\\n <DiskAllocatedAmount>1024</DiskAllocatedAmount>\\n <HostNumber>2</HostNumber>\\n <DiskUsedAmount>1024</DiskUsedAmount>\\n <AllocationPolicy>Evenly</AllocationPolicy>\\n <Engine>MySQL</Engine>\\n <DiskAllocationRatio>200</DiskAllocationRatio>\\n <BastionInstanceId>rm-bp15rszyxs4t3****</BastionInstanceId>\\n <HostReplacePolicy>Auto</HostReplacePolicy>\\n <ZoneIDList>cn-hangzhou-f</ZoneIDList>\\n <Category>Pro</Category>\\n </DedicatedHostGroups>\\n</DescribeDedicatedHostGroupsResponse>","errorExample":""}]', + 'title' => 'DescribeDedicatedHostGroups', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDedicatedHost' => [ + 'summary' => 'Creates hosts in a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '74472', + 'abilityTreeNodes' => [ + 'FEATUREcddcU7RCQ6', + ], + ], + 'parameters' => [ + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the **Dedicated Clusters** page to view the dedicated cluster ID.'."\n" + ."\n" + .'> The database engine of the host is the same as the database engine of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dhg-6w7q18iwt5jo****', + ], + ], + [ + 'name' => 'HostClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the host. For information about the host instance types supported by different database engines, see [Instance types of hosts](~~206343~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds.g6.4xlarge', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the host. Set the value to **prepaid**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'prepaid', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'* **Year**'."\n" + .'* **Month**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the host.'."\n" + ."\n" + .'* Valid values when **Period** is set to **Year**: **1** to **5**.****'."\n" + .'* Valid values when **Period** is set to **Month**: **1** to **9**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ETnLKlblzczshOTUbOCzSBZH8****', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the auto-renewal feature. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> If you do not specify this parameter, the default value **false** is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ImageCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image of the host. Valid values:'."\n" + ."\n" + .'* **WindowsWithMssqlEntAlwaysonLicense**: SQL Server Cluster Edition.'."\n" + .'* **WindowsWithMssqlStdLicense**: SQL Server Standard Edition.'."\n" + .'* **WindowsWithMssqlEntLicense**: SQL Server Enterprise Edition.'."\n" + .'* **WindowsWithMssqlWebLicense**: SQL Server Web Edition.'."\n" + .'* **AliLinux**: other images.'."\n" + ."\n" + .'> When you create a host that runs SQL Server, you must specify a host image.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliLinux', + ], + ], + [ + 'name' => 'OsPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the host. You can specify a password only when you create a host in a **Proprietary MyBase** dedicated cluster.'."\n" + ."\n" + .'* The password must be 8 to 30 characters in length.'."\n" + .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* The password can contain the following special characters: () \\ \\` ~ ! @ # $ % ^ & \\* - \\_ + = | { } \\[ ] : ; \' < > , . ? /'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test123456', + ], + ], + [ + 'name' => 'HostStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk type of the host. This parameter takes effect only for dedicated clusters that run Tair. Valid values:'."\n" + ."\n" + .'* **cloud_essd**: PL1 enhanced SSD (ESSD).'."\n" + .'* **cloud_essd0**: PL0 ESSD.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cloud_essd0' => 'cloud_essd0', + 'cloud_essd' => 'cloud_essd', + ], + 'example' => 'cloud_essd0', + ], + ], + [ + 'name' => 'HostStorage', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The disk storage of the host. This parameter takes effect only for dedicated clusters that run Tair. Unit: GB. Valid values:'."\n" + ."\n" + .'* 512'."\n" + .'* 1024'."\n" + .'* 1536'."\n" + .'* 2048'."\n" + .'* 2560'."\n" + .'* 3072'."\n" + .'* 3584'."\n" + .'* 4096'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '512', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The [region ID](~~198326~~) of the dedicated cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID. You can call the [DescribeRegions](~~214103~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID. You can view the vSwitch ID in the Virtual Private Cloud (VPC) console.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp133c8ifzxd3iv6q****', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The deployment type of the Self-managed MyBase cluster. Valid values: onACK and onECS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'onACK', + ], + ], + [ + 'name' => 'ClusterAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the Self-managed MyBase cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-on-ack-cluster', + ], + ], + [ + 'name' => 'VpcID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The VPC ID of the Self-managed MyBase cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-xxxxxx', + ], + ], + [ + 'name' => 'ClusterServices', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The services associated with the instances in the Self-managed MyBase on Elastic Compute Service (ECS) cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The services associated with the instances in the Self-managed MyBase on Elastic Compute Service (ECS) cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"Orchestrator3.2.6,Promethus2.49.1,Grafana10.2.3"', + ], + 'required' => false, + ], + ], + [ + 'name' => 'MyBaseEcsClass', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameters of the instances in the Self-managed MyBase on Elastic Compute Service (ECS) cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'ChargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PrePaid: subscription.'."\n" + .'* PostPaid: pay-as-you-go.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + ], + 'EcsClassCode' => [ + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g7.large', + ], + 'Amount' => [ + 'description' => 'The number of hosts that you want to create.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Period' => [ + 'description' => 'The subscription duration of the host. The Period parameter must be specified when ChargeType is set to PrePaid.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'PeriodType' => [ + 'description' => 'The unit of the subscription duration. Default value: Month.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'SystemDiskSize' => [ + 'description' => 'The size of the system disk. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '40', + ], + 'SystemDiskCategory' => [ + 'description' => 'The type of the system disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'DataDiskSize' => [ + 'description' => 'The size of the data disk. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '40', + ], + 'DataDiskCategory' => [ + 'description' => 'The type of the data disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'DataDiskCount' => [ + 'description' => 'The number of data disks.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'AutoRenew' => [ + 'description' => 'Specifies whether to enable auto-renewal for the host. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Password' => [ + 'description' => 'The password of the host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '***********', + ], + 'KeyPairName' => [ + 'description' => 'The name of the key pair.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test****', + ], + 'SecurityGroupIds' => [ + 'description' => 'The IDs of the security groups to which the instance belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the security groups to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-uf64zn0tc9qakm2j****', + ], + 'required' => false, + ], + 'Tags' => [ + 'description' => 'The tags that you want to add to the host.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that you want to add to the host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"key1\\":\\"value1\\"}', + ], + 'required' => false, + ], + 'InternetMaxBandwidthOut' => [ + 'description' => 'The maximum outbound public bandwidth. Unit: Mbit/s.'."\n" + ."\n" + .'Default value: 0. If you specify the parameter to a value greater than 0, a public IP address is automatically created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'InternetChargeType' => [ + 'description' => 'The metering method for network usage. Valid values:'."\n" + ."\n" + .'* PayByBandwidth'."\n" + .'* PayByTraffic'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + ], + 'DepolymentSetId' => [ + 'description' => 'The deployment set ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '102565235', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C860658E-68A6-46C1-AF6E-3AE7C4D32375', + ], + 'ClusterName' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'ca-2ze0x527ovq3y****', + ], + 'DedicateHostList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DedicateHostList' => [ + 'description' => 'The created hosts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DedicatedHostId' => [ + 'description' => 'The ID of the created host.'."\n", + 'type' => 'string', + 'example' => ' ch-bp108dki3wdl6****', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'COMMODITY.INVALID_COMPONENT', + 'errorMessage' => 'Invalid component.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Format', + 'errorMessage' => 'The account password format is invalid.', + ], + [ + 'errorCode' => 'InsufficientResourceCapacity', + 'errorMessage' => 'No host is available for the requested instance.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 102565235,\\n \\"RequestId\\": \\"C860658E-68A6-46C1-AF6E-3AE7C4D32375\\",\\n \\"ClusterName\\": \\"ca-2ze0x527ovq3y****\\",\\n \\"DedicateHostList\\": {\\n \\"DedicateHostList\\": [\\n {\\n \\"DedicatedHostId\\": \\" ch-bp108dki3wdl6****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateDedicatedHostResponse>\\n <OrderId>102565235</OrderId>\\n <RequestId>C860658E-68A6-46C1-AF6E-3AE7C4D32375</RequestId>\\n <DedicateHostList>\\n <DedicatedHostId> ch-bp108dki3wdl6****</DedicatedHostId>\\n </DedicateHostList>\\n</CreateDedicatedHostResponse>","errorExample":""}]', + 'title' => 'CreateDedicatedHost', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDedicatedHosts' => [ + 'summary' => 'Queries the information about hosts in a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74497', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '[The region ID](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the **Dedicated Clusters** page to view the dedicated cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'dhg-h5i4p331f509****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order ID. You can log on to the Billing Management console and go to the **Orders** page to view the order ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'HostType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage type of the host. Valid values:'."\n" + ."\n" + .'* **dhg_local_ssd**: local SSD.'."\n" + .'* **dhg_cloud_ssd** or **dhg_cloud_essd**: enhanced SSD (ESSD).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dhg_cloud_ssd', + ], + ], + [ + 'name' => 'HostStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the host. Valid values:'."\n" + ."\n" + .'* **0**: The host is being created.'."\n" + .'* **1**: The host is running.'."\n" + .'* **2**: The host is faulty.'."\n" + .'* **3**: The host is ready for disabling.'."\n" + .'* **4**: The host is being maintained.'."\n" + .'* **5**: The host is disabled.'."\n" + .'* **6**: The host is restarting.'."\n" + .'* **7**: The host is locked.'."\n" + ."\n" + .'> When a host fails, the host is disabled. Before the host is disabled, the data of the instances that run on the host is migrated to another host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AllocationStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether instances can be deployed on the host. Valid values:'."\n" + ."\n" + .'* **Allocatable**: Instances can be deployed on the host.'."\n" + .'* **Suspended**: Instances cannot be deployed on the host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Allocatable', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID. You can call the [DescribeRegions](~~214103~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1a', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the host in the dedicated cluster. You can log on to the ApsaraDB for MyBase console and go to the **Hosts** page to view the host ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'PageNumbers', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags that are added to the host. Each tag is a key-value pair that consists of TagKey and TagValue. You can specify a maximum of five tags in the following format for each request: {"key1":"value1","key2":"value2"...}.'."\n" + ."\n" + .'> If you want to filter hosts based on tags, do not specify the **DedicatedHostId** parameter. Otherwise, the **DedicatedHostId** parameter is used to filter hosts.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key1":"value1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecords' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22EASER', + ], + 'PageNumbers' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DedicatedHostGroupId' => [ + 'description' => 'The dedicated cluster ID.'."\n", + 'type' => 'string', + 'example' => 'dhg-6w7q18iwt5jo****', + ], + 'DedicatedHosts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DedicatedHosts' => [ + 'description' => 'The queried hosts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HostType' => [ + 'description' => 'The storage type of the host.'."\n", + 'type' => 'string', + 'example' => 'dhg_cloud_ssd', + ], + 'HostStorage' => [ + 'description' => 'The total storage of the host. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + 'MemoryUsed' => [ + 'description' => 'The amount of memory used by the host. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '24576', + ], + 'DedicatedHostGroupId' => [ + 'description' => 'The ID of the dedicated cluster in which the host is created.'."\n", + 'type' => 'string', + 'example' => 'dhg-6w7q18iwt5jo****', + ], + 'AllocationStatus' => [ + 'description' => 'Specifies whether instances can be deployed on the host. Valid values:'."\n" + ."\n" + .'* **Allocatable**: Instances can be deployed on the host.'."\n" + .'* **Suspended**: Instances cannot be deployed on the host.'."\n", + 'type' => 'string', + 'example' => 'Suspended', + ], + 'StorageUsed' => [ + 'description' => 'The amount of storage used by the host. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '588800', + ], + 'EcsClassCode' => [ + 'description' => 'The instance type of the Elastic Compute Service (ECS) instance. For more information, see [Overview of instance families](~~25378~~).'."\n", + 'type' => 'string', + 'example' => 'ecs.r5.16xlarge', + ], + 'DedicatedHostId' => [ + 'description' => 'The host ID.'."\n", + 'type' => 'string', + 'example' => 'ch-bp10a5id3boqi****', + ], + 'MemAllocationRatio' => [ + 'description' => 'The memory usage of the host. Unit: %.'."\n", + 'type' => 'string', + 'example' => '90', + ], + 'CreatedTime' => [ + 'description' => 'The time when the host was created. The time follows the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-10-16 16:30:19', + ], + 'IPAddress' => [ + 'description' => 'The IP address of the host.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'HostStatus' => [ + 'description' => 'The state of the host. Valid values:'."\n" + ."\n" + .'* **0**: The host is being created.'."\n" + .'* **1**: The host is running.'."\n" + .'* **2**: The host is faulty.'."\n" + .'* **3**: The host is ready for disabling.'."\n" + .'* **4**: The host is being maintained.'."\n" + .'* **5**: The host is disabled.'."\n" + .'* **6**: The host is restarting.'."\n" + .'* **7**: The host is locked.'."\n" + ."\n" + .'> When a host fails, the host is disabled. Before the host is disabled, the data of the instances that run on the host is migrated to another host.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'HostName' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => 'ch-bp15xfnp706tl****', + ], + 'HostCPU' => [ + 'description' => 'The number of CPU cores of the host.'."\n", + 'type' => 'string', + 'example' => '16', + ], + 'CpuUsed' => [ + 'description' => 'The number of used CPU cores.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'InstanceNumber' => [ + 'description' => 'The number of instances deployed on the host.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'OpenPermission' => [ + 'description' => 'Indicates whether the host OS permissions are granted. Valid values:'."\n" + ."\n" + .'* **0**: no.'."\n" + .'* **1** (default): yes.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'DistributionSymbol' => [ + 'description' => 'The distribution symbol of the host.'."\n" + ."\n" + .'> This parameter is returned only when the host runs **Tair**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'VPCId' => [ + 'description' => 'The virtual private cloud (VPC) ID of the dedicated cluster in which the host is created.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1roz55mrbj3ka1s****', + ], + 'HostClass' => [ + 'description' => 'The instance type of the host.'."\n", + 'type' => 'string', + 'example' => 'rds.g6.4xlarge', + ], + 'EndTime' => [ + 'description' => 'The expiration time of the host. The time follows the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-10-16 16:30:19', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch to which the host is connected.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp133c8ifzxd3iv6q****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone in which the host resides.'."\n", + 'type' => 'string', + 'example' => 'ap-southeast-1a', + ], + 'CPUAllocationRatio' => [ + 'description' => 'The CPU utilization of the host.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'ImageCategory' => [ + 'description' => 'The image type of the host.'."\n", + 'type' => 'string', + 'example' => 'ALinux', + ], + 'Engine' => [ + 'description' => 'The database engine of the host.'."\n", + 'type' => 'string', + 'example' => 'mysql', + ], + 'DiskAllocationRatio' => [ + 'description' => 'The disk usage of the host. Unit: %.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'HostMem' => [ + 'description' => 'The memory size of the host. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '65536', + ], + 'BastionInstanceId' => [ + 'description' => 'The ID of the bastion host with which the host is associated.'."\n", + 'type' => 'string', + 'example' => 'bastionhost-cn-i7m2fgw****', + ], + 'AccountName' => [ + 'description' => 'The custom account name of the host.'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* The name must be 2 to 16 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AccountType' => [ + 'description' => 'The account type of the host. Valid values:'."\n" + ."\n" + .'**Normal**: standard account.'."\n" + ."\n" + .'**Admin**: administrator account.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'DistributionTag' => [ + 'description' => 'The distribution tag of the host.'."\n", + 'type' => 'string', + 'example' => 't4n9uz07h3r1tmcejtxf:1', + ], + 'Category' => [ + 'description' => 'The type of the dedicated cluster. Valid values:'."\n" + ."\n" + .'* **Pro**: Proprietary MyBase.'."\n" + .'* **Standard**: Managed MyBase.'."\n" + ."\n" + .'> This parameter is returned only for the China site (aliyun.com).'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'EcsId' => [ + 'description' => 'The ID of the ECS instance.'."\n" + ."\n" + .'> This parameter is returned only for the China site (aliyun.com) when the dedicated cluster is of the **Proprietary MyBase** type.'."\n", + 'type' => 'string', + 'example' => 'i-2zec7l031p0jtru3pn7a', + ], + 'DiskInfo' => [ + 'description' => 'The disk information of the ECS instance.'."\n" + ."\n" + .'> This parameter is returned only for the China site (aliyun.com) when the dedicated cluster is of the **Proprietary MyBase** type.'."\n", + 'type' => 'string', + 'example' => '{\\"SystemDiskSize\\":20,\\"DataDiskCount\\":0,\\"DataDiskSize\\":0,\\"DataDiskCategory\\":[\\"\\"],\\"SystemDiskCategory\\":\\"cloud_essd\\"}', + ], + 'ChargeType' => [ + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'MssqlSupportVersion' => [ + 'description' => 'The versions supported by hosts in ApsaraDB MyBase for SQL Server.'."\n", + 'type' => 'string', + 'example' => '2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std', + ], + ], + ], + ], + ], + ], + 'MaxAutoScaleHostStorage' => [ + 'description' => 'The maximum storage of local SSDs for auto scaling. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3661824', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Tag.InvalidTagsParameter', + 'errorMessage' => 'tags parameter is invalid', + ], + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The userid have no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDedicatedHostGroup.NotFound', + 'errorMessage' => 'Specified DedicatedHostGroup does not exists.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecords\\": 40,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22EASER\\",\\n \\"PageNumbers\\": 2,\\n \\"DedicatedHostGroupId\\": \\"dhg-6w7q18iwt5jo****\\",\\n \\"DedicatedHosts\\": {\\n \\"DedicatedHosts\\": [\\n {\\n \\"HostType\\": \\"dhg_cloud_ssd\\",\\n \\"HostStorage\\": \\"1234\\",\\n \\"MemoryUsed\\": \\"24576\\",\\n \\"DedicatedHostGroupId\\": \\"dhg-6w7q18iwt5jo****\\",\\n \\"AllocationStatus\\": \\"Suspended\\",\\n \\"StorageUsed\\": \\"588800\\",\\n \\"EcsClassCode\\": \\"ecs.r5.16xlarge\\",\\n \\"DedicatedHostId\\": \\"ch-bp10a5id3boqi****\\",\\n \\"MemAllocationRatio\\": \\"90\\",\\n \\"CreatedTime\\": \\"2020-10-16 16:30:19\\",\\n \\"IPAddress\\": \\"192.168.XX.XX\\",\\n \\"HostStatus\\": \\"1\\",\\n \\"HostName\\": \\"ch-bp15xfnp706tl****\\",\\n \\"HostCPU\\": \\"16\\",\\n \\"CpuUsed\\": \\"10\\",\\n \\"InstanceNumber\\": \\"1\\",\\n \\"OpenPermission\\": \\"1\\",\\n \\"DistributionSymbol\\": \\"0\\",\\n \\"VPCId\\": \\"vpc-bp1roz55mrbj3ka1s****\\",\\n \\"HostClass\\": \\"rds.g6.4xlarge\\",\\n \\"EndTime\\": \\"2021-10-16 16:30:19\\",\\n \\"VSwitchId\\": \\"vsw-bp133c8ifzxd3iv6q****\\",\\n \\"ZoneId\\": \\"ap-southeast-1a\\",\\n \\"CPUAllocationRatio\\": \\"10\\",\\n \\"ImageCategory\\": \\"ALinux\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"DiskAllocationRatio\\": \\"10\\",\\n \\"HostMem\\": \\"65536\\",\\n \\"BastionInstanceId\\": \\"bastionhost-cn-i7m2fgw****\\",\\n \\"AccountName\\": \\"test\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"DistributionTag\\": \\"t4n9uz07h3r1tmcejtxf:1\\",\\n \\"Category\\": \\"Standard\\",\\n \\"EcsId\\": \\"i-2zec7l031p0jtru3pn7a\\",\\n \\"DiskInfo\\": \\"{\\\\\\\\\\\\\\"SystemDiskSize\\\\\\\\\\\\\\":20,\\\\\\\\\\\\\\"DataDiskCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"DataDiskSize\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"DataDiskCategory\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"SystemDiskCategory\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cloud_essd\\\\\\\\\\\\\\"}\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"MssqlSupportVersion\\": \\"2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std\\"\\n }\\n ]\\n },\\n \\"MaxAutoScaleHostStorage\\": 3661824\\n}","errorExample":""},{"type":"xml","example":"<DescribeDedicatedHostsResponse>\\n <TotalRecords>40</TotalRecords>\\n <PageSize>20</PageSize>\\n <RequestId>D6E068C3-25BC-455A-85FE-45F0B22EASER</RequestId>\\n <PageNumbers>2</PageNumbers>\\n <DedicatedHostGroupId>dhg-6w7q18iwt5jo****</DedicatedHostGroupId>\\n <DedicatedHosts>\\n <HostType>dhg_cloud_ssd</HostType>\\n <HostStorage>1234</HostStorage>\\n <MemoryUsed>24576</MemoryUsed>\\n <DedicatedHostGroupId>dhg-6w7q18iwt5jo****</DedicatedHostGroupId>\\n <AllocationStatus>Suspended</AllocationStatus>\\n <StorageUsed>588800</StorageUsed>\\n <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>\\n <DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>\\n <MemAllocationRatio>90</MemAllocationRatio>\\n <CreatedTime>2020-10-16 16:30:19</CreatedTime>\\n <IPAddress>192.168.XX.XX</IPAddress>\\n <HostStatus>1</HostStatus>\\n <HostName>ch-bp15xfnp706tl****</HostName>\\n <HostCPU>16</HostCPU>\\n <CpuUsed>10</CpuUsed>\\n <InstanceNumber>1</InstanceNumber>\\n <OpenPermission>1</OpenPermission>\\n <DistributionSymbol>0</DistributionSymbol>\\n <VPCId>vpc-bp1roz55mrbj3ka1s****</VPCId>\\n <HostClass>rds.g6.4xlarge</HostClass>\\n <EndTime>2021-10-16 16:30:19</EndTime>\\n <VSwitchId>vsw-bp133c8ifzxd3iv6q****</VSwitchId>\\n <ZoneId>ap-southeast-1a</ZoneId>\\n <CPUAllocationRatio>10</CPUAllocationRatio>\\n <ImageCategory>ALinux</ImageCategory>\\n <Engine>mysql</Engine>\\n <DiskAllocationRatio>10</DiskAllocationRatio>\\n <HostMem>65536</HostMem>\\n <BastionInstanceId>bastionhost-cn-i7m2fgw****</BastionInstanceId>\\n <AccountName>test</AccountName>\\n <AccountType>Normal</AccountType>\\n <DistributionTag>t4n9uz07h3r1tmcejtxf:1</DistributionTag>\\n <Category>Standard</Category>\\n <EcsId>i-2zec7l031p0jtru3pn7a</EcsId>\\n <DiskInfo>{\\\\\\"SystemDiskSize\\\\\\":20,\\\\\\"DataDiskCount\\\\\\":0,\\\\\\"DataDiskSize\\\\\\":0,\\\\\\"DataDiskCategory\\\\\\":[\\\\\\"\\\\\\"],\\\\\\"SystemDiskCategory\\\\\\":\\\\\\"cloud_essd\\\\\\"}</DiskInfo>\\n <ChargeType>PREPAY</ChargeType>\\n </DedicatedHosts>\\n <MaxAutoScaleHostStorage>3661824</MaxAutoScaleHostStorage>\\n</DescribeDedicatedHostsResponse>","errorExample":""}]', + 'title' => 'DescribeDedicatedHosts', + 'description' => 'After hosts are created in a dedicated cluster, you can query the information about the hosts such as performance metrics, total number of CPU cores, total memory size, and total storage.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDedicatedHostAttribute' => [ + 'summary' => 'Queries the parameter settings of a host in a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74487', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '[The region ID](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can log on to the ApsaraDB for MyBase console and go to the **Hosts** page to view the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dedicated cluster in which the host is created. You can log on to the ApsaraDB for MyBase console and go to the **Dedicated Clusters** page to view the dedicated cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dhg-34639v1jt4y4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HostType' => [ + 'description' => 'The storage type of the host. Valid values:'."\n" + ."\n" + .'* **dhg_cloud_ssd** or **dhg_cloud_essd**: enhanced SSD (ESSD).'."\n" + .'* **dhg_local_ssd**: local SSD.'."\n", + 'type' => 'string', + 'example' => 'dhg_cloud_ssd', + ], + 'HostStorage' => [ + 'description' => 'The total storage of the host. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstanceNumberROSlave' => [ + 'description' => 'The number of secondary instances of the read-only instance deployed on the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccountType' => [ + 'description' => 'The account type of the host. Valid values:'."\n" + ."\n" + .'* **Normal**: standard account.'."\n" + .'* **Admin**: administrator account.'."\n", + 'type' => 'string', + 'example' => 'Admin', + ], + 'MemoryUsed' => [ + 'description' => 'The amount of memory used by the host. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '24576', + ], + 'DedicatedHostGroupId' => [ + 'description' => 'The ID of the dedicated cluster in which the host is created.'."\n", + 'type' => 'string', + 'example' => 'dhg-34639v1jt4y4****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '00A001D6-2630-5CBD-A23C-80BC1BAFDC31', + ], + 'InstanceNumberROMaster' => [ + 'description' => 'The number of primary instances of the read-only instance deployed on the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AllocationStatus' => [ + 'description' => 'Indicates whether instances can be deployed on the host. Valid values:'."\n" + ."\n" + .'* **Allocatable**: yes.'."\n" + .'* **Suspended**: no.'."\n", + 'type' => 'string', + 'example' => 'Suspended', + ], + 'StorageUsed' => [ + 'description' => 'The storage usage of the host. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '588800', + ], + 'EcsClassCode' => [ + 'description' => 'The instance type of the Elastic Compute Service (ECS) instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.r5.16xlarge', + ], + 'DedicatedHostId' => [ + 'description' => 'The host ID.'."\n", + 'type' => 'string', + 'example' => 'ch-bp10a5id3boqi****', + ], + 'MemAllocationRatio' => [ + 'description' => 'The memory usage of the host. Unit: %.'."\n", + 'type' => 'string', + 'example' => '90', + ], + 'CreatedTime' => [ + 'description' => 'The time when the host was created. The time follows the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-11-13T07:14:22Z', + ], + 'IPAddress' => [ + 'description' => 'The IP address of the host.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AutoRenew' => [ + 'description' => 'Indicates whether auto-renewal is enabled on the host. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'HostStatus' => [ + 'description' => 'The state of the host. Valid values:'."\n" + ."\n" + .'* **0**: The host is being created.'."\n" + .'* **1**: The host is running.'."\n" + .'* **2**: The host is faulty.'."\n" + .'* **3**: The host is ready for disabling.'."\n" + .'* **4**: The host is being maintained.'."\n" + .'* **5**: The host is disabled.'."\n" + .'* **6**: The host is restarting.'."\n" + .'* **7**: The host is locked.'."\n" + ."\n" + .'> When a host fails, the host is disabled. Before the host is disabled, the data of the instances that run on the host is migrated to another host. This ensures data integrity.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'HostName' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => 'ch-8vbj9x74z874o****', + ], + 'HostCPU' => [ + 'description' => 'The number of CPU cores of the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'OpenPermission' => [ + 'description' => 'Indicates whether the host OS permissions are grated. Valid values:'."\n" + ."\n" + .'* **0**: no.'."\n" + .'* **1**: yes.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'InstanceNumber' => [ + 'description' => 'The number of instances deployed on the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CpuUsed' => [ + 'description' => 'The number of CPU cores used by the host.'."\n", + 'type' => 'string', + 'example' => '36', + ], + 'VPCId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9vu1jb32wn3sdd6****', + ], + 'HostClass' => [ + 'description' => 'The instance type of the host.'."\n", + 'type' => 'string', + 'example' => 'mssql.host.c2xlarge', + ], + 'RegionId' => [ + 'description' => '[The region ID](~~198326~~).'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceNumberMaster' => [ + 'description' => 'The number of primary instances deployed on the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1kaugqyrzb58oc1****', + ], + 'InstanceNumberSlave' => [ + 'description' => 'The number of secondary instances deployed on the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExpiredTime' => [ + 'description' => 'The expiration time of the host. The time follows the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-03-16T16:00:00Z', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'CPUAllocationRatio' => [ + 'description' => 'The CPU overcommit ratio of the dedicated cluster. Unit: %. The value is accurate to the tens digit.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'ImageCategory' => [ + 'description' => 'The image of the host. This parameter is returned only when the database engine is **SQL Server**. Valid values:'."\n" + ."\n" + .'* **WindowsWithMssqlEntAlwaysonLicense**: SQL Server Cluster Edition (AlwaysOn).'."\n" + .'* **WindowsWithMssqlStdLicense**: SQL Server Standard Edition.'."\n" + .'* **WindowsWithMssqlEntLicense**: SQL Server Enterprise Edition.'."\n" + .'* **WindowsWithMssqlWebLicense**: SQL Server Web Edition.'."\n", + 'type' => 'string', + 'example' => 'WindowsWithMssqlStdLicense', + ], + 'DiskAllocationRatio' => [ + 'description' => 'The storage overcommit ratio of the dedicated cluster.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'HostMem' => [ + 'description' => 'The memory size of the host. Unit: MB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + ], + 'AccountName' => [ + 'description' => 'The account name of the host.'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* The name must be 2 to 16 characters in length.'."\n", + 'type' => 'string', + 'example' => 'cdp_system', + ], + 'DistributionTag' => [ + 'description' => 'The distribution tag of the host.'."\n", + 'type' => 'string', + 'example' => 'tag', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The userid have no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + [ + 'errorCode' => 'Permission.NotSupport', + 'errorMessage' => 'The user permission does not support the operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDedicatedHostGroup.NotFound', + 'errorMessage' => 'Specified DedicatedHostGroup does not exists.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostType\\": \\"dhg_cloud_ssd\\",\\n \\"HostStorage\\": 100,\\n \\"InstanceNumberROSlave\\": 1,\\n \\"AccountType\\": \\"Admin\\",\\n \\"MemoryUsed\\": \\"24576\\",\\n \\"DedicatedHostGroupId\\": \\"dhg-34639v1jt4y4****\\",\\n \\"RequestId\\": \\"00A001D6-2630-5CBD-A23C-80BC1BAFDC31\\",\\n \\"InstanceNumberROMaster\\": 1,\\n \\"AllocationStatus\\": \\"Suspended\\",\\n \\"StorageUsed\\": \\"588800\\",\\n \\"EcsClassCode\\": \\"ecs.r5.16xlarge\\",\\n \\"DedicatedHostId\\": \\"ch-bp10a5id3boqi****\\",\\n \\"MemAllocationRatio\\": \\"90\\",\\n \\"CreatedTime\\": \\"2021-11-13T07:14:22Z\\",\\n \\"IPAddress\\": \\"192.168.XX.XX\\",\\n \\"AutoRenew\\": \\"false\\",\\n \\"HostStatus\\": \\"1\\",\\n \\"HostName\\": \\"ch-8vbj9x74z874o****\\",\\n \\"HostCPU\\": 16,\\n \\"OpenPermission\\": \\"1\\",\\n \\"InstanceNumber\\": 3,\\n \\"CpuUsed\\": \\"36\\",\\n \\"VPCId\\": \\"vpc-wz9vu1jb32wn3sdd6****\\",\\n \\"HostClass\\": \\"mssql.host.c2xlarge\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceNumberMaster\\": 4,\\n \\"VSwitchId\\": \\"vsw-bp1kaugqyrzb58oc1****\\",\\n \\"InstanceNumberSlave\\": 1,\\n \\"ExpiredTime\\": \\"2022-03-16T16:00:00Z\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"CPUAllocationRatio\\": \\"200\\",\\n \\"ImageCategory\\": \\"WindowsWithMssqlStdLicense\\",\\n \\"DiskAllocationRatio\\": \\"200\\",\\n \\"HostMem\\": 2048,\\n \\"AccountName\\": \\"cdp_system\\",\\n \\"DistributionTag\\": \\"tag\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDedicatedHostAttributeResponse>\\n <HostType>dhg_cloud_ssd</HostType>\\n <HostStorage>100</HostStorage>\\n <InstanceNumberROSlave>1</InstanceNumberROSlave>\\n <AccountType>Admin</AccountType>\\n <MemoryUsed>24576</MemoryUsed>\\n <DedicatedHostGroupId>dhg-34639v1jt4y4****</DedicatedHostGroupId>\\n <RequestId>00A001D6-2630-5CBD-A23C-80BC1BAFDC31</RequestId>\\n <InstanceNumberROMaster>1</InstanceNumberROMaster>\\n <AllocationStatus>Suspended</AllocationStatus>\\n <StorageUsed>588800</StorageUsed>\\n <EcsClassCode>ecs.r5.16xlarge</EcsClassCode>\\n <DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>\\n <MemAllocationRatio>90</MemAllocationRatio>\\n <CreatedTime>2021-11-13T07:14:22Z</CreatedTime>\\n <IPAddress>192.168.XX.XX</IPAddress>\\n <AutoRenew>false</AutoRenew>\\n <HostStatus>1</HostStatus>\\n <HostName>ch-8vbj9x74z874o****</HostName>\\n <HostCPU>16</HostCPU>\\n <OpenPermission>1</OpenPermission>\\n <InstanceNumber>3</InstanceNumber>\\n <CpuUsed>36</CpuUsed>\\n <VPCId>vpc-wz9vu1jb32wn3sdd6****</VPCId>\\n <HostClass>mssql.host.c2xlarge</HostClass>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceNumberMaster>4</InstanceNumberMaster>\\n <VSwitchId>vsw-bp1kaugqyrzb58oc1****</VSwitchId>\\n <InstanceNumberSlave>1</InstanceNumberSlave>\\n <ExpiredTime>2022-03-16T16:00:00Z</ExpiredTime>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <CPUAllocationRatio>200</CPUAllocationRatio>\\n <ImageCategory>WindowsWithMssqlStdLicense</ImageCategory>\\n <DiskAllocationRatio>200</DiskAllocationRatio>\\n <HostMem>2048</HostMem>\\n <AccountName>cdp_system</AccountName>\\n <DistributionTag>tag</DistributionTag>\\n</DescribeDedicatedHostAttributeResponse>","errorExample":""}]', + 'title' => 'DescribeDedicatedHostAttribute', + ], + 'DescribeHostEcsLevelInfo' => [ + 'summary' => 'Queries the information about host specifications.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74507', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine. Valid values:'."\n" + ."\n" + .'* **mysql**'."\n" + .'* **mssql**'."\n" + .'* **pgsql**'."\n" + .'* **redis**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ap-southeast-1a', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage type. Valid values:'."\n" + ."\n" + .'* **local_ssd**: standard SSD.'."\n" + .'* **cloud_essd**: PL1 enhanced SSD (ESSD).'."\n" + .'* **cloud_essd2**: PL2 ESSD.'."\n" + .'* **cloud_essd3**: PL3 ESSD.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'local_ssd', + ], + ], + [ + 'name' => 'ImageCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image of the host. Valid values:'."\n" + ."\n" + .'* **WindowsWithMssqlEntAlwaysonLicense**: SQL Server Cluster Edition.'."\n" + .'* **WindowsWithMssqlStdLicense**: SQL Server Standard Edition.'."\n" + .'* **WindowsWithMssqlEntLicense**: SQL Server Enterprise Edition.'."\n" + .'* **WindowsWithMssqlWebLicense**: SQL Server Web Edition.'."\n" + .'* **AliLinux**: other images.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliLinux', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '395858E2-2A82-4ED7-BB93-2DB60119EF4C', + ], + 'HostEcsLevelInfos' => [ + 'description' => 'The queried host.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CddcHostType' => [ + 'description' => 'The category of the host. Valid values:'."\n" + ."\n" + .'* **general**: general-purpose.'."\n" + .'* **compute**: compute-optimized.'."\n" + .'* **ram**: memory-optimized.'."\n" + .'* **dragon**: ECS Bare Metal Instance.'."\n", + 'type' => 'string', + 'example' => 'ram', + ], + 'Items' => [ + 'description' => 'The queried host specifications.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NetBandWidth' => [ + 'description' => 'The internal bandwidth of the host. Unit: Gbit/s.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'EcsClass' => [ + 'description' => 'The instance family of the host.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RdsClassCode' => [ + 'description' => 'The instance type of the instance.'."\n", + 'type' => 'string', + 'example' => 'mssql.cluster.host.g2xlarge ', + ], + 'Cpu' => [ + 'description' => 'The number of CPU cores of the host.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'CpuFrequency' => [ + 'description' => 'The processor frequency. Unit: GHz.'."\n", + 'type' => 'string', + 'example' => '2.5 GHz/3.2 GHz', + ], + 'StorageIops' => [ + 'description' => 'The storage IOPS of the host, which is displayed after being divided by 10,000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CloudStorageBandwidth' => [ + 'description' => 'The disk bandwidth. Unit: Gbit/s.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + 'EcsClassCode' => [ + 'description' => 'The instance type of the host.'."\n", + 'type' => 'string', + 'example' => 'ecs.g6.2xlarge ', + ], + 'IsCloudDisk' => [ + 'description' => 'Indicates whether the host uses cloud disks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The memory size of the host. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '192', + ], + 'NetPackage' => [ + 'description' => 'The packet forwarding rate over the internal network, which is displayed after being divided by 10,000. Unit: packets per second (PPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'CpuVersion' => [ + 'description' => 'The CPU model of the host.'."\n", + 'type' => 'string', + 'example' => 'Intel Xeon(Cascade Lake) Platinum 8269CY ', + ], + 'LocalStorage' => [ + 'description' => 'The local storage.'."\n", + 'type' => 'string', + 'example' => '7', + ], + 'Description' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => 'testxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAction', + 'errorMessage' => 'The specified action is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Permission.NotSupport', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"395858E2-2A82-4ED7-BB93-2DB60119EF4C\\",\\n \\"HostEcsLevelInfos\\": [\\n {\\n \\"CddcHostType\\": \\"ram\\",\\n \\"Items\\": [\\n {\\n \\"NetBandWidth\\": 10,\\n \\"EcsClass\\": \\"通用型 g6\\",\\n \\"RdsClassCode\\": \\"mssql.cluster.host.g2xlarge\\\\t\\",\\n \\"Cpu\\": 24,\\n \\"CpuFrequency\\": \\"2.5 GHz/3.2 GHz\\",\\n \\"StorageIops\\": 5,\\n \\"CloudStorageBandwidth\\": 4,\\n \\"EcsClassCode\\": \\"ecs.g6.2xlarge\\\\t\\",\\n \\"IsCloudDisk\\": 1,\\n \\"Memory\\": 192,\\n \\"NetPackage\\": 150,\\n \\"CpuVersion\\": \\"Intel Xeon(Cascade Lake) Platinum 8269CY\\\\t\\",\\n \\"LocalStorage\\": \\"7\\",\\n \\"Description\\": \\"testxxx\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeHostEcsLevelInfoReponse>\\n<RequestId>395858E2-2A82-4ED7-BB93-2DB60119EF4C</RequestId>\\n<HostEcsLevelInfos>\\n <CddcHostType>ram</CddcHostType>\\n <Items>\\n <Description>testxxx</Description>\\n <Memory>192</Memory>\\n <Cpu>24</Cpu>\\n <NetPackage>150</NetPackage>\\n <CloudStorageBandwidth>4</CloudStorageBandwidth>\\n <CpuVersion>Intel Xeon(Cascade Lake) Platinum 8269CY\\t</CpuVersion>\\n <IsCloudDisk>1</IsCloudDisk>\\n <NetBandWidth>10</NetBandWidth>\\n <LocalStorage>7</LocalStorage>\\n <StorageIops>5</StorageIops>\\n <RdsClassCode>mssql.cluster.host.g2xlarge\\t</RdsClassCode>\\n <EcsClassCode>ecs.g6.2xlarge\\t</EcsClassCode>\\n <CpuFrequency>2.5 GHz/3.2 GHz</CpuFrequency>\\n <EcsClass>通用型 g6\\t</EcsClass>\\n </Items>\\n</HostEcsLevelInfos>\\n</DescribeHostEcsLevelInfoReponse>","errorExample":""}]', + 'title' => 'DescribeHostEcsLevelInfo', + 'description' => 'After a host is created, you can call this operation to query the information about the host specifications, such as the CPU resources, memory resources, CPU model, host category, and storage type.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDedicatedHostDisks' => [ + 'summary' => 'Queries the information about disks on a host.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76548', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can log on to the ApsaraDB for MyBase console and go to the **Hosts** page to view the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp183v72jr033****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can log on to the ApsaraDB for MyBase console to view the [region ID](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DedicatedHostId' => [ + 'description' => 'The host ID.'."\n", + 'type' => 'string', + 'example' => 'ch-bp183v72jr033****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C6C6CF41-F284-4F63-AB4D-44FACE3BASQW', + ], + 'Disks' => [ + 'description' => 'The queried disks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The disk type of the enhanced SSD (ESSD) or local SSD. Valid values:'."\n" + ."\n" + .'* **system**: system disk.'."\n" + .'* **data**: data disk.'."\n", + 'type' => 'string', + 'example' => 'data', + ], + 'Status' => [ + 'description' => 'The state of the ESSD. Valid values:'."\n" + ."\n" + .'* **In_use**'."\n" + .'* **Available**'."\n" + .'* **Attaching**'."\n" + .'* **Detaching**'."\n" + .'* **Creating**'."\n" + .'* **ReIniting**'."\n", + 'type' => 'string', + 'example' => 'In_use', + ], + 'PerformanceLevel' => [ + 'description' => 'The performance level of the ESSD.'."\n" + ."\n" + .'> ApsaraDB for MyBase provides the following types of ESSDs: **ESSD**, **PL2 ESSD**, and **PL3 ESSD**. The higher performance level delivers better ESSD performance.'."\n", + 'type' => 'string', + 'example' => 'PL1', + ], + 'DiskId' => [ + 'description' => 'The ID of the ESSD or local SSD.'."\n", + 'type' => 'string', + 'example' => 'd-bp1dffpog8r2eowd****', + ], + 'MaxThroughput' => [ + 'description' => 'The maximum throughput of the disk. Unit: MB/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '284', + ], + 'MaxIOPS' => [ + 'description' => 'The maximum IOPS of the disk, which is displayed after being divided by 10,000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18250', + ], + 'HasDBInstance' => [ + 'description' => 'Indicates whether the disk is attached to instances. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Device' => [ + 'description' => 'The device name of the instance to which the ESSD or local SSD is attached.'."\n", + 'type' => 'string', + 'example' => '/dev/xvdb', + ], + 'Size' => [ + 'description' => 'The size of the ESSD or local SSD. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '329', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the ESSD or local SSD.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => 'The storage type of the host. Valid values:'."\n" + ."\n" + .'* **cloud_ssd**: local SSD.'."\n" + .'* **cloud_essd**: ESSD.'."\n", + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'DBInstanceId' => [ + 'description' => 'The ID of the instance that uses the disk.'."\n", + 'type' => 'string', + 'example' => 'rm-bp121zcqr5h8m****', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The user ID has no permission.', + ], + ], + 404 => [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'The specified host info is not found.', + ], + [ + 'errorCode' => 'InvalidDedicatedHostGroup.NotFound', + 'errorMessage' => 'The specified DedicatedHostGroup does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DedicatedHostId\\": \\"ch-bp183v72jr033****\\",\\n \\"RequestId\\": \\"C6C6CF41-F284-4F63-AB4D-44FACE3BASQW\\",\\n \\"Disks\\": [\\n {\\n \\"Type\\": \\"data\\",\\n \\"Status\\": \\"In_use\\",\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"DiskId\\": \\"d-bp1dffpog8r2eowd****\\",\\n \\"MaxThroughput\\": 284,\\n \\"MaxIOPS\\": 18250,\\n \\"HasDBInstance\\": true,\\n \\"Device\\": \\"/dev/xvdb\\",\\n \\"Size\\": 329,\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Category\\": \\"cloud_essd\\",\\n \\"DBInstanceId\\": \\"rm-bp121zcqr5h8m****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDedicatedHostDisksResponse>\\n<DedicatedHostId>ch-bp183v72jr033****</DedicatedHostId>\\n<RequestId>C6C6CF41-F284-4F63-AB4D-44FACE3BASQW</RequestId>\\n<Disks>\\n <Status>In_use</Status>\\n <HasDBInstance>true</HasDBInstance>\\n <MaxThroughput/>\\n <Type>data</Type>\\n <Category>cloud</Category>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <DBInstanceId>rm-bp121zcqr5h8m****</DBInstanceId>\\n <Size>329</Size>\\n <Device>/dev/xvdb</Device>\\n <PerformanceLevel>PL1</PerformanceLevel>\\n <MaxIOPS>18250</MaxIOPS>\\n <DiskId>d-bp1dffpog8r2eowd****</DiskId>\\n</Disks>\\n</DescribeDedicatedHostDisksResponse>","errorExample":""}]', + 'title' => 'DescribeDedicatedHostDisks', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDedicatedHostAttribute' => [ + 'summary' => 'Specifies whether instances can be deployed on a host in a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74526', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The [region ID](~~198326~~) of the host.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can log on to the ApsaraDB for MyBase console and go to the **Hosts** page to view the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mysql-host', + ], + ], + [ + 'name' => 'AllocationStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether instances can be deployed on the host. Valid values:'."\n" + ."\n" + .'* **1**: yes.'."\n" + .'* **0**: no.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ESFS', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The userid have no permission.', + ], + [ + 'errorCode' => 'ParamTypeException', + 'errorMessage' => 'The parameter\'s type error.', + ], + ], + 404 => [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'Specified hostinfo is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ESFS\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDedicatedHostAttributeReponse>\\r\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ESFS</RequestId>\\r\\n</ModifyDedicatedHostAttributeReponse>","errorExample":""}]', + 'title' => 'ModifyDedicatedHostAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReplaceDedicatedHost' => [ + 'summary' => 'Replaces a host in a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74535', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can call the [DescribeDedicatedHosts](~~200944~~) operation to query the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'FailoverMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The switchover method of the primary instance. Valid values:'."\n" + ."\n" + .'* **MaintainTime** (default): The system performs a switchover within a maintenance window. The system switches workloads from the primary instance on the host to the secondary instance on another host, and then restarts the current host. This prevents service interruptions.'."\n" + .'* **Immediate**: The system immediately restarts the host.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MaintainTime', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DedicatedHostId' => [ + 'description' => 'The ID of the host in the dedicated cluster.'."\n", + 'type' => 'string', + 'example' => ' ch-bp10a5id3boqi****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22EDSD8', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10254125', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDedicatedHostId_NotFound', + 'errorMessage' => 'specific DedicatedHostId not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DedicatedHostId\\": \\" ch-bp10a5id3boqi****\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22EDSD8\\",\\n \\"TaskId\\": 10254125\\n}","errorExample":""},{"type":"xml","example":"<ReplaceDedicatedHostReponse>\\n<DedicatedHostId> dhg-6w7q18iwt5jo****</DedicatedHostId>\\n<TaskId>10254125</TaskId>\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22EDSD8</RequestId>\\n</ReplaceDedicatedHostReponse>","errorExample":""}]', + 'title' => 'ReplaceDedicatedHost', + 'description' => 'If you specify the manual host replacement policy when you create an ApsaraDB MyBase for MySQL dedicated cluster, you can call this operation to replace a **faulty** host in the dedicated cluster.'."\n" + ."\n" + .'> You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the value of the **HostStatus** parameter.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestartDedicatedHost' => [ + 'summary' => 'Restarts a host in a dedicated cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74537', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '[The region ID](~~198326~~) of the host.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can log on to the ApsaraDB for MyBase console and go to the **Hosts** page to view the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'FailoverMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The switchover method of the primary instance. Valid values:'."\n" + ."\n" + .'* **MaintainTime** (default): The system performs a switchover within a maintenance window. The system switches workloads from the primary instance on the host to the secondary instance on another host, and then restarts the current host. This prevents service interruptions.'."\n" + .'* **Immediate**: The system immediately restarts the host.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MaintainTime', + ], + ], + [ + 'name' => 'ForceStop', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to forcefully restart the host. Valid values:'."\n" + ."\n" + .'* true: The system forcefully restarts the host. If this value is used, the system powers off the host. This results in the loss of cached data that is not written to storage. Exercise caution when you select this value.'."\n" + .'* false (default): The system restarts the host normally.'."\n" + ."\n" + .'> This parameter takes effect only for hosts that are created in ApsaraDB MyBase for Redis dedicated clusters of the Enhanced Edition (Tair). Hosts that are created in ApsaraDB MyBase dedicated clusters that run other database engines can be restarted normally.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DedicatedHostId' => [ + 'description' => 'The host ID.'."\n", + 'type' => 'string', + 'example' => 'ch-bp10a5id3boqi****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22EDSH', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10254125', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The userid have no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAction.NotSupport', + 'errorMessage' => 'The host status does not support the operation.', + ], + ], + [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'Specified hostinfo is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DedicatedHostId\\": \\"ch-bp10a5id3boqi****\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22EDSH\\",\\n \\"TaskId\\": 10254125\\n}","errorExample":""},{"type":"xml","example":"<RestartDedicatedHostReponse>\\n<DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>\\n<TaskId>10254125</TaskId>\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22EDSH</RequestId>\\n</RestartDedicatedHostReponse>","errorExample":""}]', + 'title' => 'RestartDedicatedHost', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeHostWebShell' => [ + 'summary' => 'Queries the URL of a webshell that is used to access a host.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76551', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can call the [DescribeDedicatedHosts](~~200944~~) operation to query the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the host. You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the zone ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LoginUrl' => [ + 'description' => 'The URL of the webshell.'."\n", + 'type' => 'string', + 'example' => 'https://ecs-workbench-disposable.aliyun.com/account/disposable/login/sst/mybase.c7dfa64e9f/m44kih****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ESTG2', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The user ID has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidInstance', + 'errorMessage' => 'The instance does not support the operation.', + ], + ], + [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'The specified host info is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LoginUrl\\": \\"https://ecs-workbench-disposable.aliyun.com/account/disposable/login/sst/mybase.c7dfa64e9f/m44kih****\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ESTG2\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeHostWebShellReponse>\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ESTG2</RequestId>\\n<LoginUrl>https://ecs-workbench-disposable.aliyun.com/account/disposable/login/sst/mybase.c7dfa64e9f/m44kih****</LoginUrl>\\n</DescribeHostWebShellReponse>","errorExample":""}]', + 'title' => 'DescribeHostWebShell', + 'description' => 'You can use a webshell to access a host in an ApsaraDB MyBase for MySQL or ApsaraDB MyBase for PostgreSQL dedicated cluster. For more information, see [Use a webshell to access a host](~~205456~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDedicatedHostClass' => [ + 'summary' => 'Upgrades host specifications.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76557', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The [region ID](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can log on to the ApsaraDB for MyBase console and go to the **Hosts** page to view the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp1fgj3kt7fsb****', + ], + ], + [ + 'name' => 'TargetClassCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type to which you want the host to be upgraded. For more information, see [Host specification details](~~206343~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds.c6.x4large', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when you want to upgrade the specifications of the host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> This parameter must be specified only when SwitchTimeMode is set to 2.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2021-07-13T07:14:22Z', + ], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution mode that is used to upgrade host specifications. Valid values:'."\n" + ."\n" + .'* **0** (default): immediately upgrades host specifications.'."\n" + .'* **2**: upgrades host specifications at a specified point in time.'."\n" + ."\n" + .'> If you set this parameter to **2**, you must specify **SwitchTime**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DedicatedHostId' => [ + 'description' => 'The host ID.'."\n", + 'type' => 'string', + 'example' => 'ch-bp1fgj3kt7fsb****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ESD12', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '10254125', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAction', + 'errorMessage' => 'The specified action is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DedicatedHostId\\": \\"ch-bp1fgj3kt7fsb****\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ESD12\\",\\n \\"TaskId\\": \\"10254125\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDedicatedHostClassReponse>\\n<DedicatedHostId>ch-bp1fgj3kt7fsb****</DedicatedHostId>\\n<TaskId>10254125</TaskId>\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ESD12</RequestId>\\n</ModifyDedicatedHostClassReponse>","errorExample":""}]', + 'title' => 'ModifyDedicatedHostClass', + 'description' => 'After a host is created in a dedicated cluster, you can modify the specifications of the host based on your business requirements. The host specifications include the CPU and memory resources. For more information, see [Upgrade host specifications](~~262822~~).'."\n" + ."\n" + .'> When you upgrade the specifications of a host, the host restarts. The database instances that are running on the host also restart. For information about the impacts of a host restart, see [Restart a host](~~141772~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to hosts.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94226', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of host N. You can specify multiple host IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of host N. You can specify multiple host IDs. **N** specifies the serial number of the host. Examples:'."\n" + ."\n" + .'* **ResourceId.1** specifies the ID of the first host.'."\n" + .'* **ResourceId.2** specifies the ID of the second host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ch-bp1yp3mqggn8****', + ], + 'required' => true, + 'example' => 'ch-t4n4dcdvu6840****', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N.'."\n" + ."\n" + .'* **N** specifies the serial number of the tag. Examples:'."\n" + ."\n" + .' * **Tag.1.Key** specifies the key of the first tag.'."\n" + .' * **Tag.2.Key** specifies the key of the second tag.'."\n" + ."\n" + .'* If no tag key exists, a key is automatically created.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demokey', + ], + 'Value' => [ + 'description' => 'The value of tag N.'."\n" + ."\n" + .'* **N** specifies the serial number of the tag. Examples:'."\n" + ."\n" + .' * **Tag.1.Value** specifies the value of the first tag.'."\n" + .' * **Tag.2.Value** specifies the value of the second tag.'."\n" + ."\n" + .'* If no tag value exists, a value is automatically created.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'demovalue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to DEDICATEDHOST.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DEDICATEDHOST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4B938011-874B-5F54-8B9E-7E2A08B3AA13', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.QuotaExceed', + 'errorMessage' => 'The Tags parameter number is exceed. Valid is 20.', + ], + [ + 'errorCode' => 'NoPermission.SystemTag', + 'errorMessage' => 'The operator is not permission for the system tag', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.%s.Value parameter - %s is invalid', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.%s.Key parameter - %s is invalid', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter "Tag.n.Value" is not valid.', + ], + [ + 'errorCode' => 'InvalidDedicatedHostId.NotFound', + 'errorMessage' => 'The parameter - ResourceIds.N is not found.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The specified parameter "ResourceType" is not valid.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed, Valid : 20.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contain duplicate key.', + ], + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B938011-874B-5F54-8B9E-7E2A08B3AA13\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>4B938011-874B-5F54-8B9E-7E2A08B3AA13</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => 'TagResources', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the information about tags that are added to hosts.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '95097', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to DEDICATEDHOST.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DEDICATEDHOST', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of host N. You can specify multiple host IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of host N. You can specify multiple host IDs.'."\n" + ."\n" + .'**N** specifies the serial number of the host. Examples:'."\n" + ."\n" + .'* **ResourceId.1** specifies the ID of the first host.'."\n" + .'* **ResourceId.2** specifies the ID of the second host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ch-t4n4dcdvu6840****', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N.'."\n" + ."\n" + .'* **N** specifies the serial number of the tag. Examples:'."\n" + ."\n" + .' * **Tag.1.Key** specifies the key of the first tag.'."\n" + .' * **Tag.2.Key** specifies the key of the second tag.'."\n" + ."\n" + .'* You must specify one of this parameter and **ResourceId.N**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demokey', + ], + 'Value' => [ + 'description' => 'The value of tag N.'."\n" + ."\n" + .'* **N** specifies the serial number of the tag. Examples:'."\n" + ."\n" + .' * **Tag.1.Value** specifies the value of the first tag.'."\n" + .' * **Tag.2.Value** specifies the value of the second tag.'."\n" + ."\n" + .'* If no tag value exists, a value is automatically created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demovalue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2853CAA0-D7A2-5CAB-B3A8-BDE2994F320C', + ], + 'TagResources' => [ + 'description' => 'The queried tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'demovalue', + ], + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'ALIYUN::CDDC::DEDICATEDHOST is returned, which indicates an ApsaraDB for MyBase host.'."\n", + 'type' => 'string', + 'example' => 'ALIYUN::CDDC::DEDICATEDHOST', + ], + 'ResourceId' => [ + 'description' => 'The host ID.'."\n", + 'type' => 'string', + 'example' => 'ch-t4n4dcdvu6840****', + ], + 'TagKey' => [ + 'description' => 'The key of tag N.'."\n", + 'type' => 'string', + 'example' => 'demokey', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingResourceType', + 'errorMessage' => 'The specified parameter ResourceType is not valid.', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.%s.Value parameter - %s is invalid', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.%s.Key parameter - %s is invalid', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter "Tag.n.Value" is not valid.', + ], + [ + 'errorCode' => 'InvalidDedicatedHostId.NotFound', + 'errorMessage' => 'The parameter - ResourceIds.N is not found.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The specified parameter "ResourceType" is not valid.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed, Valid : 20.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contain duplicate key.', + ], + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2853CAA0-D7A2-5CAB-B3A8-BDE2994F320C\\",\\n \\"TagResources\\": [\\n {\\n \\"TagValue\\": \\"demovalue\\",\\n \\"ResourceType\\": \\"ALIYUN::CDDC::DEDICATEDHOST\\",\\n \\"ResourceId\\": \\"ch-t4n4dcdvu6840****\\",\\n \\"TagKey\\": \\"demokey\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <RequestId>2853CAA0-D7A2-5CAB-B3A8-BDE2994F320C</RequestId>\\n <TagResources>\\n <TagValue>demovalue</TagValue>\\n <ResourceType>ALIYUN::CDDC::DEDICATEDHOST</ResourceType>\\n <ResourceId>ch-t4n4dcdvu6840****</ResourceId>\\n <TagKey>demokey</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from hosts.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '95095', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of host N. You can specify multiple host IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of host N. You can specify multiple host IDs.'."\n" + ."\n" + .'**N** specifies the serial number of the host. Examples:'."\n" + ."\n" + .'Resourceid.1 specifies the ID of the first host.'."\n" + ."\n" + .'Resourceid.2 specifies the ID of the second host.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ch-t4n4dcdvu6840****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The key of tag N.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of tag N.'."\n" + ."\n" + .'* **N** specifies the serial number of the tag. Examples:'."\n" + ."\n" + .' * **Tag.1.Key** specifies the key of the first tag.'."\n" + .' * **Tag.2.Key** specifies the key of the second tag.'."\n" + ."\n" + .'* If no tag key exists, a key is automatically created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demokey', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags from the host. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> If you specify both this parameter and the TagKey.N parameter, this parameter does not take effect.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to DEDICATEDHOST.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DEDICATEDHOST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B74AD197-214C-50F2-BF7D-B13632EE4D75', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.SystemTag', + 'errorMessage' => 'The operator is not permission for the system tag', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.%s.Value parameter - %s is invalid', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.%s.Key parameter - %s is invalid', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed , Valid : 50', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter "Tag.n.Value" is not valid.', + ], + [ + 'errorCode' => 'InvalidDedicatedHostId.NotFound', + 'errorMessage' => 'The parameter - ResourceIds.N is not found.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The specified parameter "ResourceType" is not valid.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed, Valid : 20.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The parameter - ResourceIds.N should not be null.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contain duplicate key.', + ], + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B74AD197-214C-50F2-BF7D-B13632EE4D75\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>B74AD197-214C-50F2-BF7D-B13632EE4D75</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => 'UntagResources', + ], + 'CreateDedicatedHostAccount' => [ + 'summary' => 'Creates an account for a host.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74474', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can call the [DescribeDedicatedHosts](~~200944~~) operation to query the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the host account.'."\n" + ."\n" + .'* The name must be 2 to 16 characters in length.'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the host account.'."\n" + ."\n" + .'* The password must be 6 to 32 characters in length.'."\n" + .'* The password must contain three of the following character types: upper letters, lower letters, digits, and special characters.'."\n" + .'* The password can contain the following special characters: `! @ # $ % ^ & * ( ) _ + - =`'."\n" + ."\n" + .'> If your host runs SQL Server, the password cannot contain the account name (case-insensitive).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BastionInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the bastion host with which the host is associated. You can log on to the ApsaraDB for MyBase console and go to the **Bastion Hosts** page to view the bastion host ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bastionhost-cn-xxxxxxxxxxx', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the host account. Valid values:'."\n" + ."\n" + .'* **Normal**: standard account.'."\n" + .'* **Admin**: administrator account.'."\n" + ."\n" + .'For more information, see [Host permissions](~~176240~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Admin', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ETnLKlblzczshOTUbOCz*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E12AS', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountPassword.Format', + 'errorMessage' => 'The account password format is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAction.NotSupport', + 'errorMessage' => 'The host status does not support the operation.', + ], + ], + [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'The host is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E12AS\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDedicatedHostAccountReponse>\\r\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22E12AS</RequestId>\\r\\n</CreateDedicatedHostAccountReponse>","errorExample":""}]', + 'title' => 'CreateDedicatedHostAccount', + 'description' => 'Each host can have only one account. Before you create an account for a host, make sure that the existing account of the host is deleted. For more information, see [Create an account for a host](~~211413~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDedicatedHostAccount' => [ + 'summary' => 'Deletes a host account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74477', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can call the [DescribeDedicatedHosts](~~200944~~) operation to query the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the host account.'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* The name must be 2 to 16 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E12AS', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'Specified hostinfo is not found.', + ], + [ + 'errorCode' => 'InvalidAccountName.NotFound', + 'errorMessage' => 'Specified account name does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E12AS\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDedicatedHostAccountResponse>\\r\\n <RequestId>D6E068C3-25BC-455A-85FE-45F0B22E12AS</RequestId>\\r\\n</DeleteDedicatedHostAccountResponse> ","errorExample":""}]', + 'title' => 'DeleteDedicatedHostAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDedicatedHostPassword' => [ + 'summary' => 'Changes the root account password of a host.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76558', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NewPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new password.'."\n" + ."\n" + .'* The password must be 8 to 32 characters in length.'."\n" + .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* The password can contain the following special characters: `! @ # $ % ^ & * ( ) _ + - =`'."\n" + ."\n" + .'> If your dedicated cluster runs SQL Server, the password cannot contain the account name (case-insensitive).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test*****', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can call the [DescribeDedicatedHosts](~~200944~~) operation to query the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi**** ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DedicatedHostName' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => 'test123****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E12AS', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstance.NotFound', + 'errorMessage' => 'The specified instance does not exist or is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DedicatedHostName\\": \\"test123****\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E12AS\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDedicatedHostPasswordReponse>\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22E12AS</RequestId>\\n<DedicatedHostName>test123****</DedicatedHostName>\\n</ModifyDedicatedHostPasswordReponse>","errorExample":""}]', + 'title' => 'ModifyDedicatedHostPassword', + 'description' => 'This operation is supported only for ApsaraDB MyBase for Redis Enhanced Edition (Tair) dedicated clusters.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDedicatedHostAccount' => [ + 'summary' => 'Changes the account name and password of a host.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74525', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can call the [DescribeDedicatedHosts](~~200944~~) operation to query the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp10a5id3boqi****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account name of the host.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new account password of the host.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can call the [DescribeDedicatedHostAttribute](~~213010~~) operation to query the region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.NotSupport', + 'errorMessage' => 'The userid have no permission.', + ], + ], + 404 => [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'Specified hostinfo is not found.', + ], + [ + 'errorCode' => 'InvalidAccountName.NotFound', + 'errorMessage' => 'Specified account name does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDedicatedHostAccountReponse>\\r\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>\\r\\n</ModifyDedicatedHostAccountReponse>","errorExample":""}]', + 'title' => 'ModifyDedicatedHostAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryHostInstanceConsoleInfo' => [ + 'summary' => 'Queries the information about instances that are deployed on a host.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74534', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the host. You can log on to the ApsaraDB for MyBase console to view the [region ID](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host ID. You can log on to the ApsaraDB for MyBase console and go to the **Hosts** page to view the host ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch-bp1fgj3kt7fsb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'HostInstanceConsoleInfos' => [ + 'description' => 'The queried instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the instance.'."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'MaxConnIncreaseRatioValue' => [ + 'description' => 'The maximum number of connections to the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1300', + ], + 'MemSize' => [ + 'description' => 'The memory size of the instance. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'DiskSize' => [ + 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Ip' => [ + 'description' => 'The IP address of the host on which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => '172.22.XX.XX', + ], + 'Port' => [ + 'description' => 'The port number of the host.'."\n", + 'type' => 'string', + 'example' => '3443', + ], + 'EngineVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '5.8', + ], + 'MemoryIncreaseRatioValue' => [ + 'description' => 'The maximum memory size of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'CpuIncreaseRatioValue' => [ + 'description' => 'The maximum number of CPU cores of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1m5z8002gyj****', + ], + 'Engine' => [ + 'description' => 'The database engine of the instance.'."\n", + 'type' => 'string', + 'example' => 'mysql', + ], + 'LevelName' => [ + 'description' => 'The instance type of the instance.'."\n", + 'type' => 'string', + 'example' => 'mysql.z2.medium.2', + ], + 'Role' => [ + 'description' => 'The role of the instance.'."\n", + 'type' => 'string', + 'example' => 'master', + ], + 'DBInstanceDescription' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1m5z8002gyj****', + ], + 'CpuCores' => [ + 'description' => 'The number of CPU cores of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'PerfInfo' => [ + 'description' => 'The performance information of the host on which the instance is deployed.'."\n", + 'type' => 'object', + 'properties' => [ + 'PerfIdbPio' => [ + 'description' => 'The number of physical I/O operations performed on the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + 'DiskCurr' => [ + 'description' => 'The disk storage of the host. Unit: GB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + 'MemRatio' => [ + 'description' => 'The memory size of the host. Unit: GB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '64', + ], + 'CpuRatio' => [ + 'description' => 'The number of CPU cores of the host.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '16', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Permission.NotSupport', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + [ + [ + 'errorCode' => 'HostInfo.NotFound', + 'errorMessage' => 'The host is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"HostInstanceConsoleInfos\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"MaxConnIncreaseRatioValue\\": 1300,\\n \\"MemSize\\": 16,\\n \\"DiskSize\\": 500,\\n \\"Ip\\": \\"172.22.XX.XX\\",\\n \\"Port\\": \\"3443\\",\\n \\"EngineVersion\\": \\"5.8\\",\\n \\"MemoryIncreaseRatioValue\\": 64,\\n \\"CpuIncreaseRatioValue\\": 16,\\n \\"DBInstanceId\\": \\"rm-bp1m5z8002gyj****\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"LevelName\\": \\"mysql.z2.medium.2\\",\\n \\"Role\\": \\"master\\",\\n \\"DBInstanceDescription\\": \\"rm-bp1m5z8002gyj****\\",\\n \\"CpuCores\\": 8,\\n \\"PerfInfo\\": {\\n \\"PerfIdbPio\\": 30,\\n \\"DiskCurr\\": 1000,\\n \\"MemRatio\\": 64,\\n \\"CpuRatio\\": 16\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryHostInstanceConsoleInfoResponse>\\n <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>\\n <HostInstanceConsoleInfos>\\n <Status>RUNNING</Status>\\n <MaxConnIncreaseRatioValue>1300</MaxConnIncreaseRatioValue>\\n <MemSize>16</MemSize>\\n <DiskSize>500</DiskSize>\\n <Ip>172.22.XX.XX</Ip>\\n <Port>3443</Port>\\n <EngineVersion>5.8</EngineVersion>\\n <MemoryIncreaseRatioValue>64</MemoryIncreaseRatioValue>\\n <CpuIncreaseRatioValue>16</CpuIncreaseRatioValue>\\n <DBInstanceId>rm-bp1m5z8002gyj****</DBInstanceId>\\n <Engine>mysql</Engine>\\n <LevelName>mysql.z2.medium.2</LevelName>\\n <Role>master</Role>\\n <DBInstanceDescription>rm-bp1m5z8002gyj****</DBInstanceDescription>\\n <CpuCores>8</CpuCores>\\n <PerfInfo>\\n <PerfIdbPio>30</PerfIdbPio>\\n <DiskCurr>1000</DiskCurr>\\n <MemRatio>64</MemRatio>\\n <CpuRatio>16</CpuRatio>\\n </PerfInfo>\\n </HostInstanceConsoleInfos>\\n</QueryHostInstanceConsoleInfoResponse>","errorExample":""}]', + 'title' => 'QueryHostInstanceConsoleInfo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryHostBaseInfoByInstance' => [ + 'summary' => 'Queries the basic information about the host on which an instance is deployed.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74533', + 'abilityTreeNodes' => [ + 'FEATUREcddcZHIXH7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-bp15rszyxs4t3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E12CV', + ], + 'HostInstanceConsoleInfos' => [ + 'description' => 'The queried host and instance information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID of the host on which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1ov7as4yvz4kxei****', + ], + 'Status' => [ + 'description' => 'The state of the instance.'."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ExpiredTime' => [ + 'description' => 'The expiration time of the instance.'."\n", + 'type' => 'string', + 'example' => '2021.07.20', + ], + 'ClusterName' => [ + 'description' => 'The instance type of the instance.'."\n", + 'type' => 'string', + 'example' => 'rds.ebmr6.26xlarge', + ], + 'Ip' => [ + 'description' => 'The IP address of the host on which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => ' 172.22.0.***', + ], + 'HostName' => [ + 'description' => 'The name of the host on which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => 'ch-bp1fgj3kt7fsb****', + ], + 'Engine' => [ + 'description' => 'The database engine of the instance.'."\n", + 'type' => 'string', + 'example' => 'mysql', + ], + 'Role' => [ + 'description' => 'The role of the instance.'."\n", + 'type' => 'string', + 'example' => 'master', + ], + 'Port' => [ + 'description' => 'The port number of the host on which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => '3443', + ], + 'EngineVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Permission.NotSupport', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstance.NotFound', + 'errorMessage' => 'The specified instance does not exist or is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E12CV\\",\\n \\"HostInstanceConsoleInfos\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1ov7as4yvz4kxei****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExpiredTime\\": \\"2021.07.20\\",\\n \\"ClusterName\\": \\"rds.ebmr6.26xlarge\\",\\n \\"Ip\\": \\" 172.22.0.***\\",\\n \\"HostName\\": \\"ch-bp1fgj3kt7fsb****\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"Role\\": \\"master\\",\\n \\"Port\\": \\"3443\\",\\n \\"EngineVersion\\": \\"5.7\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryHostBaseInfoByInstanceResponse>\\n<RequestId>D6E068C3-25BC-455A-85FE-45F0B22E12CV</RequestId>\\n<HostInstanceConsoleInfos>\\n <Status>RUNNING</Status>\\n <Role>master</Role>\\n <EngineVersion>5.7</EngineVersion>\\n <VpcId>vpc-bp1ov7as4yvz4kxei****</VpcId>\\n <ExpiredTime>2021.07.20</ExpiredTime>\\n <Port>3443</Port>\\n <Ip> 172.22.0.***</Ip>\\n <ClusterName>rds.ebmr6.26xlarge</ClusterName>\\n <HostName>ch-bp1fgj3kt7fsb****</HostName>\\n <Engine>mysql</Engine>\\n</HostInstanceConsoleInfos>\\n<QueryHostBaseInfoByInstanceResponse>","errorExample":""}]', + 'title' => 'QueryHostBaseInfoByInstance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddPrinsInstance' => [ + 'summary' => 'Adds a self-managed MyBase instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226388', + 'abilityTreeNodes' => [ + 'FEATUREcddcSRVFXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EcsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ECS instance to be managed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1726beecvi8kak****', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine type that is used to filter hosts. Valid values:'."\n" + ."\n" + .'* MySQL'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance port number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'Disk', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried disks.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the cloud disk or local disk. Valid values:'."\n" + ."\n" + .'* **system**: system disk'."\n" + .'* **data**: data disk'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + 'DiskId' => [ + 'description' => 'The ID of the cloud disk or local disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-2vc9qpza81r6t2nx****', + ], + 'Category' => [ + 'description' => 'The disk category. Valid values:'."\n" + ."\n" + .'* **cloud_efficiency**: ultra disk.'."\n" + .'* **cloud_ssd**: standard SSD.'."\n" + .'* **cloud_essd**: enterprise SSD (ESSD).'."\n" + .'* **cloud**: basic disk'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'Device' => [ + 'description' => 'The device name of the cloud or local disk mounted on the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/dev/xvda', + ], + 'Mount' => [ + 'description' => 'The mount point.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/data', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database username.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'username', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database connection password.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'password', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group specified when adding the managed instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-t4neld965n89ocvt****', + ], + ], + [ + 'name' => 'Alias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alias', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5C887C7-EAF1-40B7-88FE-2C45D4DB****', + ], + 'CustInstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'CustInstanceName' => [ + 'description' => 'The globally unique name of the instance.'."\n", + 'type' => 'string', + 'example' => 'pr-22a21ac289e0****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5C887C7-EAF1-40B7-88FE-2C45D4DB****\\",\\n \\"CustInstanceId\\": \\"1\\",\\n \\"CustInstanceName\\": \\"pr-22a21ac289e0****\\"\\n}","type":"json"}]', + 'title' => 'AddPrinsInstance', + ], + 'CreatePrinsBackupPlan' => [ + 'summary' => 'Creates a backup plan for a managed instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '212746', + 'abilityTreeNodes' => [ + 'FEATUREcddcGJUHY1', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pr-22a21ac289e0****', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specification of the backup plan. Valid values:'."\n" + ."\n" + .'* **micro**'."\n" + .'* **small**'."\n" + .'* **medium**'."\n" + .'* **large**'."\n" + .'* **xlarge**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'micro', + 'enum' => [ + 'micro', + 'small', + 'medium', + 'large', + 'xlarge', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the purchase duration.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Month', + 'enum' => [ + 'Month', + 'Year', + ], + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration. Valid values:'."\n" + ."\n" + .'* If **Period** is set to **Year**, the values of **UsedTime** can be from 1 to 9.'."\n" + .'* If **Period** is set to **Month**, the valid values of **UsedTime** can be from 1 to 11.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '11', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'EcsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ECS instance to be backed up.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp1726beecvi8kak****', + ], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The full backup cycle. Valid values:'."\n" + ."\n" + .'* Monday'."\n" + .'* Tuesday'."\n" + .'* Wednesday'."\n" + .'* Thursday'."\n" + .'* Friday'."\n" + .'* Saturday'."\n" + .'* Sunday'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can select multiple values and separate them with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Monday', + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup start time in HH:mm format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '14:22', + ], + ], + [ + 'name' => 'BackupPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom name for the backup plan.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '22A601D7-3E6E-559D-B845-F643142C611E', + ], + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.'."\n", + 'type' => 'string', + 'example' => 'dbsrhm5j8rm****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22A601D7-3E6E-559D-B845-F643142C611E\\",\\n \\"BackupPlanId\\": \\"dbsrhm5j8rm****\\"\\n}","type":"json"}]', + 'title' => 'CreatePrinsBackupPlan', + 'description' => 'Before you call this operation, make sure that you fully understand the billing methods and [pricing](~~2858407~~) of DBS backup plans.'."\n", + ], + 'DescribePrinsInstance' => [ + 'summary' => 'Retrieves the details of a managed instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212752', + 'abilityTreeNodes' => [ + 'FEATUREcddcGJUHY1', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pr-22a21ac289e0****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '[Region ID](~~198326~~)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Discover', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query associated primary and replica instances.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E****', + ], + 'DbInstance' => [ + 'description' => 'The details of the managed instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceName' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'example' => 'pr-22a21ac289e0****', + ], + 'EngineType' => [ + 'description' => 'The engine type. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version.'."\n", + 'type' => 'string', + 'example' => '8.0.36', + ], + 'Status' => [ + 'description' => 'The current status of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* inacitve: Abnormal'."\n" + .'* deleted: Deleted'."\n" + .'* creating: Creating'."\n" + .'* active:Running'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'inacitve' => '', + 'deleted' => '', + 'creating' => '', + 'active' => '', + ], + 'example' => 'active', + ], + 'InstanceClass' => [ + 'description' => 'The instance specification.'."\n", + 'type' => 'string', + 'example' => '2C4G', + ], + 'InstanceStorageType' => [ + 'description' => 'The storage type of the instance.'."\n", + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'InstanceStorageCapacity' => [ + 'description' => 'The storage capacity.'."\n", + 'type' => 'string', + 'example' => '40', + ], + 'GmtCreated' => [ + 'description' => 'The timestamp when the instance was created.'."\n", + 'type' => 'string', + 'example' => '1729758903000', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance.'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) where the cluster is located.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6idhbqkbuw11kw3****', + ], + 'Description' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'HostInstances' => [ + 'description' => 'A list of hosts included in the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreated' => [ + 'description' => 'The timestamp when the host was created.'."\n", + 'type' => 'string', + 'example' => '1729758903000', + ], + 'InstanceId' => [ + 'description' => 'The ECS instance ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp1gmm4pnacse343****', + ], + 'InstanceClass' => [ + 'description' => 'The ECS specification information.'."\n", + 'type' => 'string', + 'example' => 'ecs.c7.large', + ], + 'IpAddress' => [ + 'description' => 'The IP address of the ECS instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'Port' => [ + 'description' => 'The port number that is used to connect to the instance.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'Type' => [ + 'description' => 'The IP address type. Valid values:'."\n" + ."\n" + .'* **Private**: Internal IP'."\n" + .'* **Public**: Public IP'."\n", + 'type' => 'string', + 'example' => 'Private', + ], + ], + 'description' => '', + ], + ], + 'InstanceName' => [ + 'description' => 'The ECS instance name.'."\n", + 'type' => 'string', + 'example' => 'launch-advisor-20250603', + ], + 'Status' => [ + 'description' => 'The ECS host status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* deleted: Deleted'."\n" + .'* inactive: Abnormal'."\n" + .'* active: Running'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'deleted' => '', + 'inactive' => '', + 'active' => '', + ], + 'example' => 'active', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'InstanceRole' => [ + 'description' => 'The role of the host.'."\n" + ."\n" + .'* master'."\n" + .'* slave'."\n", + 'type' => 'string', + 'example' => 'master', + ], + 'DiskInfo' => [ + 'description' => 'The disk information of the ECS instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ECS disk information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The disk ID.'."\n", + 'type' => 'string', + 'example' => 'd-bp1ddpo8lqswottd****', + ], + 'Size' => [ + 'description' => 'The size of the disk. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'Category' => [ + 'description' => 'The disk category. Valid values:'."\n" + ."\n" + .'* **cloud_efficiency**: ultra disk'."\n" + .'* **cloud_ssd**: standard SSD'."\n" + .'* **cloud_essd**: enterprise SSD (ESSD)'."\n" + .'* **cloud**: basic disk'."\n", + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Type' => [ + 'description' => 'The type of the cloud disk or local disk. Valid values:'."\n" + ."\n" + .'* **system**: system disk'."\n" + .'* **data**: data disk'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'Usage' => [ + 'description' => 'The disk usage percentage.'."\n", + 'type' => 'string', + 'example' => '40', + ], + 'Device' => [ + 'description' => 'The device name of the disk mounted on the instance.'."\n", + 'type' => 'string', + 'example' => '/dev/xvda', + ], + ], + ], + ], + 'Cpu' => [ + 'description' => 'The number of the CPU cores on the host.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Mem' => [ + 'description' => 'The memory size, in GB.'."\n", + 'type' => 'string', + 'example' => '4', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC where the host is located.'."\n", + 'type' => 'string', + 'example' => ' vpc-bp1d5gyhoue53eu6h****', + ], + 'Port' => [ + 'description' => 'The host port.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'Description' => [ + 'description' => 'The description of the host.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Ip' => [ + 'description' => 'The host IP address selected when the instance was added for management.'."\n", + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'SecurityGroupId' => [ + 'description' => 'The security group ID specified when the instance was added for management.'."\n", + 'type' => 'string', + 'example' => 'sg-uf6bo3fxuuen4uxndp9j', + ], + ], + 'description' => '', + ], + ], + 'Tag' => [ + 'description' => 'A list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'description' => 'The tag value'."\n", + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'DmsId' => [ + 'description' => 'The ID of the associated DMS instance.'."\n", + 'type' => 'string', + 'example' => '2717906', + ], + 'DasId' => [ + 'description' => 'The ID of the associated DAS instance.'."\n", + 'type' => 'string', + 'example' => 'hdm_ef2263e117f23c4f3114417742b4****', + ], + 'Alias' => [ + 'description' => 'The alias of the instance.'."\n", + 'type' => 'string', + 'example' => 'alias', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E****\\",\\n \\"DbInstance\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceName\\": \\"pr-22a21ac289e0****\\",\\n \\"EngineType\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"8.0.36\\",\\n \\"Status\\": \\"active\\",\\n \\"InstanceClass\\": \\"2C4G\\",\\n \\"InstanceStorageType\\": \\"cloud_essd\\",\\n \\"InstanceStorageCapacity\\": \\"40\\",\\n \\"GmtCreated\\": \\"1729758903000\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"VpcId\\": \\"vpc-uf6idhbqkbuw11kw3****\\",\\n \\"Description\\": \\"test\\",\\n \\"HostInstances\\": [\\n {\\n \\"GmtCreated\\": \\"1729758903000\\",\\n \\"InstanceId\\": \\"i-bp1gmm4pnacse343****\\",\\n \\"InstanceClass\\": \\"ecs.c7.large\\",\\n \\"IpAddress\\": [\\n {\\n \\"Ip\\": \\"127.0.0.1\\",\\n \\"Port\\": \\"3306\\",\\n \\"Type\\": \\"Private\\"\\n }\\n ],\\n \\"InstanceName\\": \\"launch-advisor-20250603\\",\\n \\"Status\\": \\"active\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"InstanceRole\\": \\"master\\",\\n \\"DiskInfo\\": [\\n {\\n \\"Id\\": \\"d-bp1ddpo8lqswottd****\\",\\n \\"Size\\": 50,\\n \\"Category\\": \\"cloud_essd\\",\\n \\"Type\\": \\"system\\",\\n \\"Usage\\": \\"40\\",\\n \\"Device\\": \\"/dev/xvda\\"\\n }\\n ],\\n \\"Cpu\\": \\"2\\",\\n \\"Mem\\": \\"4\\",\\n \\"VpcId\\": \\" vpc-bp1d5gyhoue53eu6h****\\",\\n \\"Port\\": \\"3306\\",\\n \\"Description\\": \\"test\\",\\n \\"Ip\\": \\"127.0.0.1\\",\\n \\"SecurityGroupId\\": \\"sg-uf6bo3fxuuen4uxndp9j\\"\\n }\\n ],\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"DmsId\\": \\"2717906\\",\\n \\"DasId\\": \\"hdm_ef2263e117f23c4f3114417742b4****\\",\\n \\"Alias\\": \\"alias\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribePrinsInstance', + ], + 'DescribePrinsBackupPlan' => [ + 'summary' => 'Queries the details of a DBS backup plan created on the MyBase managed instance page. An empty response indicates that no backup plan has been created for the managed instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212746', + 'abilityTreeNodes' => [ + 'FEATUREcddcGJUHY1', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pr-22a21ac289e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22****', + ], + 'BackupPlan' => [ + 'description' => 'The details of the backup plan.'."\n", + 'type' => 'object', + 'properties' => [ + 'BackupPlanId' => [ + 'description' => 'The ID of the backup plan.'."\n", + 'type' => 'string', + 'example' => 'dbsrhm5j8rm****', + ], + 'BackupPlanName' => [ + 'description' => 'The name of the backup plan.'."\n", + 'type' => 'string', + 'example' => 'test****', + ], + 'UserName' => [ + 'description' => 'The name of the database account used for the backup.'."\n", + 'type' => 'string', + 'example' => 'test_user', + ], + 'EcsInstanceId' => [ + 'description' => 'The ID of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp1726beecvi8kak****', + ], + 'BackupStartTime' => [ + 'description' => 'The backup start time in HH:mm format.'."\n", + 'type' => 'string', + 'example' => '14:22', + ], + 'InstanceClass' => [ + 'description' => 'The specifications. Valid values:'."\n" + ."\n" + .'* **micro**: Micro'."\n" + .'* **small**: Small'."\n" + .'* **medium**: Medium'."\n" + .'* **large**: Large'."\n" + .'* **xlarge**: Extra Large (unlimited traffic)'."\n", + 'type' => 'string', + 'example' => 'micro', + ], + 'BackupPeriod' => [ + 'description' => 'The full backup cycle. Valid values:'."\n" + ."\n" + .'* Monday'."\n" + .'* Tuesday'."\n" + .'* Wednesday'."\n" + .'* Thursday'."\n" + .'* Friday'."\n" + .'* Saturday'."\n" + .'* Sunday'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can select multiple values, separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'Monday', + ], + 'BackupPlanStatus' => [ + 'description' => 'The status of the backup plan. Valid values:'."\n" + ."\n" + .'* **wait**: Not configured'."\n" + .'* **init**: Not started (Pre-check failed)'."\n" + .'* **running**: Running'."\n" + .'* **stop**: Failed'."\n" + .'* **pause**: Paused'."\n" + .'* **locked**: Locked'."\n" + .'* **check_pass**: Pre-check passed.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'DatabaseType' => [ + 'description' => 'The type of the database. Valid values:'."\n" + ."\n" + .'* **MYSQL**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'BackupPlanCreateTime' => [ + 'description' => 'The timestamp when the backup plan was created.'."\n", + 'type' => 'string', + 'example' => '1582527713000', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-aek3ckqdbgg****', + ], + ], + ], + 'OssHint' => [ + 'description' => 'Indicates whether the user has activated OSS.'."\n" + ."\n" + .'> If this returns false, a backup plan cannot be created successfully. You must activate OSS first.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22****\\",\\n \\"BackupPlan\\": {\\n \\"BackupPlanId\\": \\"dbsrhm5j8rm****\\",\\n \\"BackupPlanName\\": \\"test****\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"EcsInstanceId\\": \\"i-bp1726beecvi8kak****\\",\\n \\"BackupStartTime\\": \\"14:22\\",\\n \\"InstanceClass\\": \\"micro\\",\\n \\"BackupPeriod\\": \\"Monday\\",\\n \\"BackupPlanStatus\\": \\"running\\",\\n \\"DatabaseType\\": \\"MySQL\\",\\n \\"BackupPlanCreateTime\\": \\"1582527713000\\",\\n \\"ResourceGroupId\\": \\"rg-aek3ckqdbgg****\\"\\n },\\n \\"OssHint\\": true\\n}","type":"json"}]', + 'title' => 'DescribePrinsBackupPlan', + ], + 'DescribePrinsEcsInstances' => [ + 'summary' => 'Queries a list of ECS instance information.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212746', + 'abilityTreeNodes' => [ + 'FEATUREcddcGJUHY1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EcsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ECS instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1726beecvi8kak****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the instance list. Start value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) where the cluster resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-t4nbtmekgxotv0d3y****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '> This parameter is not available. Use PageNumber and PageSize for pagination.'."\n" + ."\n" + .'The maximum number of results to be returned from a single query when the NextToken parameter is used in the query.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '> This parameter is not available. Use PageNumber and PageSize for pagination.'."\n" + ."\n" + .'The query token returned from the current call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query keyword. Supports fuzzy matching on Host ID, Host Name, and Host IP.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'keyword', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E****', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => 'The page number of the instance list. Start value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstanceList' => [ + 'description' => 'ECS instances'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'i-2zeaquy5es02nksh****', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC where the host is located.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6idhbqkbuw11kw3****', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'InstanceName' => [ + 'description' => 'The name of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'launch-advisor-20250530', + ], + 'Stauts' => [ + 'description' => 'The status of the instance.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'IpList' => [ + 'description' => 'The list of IP addresses.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address of the host.'."\n", + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'Type' => [ + 'description' => 'The IP address type. Valid values:'."\n" + ."\n" + .'* **Private**: internal IP'."\n" + .'* **Public**: Public IP'."\n", + 'type' => 'string', + 'example' => 'Private', + ], + ], + ], + ], + 'SecurityGroups' => [ + 'description' => 'A list of security groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-uf66unlpw292cgh6****', + ], + ], + 'Description' => [ + 'description' => 'The description of the ECS host.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Disks' => [ + 'description' => 'A list of disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Disk data'."\n", + 'type' => 'object', + 'properties' => [ + 'DiskId' => [ + 'description' => 'The ID of the cloud disk or local disk.'."\n", + 'type' => 'string', + 'example' => 'd-uf6aa8sjgtc4168f****', + ], + 'Category' => [ + 'description' => 'The disk category. Valid values:'."\n" + ."\n" + .'* **cloud_efficiency**: ultra disk.'."\n" + .'* **cloud_ssd**: standard SSD.'."\n" + .'* **cloud_essd**: enterprise SSD (ESSD).'."\n" + .'* **cloud**: basic disk'."\n", + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Type' => [ + 'description' => 'The type of the cloud disk or local disk. Valid values:'."\n" + ."\n" + .'* **system**: system disk'."\n" + .'* **data**: data disk'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'Device' => [ + 'description' => 'The device name of the disk mounted on the instance.'."\n", + 'type' => 'string', + 'example' => '/dev/xvda', + ], + 'Mount' => [ + 'description' => 'The mount point.'."\n", + 'type' => 'string', + 'example' => '/data', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'MaxResults' => [ + 'description' => '> This parameter is not available. Use PageNumber and PageSize for pagination.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'NextToken' => [ + 'description' => '> This parameter is not available. Use PageNumber and PageSize for pagination.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E****\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"i-2zeaquy5es02nksh****\\",\\n \\"VpcId\\": \\"vpc-uf6idhbqkbuw11kw3****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"InstanceName\\": \\"launch-advisor-20250530\\",\\n \\"Stauts\\": \\"Running\\",\\n \\"IpList\\": [\\n {\\n \\"Ip\\": \\"127.0.0.1\\",\\n \\"Type\\": \\"Private\\"\\n }\\n ],\\n \\"SecurityGroups\\": [\\n \\"sg-uf66unlpw292cgh6****\\"\\n ],\\n \\"Description\\": \\"test\\",\\n \\"Disks\\": [\\n {\\n \\"DiskId\\": \\"d-uf6aa8sjgtc4168f****\\",\\n \\"Category\\": \\"cloud_essd\\",\\n \\"Type\\": \\"system\\",\\n \\"Device\\": \\"/dev/xvda\\",\\n \\"Mount\\": \\"/data\\"\\n }\\n ]\\n }\\n ],\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\"\\n}","type":"json"}]', + 'title' => 'DescribePrinsEcsInstances', + ], + 'GetPrinsEventList' => [ + 'summary' => 'Retrieves a list of events.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212752', + 'abilityTreeNodes' => [ + 'FEATUREcddcGJUHY1', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pr-22a21ac289e0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp for the start of the query time range.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1732253446000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp for the end of the query time range.'."\n" + ."\n" + .'> The interval between StartTime and EndTime cannot exceed 12 hours'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1732255446000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C6592723-09E1-4248-A78E-12AB00D7****', + ], + 'EventList' => [ + 'description' => 'A list of events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The event information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the event.'."\n", + 'type' => 'string', + 'example' => 'Instance:StateChange', + ], + 'Content' => [ + 'description' => 'The description of the system event.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Level' => [ + 'description' => 'The level of the event. Valid values:'."\n" + ."\n" + .'* Critical'."\n" + .'* Warn'."\n" + .'* Info'."\n", + 'type' => 'string', + 'example' => 'Info', + ], + 'Status' => [ + 'description' => 'The status of the event.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'Time' => [ + 'description' => 'The timestamp when the event occurred.'."\n", + 'type' => 'string', + 'example' => '1635993751000', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C6592723-09E1-4248-A78E-12AB00D7****\\",\\n \\"EventList\\": [\\n {\\n \\"Name\\": \\"Instance:StateChange\\",\\n \\"Content\\": \\"实例状态改变通知\\",\\n \\"Level\\": \\"Info\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Time\\": \\"1635993751000\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetPrinsEventList', + ], + 'GetPrinsMetricsList' => [ + 'summary' => 'Retrieves performance metric data for managed instances.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212752', + 'abilityTreeNodes' => [ + 'FEATUREcddcGJUHY1', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ECS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-8vbgsaqkgzk9m24n****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp for the start of the query time range.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1732253446000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp for the end of the query time range.'."\n" + ."\n" + .'> The interval between StartTime and EndTime cannot exceed 12 hours.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1732255446000', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metric information. Specific categories include:'."\n" + ."\n" + .'**DAS**'."\n" + ."\n" + .'* mysql.tps,mysql.qps'."\n" + .'* mysql.threads_running,mysql.threads_connected,mysql.threads_created,mysql.threads_cached,mysql.threads_rejected'."\n" + .'* mysql.delete_ps,mysql.insert_ps,mysql.replace_ps,mysql.update_ps,mysql.select_ps'."\n" + .'* mysql.bytes_received,mysql.bytes_sent'."\n" + .'* mysql.innodb_bp_hit,mysql.innodb_bp_dirty_pct,mysql.innodb_bp_usage_pct'."\n" + .'* mysql.innodb_data_read,mysql.innodb_data_written'."\n" + .'* mysql.innodb_rows_read,mysql.innodb_rows_updated,mysql.innodb_rows_deleted,mysql.innodb_rows_inserted'."\n" + ."\n" + .'**ECS**'."\n" + ."\n" + .'* cpu_total'."\n" + .'* memory_usedutilization'."\n" + .'* load\\_1m,load\\_5m,load\\_15m'."\n" + .'* DiskReadBPS,DiskWriteBPS'."\n" + .'* DiskReadIOPS,DiskWriteIOPS'."\n" + .'* diskusage_utilization,fs_inodeutilization'."\n" + .'* VPC_PublicIP_InternetInRate,VPC_PublicIP_InternetOutRate'."\n" + .'* IntranetInRate,IntranetOutRate'."\n" + .'* concurrentConnections'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The [region ID](~~198326~~) of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22E****', + ], + 'Data' => [ + 'description' => 'A list of metric data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metric data result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Kpi' => [ + 'description' => 'The name of the metric.'."\n", + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'Value' => [ + 'description' => 'The value of the metric.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'Timestamp' => [ + 'description' => 'The timestamp when the metric was collected.'."\n", + 'type' => 'string', + 'example' => '1732253446000', + ], + 'Category' => [ + 'description' => 'The type of metric. Valid values:'."\n" + ."\n" + .'* DAS'."\n" + .'* ECS'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22E****\\",\\n \\"Data\\": [\\n {\\n \\"Kpi\\": \\"cpu_total\\",\\n \\"Value\\": \\"50\\",\\n \\"Timestamp\\": \\"1732253446000\\",\\n \\"Category\\": \\"ECS\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetPrinsMetricsList', + ], + 'ListPrinsSQLErrorLog' => [ + 'summary' => 'Retrieves log information for a managed instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227820', + 'abilityTreeNodes' => [ + 'FEATUREcddc7QNOWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pr-22a21ac289e0****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword of log query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'keyword', + ], + ], + [ + 'name' => 'StartLinenum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The starting line number for log retrieval. A value of 0 indicates retrieving the latest log content. Default: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of log entries to query. Default: 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the query direction. Default value: false.'."\n" + ."\n" + .'* true: Queries in reverse order, retrieving Size log entries before StartLinenum. This returns data from the range (StartLinenum - Size, StartLinenum).'."\n" + .'* false: Queries in forward order, retrieving Size log entries after StartLinenum. This returns data from the range (StartLinenum, StartLinenum + Size).'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LogPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path of the log file. If left empty, the system automatically retrieves the path of the MySQL error log.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'error.log', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B74AD197-214C-50F2-BF7D-B13632EE****', + ], + 'LogList' => [ + 'description' => 'A list of log information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A log entry.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The content of the log entry.'."\n", + 'type' => 'string', + 'example' => 'error: ****', + ], + 'Linenum' => [ + 'description' => 'The line number of the log entry.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of log entries found.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LogPath' => [ + 'description' => 'The path of the log file from which the entries were collected.'."\n", + 'type' => 'string', + 'example' => 'error.log', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B74AD197-214C-50F2-BF7D-B13632EE****\\",\\n \\"LogList\\": [\\n {\\n \\"Content\\": \\"error: ****\\",\\n \\"Linenum\\": 1\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"LogPath\\": \\"error.log\\"\\n}","type":"json"}]', + 'title' => 'ListPrinsSQLErrorLog', + ], + 'ListPrinsParams' => [ + 'summary' => 'Queries the parameter list of a managed database instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227820', + 'abilityTreeNodes' => [ + 'FEATUREcddc7QNOWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pr-22a21ac289e0****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~214103~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ConfigName', + 'in' => 'query', + 'schema' => [ + 'description' => 'No'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'innodb', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C860658E-68A6-46C1-AF6E-3AE7C4D3****', + ], + 'ConfigList' => [ + 'description' => 'A list of parameter information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Parameter information.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConfigName' => [ + 'description' => 'The parameter name.'."\n", + 'type' => 'string', + 'example' => 'innodb_buffer_pool_size', + ], + 'DefaultValue' => [ + 'description' => 'The default value of the parameter.'."\n", + 'type' => 'string', + 'example' => '128134217728', + ], + 'CurValue' => [ + 'description' => 'The current value of the parameter.'."\n", + 'type' => 'string', + 'example' => '134217728', + ], + 'Comment' => [ + 'description' => 'The English description of the parameter.'."\n", + 'type' => 'string', + 'example' => 'InnoDB buffer pool size。', + ], + 'Translation' => [ + 'description' => 'The Chinese description of the parameter.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of records.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C860658E-68A6-46C1-AF6E-3AE7C4D3****\\",\\n \\"ConfigList\\": [\\n {\\n \\"ConfigName\\": \\"innodb_buffer_pool_size\\",\\n \\"DefaultValue\\": \\"128134217728\\",\\n \\"CurValue\\": \\"134217728\\",\\n \\"Comment\\": \\"InnoDB buffer pool size。\\",\\n \\"Translation\\": \\"InnoDB 缓冲池的大小。\\"\\n }\\n ],\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => 'ListPrinsParams', + ], + 'ListPrinsInstances' => [ + 'summary' => 'Queries the list of managed instances.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212746', + 'abilityTreeNodes' => [ + 'FEATUREcddcGJUHY1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. For more information, see [Region IDs](~~198326~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pr-22a21ac289e0****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the instance list. Start value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine of the instance. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => 'The tag information, which filters the instances that contain the corresponding tag key value.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demokey', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demovalue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '> This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '> This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8.0.36', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22****', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The current page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Instances' => [ + 'description' => 'Details of the instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The region ID of the host.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => 'The state of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* inactive: Abnormal.'."\n" + .'* Deleted: Deleted'."\n" + .'* Creating:Creating'."\n" + .'* Active: Running'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'inactive' => '', + 'deleted' => '', + 'creating' => '', + 'active' => '', + ], + 'example' => 'active', + ], + 'InstanceName' => [ + 'description' => 'The name of the self-managed instance.'."\n", + 'type' => 'string', + 'example' => 'pr-22a21ac289e0****', + ], + 'Alias' => [ + 'description' => 'The alias of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'EngineType' => [ + 'description' => 'The engine type. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version.'."\n", + 'type' => 'string', + 'example' => '8.0.36', + ], + 'GmtCreated' => [ + 'description' => 'The timestamp when the instance was created.'."\n", + 'type' => 'string', + 'example' => '1729758903000', + ], + 'Description' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Tag' => [ + 'description' => 'A list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'DmsId' => [ + 'description' => 'The ID of the DMS instance associated with this instance.'."\n", + 'type' => 'string', + 'example' => '2717906', + ], + 'DasId' => [ + 'description' => 'The ID of the DAS instance associated with this instance.'."\n", + 'type' => 'string', + 'example' => 'hdm_ef2263e117f23c4f3114417742b****', + ], + 'Vip' => [ + 'description' => 'The IP address of the instance.'."\n", + 'type' => 'boolean', + 'example' => '127.0.0.1', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '> This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries.'."\n" + ."\n" + .'The maximum number of results that can be returned each time when you use a NextToken query.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NextToken' => [ + 'description' => '> This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries.'."\n" + ."\n" + .'The query credential value returned by this call.'."\n", + 'type' => 'string', + 'example' => '4b1e854bca4f2fb7e0b5e8707e68181f', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22****\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"Instances\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"active\\",\\n \\"InstanceName\\": \\"pr-22a21ac289e0****\\",\\n \\"Alias\\": \\"test\\",\\n \\"EngineType\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"8.0.36\\",\\n \\"GmtCreated\\": \\"1729758903000\\",\\n \\"Description\\": \\"test\\",\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"DmsId\\": \\"2717906\\",\\n \\"DasId\\": \\"hdm_ef2263e117f23c4f3114417742b****\\",\\n \\"Vip\\": true\\n }\\n ],\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"4b1e854bca4f2fb7e0b5e8707e68181f\\"\\n}","type":"json"}]', + 'title' => 'ListPrinsInstances', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cddc.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'cddc.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'cddc.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'cddc.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'cddc.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'cddc.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cddc.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'cddc.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'cddc.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'cddc.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'cddc.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'cddc.ap-south-1.aliyuncs.com', + ], + ], +]; |