'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'smc', 'version' => '2019-06-01', ], 'directories' => [ [ 'id' => 68530, 'title' => 'Migration sources', 'type' => 'directory', 'children' => [ 'DescribeSourceServers', 'ModifySourceServerAttribute', 'DeleteSourceServer', ], ], [ 'id' => 68534, 'title' => 'Migration tasks', 'type' => 'directory', 'children' => [ 'CreateReplicationJob', 'CreateCrossZoneMigrationJob', 'ModifyReplicationJobAttribute', 'StartReplicationJob', 'StopReplicationJob', 'DescribeReplicationJobs', 'CutOverReplicationJob', 'DeleteReplicationJob', ], ], [ 'id' => 198919, 'title' => 'Work groups', 'type' => 'directory', 'children' => [ 'CreateWorkgroup', 'AssociateSourceServers', 'DisassociateSourceServers', 'DescribeWorkgroups', 'ModifyWorkgroupAttribute', 'DeleteWorkgroup', ], ], [ 'id' => 183898, 'title' => 'Tag', 'type' => 'directory', 'children' => [ 'TagResources', 'ListTagResources', 'UntagResources', ], ], [ 'id' => 183845, 'title' => 'Activation code', 'type' => 'directory', 'children' => [ 'CreateAccessToken', 'DisableAccessToken', 'ListAccessTokens', 'DeleteAccessToken', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'DescribeSourceServers' => [ 'summary' => 'Queries the information about one or more source servers.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '18569', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the migration job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'j-bp19vlwm0tyigbmj****', ], ], [ 'name' => 'State', 'in' => 'query', 'schema' => [ 'description' => 'The state of the migration source. Valid values:'."\n" ."\n" .'* Unavailable: The migration source is inactive, or an error occurs in the migration source.'."\n" .'* Available: The migration source is active.'."\n" .'* InUse: The migration source is being migrated.'."\n" .'* Deleting: The migration source is being deleted from Server Migration Center (SMC).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Available', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the migration source. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain digits, colons (:), underscores (\\_), and hyphens (-).'."\n" ."\n" .'This parameter is empty by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testSourceServerName', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Minimum value: 1.'."\n" ."\n" .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: 1 to 50.'."\n" ."\n" .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The migration source ID. You can specify multiple IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The migration source ID. You can specify multiple IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****', ], 'required' => false, 'example' => 's-bp1e2fsl57knvuug****', 'maxItems' => 100, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tag.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag object.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of tag N that is attached to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'You cannot specify an empty string as a tag key. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The value of tag N that is attached to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'You can specify an empty string as a tag key. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'RelatedJobType', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The type of migration job that is associated with the migration source.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of migration job that is associated with the migration source. Valid values:'."\n" ."\n" .'* Not_Related: No migration job is associated with the migration source.'."\n" .'* Server: server migration job.'."\n" .'* Os: operating system migration job.'."\n" .'* Cross_Zone: cross-zone migration job.'."\n" .'* VMWare: job to migrate VMware VMs without agents.'."\n" .'* Desktop: desktop migration job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Server', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'WorkgroupId', 'in' => 'query', 'schema' => [ 'description' => 'The workgroup ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-bp1ja22kdqphehlj****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The collection of information.'."\n", 'type' => 'object', 'properties' => [ 'SourceServers' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SourceServer' => [ 'description' => 'The information about the migration source.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the migration source.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => [ 'description' => 'The time when the migration source was created.'."\n", 'type' => 'string', 'example' => '2019-06-27T02:58:09Z', ], 'HeartbeatRate' => [ 'description' => 'The interval at which heartbeats are sent from the SMC client. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'State' => [ 'description' => 'The state of the migration source.'."\n", 'type' => 'string', 'example' => 'InUse', ], 'DataDisks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DataDisk' => [ 'description' => 'The data disks on the migration source.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data disks on the migration source.'."\n", 'type' => 'object', 'properties' => [ 'Index' => [ 'description' => 'The index number of the data disk.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Size' => [ 'description' => 'The size of data disk N. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Parts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Part' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'object', 'properties' => [ 'CanBlock' => [ 'description' => 'Indicates whether block replication is enabled for the data disk partition.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'SizeBytes' => [ 'description' => 'The size of the data disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480', ], 'Need' => [ 'description' => 'Indicates whether the data disk partition must be selected.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Device' => [ 'description' => 'The device ID of the data disk partition.'."\n", 'type' => 'string', 'example' => '1_0', ], 'Path' => [ 'description' => 'The path of the data disk partition.'."\n", 'type' => 'string', 'example' => '/home/data', ], ], ], ], ], ], 'Path' => [ 'description' => 'The path of data disk N.'."\n", 'type' => 'string', 'example' => '/home/data', ], ], ], ], ], ], 'SystemDiskParts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SystemDiskPart' => [ 'description' => 'The information about the system disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the system disk partition.'."\n", 'type' => 'object', 'properties' => [ 'CanBlock' => [ 'description' => 'Indicates whether block replication is enabled for the system disk partition.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'SizeBytes' => [ 'description' => 'The size of the system disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '254803968', ], 'Need' => [ 'description' => 'Indicates whether the system disk partition must be selected.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Device' => [ 'description' => 'The device ID of the system disk partition.'."\n", 'type' => 'string', 'example' => '0_0', ], 'Path' => [ 'description' => 'The path of the system disk partition.'."\n", 'type' => 'string', 'example' => '/boot', ], ], ], ], ], ], 'KernelLevel' => [ 'description' => 'The kernel level of the migration source.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SourceId' => [ 'description' => 'The ID of the migration source.'."\n", 'type' => 'string', 'example' => 's-bp1e2fsl57knvuug****', ], 'AgentVersion' => [ 'description' => 'The version number of the SMC client.'."\n", 'type' => 'string', 'example' => '1.5.2.3', ], 'StatusInfo' => [ 'description' => 'The status information of the migration source. This parameter is returned if the migration source is in the Unavailable state. The value of this parameter consists of key-value pairs in the JSON format. Sample keys:'."\n" ."\n" .' error_code: The error code.'."\n" .' error_msg: the error message.'."\n", 'type' => 'string', 'example' => '{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}', ], 'SystemDiskSize' => [ 'description' => 'The system disk size of the migration source. Unit: GiB'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'Description' => [ 'description' => 'The description of the migration source.'."\n", 'type' => 'string', 'example' => 'Server Source Imported By GotoAliyun.', ], 'ErrorCode' => [ 'description' => 'The error code of the migration source.'."\n", 'type' => 'string', 'example' => 'SourceServer.Offline', ], 'JobId' => [ 'description' => 'The ID of the last migration job.'."\n", 'type' => 'string', 'example' => 'j-bp19vlwm0tyigbmj****', ], 'Platform' => [ 'description' => 'The operating system of the migration source.'."\n", 'type' => 'string', 'example' => 'OpenSUSE', ], 'ReplicationDriver' => [ 'description' => 'The replication driver used for migration. Default value: SMT.'."\n", 'type' => 'string', 'example' => 'SMT', ], 'Name' => [ 'description' => 'The name of the migration source.'."\n", 'type' => 'string', 'example' => 'SourceServerName', ], 'SystemInfo' => [ 'description' => 'The system information of the migration source. The parameter must be specified as key-value pairs in the JSON format. The key-value pairs are extensible and have fixed keys. Maximum value: 1 KB. Example:'."\n" ."\n" .' agent_mode: the running mode.'."\n" .' agent_type: the type of the run.'."\n" .' client_type: the type of the client.'."\n" .' hostname : the hostname.'."\n" .' ipv4:IPv4 address'."\n" .' ipv6: IPv6 address'."\n" .' cores: the number of CPU cores.'."\n" .' cpu_usage: the CPU utilization.'."\n" .' memory: the memory size.'."\n" .' memory_usage: the memory usage.'."\n", 'type' => 'string', 'example' => '{\\"agent_mode\\":\\"daemon\\",\\"agent_type\\":\\"aliyun\\",\\"client_type\\":\\"\\",\\"cores\\":\\"2\\",\\"cpu_usage\\":\\"0.00\\",\\"hostname\\":\\"ixxxxxxxxxx\\",\\"ipv4\\":\\"10.0.0.1\\",\\"memory\\":\\"8.00\\",\\"memory_usage\\":\\"3.61\\"}', ], 'Architecture' => [ 'description' => 'The system architecture of the migration source.'."\n", 'type' => 'string', 'example' => 'x86_64', ], 'ResourceGroupId' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmw3ty5y7****', ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tag details.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag object.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of tag N that is attached to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'You cannot specify an empty string as a tag key. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n", 'type' => 'string', 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The value of tag N that is attached to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag key can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.'."\n", 'type' => 'string', 'example' => 'TestValue', ], ], ], ], ], ], 'Disks' => [ 'description' => 'The information about the disk.'."\n", 'type' => 'object', 'properties' => [ 'System' => [ 'description' => 'The information about the system disk.'."\n", 'type' => 'object', 'properties' => [ 'Size' => [ 'description' => 'The size of the source system disk. Unit: GiB. Valid values: 20 to 32768.'."\n" ."\n" .'> The parameter value must be greater than the actual used space of the data disk on the source server. For example, if the size of the source disk is 500 GiB but the actual used space is 100 GiB, you must set this parameter to a value greater than 100 GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Offset' => [ 'description' => 'The start offset of the first partition of the system disk. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'Parts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Part' => [ 'description' => 'The information about the system disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The partition information.'."\n", 'type' => 'object', 'properties' => [ 'CanBlock' => [ 'description' => 'Indicates whether block replication is enabled for the system disk partition. Valid values:'."\n" ."\n" .'* true: Block replication is enabled for the system disk partition.'."\n" .'* false: Block replication is disabled for the system disk partition.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'SizeBytes' => [ 'description' => 'The size of the system disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480', ], 'Path' => [ 'description' => 'The path of the system disk partition.'."\n", 'type' => 'string', 'example' => '/home/data', ], 'Type' => [ 'description' => 'The type of the system disk partition. Valid values:'."\n" ."\n" .'* Normal: normal partition.'."\n" .'* System: system partition.'."\n" .'* Boot: boot partition.'."\n", 'type' => 'string', 'example' => 'Normal', ], ], ], ], ], ], ], 'required' => false, ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Data' => [ 'description' => 'The list of data disk information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'object', 'properties' => [ 'Size' => [ 'description' => 'The data disk size of the migration source. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', ], 'Offset' => [ 'description' => 'The start offset of the first partition of the data disk. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'Parts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Part' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'object', 'properties' => [ 'CanBlock' => [ 'description' => 'Whether block replication is enabled for the data disk partition. Valid values:'."\n" ."\n" .'* true: Block replication is enabled for the data disk partition.'."\n" .'* false: Block replication is disabled for the data disk partition.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'SizeBytes' => [ 'description' => 'The size of the data disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480', ], 'Path' => [ 'description' => 'The path of the data disk partition.'."\n", 'type' => 'string', 'example' => '/home/data', ], 'Type' => [ 'description' => 'The type of the data disk partition. Valid values:'."\n" ."\n" .'* Normal: normal partition.'."\n" .'* System: system partition.'."\n" .'* Boot: boot partition.'."\n", 'type' => 'string', 'example' => 'Normal', ], ], ], ], ], ], ], ], ], ], ], ], ], 'WorkgroupId' => [ 'description' => 'The workgroup ID.'."\n", 'type' => 'string', 'example' => 'w-bp1ja22kdqphehlj****', ], ], ], ], ], ], 'TotalCount' => [ 'description' => 'The total number of migration sources returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '410E6073-66D0-45D3-AB3E-4DC3F5E4****', ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"SourceServers\\": {\\n \\"SourceServer\\": [\\n {\\n \\"CreationTime\\": \\"2019-06-27T02:58:09Z\\",\\n \\"HeartbeatRate\\": 30,\\n \\"State\\": \\"InUse\\",\\n \\"DataDisks\\": {\\n \\"DataDisk\\": [\\n {\\n \\"Index\\": 1,\\n \\"Size\\": 20,\\n \\"Parts\\": {\\n \\"Part\\": [\\n {\\n \\"CanBlock\\": false,\\n \\"SizeBytes\\": 21474836480,\\n \\"Need\\": false,\\n \\"Device\\": \\"1_0\\",\\n \\"Path\\": \\"/home/data\\"\\n }\\n ]\\n },\\n \\"Path\\": \\"/home/data\\"\\n }\\n ]\\n },\\n \\"SystemDiskParts\\": {\\n \\"SystemDiskPart\\": [\\n {\\n \\"CanBlock\\": true,\\n \\"SizeBytes\\": 254803968,\\n \\"Need\\": true,\\n \\"Device\\": \\"0_0\\",\\n \\"Path\\": \\"/boot\\"\\n }\\n ]\\n },\\n \\"KernelLevel\\": 1,\\n \\"SourceId\\": \\"s-bp1e2fsl57knvuug****\\",\\n \\"AgentVersion\\": \\"1.5.2.3\\",\\n \\"StatusInfo\\": \\"{\\\\\\"error_code\\\\\\": \\\\\\"S1\\\\\\", \\\\\\"error_msg\\\\\\": \\\\\\"Rsync not found. Please install rsync.\\\\\\"}\\",\\n \\"SystemDiskSize\\": 40,\\n \\"Description\\": \\"Server Source Imported By GotoAliyun.\\",\\n \\"ErrorCode\\": \\"SourceServer.Offline\\",\\n \\"JobId\\": \\"j-bp19vlwm0tyigbmj****\\",\\n \\"Platform\\": \\"OpenSUSE\\",\\n \\"ReplicationDriver\\": \\"SMT\\",\\n \\"Name\\": \\"SourceServerName\\",\\n \\"SystemInfo\\": \\"{\\\\\\\\\\\\\\"agent_mode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"daemon\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"agent_type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aliyun\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"client_type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cores\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpu_usage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.00\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hostname\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ixxxxxxxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ipv4\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10.0.0.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8.00\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"memory_usage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3.61\\\\\\\\\\\\\\"}\\",\\n \\"Architecture\\": \\"x86_64\\",\\n \\"ResourceGroupId\\": \\"rg-acfmw3ty5y7****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n },\\n \\"Disks\\": {\\n \\"System\\": {\\n \\"Size\\": 100,\\n \\"Offset\\": 1024,\\n \\"Parts\\": {\\n \\"Part\\": [\\n {\\n \\"CanBlock\\": false,\\n \\"SizeBytes\\": 21474836480,\\n \\"Path\\": \\"/home/data\\",\\n \\"Type\\": \\"Normal\\"\\n }\\n ]\\n }\\n },\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"Size\\": 80,\\n \\"Offset\\": 1024,\\n \\"Parts\\": {\\n \\"Part\\": [\\n {\\n \\"CanBlock\\": false,\\n \\"SizeBytes\\": 21474836480,\\n \\"Path\\": \\"/home/data\\",\\n \\"Type\\": \\"Normal\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n },\\n \\"WorkgroupId\\": \\"w-bp1ja22kdqphehlj****\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"410E6073-66D0-45D3-AB3E-4DC3F5E4****\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2019-06-27T02:58:09Z\\n 30\\n InUse\\n \\n 1\\n 20\\n \\n false\\n 21474836480\\n false\\n 1_0\\n /home/data\\n \\n /home/data\\n \\n \\n true\\n 254803968\\n true\\n 0_0\\n /boot\\n \\n 1\\n s-bp1e2fsl57knvuug****\\n 1.5.2.3\\n {\\"error_code\\": \\"S1\\", \\"error_msg\\": \\"Rsync not found. Please install rsync.\\"}\\n 40\\n Server Source Imported By GotoAliyun.\\n SourceServer.Offline\\n j-bp19vlwm0tyigbmj****\\n OpenSUSE\\n SMT\\n SourceServerName\\n {\\\\\\"agent_mode\\\\\\":\\\\\\"daemon\\\\\\",\\\\\\"agent_type\\\\\\":\\\\\\"aliyun\\\\\\",\\\\\\"client_type\\\\\\":\\\\\\"\\\\\\",\\\\\\"cores\\\\\\":\\\\\\"2\\\\\\",\\\\\\"cpu_usage\\\\\\":\\\\\\"0.00\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"ixxxxxxxxxx\\\\\\",\\\\\\"ipv4\\\\\\":\\\\\\"10.0.0.1\\\\\\",\\\\\\"memory\\\\\\":\\\\\\"8.00\\\\\\",\\\\\\"memory_usage\\\\\\":\\\\\\"3.61\\\\\\"}\\n x86_64\\n rg-acfmw3ty5y7****\\n \\n TestKey\\n TestValue\\n \\n \\n 1\\n 10\\n 410E6073-66D0-45D3-AB3E-4DC3F5E4****\\n 1\\n","errorExample":""}]', 'title' => 'DescribeSourceServers', 'description' => '## [](#)Usage notes'."\n" ."\n" .'You can specify multiple request parameters to filter instances. Specified parameters have logical AND relations. Only the specified parameters are used as filter conditions.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifySourceServerAttribute' => [ 'summary' => 'Modifies the name and description of a migration source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '18573', 'abilityTreeNodes' => [ 'FEATUREsmcBBDD6M', ], ], 'parameters' => [ [ 'name' => 'SourceId', 'in' => 'query', 'schema' => [ 'description' => 'The migration source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 's-bp17m1vi6x20c6g6****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the migration source. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", 'type' => 'string', 'required' => false, 'example' => 'testSourceServerName', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the migration source. The description can be up to 256 characters in length and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a source server.', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SourceServerName.Duplicate', 'errorMessage' => 'The specified source server name already exists. Please modify the source server name.', ], [ 'errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]', 'title' => 'ModifySourceServerAttribute', 'description' => '## Usage notes'."\n" ."\n" .'You can call this operation regardless of the status of the migration source.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteSourceServer' => [ 'summary' => 'Deletes a migration source.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '18563', 'abilityTreeNodes' => [ 'FEATUREsmcWZM4IC', ], ], 'parameters' => [ [ 'name' => 'SourceId', 'in' => 'query', 'schema' => [ 'description' => 'The migration source ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 's-bp17m1vi6x20c6g6****', ], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcibly delete the migration source. Valid values:'."\n" ."\n" .'* true: forcibly deletes the migration source and the migration job created for the migration source, and releases the intermediate resources of the migration job.'."\n" .'* false: does not delete the migration source if a migration job is created for the migration source.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SourceServer.WithRunningReplicationJob', 'errorMessage' => 'The specified source server has related replication jobs that are running.', ], [ 'errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'ReplicationJob.Related', 'errorMessage' => 'The specified source server has related replication jobs. Please delete replication jobs: %s before delete this source server.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]', 'title' => 'DeleteSourceServer', 'description' => '## Usage notes'."\n" ."\n" .'* If a migration job is created for the migration source and the migration job is in the Running state, the migration source cannot be deleted.'."\n" .'* If a migration job is created for the migration source but the migration job is not in the Running state, you can set the `Force` parameter to true to delete the migration source.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateReplicationJob' => [ 'summary' => 'Creates a migration job for a source server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '18560', 'abilityTreeNodes' => [ 'FEATUREsmcBBDD6M', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud region to which you want to migrate the source server.'."\n" ."\n" .'For example, if you want to migrate the source server to the China (Hangzhou) region, set this parameter to `cn-hangzhou`. You can call the [DescribeRegions](~~25609~~) operation to query the latest regions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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. For more information, see [How to ensure idempotence](~~25693~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the migration job. The name must meet the following requirements:'."\n" ."\n" .'* The name must be unique.'."\n" .'* The name must be 2 to 128 characters in length, and can contain digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter, but cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the migration job.'."\n" ."\n" .'The description must be 2 to 128 characters in length, and can contain digits, colons (:), underscores (\\_), and hyphens (-). The description must start with a letter, but cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This_is_a_migration_task', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the source server.'."\n", 'type' => 'string', 'required' => true, 'example' => 's-bp1e2fsl57knvuug****', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of destination to which you want to migrate the source server. Valid values:'."\n" ."\n" .'* Image: After the migration job is complete, SMC generates an Elastic Compute Service (ECS) image for the source server.'."\n" .'* ContainerImage: After the migration job is complete, SMC generates a Docker container image for the source server.'."\n" .'* TargetInstance: After the migration job is completed, SMC migrates the source server to the destination instance. If you set this parameter to TargetInstance, you must set the `InstanceId` parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Image', ], ], [ 'name' => 'ScheduledStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to run the migration job. The time must meet the following requirements:'."\n" ."\n" .'* The time must be specified in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. For example, 2018-01-01T12:00:00Z specifies 20:00:00 on January 1, 2018 (UTC+8).'."\n" .'* The value must be within 30 days after the current time.'."\n" ."\n" .'> If you do not specify this parameter, you must manually start the migration job after the job is created. You can call the [StartReplicationJob](~~121823~~) operation to start the migration job.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z', ], ], [ 'name' => 'ValidTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the migration job expires. You can schedule the migration job to expire 7 to 90 days after the job is created.'."\n" ."\n" .'* The time must be specified in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. For example, 2018-01-01T12:00:00Z specifies 20:00:00 on January 1, 2018 (UTC+8).'."\n" .'* If you do not specify this parameter, the migration job does not expire.'."\n" .'* After a migration job expires, the job state changes to Expired. SMC retains the migration job for seven days after the job expires. After the job is retained for seven days, SMC deletes the migration job.'."\n" ."\n" .'By default, a migration job is valid for 30 days after it is created.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the destination image. The name must meet the following requirements:'."\n" ."\n" .'* The name must be unique within an Alibaba Cloud region.'."\n" .'* The name must be 2 to 128 characters in length, and can contain digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter, but cannot start with `http://` or `https://`.'."\n" ."\n" .'> If you specify an image name that already exists in the destination region, the migration job ID is appended to the image name as a suffix. Example: ImageName_j-2zexxxxxxxxxxxxx.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testAliCloudImageName', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination ECS instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1f1dvfto1sigz5****', ], ], [ 'name' => 'SystemDiskSize', 'in' => 'query', 'schema' => [ 'description' => 'The system disk size of the destination ECS instance. Unit: GiB. Valid values: 20 to 2048.'."\n" ."\n" .'> The value must be greater than the used space of the system disk on the source server. For example, if the total size of the source disk is 500 GiB and the used space is 100 GiB, the value of this parameter must be greater than 100 GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of a VPC for which you have configured an Express Connect circuit or a VPN gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1vwnn14rqpyiczj****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch in the specified VPC.'."\n" ."\n" .'You must set this parameter if you use a VPC to migrate data.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1ddbrxdlrcbim46****', ], ], [ 'name' => 'ReplicationParameters', 'in' => 'query', 'schema' => [ 'description' => 'The parameters of the replication driver. The parameters must be specified as key-value pairs in the JSON format. The keys are fixed for each type of replication driver. The JSON string can be up to 2,048 characters in length.'."\n" ."\n" .'A replication driver is a tool that is used to migrate a source server to an intermediate instance. The parameters vary based on the replication driver type. If you use a Server Migration Tool (SMT) driver, you can specify the following parameters:'."\n" ."\n" .'* bandwidth_limit: the maximum bandwidth for data transmission.'."\n" .'* compress_level: the compression ratio of data to be transmitted.'."\n" .'* checksum: specifies whether to enable checksum verification.'."\n" ."\n" .'For more information about replication drivers, see the response parameter `SourceServers.ReplicationDriver` of the [DescribeSourceServers](~~121818~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"bandwidth_limit":0,"compress_level":1,"checksum":true}', ], ], [ 'name' => 'NetMode', 'in' => 'query', 'schema' => [ 'description' => 'The network mode for data transmission. Valid values:'."\n" ."\n" .'* 0: Data is transmitted over the Internet. Make sure that the source server can access the Internet.'."\n" .'* 2: Data is transmitted over a VPC. If you specify this value, you must specify the VSwitchId parameter. You do not need to specify the VpcId parameter because the value of the VpcId parameter can be retrieved based on the value of the VSwitchId parameter.'."\n" ."\n" .'Default value: 0'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'RunOnce', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to disable incremental migration for the source server. Valid values:'."\n" ."\n" .'* true: creates a migration job that runs only once. This is the default value. Incremental data of the source server is not synchronized.'."\n" .'* false: creates an incremental migration job. In this case, you must specify the `Frequency` parameter. SMC synchronizes incremental data of the source server to Alibaba Cloud at the specified frequency. You can use an incremental migration job to synchronize incremental data from the source server to Alibaba Cloud without the need to interrupt your business. A full data image is generated for the source server when the job is running.'."\n" ."\n" .'> You can specify this parameter only when you create a migration job. The parameter value cannot be changed after the migration job is created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Frequency', 'in' => 'query', 'schema' => [ 'description' => 'The interval at which SMC synchronizes incremental data to Alibaba Cloud. Unit: hour. Valid values: 1 to 168.'."\n" ."\n" .'This parameter is required if you set the `RunOnce` parameter to false.'."\n" ."\n" .'By default, this parameter is empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', ], ], [ 'name' => 'MaxNumberOfImageToKeep', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of images retained for the incremental migration job. Valid values: 1 to 10.'."\n" ."\n" .'This parameter is required if you set the `RunOnce` parameter to false.'."\n" ."\n" .'By default, this parameter is empty.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the intermediate instance.'."\n" ."\n" .'You can call the [DescribeInstanceTypes](~~25620~~) operation to obtain the ECS instance types.'."\n" ."\n" .'* If you specify this parameter, SMC creates an intermediate instance of the specified instance type. If the specified instance type is unavailable, you cannot create the migration job.'."\n" .'* If you do not specify this parameter, SMC selects an available instance type in a specific order to create an intermediate instance. For more information, see [SMC FAQ](~~121707~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large', ], ], [ 'name' => 'LaunchTemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the launch template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'lt-bp16jovvln1cgaaq****', ], ], [ 'name' => 'LaunchTemplateVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version number of the launch template.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'InstanceRamRole', 'in' => 'query', 'schema' => [ 'description' => 'The name of the Resource Access Management (RAM) role that is assigned to the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SMCAdmin', ], ], [ 'name' => 'ContainerNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace of the destination Docker container image. For more information about Docker container images, see [Terms](~~60744~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'testNamespace', ], ], [ 'name' => 'ContainerRepository', 'in' => 'query', 'schema' => [ 'description' => 'The repository that stores the destination Docker container image. For more information about Docker container images, see [Terms](~~60744~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'testRepository', ], ], [ 'name' => 'ContainerTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of the destination Docker container image. For more information about Docker container images, see [Terms](~~60744~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'CentOS:v1', ], ], [ 'name' => 'LicenseType', 'in' => 'query', 'schema' => [ 'description' => 'The license type. Valid values:'."\n" ."\n" .'* An empty value specifies no license.'."\n" .'* A value of BYOL specifies Bring Your Own License (BYOL).'."\n" ."\n" .'For more information, see [SMC FAQ](~~121707~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'BYOL', ], ], [ 'name' => 'DataDisk', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The data disks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data disks.'."\n", 'type' => 'object', 'properties' => [ 'Index' => [ 'description' => 'The index of data disk N on the destination ECS instance. Data disks on a destination ECS instance are arranged in a sequential order that starts from 1. Valid values: 1 to 16.'."\n" ."\n" .'> To create a destination data disk for a source server, make sure that the source server has data disks.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Part' => [ 'description' => 'The data disk partitions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Partition information of data disk.', 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of partition N in the destination data disk. Unit: bytes. The default value is equal to the corresponding partition size of the source data disk.'."\n" ."\n" .'> '."\n" ."\n" .'* The total size of all partitions in a destination data disk cannot exceed the size of the destination data disk.'."\n" ."\n" .'* You must set both the `DataDisk.N.Part.N.Device` and DataDisk.N.Part.N.SizeBytes parameters or leave both parameters empty.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968', ], 'Block' => [ 'description' => 'Specifies whether to enable block replication for partition N in the destination data disk. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n" ."\n" .'Default value: true'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Device' => [ 'description' => 'The device ID of partition N in the destination data disk. The partitions in the destination data disk are arranged in the same sequential order as those in the source data disk.'."\n" ."\n" .'> You must set both the DataDisk.N.Part.N.Device and `DataDisk.N.Part.N.SizeBytes` parameters or leave both parameters empty.'."\n", 'type' => 'string', 'required' => false, 'example' => '0_1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 32, ], 'Size' => [ 'description' => 'The size of the data disk on the destination ECS instance. Unit: GiB. Valid values: 20 to 32768.'."\n" ."\n" .'> The size of a destination data disk must be larger than the size of data in the source data disk. For example, if the size of the source data disk is 500 GiB and the used space is 100 GiB, you must set this parameter to a value greater than 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags list.', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag for the migration job. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The value of the tag for the migration job. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'SystemDiskPart', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about system disk partitions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Partition information of system disk.', 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of the partition N in the destination system disk. Unit: bytes. The default value is equal to the partition size of the source system disk.'."\n" ."\n" .'> '."\n" ."\n" .'* The total size of all partitions in the destination system disk cannot exceed the size of the destination system disk.'."\n" ."\n" .'* You must set both the `SystemDiskPart.N.Device` and SystemDiskPart.N.SizeBytes parameters or leave both parameters empty.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968', ], 'Block' => [ 'description' => 'Specifies whether to enable block replication for partition N in the destination system disk. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n" ."\n" .'Default value: true'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Device' => [ 'description' => 'The ID of partition N in the destination system disk. The partitions in the destination system disk are arranged in the same sequential order as those in the source system disk.'."\n" ."\n" .'> You must set both the SystemDiskPart.N.Device and `SystemDiskPart.N.SizeBytes` parameters or leave both parameters empty.'."\n", 'type' => 'string', 'required' => false, 'example' => '0_1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 32, ], ], [ 'name' => 'JobType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the migration job. Valid values:'."\n" ."\n" .'* 0: server migration.'."\n" .'* 1: operating system migration.'."\n" .'* 2: cross-zone migration.'."\n" .'* 3: agentless migration for a VMware VM.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****', ], ], [ 'name' => 'Disks', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The information about the disk.'."\n", 'type' => 'object', 'properties' => [ 'System' => [ 'description' => 'The information about the system disk.'."\n", 'type' => 'object', 'properties' => [ 'Size' => [ 'description' => 'The size of the source system disk. Unit: GiB. Valid values: 20 to 32768.'."\n" ."\n" .'> The parameter value must be greater than the actual used space of the data disk on the source server. For example, if the size of the source disk is 500 GiB but the actual used space is 100 GiB, you must set this parameter to a value greater than 100 GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], 'LVM' => [ 'description' => 'Specifies whether to use LVM. Valid values:'."\n" ."\n" .'* true: Use LVM.'."\n" .'* false: Not use LVM.'."\n" ."\n" .'LVM is not supported:'."\n" ."\n" .'* If your source server runs Windows, LVM is not supported.'."\n" .'* The system disk does not have a boot partition, and LVM is not supported.'."\n" ."\n" .'After LVM is enabled, this feature does not take effect in the following scenarios:'."\n" ."\n" .'* LVM2 is not supported on your source server and the software package is not installed.'."\n" .'* Your source server runs Debian with a kernel version of 3.x or earlier and XFS file systems are mounted.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Part' => [ 'description' => 'The information about the system disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the system disk partition.'."\n", 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of the system disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968', ], 'Block' => [ 'description' => 'Specifies whether block replication is enabled for the system disk partition.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Path' => [ 'description' => 'The path of the system disk partition.'."\n", 'type' => 'string', 'required' => false, 'example' => '/boot', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Data' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'object', 'properties' => [ 'Size' => [ 'description' => 'The size of the data disk of the migration source. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', ], 'LVM' => [ 'description' => 'Specifies whether the data disk uses LVM. Valid values:'."\n" ."\n" .'* true: Use LVM.'."\n" .'* false: Not use LVM.'."\n", 'type' => 'boolean', 'required' => false, ], 'DiskId' => [ 'description' => 'The ID of the data disk.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-2ze8hyowhdgd6ou2m5z6', ], 'Part' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of the data disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '21474836480', ], 'Block' => [ 'description' => 'Whether block replication is enabled for the data disk partition. Valid values:'."\n" ."\n" .'* true: Block replication is enabled for the data disk partition.'."\n" .'* false: Block replication is disabled for the data disk partition.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Path' => [ 'description' => 'The path of the data disk partition.'."\n", 'type' => 'string', 'required' => false, 'example' => '/home/date', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The information of parameters that is returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9', ], 'JobId' => [ 'description' => 'The ID of the migration job.'."\n", 'type' => 'string', 'example' => 'j-bp17bclvg344jlyt****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReplicationJobDataDiskIndex.Invalid', 'errorMessage' => 'The specified replication job contains data disk index not found in source server.', ], [ 'errorCode' => 'VSwitchIdVpcId.Mismatch', 'errorMessage' => 'The specified VSwitchId and VpcId does not match.', ], [ 'errorCode' => 'InvalidSecurityGroupId.IncorrectNetworkType', 'errorMessage' => 'The network type of the specified security group does not support this action.', ], [ 'errorCode' => 'InvalidSecurityGroupId.VPCMismatch', 'errorMessage' => 'The specified security group and the specified virtual switch are not in the same VPC.', ], [ 'errorCode' => 'QuotaExceeded.ReplicationJob', 'errorMessage' => 'The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota.', ], [ 'errorCode' => 'ReplicationJobName.Duplicate', 'errorMessage' => 'The specified replication job name already exists.', ], [ 'errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'ImageName.UsedByReplicationJob', 'errorMessage' => 'The specified imageName: "%s" was used by another replication job in the current region.', ], [ 'errorCode' => 'InvalidOsMigrationType.NotMatched', 'errorMessage' => 'The SourceOsType: %s and TargetOsType: %s are not matched. The supported TargetOsType list is: %s.', ], ], 403 => [ [ 'errorCode' => 'EntityNotExist.Role', 'errorMessage' => 'The account is unauthorized. Please assign the role AliyunServiceRoleForSMC to your account.', ], [ 'errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'You must perform real-name verification for your account.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C8B26B44-0189-443E-9816-D951F59623A9\\",\\n \\"JobId\\": \\"j-bp17bclvg344jlyt****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C8B26B44-0189-443E-9816-D951F59623A9\\n j-bp17bclvg344jlyt****\\n","errorExample":""}]', 'title' => 'CreateReplicationJob', 'description' => '## Usage notes'."\n" ."\n" .'* You can create migration jobs only for source servers that are in the Available state.'."\n" .'* Each source server can be associated with only one migration job that is in the Ready, Running, Stopped, Waiting, InError, or Expired state.'."\n" .'* You can create a maximum of 1,000 migration jobs within each Alibaba Cloud account.'."\n" .'* If you migrate a source server to an image, you must specify the ImageName, SystemDiskSize, and DataDisk parameters.'."\n" .'* If you use a virtual private cloud (VPC) to migrate data, the VSwitchId parameter is required and the VpcId parameter is optional.'."\n" .'* Server Migration Center (SMC) allows you to migrate source servers to Docker container images. This allows you to migrate containerized applications in a cost-effective way.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateCrossZoneMigrationJob' => [ 'summary' => 'Server Migration Center (SMC) allows you to migrate Alibaba Cloud ECS instances across zones in the same region. You can also change the instance type (vCPU and memory) within the same instance family to meet your business requirements. You can use this API to create a cross-zone migration job.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '149399', 'abilityTreeNodes' => [ 'FEATUREsmcL35UBA', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination Alibaba Cloud region.'."\n" ."\n" .'For example, if you want to migrate the source server to the China (Hangzhou) region, set this parameter to `cn-hangzhou`. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotency 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, 'example' => '123e4567-e89b-12d3-a456-426655440000', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1ff25rzvnul6kr****', ], ], [ 'name' => 'TargetVSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID of the destination Elastic Compute Service (ECS) instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1mxqnssl8nafltcx32e', ], ], [ 'name' => 'TargetZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination zone.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', ], ], [ 'name' => 'TargetInstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the new instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.g7.large', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true** (default): enables automatic payment. Make sure that you have sufficient balance within your account.'."\n" .'* **false**: disables automatic payment. In this case, you must manually pay for the instance. For more information, see [Renew a subscription instance](~~85052~~).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Disk', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The disk list.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The disk list.'."\n", 'type' => 'object', 'properties' => [ 'DiskId' => [ 'description' => 'The disk ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-bp1eeplkn4j29wf7irpb', ], 'Category' => [ 'description' => 'The disk category. A value of cloud_essd indicates enhanced SSD (ESSD).'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', ], 'PerformanceLevel' => [ 'description' => 'The performance level of the ESSD. Valid values:'."\n" ."\n" .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" .'* PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PL0', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 101, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The information of parameters that is returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A9DBD2F8-DE5A-5844-BA6F-957A996CBD78', ], 'JobId' => [ 'description' => 'The ID of the migration job.'."\n", 'type' => 'string', 'example' => 'j-bp17bclvg344jlyt****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReplicationJobDataDiskIndex.Invalid', 'errorMessage' => 'The specified replication job contains data disk index not found in source server.', ], [ 'errorCode' => 'VSwitchIdVpcId.Mismatch', 'errorMessage' => 'The specified VSwitchId and VpcId does not match.', ], [ 'errorCode' => 'InvalidSecurityGroupId.IncorrectNetworkType', 'errorMessage' => 'The network type of the specified security group does not support this action.', ], [ 'errorCode' => 'InvalidSecurityGroupId.VPCMismatch', 'errorMessage' => 'The specified security group and the specified virtual switch are not in the same VPC.', ], [ 'errorCode' => 'QuotaExceeded.ReplicationJob', 'errorMessage' => 'The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota.', ], [ 'errorCode' => 'ReplicationJobName.Duplicate', 'errorMessage' => 'The specified replication job name already exists.', ], [ 'errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', ], ], 403 => [ [ 'errorCode' => 'EntityNotExist.Role', 'errorMessage' => 'The account is unauthorized. Please assign the role AliyunServiceRoleForSMC to your account.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A9DBD2F8-DE5A-5844-BA6F-957A996CBD78\\",\\n \\"JobId\\": \\"j-bp17bclvg344jlyt****\\"\\n}","type":"json"}]', 'title' => 'CreateCrossZoneMigrationJob', 'description' => 'For more information about the limits and impacts of cross-zone migration, see [Cross-zone ECS instance migration](~~476797~~).'."\n", ], 'ModifyReplicationJobAttribute' => [ 'summary' => 'Modifies the parameters of a migration job.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '18572', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The migration job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'j-bp19vlwm0tyigbmj****', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the migration job. The name must meet the following requirements:'."\n" ."\n" .'* The name must be unique.'."\n" .'* The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the migration job.'."\n" ."\n" .'The description must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This_is_my_migration_task', ], ], [ 'name' => 'TargetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of destination to which the source server is migrated. You can modify the value only before the migration job starts. Valid values:'."\n" ."\n" .'* Image: After the migration job is complete, Server Migration Center (SMC) generates a destination Elastic Compute Service (ECS) image for the source server. You can use the image to create an ECS instance.'."\n" .'* ContainerImage: After the migration job is complete, SMC generates a container image for the source server. You can use the container image in Container Registry.'."\n" .'* TargetInstance: After the migration job is complete, SMC migrates the source server to the destination instance. If you set this parameter to TargetInstance, you must set the `InstanceId` parameter.'."\n" ."\n" .'> '."\n" ."\n" .'* The value of this parameter is not case-sensitive.'."\n" ."\n" .'* SMC does not allow you to migrate Windows servers or servers that run operating systems on the ARM architecture to Container Registry.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Image', ], ], [ 'name' => 'ScheduledStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the migration job is executed. SMC starts the migration job at the specified time.'."\n" ."\n" .'Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. For example, 2018-01-01T12:00:00Z indicates 20:00:00 on January 1, 2018 (UTC+8).'."\n" ."\n" .'> If ScheduledStartTime is left empty, SMC does not automatically start the migration job. In this case, you must call the [StartReplicationJob](~~121823~~) operation to start the migration job.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the destination image. The name must meet the following requirements:'."\n" ."\n" .'* The name must be unique within an Alibaba Cloud region.'."\n" .'* The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.'."\n" ."\n" .'> If an image whose name is the same as that of the destination image already exists in the current region when the migration job is in progress, the system adds the migration job ID to the end of the image name by default. Example: ImageName-JobId.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testAliCloudImageName', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The destination instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1f1dvfto1sigz5****', ], ], [ 'name' => 'SystemDiskSize', 'in' => 'query', 'schema' => [ 'description' => 'The system disk size of the destination ECS instance. Unit: GiB. Valid values: 20 to 500.'."\n" ."\n" .'> The size of a destination data disk must be greater than the size of data in the source data disk. For example, if the source data disk has 500 GiB of storage space and 100 GiB of data, you must set this parameter to a value greater than 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], [ 'name' => 'Frequency', 'in' => 'query', 'schema' => [ 'description' => 'The interval at which an incremental migration job runs. Unit: hour. Valid values: 1 to 168.'."\n" ."\n" .'This parameter is required if you set the `RunOnce` parameter to false.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'MaxNumberOfImageToKeep', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of images that are retained for an incremental migration job. Valid values: 1 to 10.'."\n" ."\n" .'This parameter is required if you set the `RunOnce` parameter to false.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the intermediate instance.'."\n" ."\n" .'You can call the [DescribeInstanceTypes](~~25620~~) operation to query the ECS instance types.'."\n" ."\n" .'* If you specify this parameter, SMC creates an intermediate instance of the specified instance type. If the specified instance type is unavailable, you cannot create the migration job.'."\n" .'* If you do not specify this parameter, SMC selects an available instance type in a specific order to create an intermediate instance. For more information,'."\n" ."\n" .'see the "How does SMC create an intermediate instance?" section of the "FAQ" topic.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c5.large', ], ], [ 'name' => 'LaunchTemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The launch template ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'lt-bp16jovvln1cgaaq****', ], ], [ 'name' => 'LaunchTemplateVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version number of the launch template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Latest', ], ], [ 'name' => 'InstanceRamRole', 'in' => 'query', 'schema' => [ 'description' => 'The name of the Resource Access Management (RAM) role that is attached to the intermediate instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SMCAdmin', ], ], [ 'name' => 'ContainerNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The namespace of the destination Docker container image. For more information about Docker container images, see [Terms](~~60744~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'testNamespace', ], ], [ 'name' => 'ContainerRepository', 'in' => 'query', 'schema' => [ 'description' => 'The repository that stores the destination Docker container image. For more information about Docker container images, see [Terms](~~60744~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'testRepository', ], ], [ 'name' => 'ContainerTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag of the destination Docker container image. For more information about Docker container images, see [Terms](~~60744~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'CentOS:v1', ], ], [ 'name' => 'ValidTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the migration job expires. You can schedule the migration job to expire 7 to 90 days after the job is created.'."\n" ."\n" .'* This parameter can be modified only if the migration job is in the Ready, Running, Stopped, InError, or Waiting state.'."\n" .'* Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. For example, 2018-01-01T12:00:00Z indicates 20:00:00 on January 1, 2018 (UTC+8).'."\n" .'* If you do not specify this parameter, the migration job does not expire.'."\n" .'* After a migration job expires, the job state changes to Expired. SMC retains the migration job for seven days after the job expires. After the job is retained for seven days, SMC deletes the migration job.'."\n" ."\n" .'By default, a migration job is valid for 30 days after it is created.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z', ], ], [ 'name' => 'SystemDiskPart', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The partition information of the system disk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Partition information of system disk.', 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of partition N in the destination system disk. Unit: bytes. The default value is equal to the partition size of the source system disk.'."\n" ."\n" .'> The total size of all partitions in the destination system disk cannot exceed the size of the destination system disk.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968', ], 'Block' => [ 'description' => 'Specifies whether to enable block replication for partition N in the destination system disk. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Device' => [ 'description' => 'The ID of partition N in the destination system disk.'."\n" ."\n" .'> The partitions in the destination system disk are arranged in the same sequential order as those in the source system disk.'."\n", 'type' => 'string', 'required' => false, 'example' => '0_1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 32, ], ], [ 'name' => 'DataDisk', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'object', 'properties' => [ 'Index' => [ 'description' => 'The index of data disk N on the destination ECS instance. Valid values of N: 1 to 16.'."\n" ."\n" .'Data disks on a destination ECS instance are arranged in a sequential order that starts from 1.'."\n" ."\n" .'> You can create a destination data disk only for a source server that has data disks.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Part' => [ 'description' => 'The information about partitions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The number of parts.', 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of partition N in the destination data disk. Unit: bytes. The default value is equal to the corresponding size of the partition in the source data disk.'."\n" ."\n" .'> The total size of all partitions in the destination data disk cannot exceed the size of the destination data disk.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968', ], 'Block' => [ 'description' => 'Specifies whether to enable block replication for partition N in the destination data disk. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Device' => [ 'description' => 'The ID of partition N in the destination data disk.'."\n" ."\n" .'> The partitions in the destination data disk are arranged in the same sequential order as those in the source data disk.'."\n", 'type' => 'string', 'required' => false, 'example' => '0_1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 32, ], 'Size' => [ 'description' => 'The size of the data disk on the destination ECS instance. Unit: GiB. Valid values: 20 to 32768.'."\n" ."\n" .'> The size of a destination data disk must be greater than the size of data in the source data disk. For example, if the source data disk has 500 GiB of storage space and 100 GiB of data, you must set this parameter to a value greater than 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 16, ], ], [ 'name' => 'NetMode', 'in' => 'query', 'schema' => [ 'description' => 'The network mode for data transmission. Valid values:'."\n" ."\n" .'* 0: Data is transmitted over the Internet. Make sure that the source server can access the Internet.'."\n" .'* 2: Data is transmitted over a virtual private cloud (VPC). If you set this parameter to 2, you must specify the VSwitchId parameter. You can leave the VpcId parameter empty, the VPC ID can be queried by calling an operation.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch in the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1ddbrxdlrcbim46****', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC for which an Express Connect circuit or VPN gateway is configured.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1vwnn14rqpyiczj****', ], ], [ 'name' => 'ReplicationParameters', 'in' => 'query', 'schema' => [ 'description' => 'The parameters of the replication driver. The parameters are fixed key-value pairs of the JSON format. The value can be up to 2,048 characters in length.'."\n" ."\n" .'A replication driver is a tool that is used to replicate the data of a source server to an intermediate instance. The parameters vary based on the replication driver type. If you use a Server Migration Tool (SMT) driver, you can set the following parameters:'."\n" ."\n" .'* bandwidth_limit: the maximum bandwidth for data transmission.'."\n" .'* compress_level: the compression ratio of data to be transmitted.'."\n" .'* checksum: specifies whether to enable checksum verification'."\n" ."\n" .'For more information about the replication driver, see the response parameter `SourceServers.ReplicationDriver` of the [DescribeSourceServers](~~2402126~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"bandwidth_limit":0,"compress_level":1,"checksum":true}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1C488B66-B819-4D14-8711-C4EAAA13AC01', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DataDisk.DuplicateIndex', 'errorMessage' => 'The source server data disk cannot contain the same index.', ], [ 'errorCode' => 'ReplicationJobDataDiskIndex.Invalid', 'errorMessage' => 'The specified replication job contains data disk index not found in source server.', ], [ 'errorCode' => 'ReplicationJobName.Duplicate', 'errorMessage' => 'The specified replication job name already exists.', ], [ 'errorCode' => 'ReplicationJob.InvalidStatus', 'errorMessage' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'ReplicationJob.InvalidBusinessStatus', 'errorMessage' => 'The specified business status: %s of the replication job is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'ImageName.UsedByReplicationJob', 'errorMessage' => 'The specified imageName: "%s" was used by another replication job in the current region.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1C488B66-B819-4D14-8711-C4EAAA13AC01\\n","errorExample":""}]', 'title' => 'ModifyReplicationJobAttribute', 'description' => '## Usage notes'."\n" ."\n" .'Before you modify the parameters of a migration job, take note of the following information:'."\n" ."\n" .'* The `Name` and `Description` parameters can be modified during the lifecycle of the migration job.'."\n" .'* The `Frequency` and `MaxNumberOfImageToKeep` parameters can be modified only before the migration job is executed or when the migration job is in the `Waiting` state.'."\n" .'* Other parameters can be modified only before the migration job is executed.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StartReplicationJob' => [ 'summary' => 'Starts a migration job.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '18576', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The migration job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'j-bw526m1vi6x21q****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The request ID.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReplicationJob.InvalidStatus', 'errorMessage' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]', 'title' => 'StartReplicationJob', 'description' => '## Usage notes'."\n" ."\n" .'This operation can only be used to start the migration jobs that are in the Ready, Stopped, or InError state.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StopReplicationJob' => [ 'summary' => 'Pauses a migration job.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '18577', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The migration job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'j-bw526m1vi6x21qh****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReplicationJob.InvalidStatus', 'errorMessage' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'ReplicationJob.InvalidBusinessStatus', 'errorMessage' => 'The specified business status: %s of the replication job is invalid. This operation can only be performed in the following status: %s.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]', 'title' => 'StopReplicationJob', 'description' => '## Usage notes'."\n" ."\n" .'You can call this operation to pause only a migration job whose primary status is Running and business status is Syncing.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeReplicationJobs' => [ 'summary' => 'Queries the details of migration jobs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '18568', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the migration job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud region to which you want to migrate the source server.'."\n" ."\n" .'For example, if you want to migrate a source server to the China (Hangzhou) region, set this parameter to `cn-hangzhou`. You can call the [DescribeRegions](~~25609~~) operation to query the latest regions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the migration job. Valid values:'."\n" ."\n" .'* Ready: The migration job is not started.'."\n" .'* Running: The migration job is running.'."\n" .'* Stopped: The migration job is paused.'."\n" .'* InError: An error occurs in the migration job.'."\n" .'* Finished: The migration job is complete.'."\n" .'* Waiting: The migration job is waiting to run.'."\n" .'* Expired: The migration job has expired.'."\n" .'* Deleting: The migration job is being deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Ready', ], ], [ 'name' => 'BusinessStatus', 'in' => 'query', 'schema' => [ 'description' => 'The business status of the migration job. Valid values:'."\n" ."\n" .'* Preparing: The migration is being prepared.'."\n" .'* Syncing: Data is being synchronized.'."\n" .'* Processing: The migration is in progress.'."\n" .'* Cleaning: Intermediate resources are being released.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Preparing', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Minimum value: 1.'."\n" ."\n" .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: 1 to 50.'."\n" ."\n" .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the source servers. You can specify a maximum of 50 IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the source server.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp1bjhkwk2j5hlbn****', ], 'required' => false, 'example' => 's-bp1e2fsl57knvuug****', 'maxItems' => 100, ], ], [ 'name' => 'JobId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the migration jobs. You can specify a maximum of 50 IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the migration job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'j-bp1h3d33mekxwu0n****', ], 'required' => false, 'example' => 'j-bp19vlwm0tyigbmj****', 'maxItems' => 100, ], ], [ 'name' => 'JobType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the migration job. Valid values:'."\n" ."\n" .'* 0: server migration.'."\n" .'* 1: operating system migration.'."\n" .'* 2: cross-zone migration.'."\n" .'* 3: agentless migration for a VMware VM.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the destination Elastic Compute Service (ECS) instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the destination ECS instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1f1dvfto1sigz5****', ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about tags that are attached to the SMC resource.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags list.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag N that is added to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag key can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The value of tag N that is added to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag value can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.[](http://https://。)'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of migration jobs returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'ReplicationJobs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReplicationJob' => [ 'description' => 'The details of migration jobs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of migration jobs.'."\n", 'type' => 'object', 'properties' => [ 'Frequency' => [ 'description' => 'The interval at which the incremental migration job runs. Unit: hour. Valid values: 1 to 168.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], 'VpcId' => [ 'description' => 'The ID of a virtual private cloud (VPC) for which you have configured an Express Connect circuit or a VPN gateway.'."\n", 'type' => 'string', 'example' => 'vpc-bp1vwnn14rqpyiczj****', ], 'CreationTime' => [ 'description' => 'The time when the migration job was created.'."\n", 'type' => 'string', 'example' => '2014-07-24T13:00:52Z', ], 'Status' => [ 'description' => 'The status of the migration job. Valid values:'."\n" ."\n" .'* Ready: The migration job is not started.'."\n" .'* Running: The migration job is running.'."\n" .'* Stopped: The migration job is paused.'."\n" .'* InError: An error occurs in the migration job.'."\n" .'* Finished: The migration job is complete.'."\n" .'* Waiting: The migration job is waiting to run.'."\n" .'* Expired: The migration job has expired.'."\n" .'* Deleting: The migration job is being deleted.'."\n", 'type' => 'string', 'example' => 'Running', ], 'ScheduledStartTime' => [ 'description' => 'The time when the migration job is scheduled to run. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. The time must meet the following requirements:'."\n" ."\n" .'* The value must be within 30 days after the current time.'."\n" .'* If you do not specify this parameter, you must manually start the migration job after the migration job is created. You can call the [StartReplicationJob](~~121823~~) operation to start the migration job.'."\n", 'type' => 'string', 'example' => '2019-06-04T13:35:00Z', ], 'MaxNumberOfImageToKeep' => [ 'description' => 'The maximum number of images retained for the incremental migration job. Valid values: 1 to 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'ContainerNamespace' => [ 'description' => 'The namespace of the destination Docker container image.'."\n", 'type' => 'string', 'example' => 'testNamespace', ], 'DataDisks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DataDisk' => [ 'description' => 'The data disks on the destination ECS instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data disks on the destination Elastic Compute Service (ECS) instance.', 'type' => 'object', 'properties' => [ 'Index' => [ 'description' => 'The index number of the data disk.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Size' => [ 'description' => 'The size of the data disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'Parts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Part' => [ 'description' => 'The data disk partitions.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of the data disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480', ], 'Block' => [ 'description' => 'Indicates whether block replication is enabled for the data disk partition.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Device' => [ 'description' => 'The device ID of the data disk partition.'."\n", 'type' => 'string', 'example' => '0_1', ], ], ], ], ], ], ], ], ], ], ], 'StatusInfo' => [ 'description' => 'The status information about the migration job.'."\n", 'type' => 'string', 'example' => 'statusinfo', ], 'InstanceRamRole' => [ 'description' => 'The name of the Resource Access Management (RAM) role that is assigned to the instance.'."\n", 'type' => 'string', 'example' => 'SMCAdmin', ], 'SystemDiskSize' => [ 'description' => 'The size of the system disk of the destination ECS instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'Description' => [ 'description' => 'The description of the migration job.'."\n", 'type' => 'string', 'example' => 'This is my migration task.', ], 'ReplicationParameters' => [ 'description' => 'The string of key-value pairs configured for the replication driver.'."\n", 'type' => 'string', 'example' => 'BandWidthLimit:0', ], 'ErrorCode' => [ 'description' => 'The error code returned if an error occurred in the migration job.'."\n", 'type' => 'string', 'example' => 'InternalError', ], 'ValidTime' => [ 'description' => 'The time when the migration job expired. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" ."\n" .'> The time displayed in the SMC console is in the format of UTC+8.'."\n", 'type' => 'string', 'example' => '2019-06-08T14:40:52Z', ], 'NetMode' => [ 'description' => 'The type of network used for the migration.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ContainerTag' => [ 'description' => 'The tag of the destination Docker container image.'."\n", 'type' => 'string', 'example' => 'CentOS:v1', ], 'LicenseType' => [ 'description' => 'The type of license for the migration job. Valid values:'."\n" ."\n" .'* An empty value indicates no license.'."\n" .'* A value of BYOL indicates Bring Your Own License (BYOL).'."\n", 'type' => 'string', 'example' => 'BYOL', ], 'Name' => [ 'description' => 'The name of the migration job.'."\n", 'type' => 'string', 'example' => 'testMigrationTaskName', ], 'ImageId' => [ 'description' => 'The ID of the destination image.'."\n", 'type' => 'string', 'example' => 'm-o6w3gy99qf89rkga****', ], 'Progress' => [ 'description' => 'The progress of the migration job.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '100', ], 'RunOnce' => [ 'description' => 'Indicates whether incremental migration is disabled for the source server. Valid values:'."\n" ."\n" .'* true: Incremental migration is disabled. A migration job runs only once after the job is created.'."\n" .'* false: Incremental migration is enabled. For an incremental migration job, SMC synchronizes incremental data to Alibaba Cloud at the interval specified by the `Frequency` parameter.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'LaunchTemplateId' => [ 'description' => 'The ID of the launch template.'."\n", 'type' => 'string', 'example' => 'lt-launchtemplateid', ], 'ContainerRepository' => [ 'description' => 'The repository that stores the destination Docker container image.'."\n", 'type' => 'string', 'example' => 'testRepository', ], 'InstanceId' => [ 'description' => 'The ID of the destination ECS instance.'."\n", 'type' => 'string', 'example' => 'i-bp1ff25rzvnul6kr****', ], 'SystemDiskParts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SystemDiskPart' => [ 'description' => 'The system disk partitions.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of the system disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '254803968', ], 'Block' => [ 'description' => 'Indicates whether block replication is enabled for the system disk partition.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Device' => [ 'description' => 'The device ID of the system disk partition.'."\n", 'type' => 'string', 'example' => '0_1', ], ], ], ], ], ], 'InstanceType' => [ 'description' => 'The instance type of the intermediate instance.'."\n", 'type' => 'string', 'example' => 'ecs.sn1ne.large', ], 'SourceId' => [ 'description' => 'The ID of the source server.'."\n", 'type' => 'string', 'example' => 's-bp1e2fsl57knvuug****', ], 'LaunchTemplateVersion' => [ 'description' => 'The versions of the launch template.'."\n", 'type' => 'string', 'example' => '1', ], 'RegionId' => [ 'description' => 'The ID of the Alibaba Cloud region to which the source server is migrated.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'TransitionInstanceId' => [ 'description' => 'The ID of the intermediate instance.'."\n", 'type' => 'string', 'example' => 'i-bp1ff25rzvnul6kr****', ], 'EndTime' => [ 'description' => 'The time when the migration job was complete. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" ."\n" .'> The time displayed in the SMC console is in the format of UTC+8.'."\n", 'type' => 'string', 'example' => '2019-06-04T16:00:52Z', ], 'StartTime' => [ 'description' => 'The time when the migration job was started. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" ."\n" .'> The time displayed in the SMC console is in the format of UTC+8.'."\n", 'type' => 'string', 'example' => '2019-06-04T14:40:52Z', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch in the specified VPC.'."\n", 'type' => 'string', 'example' => 'vsw-bp1ddbrxdlrcbim46****', ], 'JobId' => [ 'description' => 'The ID of the migration job.'."\n", 'type' => 'string', 'example' => 'j-bp19vlwm0tyigbmj****', ], 'ImageName' => [ 'description' => 'The name of the destination image.'."\n", 'type' => 'string', 'example' => 'testAliCloudImageName', ], 'BusinessStatus' => [ 'description' => 'The business status of the migration job. Valid values:'."\n" ."\n" .'* Preparing: The migration is being prepared.'."\n" .'* Syncing: Data is being synchronized.'."\n" .'* Processing: The migration is in progress.'."\n" .'* Cleaning: Intermediate resources are being released.'."\n", 'type' => 'string', 'example' => 'Preparing', ], 'ReplicationJobRuns' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReplicationJobRun' => [ 'description' => 'The execution records of the migration job.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The time when the migration job ended. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" ."\n" .'> The time displayed in the SMC console is in the format of UTC+8.'."\n", 'type' => 'string', 'example' => '2019-10-04T13:35:00Z', ], 'Type' => [ 'description' => 'The method used to run the migration job. Valid values:'."\n" ."\n" .'* Manual: The migration job was manually started.'."\n" .'* Schedule: The migration job was started at a scheduled time or at a specific interval.'."\n", 'type' => 'string', 'example' => 'Schedule', ], 'StartTime' => [ 'description' => 'The time when the migration job was started. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" ."\n" .'> The time displayed in the SMC console is in the format of UTC+8.'."\n", 'type' => 'string', 'example' => '2019-10-01T13:35:00Z', ], 'ImageId' => [ 'description' => 'The ID of the destination image.'."\n", 'type' => 'string', 'example' => 'm-o6w3gy99qf89rkga****', ], ], ], ], ], ], 'TargetType' => [ 'description' => 'The type of destination to which the source server is migrated. Valid values:'."\n" ."\n" .'* Image: After the migration job is complete, SMC generates an ECS image for the source server.'."\n" .'* ContainerImage: After the migration job is complete, SMC generates a Docker container image for the source server.'."\n" .'* TargetInstance: After the migration job is complete, SMC migrates the source server to the destination instance. If you set this parameter to TargetInstance, you must set the InstanceId parameter.'."\n", 'type' => 'string', 'example' => 'Image', ], 'JobType' => [ 'description' => 'The type of the migration job. Valid values:'."\n" ."\n" .'* 0: server migration.'."\n" .'* 1: operating system migration.'."\n" .'* 2: cross-zone migration.'."\n" .'* 3: agentless migration for a VMware VM.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmw3ty5y7****', ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The information about tags that are attached to the SMC resource.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag N that is added to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag key can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.[](http://https://。)'."\n", 'type' => 'string', 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The value of tag N that is added to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag value can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.[](http://https://。)'."\n", 'type' => 'string', 'example' => 'TestValue', ], ], ], ], ], ], 'Disks' => [ 'description' => 'The information about the disk.'."\n", 'type' => 'object', 'properties' => [ 'System' => [ 'description' => 'The information about the system disk.'."\n", 'type' => 'object', 'properties' => [ 'Size' => [ 'description' => 'The size of the source system disk. Unit: GiB. Valid values: 20 to 32768.'."\n" ."\n" .'> The parameter value must be greater than the actual used space of the data disk on the source server. For example, if the size of the source disk is 500 GiB but the actual used space is 100 GiB, you must set this parameter to a value greater than 100 GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'LVM' => [ 'description' => 'Specifies whether to use LVM. Valid values:'."\n" ."\n" .'* true: Use LVM.'."\n" .'* false: Not use LVM.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'DiskId' => [ 'description' => 'The ID of the system disk.'."\n", 'type' => 'string', 'example' => 'd-2zeh4twm100qskw7z41z', ], 'Parts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Part' => [ 'description' => 'The information about the system disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the system disk partition.'."\n", 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of the system disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'."\n", ], 'Block' => [ 'description' => 'Specifies whether block replication is enabled for the system disk partition. Valid values:'."\n" ."\n" .'* true: Block replication is enabled for the system disk partition.'."\n" .'* false: Block replication is disabled for the system disk partition.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Path' => [ 'description' => 'The path of the system disk partition.'."\n", 'type' => 'string', 'example' => '/boot', ], ], ], ], ], ], ], ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Data' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'object', 'properties' => [ 'Size' => [ 'description' => 'The size of a data disk on the destination ECS instance. Unit: GiB. Valid values: 20 to 32768.'."\n" ."\n" .'> The size of a destination data disk must be larger than the size of data in the corresponding source data disk. For example, if the size of the source disk is 500 GiB but the actual used space is 100 GiB, you must set this parameter to a value greater than 100 GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22548578304', ], 'LVM' => [ 'description' => 'Specifies whether to use LVM. Valid values:'."\n" ."\n" .'* true: Use LVM.'."\n" .'* false: Not use LVM.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'DiskId' => [ 'description' => 'The ID of the data disk.'."\n", 'type' => 'string', 'example' => 'd-2zeh4twm100qskw7z41z', ], 'Parts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Part' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk partition.'."\n", 'type' => 'object', 'properties' => [ 'SizeBytes' => [ 'description' => 'The size of the data disk partition. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'."\n", ], 'Block' => [ 'description' => 'Whether block replication is enabled for the data disk partition. Valid values:'."\n" ."\n" .'* true: Block replication is enabled for the data disk partition.'."\n" .'* false: Block replication is disabled for the data disk partition.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Path' => [ 'description' => 'The path of the data disk partition.'."\n", 'type' => 'string', 'example' => '/home/data'."\n", ], ], ], ], ], ], ], ], ], ], ], ], ], 'WorkgroupId' => [ 'type' => 'string', ], ], ], ], ], ], 'PageSize' => [ 'description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6E1187E8-843A-4850-B97E-2F17F00D48F7', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 5,\\n \\"ReplicationJobs\\": {\\n \\"ReplicationJob\\": [\\n {\\n \\"Frequency\\": 15,\\n \\"VpcId\\": \\"vpc-bp1vwnn14rqpyiczj****\\",\\n \\"CreationTime\\": \\"2014-07-24T13:00:52Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"ScheduledStartTime\\": \\"2019-06-04T13:35:00Z\\",\\n \\"MaxNumberOfImageToKeep\\": 8,\\n \\"ContainerNamespace\\": \\"testNamespace\\",\\n \\"DataDisks\\": {\\n \\"DataDisk\\": [\\n {\\n \\"Index\\": 1,\\n \\"Size\\": 40,\\n \\"Parts\\": {\\n \\"Part\\": [\\n {\\n \\"SizeBytes\\": 21474836480,\\n \\"Block\\": true,\\n \\"Device\\": \\"0_1\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"StatusInfo\\": \\"statusinfo\\",\\n \\"InstanceRamRole\\": \\"SMCAdmin\\",\\n \\"SystemDiskSize\\": 40,\\n \\"Description\\": \\"This is my migration task.\\",\\n \\"ReplicationParameters\\": \\"BandWidthLimit:0\\",\\n \\"ErrorCode\\": \\"InternalError\\",\\n \\"ValidTime\\": \\"2019-06-08T14:40:52Z\\",\\n \\"NetMode\\": 0,\\n \\"ContainerTag\\": \\"CentOS:v1\\",\\n \\"LicenseType\\": \\"BYOL\\",\\n \\"Name\\": \\"testMigrationTaskName\\",\\n \\"ImageId\\": \\"m-o6w3gy99qf89rkga****\\",\\n \\"Progress\\": 100,\\n \\"RunOnce\\": true,\\n \\"LaunchTemplateId\\": \\"lt-launchtemplateid\\",\\n \\"ContainerRepository\\": \\"testRepository\\",\\n \\"InstanceId\\": \\"i-bp1ff25rzvnul6kr****\\",\\n \\"SystemDiskParts\\": {\\n \\"SystemDiskPart\\": [\\n {\\n \\"SizeBytes\\": 254803968,\\n \\"Block\\": true,\\n \\"Device\\": \\"0_1\\"\\n }\\n ]\\n },\\n \\"InstanceType\\": \\"ecs.sn1ne.large\\",\\n \\"SourceId\\": \\"s-bp1e2fsl57knvuug****\\",\\n \\"LaunchTemplateVersion\\": \\"1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TransitionInstanceId\\": \\"i-bp1ff25rzvnul6kr****\\",\\n \\"EndTime\\": \\"2019-06-04T16:00:52Z\\",\\n \\"StartTime\\": \\"2019-06-04T14:40:52Z\\",\\n \\"VSwitchId\\": \\"vsw-bp1ddbrxdlrcbim46****\\",\\n \\"JobId\\": \\"j-bp19vlwm0tyigbmj****\\",\\n \\"ImageName\\": \\"testAliCloudImageName\\",\\n \\"BusinessStatus\\": \\"Preparing\\",\\n \\"ReplicationJobRuns\\": {\\n \\"ReplicationJobRun\\": [\\n {\\n \\"EndTime\\": \\"2019-10-04T13:35:00Z\\",\\n \\"Type\\": \\"Schedule\\",\\n \\"StartTime\\": \\"2019-10-01T13:35:00Z\\",\\n \\"ImageId\\": \\"m-o6w3gy99qf89rkga****\\"\\n }\\n ]\\n },\\n \\"TargetType\\": \\"Image\\",\\n \\"JobType\\": 0,\\n \\"ResourceGroupId\\": \\"rg-acfmw3ty5y7****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n },\\n \\"Disks\\": {\\n \\"System\\": {\\n \\"Size\\": 100,\\n \\"LVM\\": false,\\n \\"DiskId\\": \\"d-2zeh4twm100qskw7z41z\\",\\n \\"Parts\\": {\\n \\"Part\\": [\\n {\\n \\"SizeBytes\\": 21474836480,\\n \\"Block\\": true,\\n \\"Path\\": \\"/boot\\"\\n }\\n ]\\n }\\n },\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"Size\\": 22548578304,\\n \\"LVM\\": false,\\n \\"DiskId\\": \\"d-2zeh4twm100qskw7z41z\\",\\n \\"Parts\\": {\\n \\"Part\\": [\\n {\\n \\"SizeBytes\\": 21474836480,\\n \\"Block\\": false,\\n \\"Path\\": \\"/home/data\\\\n\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n },\\n \\"WorkgroupId\\": \\"w-bp1ja22kdqphehlj****\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"6E1187E8-843A-4850-B97E-2F17F00D48F7\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n \\n 15\\n vpc-bp1vwnn14rqpyiczj****\\n 2014-07-24T13:00:52Z\\n Running\\n 2019-06-04T13:35:00Z\\n 8\\n testNamespace\\n \\n 1\\n 40\\n \\n 21474836480\\n true\\n 0_1\\n \\n \\n statusinfo\\n SMCAdmin\\n 40\\n This is my migration task.\\n BandWidthLimit:0\\n InternalError\\n 2019-06-08T14:40:52Z\\n 0\\n CentOS:v1\\n BYOL\\n testMigrationTaskName\\n m-o6w3gy99qf89rkga****\\n 100\\n true\\n lt-launchtemplateid\\n testRepository\\n i-bp1ff25rzvnul6kr****\\n \\n 254803968\\n true\\n 0_1\\n \\n ecs.sn1ne.large\\n s-bp1e2fsl57knvuug****\\n 1\\n cn-hangzhou\\n i-bp1ff25rzvnul6kr****\\n 2019-06-04T16:00:52Z\\n 2019-06-04T14:40:52Z\\n vsw-bp1ddbrxdlrcbim46****\\n j-bp19vlwm0tyigbmj****\\n testAliCloudImageName\\n Preparing\\n \\n 2019-10-04T13:35:00Z\\n Schedule\\n 2019-10-01T13:35:00Z\\n m-o6w3gy99qf89rkga****\\n \\n Image\\n 0\\n rg-acfmw3ty5y7****\\n \\n TestKey\\n TestValue\\n \\n \\n 10\\n 6E1187E8-843A-4850-B97E-2F17F00D48F7\\n 1\\n","errorExample":""}]', 'title' => 'DescribeReplicationJobs', 'description' => '## Usage notes'."\n" ."\n" .'* You can specify multiple request parameters to be queried. Specified parameters are evaluated by using the AND operator. Only the specified parameters are used as filter conditions.'."\n" .'* Server Migration Center (SMC) allows you to migrate source servers to Docker container images. You can use SMC to migrate containerized applications in a cost-effective way. For more information, see [Terms](~~60744~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CutOverReplicationJob' => [ 'summary' => 'Stops an incremental migration job that periodically runs. After you call this operation to stop an incremental migration job, the migration job is complete.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '18561', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the incremental migration job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'j-bp1fnx5y3djc4cop****', ], ], [ 'name' => 'SyncData', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to migrate full data for the last time. Valid Values:'."\n" ."\n" .'* true: migrates full data for the last time.'."\n" .'* false: does not migrate full data for the last time.'."\n" ."\n" .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The request ID.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReplicationJob.InvalidStatus', 'errorMessage' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'ReplicationJob.InvalidBusinessStatus', 'errorMessage' => 'The specified business status: %s of the replication job is invalid. This operation can only be performed in the following status: %s.', ], [ 'errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]', 'title' => 'CutOverReplicationJob', 'description' => '## Usage notes'."\n" ."\n" .'* The incremental migration job must be in the Waiting state.'."\n" .'* After you call this operation, the incremental migration job no longer periodically runs. In the meantime, Server Migration Center (SMC) determines whether to perform a full data migration for the last time based on the value of the `SyncData` parameter. If you set the SyncData parameter to `false`, SMC releases intermediate resources without data migration before the migration job is complete. If you set the SyncData parameter to `true`, SMC performs a full data migration and releases intermediate resources before the migration job is complete.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteReplicationJob' => [ 'summary' => 'Deletes a migration job.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '18562', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The migration job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'j-bp17m1vi6x21qhqk****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReplicationJob.InvalidStatus', 'errorMessage' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]', 'title' => 'DeleteReplicationJob', 'description' => '## Usage notes'."\n" ."\n" .'* Deleted migration jobs cannot be restored.'."\n" .'* After a migration job is deleted, associated resources, such as the intermediate instance, are automatically released.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateWorkgroup' => [ 'summary' => 'Creates a workgroup. You can create a workgroup to manage the lifecycles of multiple migration tasks at a time. This is suitable for scenarios in which multiple servers are migrated.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '240381', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '幂等参数', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, 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. For more information, see [How to ensure idempotence](~~25693~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the workgroup. The name must meet the following requirements:'."\n" ."\n" .'* The name must be unique.'."\n" .'* The name must be 2 to 64 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain digits, colons (:), periods (.), underscores (\\_), and hyphens (-).'."\n", 'type' => 'string', 'required' => false, 'example' => 'testWorkgroupName', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the workgroup. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the reserved instance. You can specify up to 20 tags. If you specify multiple tags, the tag keys cannot be duplicated.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Tag N.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key of the workgroup. You cannot specify an empty string as a tag key. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The tag value of the workgroup. The tag value can be up to 128 characters in length, cannot be an empty string, and cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9', ], 'WorkgroupId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the workgroup.'."\n", 'type' => 'string', 'example' => 'w-***', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8B26B44-0189-443E-9816-D951F59623A9\\",\\n \\"WorkgroupId\\": \\"w-bp10geepnj916e3d****\\"\\n}","type":"json"}]', 'title' => 'CreateWorkgroup', 'description' => '* You can create up to 50 workgroups within an Alibaba Cloud account.'."\n" .'* A workgroup can be associated with a maximum of 50 migration sources.'."\n" .'* A migration source can be associated with only one workgroup.'."\n", ], 'AssociateSourceServers' => [ 'summary' => 'Associates multiple migration sources with a workgroup.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '240395', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'WorkgroupId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '幂等参数', 'description' => 'The ID of the workgroup.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-***', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The ID of the migration source. A workgroup can be associated with a maximum of 50 migration sources.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the migration source.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****', ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8B26B44-0189-443E-9816-D951F59623A9\\"\\n}","type":"json"}]', 'title' => 'AssociateSourceServers', 'description' => 'A migration source can be associated with only one workgroup.'."\n", ], 'DisassociateSourceServers' => [ 'summary' => 'Disassociates migration sources from a workgroup. If you do not need to use a workgroup to migrate migration sources, you can disassociate the migration sources from the workgroup.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '240400', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'WorkgroupId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '幂等参数', 'description' => 'The ID of the workgroup.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-***', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of migration sources that you want to disassociate from the workgroup. You can specify up to 50 migration sources.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the migration source.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp17m1vi6x20c6g6****', ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","type":"json"}]', 'title' => 'DisassociateSourceServers', ], 'DescribeWorkgroups' => [ 'summary' => 'Queries the information about workgroups. After you create a workgroup, you can query the information about the workgroup, such as the name, description, and alert information.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '240404', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'WorkgroupId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The workgroup IDs. You can specify up to 50 workgroup IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The workgroup ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-***', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the workgroup.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The state of the workgroup. Valid values:'."\n" ."\n" .'* NotStarted'."\n" .'* InProgress'."\n" .'* Cutover'."\n" .'* Completed'."\n", 'type' => 'string', 'required' => false, 'example' => 'InProgress', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Minimum value: 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the reserved instance. You can specify up to 20 tags. If you specify multiple tags, the tag keys cannot be duplicated.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Tag N.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key of the workgroup. You cannot specify an empty string as a tag key. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The tag value of the workgroup. The tag value can be up to 128 characters in length, cannot be an empty string, and cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The information of parameters that is returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', ], 'TotalCount' => [ 'description' => 'The total number of workgroups.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Workgroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Workgroup' => [ 'description' => 'The details of the workgroup.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object of the workgroup.'."\n", 'type' => 'object', 'properties' => [ 'WorkgroupId' => [ 'description' => 'The ID of the workgroup.'."\n", 'type' => 'string', 'example' => 'w-***', ], 'Name' => [ 'description' => 'The name of the workgroup.'."\n", 'type' => 'string', 'example' => 'testWorkgroupName', ], 'Description' => [ 'description' => 'The description of the workgroup.'."\n", 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'description' => 'The state of the workgroup. Valid values:'."\n" ."\n" .'* NotStarted'."\n" .'* InProgress'."\n" .'* Cutover'."\n" .'* Completed'."\n", 'type' => 'string', 'example' => 'InProgress', ], 'Warnings' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Warning' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'WarningType' => [ 'type' => 'string', ], 'SourceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SourceId' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tag information of the workgroup.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag information of the workgroup.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key of the workgroup.'."\n", 'type' => 'string', 'example' => ' '."\n" .'TestKey', ], 'Value' => [ 'description' => 'The tag value of the workgroup.'."\n", 'type' => 'string', 'example' => 'TestValue', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Workgroups\\": {\\n \\"Workgroup\\": [\\n {\\n \\"WorkgroupId\\": \\"w-bp10geepnj916e3d****\\",\\n \\"Name\\": \\"testWorkgroupName\\",\\n \\"Description\\": \\"test\\",\\n \\"Status\\": \\"InProgress\\",\\n \\"Warnings\\": {\\n \\"Warning\\": [\\n {\\n \\"WarningType\\": \\"InError\\",\\n \\"SourceIds\\": {\\n \\"SourceId\\": [\\n \\"s-bp1h7ymebl7swbt4****\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"\\\\t\\\\nTestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeWorkgroups', ], 'ModifyWorkgroupAttribute' => [ 'summary' => 'Modifies the name and description of a workgroup.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '240380', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'WorkgroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the workgroup.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-***', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the workgroup. The name must meet the following requirements:'."\n" ."\n" .'* The name must be unique.'."\n" .'* The name must be 2 to 64 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain digits, colons (:), periods (.), underscores (\\_), and hyphens (-).'."\n", 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The new description of the workgroup. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","type":"json"}]', 'title' => 'ModifyWorkgroupAttribute', ], 'DeleteWorkgroup' => [ 'summary' => 'Deletes a workgroup.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '240401', 'abilityTreeNodes' => [ 'FEATUREsmcTXNBS6', ], ], 'parameters' => [ [ 'name' => 'WorkgroupId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The ID of the workgroup.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '410E6073-66D0-45D3-AB3E-4DC3F5E4****', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"410E6073-66D0-45D3-AB3E-4DC3F5E4****\\"\\n}","type":"json"}]', 'title' => 'DeleteWorkgroup', 'description' => 'To delete a workgroup, you must delete or dissociate the migration source that is associated with the workgroup. For more information, see [DeleteSourceServer](~~2402124~~).'."\n", ], 'TagResources' => [ 'summary' => 'Creates tags and adds them to Server Migration Center (SMC) resources. The SMC resources include migration sources and jobs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '18578', 'abilityTreeNodes' => [ 'FEATUREsmc6EK4ZG', ], ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the SMC resource. Valid values:'."\n" ."\n" .'* sourceserver: migration source.'."\n" .'* replicationjob: migration job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sourceserver', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of N SMC resources. SMC resources include migration sources and jobs. Valid values of N: 1 to 50.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The SMC resource ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bw526m1vi6x20c6g****', ], 'required' => true, 'example' => 's-bw526m1vi6x20c6g****', 'maxItems' => 51, ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags list.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of tag N to be added to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag key cannot be an empty string. It can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The value of tag N to be added to the SMC resource. Valid values of N: 1 to 20.'."\n" ."\n" .'The tag value can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of the Tag parameters cannot exceed 20.', ], [ 'errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', ], [ 'errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The specified ResourceType does not exist.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceId parameters cannot exceed 50.', ], [ 'errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The ResourceId contains duplicate values.', ], [ 'errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds do not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3E8B9ABB-289A-44E6-942D-8AA9E493****\\n","errorExample":""}]', 'title' => 'TagResources', 'description' => '## Usage notes'."\n" ."\n" .'Up to 20 tags can be added to each SMC resource.'."\n" ."\n" .'Before you add tags to an SMC resource, Alibaba Cloud checks the number of the tags that have been added to the resource. If the maximum number is reached, an error message is returned.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListTagResources' => [ 'summary' => 'Queries the tags that are attached to Server Migration Center (SMC) resources. SMC resources include migration sources and migration jobs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '18571', 'abilityTreeNodes' => [ 'FEATUREsmc6EK4ZG', ], ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the SMC resource. Valid values:'."\n" ."\n" .'* sourceserver: migration source.'."\n" .'* replicationjob: migration job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sourceserver', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of SMC resources. SMC resources include migration sources and migration jobs. You can specify a maximum of 50 SMC resource IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the SMC resource. SMC resources include migration sources and migration jobs.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****', ], 'required' => false, 'example' => 's-bp1e2fsl57knvuug****', 'maxItems' => 51, ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags that are attached to SMC resources.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of tag N. The tag key must be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n" ."\n" .'Tag.N is used for exact match of SMC resources to which the tag is attached. Tag N consists of a key-value pair.'."\n" ."\n" .'* Tag keys and values are case-sensitive.'."\n" .'* If you set only the Tag.N.Key parameter, all resources to which the specified tags are attached are returned.'."\n" .'* If you set only the Tag.N.Value parameter, the error message InvalidParameter.TagValue is returned.'."\n" .'* If you specify multiple tag key-value pairs at a time, only SMC resources that match all tag key-value pairs are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', ], 'Value' => [ 'description' => 'The value of tag N. The value must be 1 to 64 characters in length. Valid values of N: 1 to 20.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', ], ], 'required' => false, 'description' => 'The tags list.'."\n", ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => [ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n" ."\n" .'If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '17743161-66F3-4E7F-B8AE-845FB28B928F', ], 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagResource' => [ 'description' => 'The information about SMC resources and tags, such as the IDs, types, and tag key-value pairs of the resources.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'description' => 'The type of the resource.'."\n", 'type' => 'string', 'example' => 'ALIYUN::SMC::SOURCESERVER', ], 'TagValue' => [ 'description' => 'The value of the tag that is attached to the resource.'."\n", 'type' => 'string', 'example' => 'TestValue', ], 'ResourceId' => [ 'description' => 'The resource ID.'."\n", 'type' => 'string', 'example' => 's-bp1e2fsl57knvuug****', ], 'TagKey' => [ 'description' => 'The key of the tag that is attached to the resource.'."\n", 'type' => 'string', 'example' => 'TestKey', ], ], 'description' => 'The details about the resources and tags, such as the resource ID, the resource type, tag keys, and tag values.'."\n", ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of the Tag parameters cannot exceed 20.', ], [ 'errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', ], [ 'errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The specified ResourceType does not exist.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceId parameters cannot exceed 50.', ], [ 'errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The ResourceId contains duplicate values.', ], [ 'errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds do not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"17743161-66F3-4E7F-B8AE-845FB28B928F\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::SMC::SOURCESERVER\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"s-bp1e2fsl57knvuug****\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 17743161-66F3-4E7F-B8AE-845FB28B928F\\n \\n ALIYUN::SMC::SOURCESERVER\\n TestValue\\n s-bp1e2fsl57knvuug****\\n TestKey\\n \\n","errorExample":""}]', 'title' => 'ListTagResources', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UntagResources' => [ 'summary' => 'Removes tags that are added to Server Migration Center (SMC) resources. The SMC resources include migration sources and jobs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '18579', 'abilityTreeNodes' => [ 'FEATUREsmc6EK4ZG', ], ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the SMC resource. Valid values:'."\n" ."\n" .'* sourceserver: migration source.'."\n" .'* replicationjob: migration job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sourceserver', ], ], [ 'name' => 'All', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to remove all tags that are added to the specified SMC resource. This parameter is valid only if you do not set `TagKey.N`. Valid values:'."\n" ."\n" .'* true: removes all tags that are added to the specified SMC resource. If no tags are added to the specified SMC resource, no operation is performed.'."\n" .'* false: does not remove tags that are added to the specified SMC resource.'."\n" ."\n" .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of N SMC resources. SMC resources include migration sources and jobs. Valid values of N: 1 to 50.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The IDs of N SMC resources. SMC resources include migration sources and jobs. Valid values of N: 1 to 50.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-bp12tueadp5ndleg****', ], 'required' => true, 'example' => 's-bw526m1vi6x20c6g****', 'maxItems' => 51, ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The key of tag N that is added to the SMC resource. Tag keys are case-sensitive. Valid values of N: 1 to 20.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The key of tag N that is added to the SMC resource. Tag keys are case-sensitive. Valid values of N: 1 to 20.'."\n", 'type' => 'string', 'required' => false, 'example' => 'smc', ], 'required' => false, 'example' => 'TestKey', 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of the Tag parameters cannot exceed 20.', ], [ 'errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', ], [ 'errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The specified ResourceType does not exist.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceId parameters cannot exceed 50.', ], [ 'errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The ResourceId contains duplicate values.', ], [ 'errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds do not exist.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2D69A58F-345C-4FDE-88E4-BF518948****\\n","errorExample":""}]', 'title' => 'UntagResources', 'description' => 'You can call this operation to remove tags that are added to one or more SMC resources and delete the tags if the tags are no longer used.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateAccessToken' => [ 'summary' => 'Creates an activation code.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144505', 'abilityTreeNodes' => [ 'FEATUREsmcWZM4IC', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the activation code. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'test_name', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the activation code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'The description of the activation code.', ], ], [ 'name' => 'Count', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of times that the activation code can be used to import the information of migration sources. Valid values: 1 to 1000.'."\n" ."\n" .'Default value: 100.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', ], ], [ 'name' => 'TimeToLiveInDays', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the activation code. The activation code can no longer be used to import the information of migration sources after the code expires. Unit: day. Valid values: 1 to 90.'."\n" ."\n" .'Default value: 30.'."\n", 'type' => 'string', 'required' => false, 'example' => '30', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DB4A7EA2-6FDA-5655-B067-854532FB****', ], 'AccessTokenCode' => [ 'description' => 'The value of the activation code. The value is returned only once after the CreateAccessToken operation is called and cannot be subsequently queried. Make sure that you properly save the returned value.'."\n", 'type' => 'string', 'example' => 'B57QoTXEA2Tytr0uZWoNY5Aju5Jt****', ], 'AccessTokenId' => [ 'description' => 'The ID of the activation code.'."\n", 'type' => 'string', 'example' => 'at-bp1akz2zp67r0k6r****', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DB4A7EA2-6FDA-5655-B067-854532FB****\\",\\n \\"AccessTokenCode\\": \\"B57QoTXEA2Tytr0uZWoNY5Aju5Jt****\\",\\n \\"AccessTokenId\\": \\"at-bp1akz2zp67r0k6r****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DB4A7EA2-6FDA-5655-B067-854532FB****\\n B57QoTXEA2Tytr0uZWoNY5Aju5Jt****\\n at-bp1akz2zp67r0k6r****\\n","errorExample":""}]', 'title' => 'CreateAccessToken', 'description' => 'If you want to import the information of migration sources by using an activation code, you can call this operation to create one.'."\n", ], 'DisableAccessToken' => [ 'summary' => 'Disables an activation code.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '144984', 'abilityTreeNodes' => [ 'FEATUREsmcWZM4IC', ], ], 'parameters' => [ [ 'name' => 'AccessTokenId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the activation code.'."\n", 'type' => 'string', 'required' => true, 'example' => 'at-bp12g5gwup0yzmce****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The request ID.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"686BB8A6-BBA5-47E5-8A75-D2ADE433****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 686BB8A6-BBA5-47E5-8A75-D2ADE433****\\n","errorExample":""}]', 'title' => 'DisableAccessToken', 'description' => 'To prevent an activation code from being leaked, you can call this operation to disable the activation code. Disabled activation codes can no longer be used to import the information about migration sources. However, migration sources whose information has been imported are not affected.'."\n", ], 'ListAccessTokens' => [ 'summary' => 'Queries activation codes and the usage details of the activation codes.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '144510', 'abilityTreeNodes' => [ 'FEATUREsmcWZM4IC', ], ], 'parameters' => [ [ 'name' => 'AccessTokenId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about activation codes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the activation code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'at-bp1akz2zp67r0k6r****', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the activation code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_name', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the activation code. Valid values:'."\n" ."\n" .'* activated'."\n" .'* unactivated'."\n" .'* expired'."\n", 'type' => 'string', 'required' => false, 'example' => 'activated', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E2DA3097-79B9-53AE-B0DF-281DC54F****', ], 'AccessTokens' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AccessToken' => [ 'description' => 'The activation codes returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The activation codes returned.', 'type' => 'object', 'properties' => [ 'AccessTokenId' => [ 'description' => 'The ID of the activation code.'."\n", 'type' => 'string', 'example' => 'at-bp1akz2zp67r0k6r****', ], 'TimeToLiveInDays' => [ 'description' => 'The validity period of the activation code. Unit: day. Valid values: 1 to 90. Default value: 30.'."\n", 'type' => 'string', 'example' => '30', ], 'Count' => [ 'description' => 'The maximum number of times that the activation code can be used. Valid values: 1 to 1000.'."\n" ."\n" .'Default value: 100.'."\n", 'type' => 'string', 'example' => '100', ], 'RegisteredCount' => [ 'description' => 'The number of migration sources whose information has been imported to Server Migration Center (SMC) by using the activation code.'."\n", 'type' => 'string', 'example' => '5', ], 'CreationTime' => [ 'description' => 'The time when the activation code was created. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-09-09T02:35:44Z', ], 'Status' => [ 'description' => 'The status of the activation code. Valid values:'."\n" ."\n" .'* activated'."\n" .'* unactivated'."\n" .'* expired'."\n", 'type' => 'string', 'example' => 'activated', ], 'Name' => [ 'description' => 'The name of the activation code.'."\n", 'type' => 'string', 'example' => 'test_name', ], 'Description' => [ 'description' => 'The description of the activation code.'."\n", 'type' => 'string', 'example' => 'This is an activation code', ], ], ], ], ], ], 'TotalCount' => [ 'description' => 'The total number of migration sources returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'PageSize' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* 10'."\n" .'* 20'."\n" .'* 50'."\n" ."\n" .'Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2DA3097-79B9-53AE-B0DF-281DC54F****\\",\\n \\"AccessTokens\\": {\\n \\"AccessToken\\": [\\n {\\n \\"AccessTokenId\\": \\"at-bp1akz2zp67r0k6r****\\",\\n \\"TimeToLiveInDays\\": \\"30\\",\\n \\"Count\\": \\"100\\",\\n \\"RegisteredCount\\": \\"5\\",\\n \\"CreationTime\\": \\"2022-09-09T02:35:44Z\\",\\n \\"Status\\": \\"activated\\",\\n \\"Name\\": \\"test_name\\",\\n \\"Description\\": \\"这是激活码\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 20\\n}","errorExample":""},{"type":"xml","example":"\\n E2DA3097-79B9-53AE-B0DF-281DC54F****\\n \\n at-bp1akz2zp67r0k6r****\\n 30\\n 100\\n 5\\n 2022-09-09T02:35:44Z\\n activated\\n test_name\\n 这是激活码\\n \\n 2\\n 1\\n 20\\n","errorExample":""}]', 'title' => 'ListAccessTokens', 'description' => 'You can call this operation to query activation codes and the usage details of the activation codes. An activation code can be in the activated, unactivated, or expired state.'."\n", ], 'DeleteAccessToken' => [ 'summary' => 'Deletes an activation code.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '144985', 'abilityTreeNodes' => [ 'FEATUREsmcWZM4IC', ], ], 'parameters' => [ [ 'name' => 'AccessTokenId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the activation code.'."\n", 'type' => 'string', 'required' => true, 'example' => 'at-bp1akz2zp67r0k6r****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The request ID.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DB4A7EA2-6FDA-5655-B067-854532FB****', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DB4A7EA2-6FDA-5655-B067-854532FB****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DB4A7EA2-6FDA-5655-B067-854532FB****\\n","errorExample":""}]', 'title' => 'DeleteAccessToken', 'description' => 'You can call this operation to delete an activation code if you no longer need to import the information about migration sources by using the activation code or if the activation code has expired.'."\n", ], ], 'endpoints' => [ [ 'regionId' => 'cn-beijing', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-2', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2-pop', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-pop', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-gov-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-nu16-b01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-edge-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-fujian', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-haidian-cm12-c01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-bj-b01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-prod-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-2', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-3', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-test-306', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong-finance-pop', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-north-2-gov-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao-nebula', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-et15-b01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-et2-b01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-inner', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-internal-test-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-inner', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-st4-d01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-su18-b01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-wuhan', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-yushanfang', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-zhangbei-na61-b01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou-na62-a01', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'cn-zhengzhou-nebula-1', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'eu-west-1-oxs', 'endpoint' => 'smc.aliyuncs.com', ], [ 'regionId' => 'rus-west-1-pop', 'endpoint' => 'smc.aliyuncs.com', ], ], ];