{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-smc/associate-source-servers":{"post":{"operationId":"cloud_aliyun_smc_associate_source_servers","summary":"To migrate servers as a group, you must first associate the migration sources with that group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkgroupId","SourceId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"WorkgroupId":{"type":"string","description":"The ID of the group"},"SourceId":{"type":"string","description":"The IDs of the migration sources. You can associate a maximum of 50 migration sources with a group (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/create-access-token":{"post":{"operationId":"cloud_aliyun_smc_create_access_token","summary":"Creates an activation code","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"Name":{"type":"string","description":"The name of the activation code. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and…"},"Description":{"type":"string","description":"The description of the activation code"},"Count":{"type":"string","description":"The maximum number of times that the activation code can be used to register migration sources. Valid values: 1 to 1000. Default value: 100"},"TimeToLiveInDays":{"type":"string","description":"The validity period of the activation code, in days. The activation code cannot be used to register new instances after it expires. Valid…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/create-cross-zone-migration-job":{"post":{"operationId":"cloud_aliyun_smc_create_cross_zone_migration_job","summary":"Server Migration Center (SMC) lets you migrate an Alibaba Cloud Elastic Compute Service (ECS) instance to a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"RegionId":{"type":"string","description":"The ID of the destination Alibaba Cloud region. For example, if you want to migrate a source server to the China (Hangzhou) region, the…"},"ClientToken":{"type":"string","description":"A client token to ensure the idempotence of the request. Generate a unique value for this parameter from your client. \\`ClientToken\\` can…"},"InstanceId":{"type":"string","description":"The ID of the ECS instance"},"TargetVSwitchId":{"type":"string","description":"The ID of the destination vSwitch"},"TargetZoneId":{"type":"string","description":"The ID of the destination zone"},"TargetInstanceType":{"type":"string","description":"The destination instance type"},"AutoPay":{"type":"string","description":"Specifies whether to enable automatic payment. Valid values: true: (Default) Enables automatic payment. Make sure that your account has a…"},"Disk":{"type":"string","description":"The disk information (JSON-encoded)"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/create-replication-job":{"post":{"operationId":"cloud_aliyun_smc_create_replication_job","summary":"Creates a migration task for a migration source by calling CreateReplicationJob","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","SourceId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"RegionId":{"type":"string","description":"The ID of the destination Alibaba Cloud region to which the migration source is to be migrated"},"ClientToken":{"type":"string","description":"Ensures the idempotency of the request. You can generate a parameter value of up to 64 ASCII characters from the client and assign the…"},"Name":{"type":"string","description":"The name of the migration task. The name must meet the following requirements: The task name must be unique. The name must be 2 to 128…"},"Description":{"type":"string","description":"The description of the migration task. The description must be 2 to 128 characters in length and must start with a letter or a Chinese…"},"SourceId":{"type":"string","description":"The ID of the migration source"},"TargetType":{"type":"string","description":"The target type of the migration task. Valid values: Image: After a successful migration, Server Migration Center (SMC) generates an…"},"ScheduledStartTime":{"type":"string","description":"The execution time of the migration task. The value of this parameter must meet the following requirements: The time must follow the ISO…"},"ValidTime":{"type":"string","description":"The expiration time of the migration task. Valid values: creation time of the migration task + 7 days to creation time of the migration…"},"ImageName":{"type":"string","description":"The name of the destination Alibaba Cloud image delivered by the migration task. The image name must meet the following requirements: The…"},"InstanceId":{"type":"string","description":"The target instance ID"},"SystemDiskSize":{"type":"integer","description":"The system cloud disk size of the destination Alibaba Cloud ECS instance. Unit: GiB. Valid values: 20 to 2048. The value of this parameter…"},"VpcId":{"type":"string","description":"The ID of the VPC for which Express Connect or VPN Gateway is configured"},"VSwitchId":{"type":"string","description":"The ID of the vSwitch in the specified VPC"},"ReplicationParameters":{"type":"string","description":"The parameter information of the replication driver. The parameter information is in JSON key-value pair format with fixed keys. Maximum…"},"NetMode":{"type":"integer","description":"The network mode for data transmission. Valid values: 0: public network transmission mode. The migration source must have access to the…"},"RunOnce":{"type":"string","description":"Specifies whether to create a one-time migration task or an incremental migration task. Valid values: true (default): one-time migration…"},"Frequency":{"type":"integer","description":"The interval at which the incremental migration task runs. Unit: hours. Valid values: 1 to 168. This parameter is required when RunOnce is…"},"MaxNumberOfImageToKeep":{"type":"integer","description":"The maximum number of images retained by default for an incremental migration task. Valid values: 1 to 10. This parameter is required when…"},"InstanceType":{"type":"string","description":"The instance type of the intermediate ECS instance. Call https://help.aliyun.com/document_detail/25620.html to query the instance types…"},"LaunchTemplateId":{"type":"string","description":"The ID of the instance launch template"},"LaunchTemplateVersion":{"type":"string","description":"The version of the instance launch template"},"InstanceRamRole":{"type":"string","description":"The name of the instance RAM role"},"ContainerNamespace":{"type":"string","description":"The namespace of the Docker container. For more information about Docker container images, see…"},"ContainerRepository":{"type":"string","description":"The Docker image repository. For more information about Docker container images, see https://help.aliyun.com/document_detail/60744.html"},"ContainerTag":{"type":"string","description":"The Docker image tag. For more information about Docker container images, see https://help.aliyun.com/document_detail/60744.html"},"LicenseType":{"type":"string","description":"The license type. Valid values: Empty value: no license. BYOL: Bring Your Own License. For more information, see…"},"DataDisk":{"type":"string","description":"The list of data cloud disk information (JSON-encoded)"},"Tag":{"type":"string","description":"The list of tags (JSON-encoded)"},"SystemDiskPart":{"type":"string","description":"The partition information of the system cloud disk (JSON-encoded)"},"JobType":{"type":"integer","description":"The type of the migration task. Valid values:"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"Disks":{"type":"string","description":"The disk information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/create-workgroup":{"post":{"operationId":"cloud_aliyun_smc_create_workgroup","summary":"Workgroups are used to manage the lifecycle of multiple migration tasks in batch server migration scenarios","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"ClientToken":{"type":"string","description":"A token to ensure the idempotence of the request. Generate a value from your client that contains up to 64 ASCII characters. This ensures…"},"Name":{"type":"string","description":"The name of the workgroup. The name must meet the following requirements: The workgroup name must be unique. The name must be 2 to 64…"},"Description":{"type":"string","description":"The description of the workgroup. It must be 2 to 256 characters in length and cannot start with `http://` or `https://`"},"Tag":{"type":"string","description":"An array of tags. The array can contain 1 to 20 tags. If the array contains multiple tags, the value of \\`Key\\` for each tag must be…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/cut-over-replication-job":{"post":{"operationId":"cloud_aliyun_smc_cut_over_replication_job","summary":"Stops the periodic execution of a specified incremental migration job and completes the migration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"JobId":{"type":"string","description":"The ID of the incremental migration job"},"SyncData":{"type":"string","description":"Specifies whether to perform a final full data migration. Valid values: true: Performs a final full data migration. false: Does not…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/delete-access-token":{"post":{"operationId":"cloud_aliyun_smc_delete_access_token","summary":"Deletes an activation code","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AccessTokenId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"AccessTokenId":{"type":"string","description":"The ID of the activation code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/delete-replication-job":{"post":{"operationId":"cloud_aliyun_smc_delete_replication_job","summary":"You can call DeleteReplicationJob to delete a migration job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"JobId":{"type":"string","description":"The ID of the migration job"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/delete-source-server":{"post":{"operationId":"cloud_aliyun_smc_delete_source_server","summary":"You can call the DeleteSourceServer operation to delete a migration source","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SourceId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"SourceId":{"type":"string","description":"The ID of the migration source"},"Force":{"type":"string","description":"Specifies whether to force delete the migration source. true: Force deletes the migration source, its associated migration tasks, and the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/delete-workgroup":{"post":{"operationId":"cloud_aliyun_smc_delete_workgroup","summary":"You can delete a workgroup that you no longer need","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkgroupId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"WorkgroupId":{"type":"string","description":"The ID of the workgroup"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/describe-replication-jobs":{"post":{"operationId":"cloud_aliyun_smc_describe_replication_jobs","summary":"Retrieves details about one or more migration tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"Name":{"type":"string","description":"The name of the migration task"},"RegionId":{"type":"string","description":"The ID of the destination Alibaba Cloud region to which you want to migrate the source. For example, if you want to migrate a source…"},"Status":{"type":"string","description":"The main status of the migration task. Valid values: Ready: The task is not started. Running: The task is running. Stopped: The task is…"},"BusinessStatus":{"type":"string","description":"The business status of the migration task. Valid values: Preparing: The task is being prepared. Syncing: Data is being synchronized.…"},"PageNumber":{"type":"integer","description":"The page number of the migration task list. The value starts from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10"},"SourceId":{"type":"string","description":"The IDs of the migration sources. You can specify up to 50 migration source IDs (JSON-encoded)"},"JobId":{"type":"string","description":"The IDs of the migration tasks. You can specify up to 50 migration task IDs (JSON-encoded)"},"JobType":{"type":"integer","description":"The type of the migration task. Valid values: 0: server migration. 1: operating system migration. 2: cross-zone migration. 3: agentless…"},"InstanceId":{"type":"string","description":"The instance ID (JSON-encoded)"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"Tag":{"type":"string","description":"The tags of the SMC resource (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/describe-source-servers":{"post":{"operationId":"cloud_aliyun_smc_describe_source_servers","summary":"Call the DescribeSourceServers operation to query information about one or more migration sources","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"JobId":{"type":"string","description":"The ID of the migration task"},"State":{"type":"string","description":"The state of the source server. Valid values: Unavailable: The source server is unavailable. This includes offline and error states.…"},"Name":{"type":"string","description":"The name of the source server. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with…"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 50. Default value: 10"},"SourceId":{"type":"string","description":"The ID of the source server. You can specify multiple IDs (JSON-encoded)"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"},"Tag":{"type":"string","description":"The tags (JSON-encoded)"},"RelatedJobType":{"type":"string","description":"The type of the associated task (JSON-encoded)"},"WorkgroupId":{"type":"string","description":"The ID of the workgroup"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/describe-workgroups":{"post":{"operationId":"cloud_aliyun_smc_describe_workgroups","summary":"After a workgroup is created, you can view its information, such as the workgroup name, description, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"WorkgroupId":{"type":"string","description":"A list of workgroup IDs. You can specify up to 50 workgroup IDs (JSON-encoded)"},"Name":{"type":"string","description":"The name of the workgroup"},"Status":{"type":"string","description":"The status of the workgroup. Valid values: NotStarted: The workgroup is not started. InProgress: The workgroup is in progress. Cutover:…"},"PageNumber":{"type":"integer","description":"The page number of the workgroup list. The value starts from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10"},"Tag":{"type":"string","description":"The array of tags. The array can contain 1 to 20 tags. If the array contains multiple tag objects, the tag keys cannot be the same…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/disable-access-token":{"post":{"operationId":"cloud_aliyun_smc_disable_access_token","summary":"You can call the DisableAccessToken operation to disable an activation code","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AccessTokenId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"AccessTokenId":{"type":"string","description":"The ID of the activation code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/disassociate-source-servers":{"post":{"operationId":"cloud_aliyun_smc_disassociate_source_servers","summary":"Disassociate a migration source from a group if you no longer need to use the group for batch migration or…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkgroupId","SourceId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"WorkgroupId":{"type":"string","description":"The ID of the group"},"SourceId":{"type":"string","description":"The IDs of the migration sources to disassociate from the group. You can specify up to 50 IDs (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/list-access-tokens":{"post":{"operationId":"cloud_aliyun_smc_list_access_tokens","summary":"Call the ListAccessTokens operation to query for created activation codes and their statuses","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"AccessTokenId":{"type":"string","description":"The IDs of the activation codes (JSON-encoded)"},"Name":{"type":"string","description":"The name of the activation code"},"Status":{"type":"string","description":"The status of the activation code. Valid values: activated: The activation code is activated. unactivated: The activation code is not…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/list-tag-resources":{"post":{"operationId":"cloud_aliyun_smc_list_tag_resources","summary":"Queries the tags attached to one or more SMC resources, such as migration sources and migration tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceType"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"ResourceType":{"type":"string","description":"The SMC resource type. Valid values: sourceserver: a migration source replicationjob: a migration task"},"NextToken":{"type":"string","description":"The token to start the next query"},"ResourceId":{"type":"string","description":"A list of SMC resource IDs. SMC resources include migration sources and migration tasks. The list can contain a maximum of 50 IDs…"},"Tag":{"type":"string","description":"A list of tags (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/modify-replication-job-attribute":{"post":{"operationId":"cloud_aliyun_smc_modify_replication_job_attribute","summary":"You can call the ModifyReplicationJobAttribute operation to modify the information of a migration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"JobId":{"type":"string","description":"The ID of the migration task"},"Name":{"type":"string","description":"The name of the migration task. The name must meet the following requirements: The name must be unique. The name must be 2 to 128…"},"Description":{"type":"string","description":"The description of the migration task. The description must be 2 to 128 characters in length. It must start with a letter or a Chinese…"},"TargetType":{"type":"string","description":"The type of the migration destination. This parameter can be modified only before the migration task starts. Valid values: Image: After…"},"ScheduledStartTime":{"type":"string","description":"The time when you want to start the migration task. SMC automatically starts the migration task at the specified time. The time must…"},"ImageName":{"type":"string","description":"The name of the destination image. The name must meet the following requirements: The image name must be unique in the same Alibaba Cloud…"},"InstanceId":{"type":"string","description":"The ID of the destination instance"},"SystemDiskSize":{"type":"integer","description":"The system disk size of the destination ECS instance. Unit: GiB. Valid values: 20 to 500. The value of this parameter must be greater than…"},"Frequency":{"type":"integer","description":"The interval at which an incremental migration task runs. Unit: hours. Valid values: 1 to 168. This parameter is required if the `RunOnce`…"},"MaxNumberOfImageToKeep":{"type":"integer","description":"The maximum number of images to retain for an incremental migration task. Valid values: 1 to 10. This parameter is required if the…"},"InstanceType":{"type":"string","description":"The instance type of the intermediate instance. You can call the https://help.aliyun.com/document_detail/25620.html operation to query the…"},"LaunchTemplateId":{"type":"string","description":"The ID of the launch template"},"LaunchTemplateVersion":{"type":"string","description":"The version of the launch template"},"InstanceRamRole":{"type":"string","description":"The name of the RAM role for the instance"},"ContainerNamespace":{"type":"string","description":"The namespace of the Docker container. For more information about Docker container images, see…"},"ContainerRepository":{"type":"string","description":"The image repository for the Docker container. For more information about Docker container images, see…"},"ContainerTag":{"type":"string","description":"The image tag for the Docker container. For more information about Docker container images, see…"},"ValidTime":{"type":"string","description":"The expiration time of the migration task. The value can be a time that is 7 to 90 days later than the time when the migration task is…"},"SystemDiskPart":{"type":"string","description":"The partitions of the system disk (JSON-encoded)"},"DataDisk":{"type":"string","description":"The data disks (JSON-encoded)"},"NetMode":{"type":"integer","description":"The network mode for data transmission. Valid values: 0: Internet transfer mode. The source server must be able to access the Internet.…"},"VSwitchId":{"type":"string","description":"The ID of the vSwitch in the specified VPC"},"VpcId":{"type":"string","description":"The ID of the VPC that is configured with Express Connect or a VPN Gateway"},"ReplicationParameters":{"type":"string","description":"The parameters of the replication driver. The parameters are key-value pairs in the JSON format. The keys are fixed. The value can be up…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/modify-source-server-attribute":{"post":{"operationId":"cloud_aliyun_smc_modify_source_server_attribute","summary":"The ModifySourceServerAttribute operation modifies the name and description of a migration source","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SourceId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"SourceId":{"type":"string","description":"The ID of the migration source"},"Name":{"type":"string","description":"The name of the migration source. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character, and…"},"Description":{"type":"string","description":"The description of the migration source. The description can be up to 256 characters in length and cannot start with `http://` or `https://`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/modify-workgroup-attribute":{"post":{"operationId":"cloud_aliyun_smc_modify_workgroup_attribute","summary":"Modifies a workgroup's name and description","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkgroupId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"WorkgroupId":{"type":"string","description":"The workgroup ID"},"Name":{"type":"string","description":"The name of the workgroup. The name must meet the following requirements: The workgroup name must be unique. The name must be 2 to 64…"},"Description":{"type":"string","description":"The description of the workgroup. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/start-replication-job":{"post":{"operationId":"cloud_aliyun_smc_start_replication_job","summary":"You can call the StartReplicationJob operation to start a migration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"JobId":{"type":"string","description":"The ID of the migration task"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/stop-replication-job":{"post":{"operationId":"cloud_aliyun_smc_stop_replication_job","summary":"You can call the StopReplicationJob operation to stop a migration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"JobId":{"type":"string","description":"The ID of the migration task"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/tag-resources":{"post":{"operationId":"cloud_aliyun_smc_tag_resources","summary":"You can call TagResources to create and attach tags to multiple SMC resources, such as migration sources and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceType","ResourceId","Tag"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"ResourceType":{"type":"string","description":"The type of the SMC resource. Valid values: sourceserver: migration source replicationjob: migration task"},"ResourceId":{"type":"string","description":"The ID of the SMC resource. SMC resources include migration sources and migration tasks. You can specify 1 to 50 resource IDs (JSON-encoded)"},"Tag":{"type":"string","description":"The list of tags (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/untag-resources":{"post":{"operationId":"cloud_aliyun_smc_untag_resources","summary":"Detaches and deletes tags from specified SMC resources, such as migration sources and migration tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceType","ResourceId"],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"},"ResourceType":{"type":"string","description":"The type of the SMC resource. Valid values: sourceserver: a migration source. replicationjob: a migration task"},"All":{"type":"string","description":"Specifies whether to remove all tags from the SMC resources. This parameter takes effect only if you do not specify the `TagKey.N`…"},"ResourceId":{"type":"string","description":"The IDs of the SMC resources. You can specify 1 to 50 resource IDs. SMC resources include migration sources and migration tasks…"},"TagKey":{"type":"string","description":"The keys of the tags to remove. You can specify 1 to 20 tag keys. Tag keys are case-sensitive (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-smc/version":{"post":{"operationId":"cloud_aliyun_smc_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://smc.aliyuncs.com"],"default":"https://smc.aliyuncs.com","description":"Regional endpoint, for example https://smc.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}