summaryrefslogtreecommitdiff
path: root/data/zh_cn/smc/2019-06-01
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/smc/2019-06-01
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/smc/2019-06-01')
-rw-r--r--data/zh_cn/smc/2019-06-01/api-docs.php6504
1 files changed, 2520 insertions, 3984 deletions
diff --git a/data/zh_cn/smc/2019-06-01/api-docs.php b/data/zh_cn/smc/2019-06-01/api-docs.php
index a1eb65a..d33d80e 100644
--- a/data/zh_cn/smc/2019-06-01/api-docs.php
+++ b/data/zh_cn/smc/2019-06-01/api-docs.php
@@ -1,844 +1,213 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'smc',
- 'version' => '2019-06-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'smc', 'version' => '2019-06-01'],
'directories' => [
[
- 'id' => 68530,
- 'title' => '迁移源',
+ 'children' => ['DescribeSourceServers', 'ModifySourceServerAttribute', 'DeleteSourceServer'],
'type' => 'directory',
- 'children' => [
- 'DescribeSourceServers',
- 'ModifySourceServerAttribute',
- 'DeleteSourceServer',
- ],
+ 'title' => '迁移源',
+ 'id' => 48156,
],
[
- 'id' => 68534,
- 'title' => '迁移任务',
+ 'children' => ['CreateReplicationJob', 'CreateCrossZoneMigrationJob', 'ModifyReplicationJobAttribute', 'StartReplicationJob', 'StopReplicationJob', 'DescribeReplicationJobs', 'CutOverReplicationJob', 'DeleteReplicationJob'],
'type' => 'directory',
- 'children' => [
- 'CreateReplicationJob',
- 'CreateCrossZoneMigrationJob',
- 'ModifyReplicationJobAttribute',
- 'StartReplicationJob',
- 'StopReplicationJob',
- 'DescribeReplicationJobs',
- 'CutOverReplicationJob',
- 'DeleteReplicationJob',
- ],
+ 'title' => '迁移任务',
+ 'id' => 48160,
],
[
- 'id' => 198919,
- 'title' => '工作组',
+ 'children' => ['CreateWorkgroup', 'AssociateSourceServers', 'DisassociateSourceServers', 'DescribeWorkgroups', 'ModifyWorkgroupAttribute', 'DeleteWorkgroup'],
'type' => 'directory',
- 'children' => [
- 'CreateWorkgroup',
- 'AssociateSourceServers',
- 'DisassociateSourceServers',
- 'DescribeWorkgroups',
- 'ModifyWorkgroupAttribute',
- 'DeleteWorkgroup',
- ],
+ 'title' => '工作组',
+ 'id' => 48178,
],
[
- 'id' => 183898,
- 'title' => '标签',
+ 'children' => ['TagResources', 'ListTagResources', 'UntagResources'],
'type' => 'directory',
- 'children' => [
- 'TagResources',
- 'ListTagResources',
- 'UntagResources',
- ],
+ 'title' => '标签',
+ 'id' => 48174,
],
[
- 'id' => 183845,
- 'title' => '激活码',
+ 'children' => ['CreateAccessToken', 'DisableAccessToken', 'ListAccessTokens', 'DeleteAccessToken'],
'type' => 'directory',
- 'children' => [
- 'CreateAccessToken',
- 'DisableAccessToken',
- 'ListAccessTokens',
- 'DeleteAccessToken',
- ],
+ 'title' => '激活码',
+ 'id' => 48169,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'DescribeSourceServers' => [
- 'summary' => '调用DescribeSourceServers查询一个或多个迁移源信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AssociateSourceServers' => [
+ 'summary' => '如果您需要通过工作组批量迁移服务器，需要先将迁移源关联到工作组。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '18569',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '240395',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
- 'name' => 'JobId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'j-bp19vlwm0tyigbmj****',
- ],
- ],
- [
- 'name' => 'State',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移源状态。取值范围：'."\n"
- ."\n"
- .'- Unavailable：不可用，包括离线和出错。'."\n"
- .'- Available：在线。'."\n"
- .'- InUse：迁移中。'."\n"
- .'- Deleting：删除中。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Available',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移源名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以http:\\//和https:\\//开头。可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。'."\n"
- ."\n"
- .'默认值：空',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testSourceServerName',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '返回的迁移源列表的页码。起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'WorkgroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。最大值：50。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '50',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['title' => '幂等参数', 'description' => '工作组ID。', 'type' => 'string', 'required' => true, 'example' => 'w-bp10geepnj916e3d****'],
],
[
'name' => 'SourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '迁移源ID，可以输入多个。',
- 'type' => 'array',
- 'items' => [
- 'description' => '迁移源ID，可以输入多个。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
- 'required' => false,
- 'example' => 's-bp1e2fsl57knvuug****',
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmw3ty5y7****',
- ],
- ],
- [
- 'name' => 'Tag',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签对象。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '为SMC资源指定的标签键。N的取值范围：1~20'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以aliyun和acs:开头，不能包含http:\\//或者https:\\//。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http:\\//或者https:\\//。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
- ],
- [
- 'name' => 'RelatedJobType',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '关联任务类型。',
+ 'description' => '迁移源ID。一个工作组最多可以关联50个迁移源。',
'type' => 'array',
- 'items' => [
- 'description' => '关联任务类型。取值如下：'."\n"
- ."\n"
- .'- Not_Related：未关联任务。'."\n"
- .'- Server：服务器迁移任务。'."\n"
- .'- Os：操作系统迁移任务。'."\n"
- .'- Cross_Zone：跨可用区迁移任务。'."\n"
- .'- VMWare：VMWare迁移任务。'."\n"
- .'- Desktop：桌面任务。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Server',
- ],
- 'required' => false,
+ 'items' => ['description' => '迁移源ID。', 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****'],
+ 'required' => true,
'maxItems' => 100,
],
],
- [
- 'name' => 'WorkgroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'w-bp1ja22kdqphehlj****',
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '信息集合。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数信息。',
'type' => 'object',
'properties' => [
- 'SourceServers' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SourceServer' => [
- 'description' => '迁移源数组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '迁移源数组。',
- 'type' => 'object',
- 'properties' => [
- 'CreationTime' => [
- 'description' => '迁移源的注册时间。',
- 'type' => 'string',
- 'example' => '2019-06-27T02:58:09Z',
- ],
- 'HeartbeatRate' => [
- 'description' => 'SMC客户端（SMC Agent）心跳频率。单位：秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'State' => [
- 'description' => '迁移源状态。',
- 'type' => 'string',
- 'example' => 'InUse',
- ],
- 'DataDisks' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'DataDisk' => [
- 'description' => '迁移源的数据盘数组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '迁移源的数据盘数组。',
- 'type' => 'object',
- 'properties' => [
- 'Index' => [
- 'description' => '数据盘顺序。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'description' => '数据盘N大小。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Parts' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Part' => [
- 'description' => '数据盘分区信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据盘分区信息。',
- 'type' => 'object',
- 'properties' => [
- 'CanBlock' => [
- 'description' => '数据盘分区是否支持块复制。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'SizeBytes' => [
- 'description' => '数据盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21474836480',
- ],
- 'Need' => [
- 'description' => '数据盘分区是否必须选择。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Device' => [
- 'description' => '数据盘分区设备标识。',
- 'type' => 'string',
- 'example' => '1_0',
- ],
- 'Path' => [
- 'description' => '数据盘分区路径。',
- 'type' => 'string',
- 'example' => '/home/data',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Path' => [
- 'description' => '数据盘N路径。',
- 'type' => 'string',
- 'example' => '/home/data',
- ],
- ],
- ],
- ],
- ],
- ],
- 'SystemDiskParts' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SystemDiskPart' => [
- 'description' => '系统盘分区信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '系统盘分区信息。',
- 'type' => 'object',
- 'properties' => [
- 'CanBlock' => [
- 'description' => '系统盘分区是否支持块复制。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SizeBytes' => [
- 'description' => '系统盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '254803968',
- ],
- 'Need' => [
- 'description' => '系统盘分区是否必须选择。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Device' => [
- 'description' => '系统盘分区设备标识符。',
- 'type' => 'string',
- 'example' => '0_0',
- ],
- 'Path' => [
- 'description' => '系统盘分区路径。',
- 'type' => 'string',
- 'example' => '/boot',
- ],
- ],
- ],
- ],
- ],
- ],
- 'KernelLevel' => [
- 'description' => '内核版本级别。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SourceId' => [
- 'description' => '迁移源ID。',
- 'type' => 'string',
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
- 'AgentVersion' => [
- 'description' => 'SMC客户端版本号。',
- 'type' => 'string',
- 'example' => '1.5.2.3',
- ],
- 'StatusInfo' => [
- 'description' => '迁移源状态详细信息。该参数在迁移源状态为异常时返回。JSON格式键值对，如：'."\n"
- .'```'."\n"
- .'- error_code：错误码。'."\n"
- .'- error_msg：错误信息。'."\n"
- .'```',
- 'type' => 'string',
- 'example' => '{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}',
- ],
- 'SystemDiskSize' => [
- 'description' => '迁移源的系统盘大小。单位：GiB',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Description' => [
- 'description' => '迁移源描述。',
- 'type' => 'string',
- 'example' => 'Server Source Imported By GotoAliyun.',
- ],
- 'ErrorCode' => [
- 'description' => '迁移源状态错误码。',
- 'type' => 'string',
- 'example' => 'SourceServer.Offline',
- ],
- 'JobId' => [
- 'description' => '最近一次的迁移任务ID。',
- 'type' => 'string',
- 'example' => 'j-bp19vlwm0tyigbmj****',
- ],
- 'Platform' => [
- 'description' => '迁移源的系统平台。',
- 'type' => 'string',
- 'example' => 'OpenSUSE',
- ],
- 'ReplicationDriver' => [
- 'description' => '复制驱动器。默认值：SMT（迁云工具）',
- 'type' => 'string',
- 'example' => 'SMT',
- ],
- 'Name' => [
- 'description' => '迁移源的名称。',
- 'type' => 'string',
- 'example' => 'SourceServerName',
- ],
- 'SystemInfo' => [
- 'description' => '迁移源系统信息。JSON格式键值对，可扩展，键值固定。大小不超过1 KB。如：'."\n"
- ."\n"
- .'```'."\n"
- .'agent_mode：运行模式。'."\n"
- .'agent_type：运行类型。'."\n"
- .'client_type：客户端类型。'."\n"
- .'hostname ：主机名。'."\n"
- .'ipv4：IPv4地址。'."\n"
- .'ipv6： IPv6地址。'."\n"
- .'cores：CPU核数。'."\n"
- .'cpu_usage： CPU使用率。'."\n"
- .'memory：内存。'."\n"
- .'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' => '迁移源的系统架构。',
- 'type' => 'string',
- 'example' => 'x86_64',
- ],
- 'ResourceGroupId' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-acfmw3ty5y7****',
- ],
- 'Tags' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Tag' => [
- 'description' => '标签信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签对象。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '为SMC资源指定的标签键。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以aliyun和acs:开头，不能包含http:\\//或者https:\\//。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http:\\//或者https:\\//。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Disks' => [
- 'description' => '磁盘信息。',
- 'type' => 'object',
- 'properties' => [
- 'System' => [
- 'description' => '系统盘信息。',
- 'type' => 'object',
- 'properties' => [
- 'Size' => [
- 'description' => '迁移源系统盘的大小，单位：GiB。取值范围为20~32768。'."\n"
- ."\n"
- .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Offset' => [
- 'description' => '系统盘首个分区的起始偏移。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1024',
- ],
- 'Parts' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Part' => [
- 'description' => '系统盘分区信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '分区信息。',
- 'type' => 'object',
- 'properties' => [
- 'CanBlock' => [
- 'description' => '系统盘分区是否支持块复制。可能值：'."\n"
- ."\n"
- .'- true：系统盘分区支持块复制。'."\n"
- .'- false：系统盘分区不支持块复制。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'SizeBytes' => [
- 'description' => '系统盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21474836480',
- ],
- 'Path' => [
- 'description' => '系统盘分区路径。',
- 'type' => 'string',
- 'example' => '/home/data',
- ],
- 'Type' => [
- 'description' => '系统盘分区类型。可能值：'."\n"
- .'- Normal：普通分区。'."\n"
- .'- System：系统分区。'."\n"
- .'- Boot：启动分区。',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'required' => false,
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Data' => [
- 'description' => '数据盘信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据盘信息。',
- 'type' => 'object',
- 'properties' => [
- 'Size' => [
- 'description' => '迁移源的数据磁盘大小。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '80',
- ],
- 'Offset' => [
- 'description' => '数据盘首个分区的起始偏移。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1024',
- ],
- 'Parts' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Part' => [
- 'description' => '数据盘分区信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据盘分区信息。',
- 'type' => 'object',
- 'properties' => [
- 'CanBlock' => [
- 'description' => '数据盘分区是否开启块复制。可能值：'."\n"
- ."\n"
- .'- true：数据盘分区开启块复制。'."\n"
- .'- false：数据盘分区不开启块复制。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'SizeBytes' => [
- 'description' => '数据盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21474836480',
- ],
- 'Path' => [
- 'description' => '数据盘分区路径。',
- 'type' => 'string',
- 'example' => '/home/data',
- ],
- 'Type' => [
- 'description' => '数据盘分区类型。可能值：'."\n"
- .'- Normal：普通分区。'."\n"
- .'- System：系统分区。'."\n"
- .'- Boot：启动分区。',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'WorkgroupId' => [
- 'description' => '工作组ID。',
- 'type' => 'string',
- 'example' => 'w-bp1ja22kdqphehlj****',
- ],
- ],
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '迁移源总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '410E6073-66D0-45D3-AB3E-4DC3F5E4****',
- ],
- 'PageNumber' => [
- 'description' => '迁移源列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'Forbidden.Unauthorized',
- 'errorMessage' => 'A required authorization for the specified action is not supplied.',
- ],
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'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":"<DescribeSourceServersResponse>\\n <SourceServers>\\n <CreationTime>2019-06-27T02:58:09Z</CreationTime>\\n <HeartbeatRate>30</HeartbeatRate>\\n <State>InUse</State>\\n <DataDisks>\\n <Index>1</Index>\\n <Size>20</Size>\\n <Parts>\\n <CanBlock>false</CanBlock>\\n <SizeBytes>21474836480</SizeBytes>\\n <Need>false</Need>\\n <Device>1_0</Device>\\n <Path>/home/data</Path>\\n </Parts>\\n <Path>/home/data</Path>\\n </DataDisks>\\n <SystemDiskParts>\\n <CanBlock>true</CanBlock>\\n <SizeBytes>254803968</SizeBytes>\\n <Need>true</Need>\\n <Device>0_0</Device>\\n <Path>/boot</Path>\\n </SystemDiskParts>\\n <KernelLevel>1</KernelLevel>\\n <SourceId>s-bp1e2fsl57knvuug****</SourceId>\\n <AgentVersion>1.5.2.3</AgentVersion>\\n <StatusInfo>{\\"error_code\\": \\"S1\\", \\"error_msg\\": \\"Rsync not found. Please install rsync.\\"}</StatusInfo>\\n <SystemDiskSize>40</SystemDiskSize>\\n <Description>Server Source Imported By GotoAliyun.</Description>\\n <ErrorCode>SourceServer.Offline</ErrorCode>\\n <JobId>j-bp19vlwm0tyigbmj****</JobId>\\n <Platform>OpenSUSE</Platform>\\n <ReplicationDriver>SMT</ReplicationDriver>\\n <Name>SourceServerName</Name>\\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\\\\\\"}</SystemInfo>\\n <Architecture>x86_64</Architecture>\\n <ResourceGroupId>rg-acfmw3ty5y7****</ResourceGroupId>\\n <Tags>\\n <Key>TestKey</Key>\\n <Value>TestValue</Value>\\n </Tags>\\n </SourceServers>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>410E6073-66D0-45D3-AB3E-4DC3F5E4****</RequestId>\\n <PageNumber>1</PageNumber>\\n</DescribeSourceServersResponse>","errorExample":""}]',
- 'title' => '查询一个或多个迁移源信息',
- 'description' => '## 接口说明'."\n"
- ."\n"
- .'请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ModifySourceServerAttribute' => [
- 'summary' => '调用ModifySourceServerAttribute修改一个迁移源的名称和描述。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '迁移源关联工作组',
+ 'description' => '一个迁移源只能关联一个工作组。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:AssociateSourceServers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8B26B44-0189-443E-9816-D951F59623A9\\"\\n}","type":"json"}]',
+ ],
+ 'CreateAccessToken' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '18573',
- 'abilityTreeNodes' => [
- 'FEATUREsmcBBDD6M',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '144505',
+ 'abilityTreeNodes' => ['FEATUREsmcWZM4IC'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'SourceId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 's-bp17m1vi6x20c6g6****',
- ],
+ 'schema' => ['description' => '激活码名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test_name'],
],
[
- 'name' => 'Name',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移源名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`或`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testSourceServerName',
- ],
+ 'schema' => ['description' => '激活码描述。', 'type' => 'string', 'required' => false, 'example' => '这是导入迁移源激活码'],
],
[
- 'name' => 'Description',
+ 'name' => 'Count',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移源描述。长度为0~256个字符，不能以`http://`或`https://`开头。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a source server.',
- ],
+ 'schema' => ['description' => '激活码用于注册迁移源的使用次数上限。取值范围为1~1000。'."\n"
+ ."\n"
+ .'默认值为100。', 'type' => 'string', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'TimeToLiveInDays',
+ 'in' => 'query',
+ 'schema' => ['description' => '激活码的有效使用时间，过期后将不能用于注册新的实例。单位：天。取值范围为1~90。'."\n"
+ ."\n"
+ .'默认值为30。', 'type' => 'string', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '响应参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DB4A7EA2-6FDA-5655-B067-854532FB****'],
+ 'AccessTokenCode' => ['description' => '激活码的代码。该代码仅在调用接口时返回一次，后续无法被查询。因此，请您务必妥善保存返回值。', 'type' => 'string', 'example' => 'B57QoTXEA2Tytr0uZWoNY5Aju5Jt****'],
+ 'AccessTokenId' => ['description' => '激活码ID。', 'type' => 'string', 'example' => 'at-bp1akz2zp67r0k6r****'],
],
],
],
],
'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.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteReplicationJobResponse>\\r\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\r\\n</DeleteReplicationJobResponse>","errorExample":""}]',
- 'title' => '修改一个迁移源的名称和描述',
- 'description' => '## 接口说明'."\n"
- ."\n"
- .'使用该API修改迁移源的名称和描述时，对迁移源的状态没有要求。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteSourceServer' => [
- 'summary' => '调用DeleteSourceServer删除一个迁移源。',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => '创建激活码',
+ 'summary' => '调用CreateAccessToken创建激活码。',
+ 'description' => '如果您使用激活码导入迁移源，需使用此接口创建激活码。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccessToken'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateAccessToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DB4A7EA2-6FDA-5655-B067-854532FB****\\",\\n \\"AccessTokenCode\\": \\"B57QoTXEA2Tytr0uZWoNY5Aju5Jt****\\",\\n \\"AccessTokenId\\": \\"at-bp1akz2zp67r0k6r****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccessTokenResponse>\\n <RequestId>DB4A7EA2-6FDA-5655-B067-854532FB****</RequestId>\\n <AccessTokenCode>B57QoTXEA2Tytr0uZWoNY5Aju5Jt****</AccessTokenCode>\\n <AccessTokenId>at-bp1akz2zp67r0k6r****</AccessTokenId>\\n</CreateAccessTokenResponse>","errorExample":""}]',
+ ],
+ 'CreateCrossZoneMigrationJob' => [
+ 'summary' => 'SMC支持将阿里云云服务器ECS迁移到同地域的不同可用区，同时也支持在同规格族内更改实例规格（vCPU和内存），满足您迁移云服务器ECS和变配实例规格的业务需求。您可以通过此接口创建跨可用区任务。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -847,93 +216,141 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '18563',
- 'abilityTreeNodes' => [
- 'FEATUREsmcWZM4IC',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '149399',
+ 'abilityTreeNodes' => ['FEATUREsmcL35UBA'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'SourceId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 's-bp17m1vi6x20c6g6****',
- ],
+ 'schema' => ['description' => '迁移源要迁入的目标阿里云地域ID。'."\n"
+ ."\n"
+ .'例如，您需要迁移源服务器至杭州，则相应的阿里云地域ID为`cn-hangzhou`。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Force',
+ 'name' => 'ClientToken',
'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ECS实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-bp1ff25rzvnul6kr****'],
+ ],
+ [
+ 'name' => 'TargetVSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1mxqnssl8nafltc****'],
+ ],
+ [
+ 'name' => 'TargetZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'],
+ ],
+ [
+ 'name' => 'TargetInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标实例规格。', 'type' => 'string', 'required' => false, 'example' => 'ecs.g7.large'],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否自动付费，取值说明：'."\n"
+ ."\n"
+ .'- **true**：（默认值）自动付费，请确保账号有足够的余额。'."\n"
+ .'- **false**：手动付费。具体操作，请参见[手动续费包年包月实例](~~85052~~)。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'Disk',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '是否强制删除迁移源。'."\n"
- ."\n"
- .'- true：强制删除迁移源、迁移源关联的迁移任务及任务对应的中转资源。'."\n"
- .'- false：无法删除已关联迁移任务的迁移源。',
- 'type' => 'boolean',
+ 'description' => '云盘信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '云盘对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiskId' => ['description' => '云盘ID。', 'type' => 'string', 'required' => false, 'example' => 'd-bp1eeplkn4j29wf7****'],
+ 'Category' => ['description' => '云盘种类为cloud_essd，表示ESSD云盘。', 'type' => 'string', 'required' => false, 'example' => 'cloud_essd'],
+ 'PerformanceLevel' => ['description' => 'ESSD云盘的性能等级。取值范围：'."\n"
+ ."\n"
+ .'- PL0：单盘最高随机读写IOPS 1万。'."\n"
+ .'- PL1：单盘最高随机读写IOPS 5万。'."\n"
+ .'- PL2：单盘最高随机读写IOPS 10万。'."\n"
+ .'- PL3：单盘最高随机读写IOPS 100万。', 'type' => 'string', 'required' => false, 'example' => 'PL0'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 101,
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回参数信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A9DBD2F8-DE5A-5844-BA6F-957A996CBD78'],
+ 'JobId' => ['description' => '迁移任务ID。', 'type' => 'string', 'example' => 'j-bp17bclvg344jlyt****'],
],
],
],
],
'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.',
- ],
+ ['errorCode' => 'ReplicationJobDataDiskIndex.Invalid', 'errorMessage' => 'The specified replication job contains data disk index not found in source server.', 'description' => '迁移任务包含的数据盘索引在迁移源中不存在。'],
+ ['errorCode' => 'VSwitchIdVpcId.Mismatch', 'errorMessage' => 'The specified VSwitchId and VpcId does not match.', 'description' => '指定的VSwitchId和VpcId不匹配。'],
+ ['errorCode' => 'InvalidSecurityGroupId.IncorrectNetworkType', 'errorMessage' => 'The network type of the specified security group does not support this action.', 'description' => '安全组网络类型不支持该操作，请检查安全组网络类型。'],
+ ['errorCode' => 'InvalidSecurityGroupId.VPCMismatch', 'errorMessage' => 'The specified security group and the specified virtual switch are not in the same VPC.', 'description' => '指定的安全组和交换机不在一个专有网络。'],
+ ['errorCode' => 'QuotaExceeded.ReplicationJob', 'errorMessage' => 'The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota.', 'description' => '迁移任务的数量已超过最大允许值，请提交工单。'],
+ ['errorCode' => 'ReplicationJobName.Duplicate', 'errorMessage' => 'The specified replication job name already exists.', 'description' => '迁移任务名称已存在，请修改迁移任务名称。'],
+ ['errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移源的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ],
+ 403 => [
+ ['errorCode' => 'EntityNotExist.Role', 'errorMessage' => 'The account is unauthorized. Please assign the role AliyunServiceRoleForSMC to your account.', 'description' => '账号不具备操作权限，请赋予账户AliyunServiceRoleForSMC角色。'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '创建跨可用区迁移任务',
+ 'description' => '关于跨可用区迁移的使用限制及其迁移影响等信息，请参见[跨可用区迁移操作](~~476797~~)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCrossZoneMigrationJob'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateCrossZoneMigrationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSourceServerResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DeleteSourceServerResponse>","errorExample":""}]',
- 'title' => '删除一个迁移源',
- 'description' => '## 接口说明'."\n"
- ."\n"
- .'- 迁移源若关联了Running（运行中）状态的迁移任务，则无法删除。'."\n"
- .'- 迁移源若关联了除Running状态外的其他状态的迁移任务，则需设置`Force=true`删除。'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A9DBD2F8-DE5A-5844-BA6F-957A996CBD78\\",\\n \\"JobId\\": \\"j-bp17bclvg344jlyt****\\"\\n}","type":"json"}]',
],
'CreateReplicationJob' => [
- 'summary' => '调用CreateReplicationJob为迁移源创建一个迁移任务。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -946,347 +363,211 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '18560',
- 'abilityTreeNodes' => [
- 'FEATUREsmcBBDD6M',
- ],
+ 'abilityTreeNodes' => ['FEATUREsmcBBDD6M'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移源要迁入的目标阿里云地域ID。'."\n"
- ."\n"
- .'例如，您需要迁移源服务器至杭州，则相应的阿里云地域ID为`cn-hangzhou`。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '迁移源要迁入的目标阿里云地域ID。'."\n"
+ ."\n"
+ .'例如，您需要迁移源服务器至杭州，则相应的阿里云地域ID为`cn-hangzhou`。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。您可以从客户端生成一个不超过64个ASCII字符的参数值，并将值赋予ClientToken，保证重试请求的幂等性。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '保证请求幂等性。您可以从客户端生成一个不超过64个ASCII字符的参数值，并将值赋予ClientToken，保证重试请求的幂等性。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务名。迁移任务的名称需满足以下要求：'."\n"
- ."\n"
- .'- 任务名称必须唯一。'."\n"
- .'- 长度为2~128个英文或中文字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testMigrationTaskName',
- ],
+ 'schema' => ['description' => '迁移任务名。迁移任务的名称需满足以下要求：'."\n"
+ ."\n"
+ .'- 任务名称必须唯一。'."\n"
+ .'- 长度为2~128个英文或中文字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。', 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName'],
],
[
'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务描述。'."\n"
- ."\n"
- .'长度应为2~128个英文或中文字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This_is_a_migration_task',
- ],
+ 'schema' => ['description' => '迁移任务描述。'."\n"
+ ."\n"
+ .'长度应为2~128个英文或中文字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。', 'type' => 'string', 'required' => false, 'example' => 'This_is_a_migration_task'],
],
[
'name' => 'SourceId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
+ 'schema' => ['description' => '迁移源ID。', 'type' => 'string', 'required' => true, 'example' => 's-bp1e2fsl57knvuug****'],
],
[
'name' => 'TargetType',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务交付的目标类型。取值范围：'."\n"
- .'- Image：迁移成功后，SMC为您的迁移源生成阿里云镜像。'."\n"
- .'- ContainerImage：迁移成功后，SMC为您的迁移源生成Docker容器镜像。'."\n"
- .'- TargetInstance：迁移成功后，SMC将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定`InstanceId`参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Image',
- ],
+ 'schema' => ['description' => '迁移任务交付的目标类型。取值范围：'."\n"
+ .'- Image：迁移成功后，SMC为您的迁移源生成阿里云镜像。'."\n"
+ .'- ContainerImage：迁移成功后，SMC为您的迁移源生成Docker容器镜像。'."\n"
+ .'- TargetInstance：迁移成功后，SMC将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定`InstanceId`参数。', 'type' => 'string', 'required' => false, 'example' => 'Image'],
],
[
'name' => 'ScheduledStartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的执行时间。该参数值的设置需满足以下要求：'."\n"
- ."\n"
- .'- 遵循ISO8601标准，并需要使用UTC+0时间，格式为YYYY-MM-DDThh:mm:ssZ。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
- .'- 该参数值必须晚于当前时间，并且需要设置在30天以内。'."\n"
- ."\n"
- .'>如果该参数值为空，则SMC不会启动迁移任务，需要您调用[StartReplicationJob](~~121823~~)启动任务。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-06-04T13:35:00Z',
- ],
+ 'schema' => ['description' => '迁移任务的执行时间。该参数值的设置需满足以下要求：'."\n"
+ ."\n"
+ .'- 遵循ISO8601标准，并需要使用UTC+0时间，格式为YYYY-MM-DDThh:mm:ssZ。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
+ .'- 该参数值必须晚于当前时间，并且需要设置在30天以内。'."\n"
+ ."\n"
+ .'>如果该参数值为空，则SMC不会启动迁移任务，需要您调用[StartReplicationJob](~~121823~~)启动任务。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z'],
],
[
'name' => 'ValidTime',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的过期时间。取值范围：迁移任务创建时间+7天~迁移任务创建时间+90天。'."\n"
- ."\n"
- .'- 过期时间须遵循ISO8601标准，并需要使用UTC+0时间，格式为YYYY-MM-DDThh:mm:ssZ。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
- .'- 过期时间设置为空，表示任务无限期有效。'."\n"
- .'- 任务到期后会被标记为过期状态，保存7天，7天后系统会自动清理。'."\n"
- ."\n"
- .'默认值：迁移任务创建时间+30天（表示迁移任务的默认有效期为创建后30天）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-06-04T13:35:00Z',
- ],
+ 'schema' => ['description' => '迁移任务的过期时间。取值范围：迁移任务创建时间+7天~迁移任务创建时间+90天。'."\n"
+ ."\n"
+ .'- 过期时间须遵循ISO8601标准，并需要使用UTC+0时间，格式为YYYY-MM-DDThh:mm:ssZ。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
+ .'- 过期时间设置为空，表示任务无限期有效。'."\n"
+ .'- 任务到期后会被标记为过期状态，保存7天，7天后系统会自动清理。'."\n"
+ ."\n"
+ .'默认值：迁移任务创建时间+30天（表示迁移任务的默认有效期为创建后30天）。', 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z'],
],
[
'name' => 'ImageName',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务交付的目标阿里云镜像名称。目标镜像的名称需满足以下要求：'."\n"
- ."\n"
- .'- 同一阿里云地域下，镜像名称必须唯一。'."\n"
- .'- 长度为2~128个英文或中文字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。'."\n"
- ."\n"
- .'>迁移任务运行过程中，若当前地域已经存在相同名称的镜像，则系统默认给镜像名称添加迁移任务ID（JobId）作为后缀，如：ImageName_j-2zexxxxxxxxxxxxx。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testAliCloudImageName',
- ],
+ 'schema' => ['description' => '迁移任务交付的目标阿里云镜像名称。目标镜像的名称需满足以下要求：'."\n"
+ ."\n"
+ .'- 同一阿里云地域下，镜像名称必须唯一。'."\n"
+ .'- 长度为2~128个英文或中文字符，必须以大小字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。'."\n"
+ ."\n"
+ .'>迁移任务运行过程中，若当前地域已经存在相同名称的镜像，则系统默认给镜像名称添加迁移任务ID（JobId）作为后缀，如：ImageName_j-2zexxxxxxxxxxxxx。', 'type' => 'string', 'required' => false, 'example' => 'testAliCloudImageName'],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '目标实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-bp1f1dvfto1sigz5****',
- ],
+ 'schema' => ['description' => '目标实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-bp1f1dvfto1sigz5****'],
],
[
'name' => 'SystemDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '目标阿里云服务器ECS的系统盘大小，单位为GiB。取值范围：20~2048。'."\n"
- ."\n"
- .'> 该参数取值需要大于迁移源系统盘实际占用大小，例如，源系统盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '80',
- ],
+ 'schema' => ['description' => '目标阿里云服务器ECS的系统盘大小，单位为GiB。取值范围：20~2048。'."\n"
+ ."\n"
+ .'> 该参数取值需要大于迁移源系统盘实际占用大小，例如，源系统盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
],
[
'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '已配置高速通道服务或者VPN网关的VPC ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc-bp1vwnn14rqpyiczj****',
- ],
+ 'schema' => ['description' => '已配置高速通道服务或者VPN网关的VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1vwnn14rqpyiczj****'],
],
[
'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定VPC下的虚拟交换机ID。'."\n"
- ."\n"
- .'使用VPC内网迁移时，该参数为必填参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-bp1ddbrxdlrcbim46****',
- ],
+ 'schema' => ['description' => '指定VPC下的虚拟交换机ID。'."\n"
+ ."\n"
+ .'使用VPC内网迁移时，该参数为必填参数。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1ddbrxdlrcbim46****'],
],
[
'name' => 'ReplicationParameters',
'in' => 'query',
- 'schema' => [
- 'description' => '复制驱动器的参数信息。参数信息为JSON格式键值对，键值固定。最大长度：2048个字符。'."\n"
- ."\n"
- .'复制驱动器是指，复制源服务器数据到中转实例时所使用的工具。不同复制驱动器支持参数可能不同。复制驱动器SMT目前支持以下参数：'."\n"
- .'- bandwidth_limit：传输速度带宽限制。'."\n"
- .'- compress_level：传输压缩率。'."\n"
- .'- checksum：是否开启checksum校验。'."\n"
- ."\n"
- .'复制驱动器的取值，请参见[DescribeSourceServers](~~121818~~)的返回参数`SourceServers.ReplicationDriver`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"bandwidth_limit":0,"compress_level":1,"checksum":true}',
- ],
+ 'schema' => ['description' => '复制驱动器的参数信息。参数信息为JSON格式键值对，键值固定。最大长度：2048个字符。'."\n"
+ ."\n"
+ .'复制驱动器是指，复制源服务器数据到中转实例时所使用的工具。不同复制驱动器支持参数可能不同。复制驱动器SMT目前支持以下参数：'."\n"
+ .'- bandwidth_limit：传输速度带宽限制。'."\n"
+ .'- compress_level：传输压缩率。'."\n"
+ .'- checksum：是否开启checksum校验。'."\n"
+ ."\n"
+ .'复制驱动器的取值，请参见[DescribeSourceServers](~~121818~~)的返回参数`SourceServers.ReplicationDriver`。', 'type' => 'string', 'required' => false, 'example' => '{"bandwidth_limit":0,"compress_level":1,"checksum":true}'],
],
[
'name' => 'NetMode',
'in' => 'query',
- 'schema' => [
- 'description' => '数据传输网络模式。取值范围：'."\n"
- ."\n"
- .'- 0：表示公网传输模式。此时要求您的源服务器能够访问公网，迁云数据从公网传输。'."\n"
- .'- 2：表示内网传输模式，选用此模式必须设置VSwitchId参数（VpcId参数可以不设置，服务内部可以通过接口反查出来）。'."\n"
- ."\n"
- .'默认值：0。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '数据传输网络模式。取值范围：'."\n"
+ ."\n"
+ .'- 0：表示公网传输模式。此时要求您的源服务器能够访问公网，迁云数据从公网传输。'."\n"
+ .'- 2：表示内网传输模式，选用此模式必须设置VSwitchId参数（VpcId参数可以不设置，服务内部可以通过接口反查出来）。'."\n"
+ ."\n"
+ .'默认值：0。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'RunOnce',
'in' => 'query',
- 'schema' => [
- 'description' => '创建一次性迁移任务还是增量迁移任务。取值范围：'."\n"
- ."\n"
- .'- true（默认值）：一次性迁移任务。任务创建后，仅执行一次。'."\n"
- ."\n"
- .'- false：增量迁移任务。任务创建后，按照您设置的`Frequency`参数值周期性自动执行。使用增量迁移任务，可在业务不暂停的情况下，同步源服务器的增量数据至阿里云，并为源服务器生成任务运行时刻的全量数据镜像。'."\n"
- ."\n"
- .'> 该参数值只能在创建迁移任务时指定。参数值一经指定，则无法更改。'."\n"
- ."\n\n"
- ."\n\n"
- ."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '创建一次性迁移任务还是增量迁移任务。取值范围：'."\n"
+ ."\n"
+ .'- true（默认值）：一次性迁移任务。任务创建后，仅执行一次。'."\n"
+ ."\n"
+ .'- false：增量迁移任务。任务创建后，按照您设置的`Frequency`参数值周期性自动执行。使用增量迁移任务，可在业务不暂停的情况下，同步源服务器的增量数据至阿里云，并为源服务器生成任务运行时刻的全量数据镜像。'."\n"
+ ."\n"
+ .'> 该参数值只能在创建迁移任务时指定。参数值一经指定，则无法更改。'."\n"
+ ."\n\n"
+ ."\n\n"
+ ."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Frequency',
'in' => 'query',
- 'schema' => [
- 'description' => '增量迁移任务运行的时间间隔，单位：小时。取值范围：1~168。'."\n"
- ."\n"
- .'`RunOnce`参数值为false时，该参数为必填参数。'."\n"
- ."\n"
- .'默认值：无。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '12',
- ],
+ 'schema' => ['description' => '增量迁移任务运行的时间间隔，单位：小时。取值范围：1~168。'."\n"
+ ."\n"
+ .'`RunOnce`参数值为false时，该参数为必填参数。'."\n"
+ ."\n"
+ .'默认值：无。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12'],
],
[
'name' => 'MaxNumberOfImageToKeep',
'in' => 'query',
- 'schema' => [
- 'description' => '增量迁移任务默认保留的最大镜像数。取值范围：1~10。'."\n"
- ."\n"
- .'`RunOnce`参数值为false时，该参数为必填参数。'."\n"
- ."\n"
- .'默认值：无。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '增量迁移任务默认保留的最大镜像数。取值范围：1~10。'."\n"
+ ."\n"
+ .'`RunOnce`参数值为false时，该参数为必填参数。'."\n"
+ ."\n"
+ .'默认值：无。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '中转实例的实例规格。'."\n"
- ."\n"
- .'调用[DescribeInstanceTypes](~~25620~~)可查询云服务器ECS提供的实例规格。'."\n"
- ."\n"
- .'- 指定该参数后，系统会选择该实例规格创建中转实例。若该实例规格库存不足，则迁移任务创建失败。'."\n"
- .'- 不指定该参数时，系统默认会按照一定顺序选择实例规格来创建中转实例，详情请参见[SMC'."\n"
- .' FAQ 中转实例规格有哪些](~~121707~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.c6.large',
- ],
+ 'schema' => ['description' => '中转实例的实例规格。'."\n"
+ ."\n"
+ .'调用[DescribeInstanceTypes](~~25620~~)可查询云服务器ECS提供的实例规格。'."\n"
+ ."\n"
+ .'- 指定该参数后，系统会选择该实例规格创建中转实例。若该实例规格库存不足，则迁移任务创建失败。'."\n"
+ .'- 不指定该参数时，系统默认会按照一定顺序选择实例规格来创建中转实例，详情请参见[SMC'."\n"
+ .' FAQ 中转实例规格有哪些](~~121707~~)。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large'],
],
[
'name' => 'LaunchTemplateId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例启动模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'lt-bp16jovvln1cgaaq****',
- ],
+ 'schema' => ['description' => '实例启动模板ID。', 'type' => 'string', 'required' => false, 'example' => 'lt-bp16jovvln1cgaaq****'],
],
[
'name' => 'LaunchTemplateVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '实例启动模板的版本。'."\n"
- .' ',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '实例启动模板的版本。'."\n"
+ .' ', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'InstanceRamRole',
'in' => 'query',
- 'schema' => [
- 'description' => '实例RAM角色名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMCAdmin',
- ],
+ 'schema' => ['description' => '实例RAM角色名称。', 'type' => 'string', 'required' => false, 'example' => 'SMCAdmin'],
],
[
'name' => 'ContainerNamespace',
'in' => 'query',
- 'schema' => [
- 'description' => 'Docker的命名空间。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testNamespace',
- ],
+ 'schema' => ['description' => 'Docker的命名空间。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。', 'type' => 'string', 'required' => false, 'example' => 'testNamespace'],
],
[
'name' => 'ContainerRepository',
'in' => 'query',
- 'schema' => [
- 'description' => 'Docker的镜像仓库。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testRepository',
- ],
+ 'schema' => ['description' => 'Docker的镜像仓库。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。', 'type' => 'string', 'required' => false, 'example' => 'testRepository'],
],
[
'name' => 'ContainerTag',
'in' => 'query',
- 'schema' => [
- 'description' => 'Docker的镜像标签。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CentOS:v1',
- ],
+ 'schema' => ['description' => 'Docker的镜像标签。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。', 'type' => 'string', 'required' => false, 'example' => 'CentOS:v1'],
],
[
'name' => 'LicenseType',
'in' => 'query',
- 'schema' => [
- 'description' => '许可证类型。取值范围：'."\n"
- ."\n"
- .'- 空值：无许可证。'."\n"
- .'- BYOL：自带许可。'."\n"
- ."\n"
- .'更多信息，请参见[SMC FAQ](~~121707~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BYOL',
- ],
+ 'schema' => ['description' => '许可证类型。取值范围：'."\n"
+ ."\n"
+ .'- 空值：无许可证。'."\n"
+ .'- BYOL：自带许可。'."\n"
+ ."\n"
+ .'更多信息，请参见[SMC FAQ](~~121707~~)。', 'type' => 'string', 'required' => false, 'example' => 'BYOL'],
],
[
'name' => 'DataDisk',
@@ -1299,15 +580,9 @@
'description' => '数据盘信息列表。',
'type' => 'object',
'properties' => [
- 'Index' => [
- 'description' => '目标阿里云服务器ECS的数据盘顺序。初始值为1。取值范围：1~16'."\n"
- ."\n\n"
- .'>您只能为迁移源中存在的数据盘创建目标数据盘。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'Index' => ['description' => '目标阿里云服务器ECS的数据盘顺序。初始值为1。取值范围：1~16'."\n"
+ ."\n\n"
+ .'>您只能为迁移源中存在的数据盘创建目标数据盘。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'Part' => [
'description' => '分区列表。',
'type' => 'array',
@@ -1315,46 +590,24 @@
'description' => '分区列表。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '目标数据盘N分区N的大小。单位：Byte。默认为源数据盘分区大小。'."\n"
- .'> - 分区空间大小不能超过数据盘空间大小，并且在同一数据盘下所有分区空间大小之和不能超过数据盘空间大小。'."\n"
- .'- 当`DataDisk.N.Part.N.Device`不为空时，该参数也不能为空。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '254803968',
- ],
- 'Block' => [
- 'description' => '数据盘N分区N是否开启块复制。取值范围：'."\n"
- .'- true。'."\n"
- .'- false。'."\n"
- ."\n"
- .'默认值：true。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Device' => [
- 'description' => '目标数据盘N分区N对应的分区设备标识。N的实际取值请参考迁移源的分区设备标识。'."\n"
- .'> 当`DataDisk.N.Part.N.SizeBytes`不为空时，该参数也不能为空。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0_1',
- ],
+ 'SizeBytes' => ['description' => '目标数据盘N分区N的大小。单位：Byte。默认为源数据盘分区大小。'."\n"
+ .'> - 分区空间大小不能超过数据盘空间大小，并且在同一数据盘下所有分区空间大小之和不能超过数据盘空间大小。'."\n"
+ .'- 当`DataDisk.N.Part.N.Device`不为空时，该参数也不能为空。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968'],
+ 'Block' => ['description' => '数据盘N分区N是否开启块复制。取值范围：'."\n"
+ .'- true。'."\n"
+ .'- false。'."\n"
+ ."\n"
+ .'默认值：true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Device' => ['description' => '目标数据盘N分区N对应的分区设备标识。N的实际取值请参考迁移源的分区设备标识。'."\n"
+ .'> 当`DataDisk.N.Part.N.SizeBytes`不为空时，该参数也不能为空。', 'type' => 'string', 'required' => false, 'example' => '0_1'],
],
'required' => false,
],
'required' => false,
'maxItems' => 32,
],
- 'Size' => [
- 'description' => '目标阿里云服务器ECS的数据盘大小，单位为GiB。取值范围：20~32768。'."\n"
- .'>该参数取值需要大于迁移源数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'Size' => ['description' => '目标阿里云服务器ECS的数据盘大小，单位为GiB。取值范围：20~32768。'."\n"
+ .'>该参数取值需要大于迁移源数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
'required' => false,
],
@@ -1373,22 +626,12 @@
'description' => '标签列表。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '迁移任务的标签键。N的取值范围：1~20'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '迁移任务的标签值。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持128个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '迁移任务的标签键。N的取值范围：1~20'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '迁移任务的标签值。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持128个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -1407,32 +650,16 @@
'description' => '系统盘分区列表。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '系统盘分区N大小。单位：Byte。默认为源系统盘分区大小。'."\n"
- .'> - 分区空间大小不能超过系统盘空间大小，并且在系统盘下所有分区空间大小之和不能超过系统盘空间大小。'."\n"
- .'- 当`SystemDiskPart.N.Device`不为空时，该参数也不能为空。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '254803968',
- ],
- 'Block' => [
- 'description' => '系统盘分区N是否开启块复制。取值范围：'."\n"
- .'- true。'."\n"
- .'- false。'."\n"
- ."\n"
- .'默认值：true。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Device' => [
- 'description' => '目标系统盘分区N设备标识。N的实际取值请参考迁移源的分区设备标识。'."\n"
- .'> 当`SystemDiskPart.N.SizeBytes`不为空时，该参数也不能为空。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0_1',
- ],
+ 'SizeBytes' => ['description' => '系统盘分区N大小。单位：Byte。默认为源系统盘分区大小。'."\n"
+ .'> - 分区空间大小不能超过系统盘空间大小，并且在系统盘下所有分区空间大小之和不能超过系统盘空间大小。'."\n"
+ .'- 当`SystemDiskPart.N.Device`不为空时，该参数也不能为空。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968'],
+ 'Block' => ['description' => '系统盘分区N是否开启块复制。取值范围：'."\n"
+ .'- true。'."\n"
+ .'- false。'."\n"
+ ."\n"
+ .'默认值：true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Device' => ['description' => '目标系统盘分区N设备标识。N的实际取值请参考迁移源的分区设备标识。'."\n"
+ .'> 当`SystemDiskPart.N.SizeBytes`不为空时，该参数也不能为空。', 'type' => 'string', 'required' => false, 'example' => '0_1'],
],
'required' => false,
],
@@ -1443,28 +670,17 @@
[
'name' => 'JobType',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的类型。取值范围：'."\n"
- ."\n"
- .'- 0：服务器迁移。'."\n"
- .'- 1：操作系统迁移。'."\n"
- .'- 2：跨可用区迁移。'."\n"
- .'- 3：VMware无代理迁移。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '迁移任务的类型。取值范围：'."\n"
+ ."\n"
+ .'- 0：服务器迁移。'."\n"
+ .'- 1：操作系统迁移。'."\n"
+ .'- 2：跨可用区迁移。'."\n"
+ .'- 3：VMware无代理迁移。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmw3ty5y7****',
- ],
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****'],
],
[
'name' => 'Disks',
@@ -1478,35 +694,24 @@
'description' => '系统盘信息。',
'type' => 'object',
'properties' => [
- 'Size' => [
- 'description' => '迁移源系统盘的大小，单位：GiB。取值范围为20~32768。'."\n"
- ."\n"
- .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- 'LVM' => [
- 'description' => '是否使用LVM。取值：'."\n"
- ."\n"
- .'- true：使用LVM。'."\n"
- ."\n"
- .'- false：不使用LVM。'."\n"
- ."\n"
- .'不支持开启LVM：'."\n"
- .' - 迁移源为Windows系统时，不支持开启LVM。'."\n"
- .' - 系统盘无启动分区，不支持开启LVM。'."\n"
- ."\n"
- .'开启LVM后，以下场景该功能不生效：'."\n"
- ."\n"
- .' - 迁移源不支持lvm2、未安装lvm2软件包。'."\n"
- ."\n"
- .' - 迁移源为内核版本在3.x及以下的Debian系统，且挂载了XFS文件系统的磁盘。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'Size' => ['description' => '迁移源系统盘的大小，单位：GiB。取值范围为20~32768。'."\n"
+ ."\n"
+ .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'LVM' => ['description' => '是否使用LVM。取值：'."\n"
+ ."\n"
+ .'- true：使用LVM。'."\n"
+ ."\n"
+ .'- false：不使用LVM。'."\n"
+ ."\n"
+ .'不支持开启LVM：'."\n"
+ .' - 迁移源为Windows系统时，不支持开启LVM。'."\n"
+ .' - 系统盘无启动分区，不支持开启LVM。'."\n"
+ ."\n"
+ .'开启LVM后，以下场景该功能不生效：'."\n"
+ ."\n"
+ .' - 迁移源不支持lvm2、未安装lvm2软件包。'."\n"
+ ."\n"
+ .' - 迁移源为内核版本在3.x及以下的Debian系统，且挂载了XFS文件系统的磁盘。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Part' => [
'description' => '系统盘分区信息。',
'type' => 'array',
@@ -1514,25 +719,9 @@
'description' => '系统盘分区信息。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '系统盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '254803968',
- ],
- 'Block' => [
- 'description' => '系统盘分区是否开启块复制。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Path' => [
- 'description' => '系统盘分区路径。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/boot',
- ],
+ 'SizeBytes' => ['description' => '系统盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968'],
+ 'Block' => ['description' => '系统盘分区是否开启块复制。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Path' => ['description' => '系统盘分区路径。', 'type' => 'string', 'required' => false, 'example' => '/boot'],
],
'required' => false,
],
@@ -1548,28 +737,13 @@
'description' => '数据盘分区信息。',
'type' => 'object',
'properties' => [
- 'Size' => [
- 'description' => '迁移源的数据磁盘大小。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '80',
- ],
- 'LVM' => [
- 'description' => '数据盘是否使用LVM。取值：'."\n"
- ."\n"
- .'- true：使用LVM。'."\n"
- ."\n"
- .'- false：不使用LVM。',
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'DiskId' => [
- 'description' => '数据盘ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd-2ze8hyowhdgd6ou2m5z6',
- ],
+ 'Size' => ['description' => '迁移源的数据磁盘大小。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
+ 'LVM' => ['description' => '数据盘是否使用LVM。取值：'."\n"
+ ."\n"
+ .'- true：使用LVM。'."\n"
+ ."\n"
+ .'- false：不使用LVM。', 'type' => 'boolean', 'required' => false],
+ 'DiskId' => ['description' => '数据盘ID。', 'type' => 'string', 'required' => false, 'example' => 'd-2ze8hyowhdgd6ou2m5z6'],
'Part' => [
'description' => '数据盘分区信息。',
'type' => 'array',
@@ -1577,28 +751,12 @@
'description' => '数据盘分区信息。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '数据盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '21474836480',
- ],
- 'Block' => [
- 'description' => '数据盘分区是否开启块复制。取值：'."\n"
- ."\n"
- .'- true：数据盘分区开启块复制。'."\n"
- .'- false：数据盘分区不开启块复制。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Path' => [
- 'description' => '数据盘分区路径。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/home/date',
- ],
+ 'SizeBytes' => ['description' => '数据盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '21474836480'],
+ 'Block' => ['description' => '数据盘分区是否开启块复制。取值：'."\n"
+ ."\n"
+ .'- true：数据盘分区开启块复制。'."\n"
+ .'- false：数据盘分区不开启块复制。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Path' => ['description' => '数据盘分区路径。', 'type' => 'string', 'required' => false, 'example' => '/home/date'],
],
'required' => false,
],
@@ -1620,82 +778,38 @@
'description' => '返回参数信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。 ',
- 'type' => 'string',
- 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9',
- ],
- 'JobId' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'example' => 'j-bp17bclvg344jlyt****',
- ],
+ 'RequestId' => ['description' => '请求ID。 ', 'type' => 'string', 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9'],
+ 'JobId' => ['description' => '迁移任务ID。', '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.',
- ],
+ ['errorCode' => 'ReplicationJobDataDiskIndex.Invalid', 'errorMessage' => 'The specified replication job contains data disk index not found in source server.', 'description' => '迁移任务包含的数据盘索引在迁移源中不存在。'],
+ ['errorCode' => 'VSwitchIdVpcId.Mismatch', 'errorMessage' => 'The specified VSwitchId and VpcId does not match.', 'description' => '指定的VSwitchId和VpcId不匹配。'],
+ ['errorCode' => 'InvalidSecurityGroupId.IncorrectNetworkType', 'errorMessage' => 'The network type of the specified security group does not support this action.', 'description' => '安全组网络类型不支持该操作，请检查安全组网络类型。'],
+ ['errorCode' => 'InvalidSecurityGroupId.VPCMismatch', 'errorMessage' => 'The specified security group and the specified virtual switch are not in the same VPC.', 'description' => '指定的安全组和交换机不在一个专有网络。'],
+ ['errorCode' => 'QuotaExceeded.ReplicationJob', 'errorMessage' => 'The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota.', 'description' => '迁移任务的数量已超过最大允许值，请提交工单。'],
+ ['errorCode' => 'ReplicationJobName.Duplicate', 'errorMessage' => 'The specified replication job name already exists.', 'description' => '迁移任务名称已存在，请修改迁移任务名称。'],
+ ['errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移源的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ['errorCode' => 'ImageName.UsedByReplicationJob', 'errorMessage' => 'The specified imageName: "%s" was used by another replication job in the current region.', 'description' => '镜像名称“%s”被当前地域的另一个迁移任务使用。'],
+ ['errorCode' => 'InvalidOsMigrationType.NotMatched', 'errorMessage' => 'The SourceOsType: %s and TargetOsType: %s are not matched. The supported TargetOsType list is: %s.', 'description' => '源操作系统类型：%s 和目标操作系统类型：%s 不匹配。支持的目标操作系统类型列表是：%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.',
- ],
+ ['errorCode' => 'EntityNotExist.Role', 'errorMessage' => 'The account is unauthorized. Please assign the role AliyunServiceRoleForSMC to your account.', 'description' => '账号不具备操作权限，请赋予账户AliyunServiceRoleForSMC角色。'."\n"],
+ ['errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'You must perform real-name verification for your account.', 'description' => '账户未实名认证，请先进行实名认证'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C8B26B44-0189-443E-9816-D951F59623A9\\",\\n \\"JobId\\": \\"j-bp17bclvg344jlyt****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateReplicationJobResponse>\\n <RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>\\n <JobId>j-bp17bclvg344jlyt****</JobId>\\n</CreateReplicationJobResponse>","errorExample":""}]',
'title' => '创建一个迁移任务',
+ 'summary' => '调用CreateReplicationJob为迁移源创建一个迁移任务。',
'description' => '## 接口说明'."\n"
."\n\n"
.'- 您只能为在线（Available）状态的迁移源创建迁移任务。'."\n"
@@ -1707,17 +821,29 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateCrossZoneMigrationJob' => [
- 'summary' => 'SMC支持将阿里云云服务器ECS迁移到同地域的不同可用区，同时也支持在同规格族内更改实例规格（vCPU和内存），满足您迁移云服务器ECS和变配实例规格的业务需求。您可以通过此接口创建跨可用区任务。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/*'],
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C8B26B44-0189-443E-9816-D951F59623A9\\",\\n \\"JobId\\": \\"j-bp17bclvg344jlyt****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateReplicationJobResponse>\\n <RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>\\n <JobId>j-bp17bclvg344jlyt****</JobId>\\n</CreateReplicationJobResponse>","errorExample":""}]',
+ ],
+ 'CreateWorkgroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1729,623 +855,260 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '149399',
- 'abilityTreeNodes' => [
- 'FEATUREsmcL35UBA',
- ],
+ 'abilityTreeCode' => '240381',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移源要迁入的目标阿里云地域ID。'."\n"
- ."\n"
- .'例如，您需要迁移源服务器至杭州，则相应的阿里云地域ID为`cn-hangzhou`。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'ECS实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-bp1ff25rzvnul6kr****',
- ],
- ],
- [
- 'name' => 'TargetVSwitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标交换机ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-bp1mxqnssl8nafltc****',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['title' => '幂等参数', 'description' => '保证请求幂等性。您可以从客户端生成一个不超过64个ASCII字符的参数值，并将值赋予ClientToken，保证重试请求的幂等性。更多详情，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
- 'name' => 'TargetZoneId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '目标可用区ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-i',
- ],
+ 'schema' => ['description' => '工作组名称。名称需满足以下要求：'."\n"
+ ."\n"
+ .'- 任务名称必须唯一。'."\n"
+ .'- 长度为2~64个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、点号（.）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'testWorkgroupName'],
],
[
- 'name' => 'TargetInstanceType',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '目标实例规格。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.g7.large',
- ],
+ 'schema' => ['description' => '工作组描述。长度为 2～256 个英文或中文字符，不能以`http://`和`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'AutoPay',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否自动付费，取值说明：'."\n"
- ."\n"
- .'- **true**：（默认值）自动付费，请确保账号有足够的余额。'."\n"
- .'- **false**：手动付费。具体操作，请参见[手动续费包年包月实例](~~85052~~)。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'Disk',
+ 'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '云盘信息。',
+ 'description' => '标签数组。数组长度：1~20。如果数组中有多个标签对象，标签键Key不允许重复。',
'type' => 'array',
'items' => [
- 'description' => '云盘对象。',
+ 'description' => '标签对象。',
'type' => 'object',
'properties' => [
- 'DiskId' => [
- 'description' => '云盘ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd-bp1eeplkn4j29wf7****',
- ],
- 'Category' => [
- 'description' => '云盘种类为cloud_essd，表示ESSD云盘。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cloud_essd',
- ],
- 'PerformanceLevel' => [
- 'description' => 'ESSD云盘的性能等级。取值范围：'."\n"
- ."\n"
- .'- PL0：单盘最高随机读写IOPS 1万。'."\n"
- .'- PL1：单盘最高随机读写IOPS 5万。'."\n"
- .'- PL2：单盘最高随机读写IOPS 10万。'."\n"
- .'- PL3：单盘最高随机读写IOPS 100万。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PL0',
- ],
+ 'Key' => ['description' => '工作组的标签键。最多支持128个字符，一旦传入该值，则不允许为空字符串，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '工作组的标签值。最多支持128个字符，一旦传入该值，可以为空字符串，不能包含`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
- 'maxItems' => 101,
- ],
- ],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmw3ty5y7****',
+ 'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回参数信息。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A9DBD2F8-DE5A-5844-BA6F-957A996CBD78',
- ],
- 'JobId' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'example' => 'j-bp17bclvg344jlyt****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9'],
+ 'WorkgroupId' => ['title' => 'Id of the request', 'description' => '工作组ID。', 'type' => 'string', 'example' => 'w-bp10geepnj916e3d****'],
],
],
],
],
'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.',
- ],
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建工作组',
+ 'summary' => '工作组可以同时管理多个迁移任务的生命周期，适用于需要批量迁移服务器的场景。',
+ 'description' => '- 每个阿里云账号最多可创建50个工作组。'."\n"
+ .'- 一个工作组最多可以关联50个迁移源。'."\n"
+ .'- 一个迁移源只能关联一个工作组。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateWorkgroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A9DBD2F8-DE5A-5844-BA6F-957A996CBD78\\",\\n \\"JobId\\": \\"j-bp17bclvg344jlyt****\\"\\n}","type":"json"}]',
- 'title' => '创建跨可用区迁移任务',
- 'description' => '关于跨可用区迁移的使用限制及其迁移影响等信息，请参见[跨可用区迁移操作](~~476797~~)。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8B26B44-0189-443E-9816-D951F59623A9\\",\\n \\"WorkgroupId\\": \\"w-bp10geepnj916e3d****\\"\\n}","type":"json"}]',
],
- 'ModifyReplicationJobAttribute' => [
- 'summary' => '调用ModifyReplicationJobAttribute修改迁移任务信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CutOverReplicationJob' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'abilityTreeCode' => '18572',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'abilityTreeCode' => '18561',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'j-bp19vlwm0tyigbmj****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务名称。迁移任务的名称需满足以下要求：'."\n"
- ."\n"
- .'- 任务名称必须唯一。'."\n"
- .'- 长度为2~128个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testMigrationTaskName',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务描述。'."\n"
- ."\n"
- .'长度应为2~128个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This_is_my_migration_task',
- ],
- ],
- [
- 'name' => 'TargetType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移交付的目标类型。仅支持在迁移任务启动前修改。取值范围：'."\n"
- .'- Image：迁移成功后，SMC为您的源服务器生成阿里云镜像，您可使用该镜像创建ECS实例达到迁移至阿里云的目的。'."\n"
- .'- ContainerImage：迁移成功后，SMC为您的源服务器生成容器镜像，您可以在容器镜像服务中使用该镜像。'."\n"
- ."\n"
- .'- TargetInstance：迁移成功后，SMC将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定`InstanceId`参数。'."\n"
- ."\n"
- .'> - 该参数的取值不区分大小写。'."\n"
- .'- Windows操作系统和Arm架构操作系统不支持迁移至容器镜像。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Image',
- ],
- ],
- [
- 'name' => 'ScheduledStartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '设置迁移任务的执行时间。SMC在指定时间自动为您启动迁移任务。'."\n"
- ."\n"
- .'执行时间遵循ISO8601标准，并需要使用UTC时间，格式为YYYY-MM-DDThh:mm:ssZ。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
- ."\n"
- .'>当执行时间为空时，SMC不自动启动迁移任务，您需要调用[StartReplicationJob](~~121823~~)启动。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-06-04T13:35:00Z',
- ],
- ],
- [
- 'name' => 'ImageName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务交付的目标镜像名称。目标镜像的名称需满足以下要求：'."\n"
- ."\n"
- .'- 同一阿里云地域下，镜像名称必须唯一。'."\n"
- .'- 长度为2~128个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n"
- ."\n"
- .'>如果迁移任务运行过程中，当前地域已经存在相同名称的镜像，则系统默认在镜像名称后面添加迁移任务ID（JobId）作为后缀，如：ImageName-JobId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testAliCloudImageName',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-bp1f1dvfto1sigz5****',
- ],
- ],
- [
- 'name' => 'SystemDiskSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标阿里云服务器ECS的系统盘大小，单位：GiB。取值范围为20~500。'."\n"
- ."\n"
- .'> 参数取值需要大于源服务器系统盘实际占用大小，例如，源系统盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- ],
- [
- 'name' => 'Frequency',
- 'in' => 'query',
- 'schema' => [
- 'description' => '增量迁移任务运行的时间间隔，单位：小时。取值范围为1~168。'."\n"
- ."\n"
- .'`RunOnce`参数值为false时，该参数为必填参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '自动增量迁移任务ID。', 'type' => 'string', 'required' => true, 'example' => 'j-bp1fnx5y3djc4cop****'],
],
[
- 'name' => 'MaxNumberOfImageToKeep',
- 'in' => 'query',
- 'schema' => [
- 'description' => '增量迁移任务默认保留的最大镜像数。取值范围为1~10。'."\n"
- ."\n"
- .'`RunOnce`参数值为false时，该参数为必填参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
- ],
- [
- 'name' => 'InstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '中转实例的实例规格。'."\n"
- ."\n"
- .'调用[DescribeInstanceTypes](~~25620~~)可查询云服务器ECS提供的实例规格。'."\n"
- ."\n"
- .'- 指定该参数后，系统会选择该实例规格创建中转实例。若该实例规格库存不足，则迁移任务创建失败。'."\n"
- .'- 不指定该参数时，系统会默认按照一定顺序选择实例规格来创建中转实例，详情请参见[SMC'."\n"
- .' FAQ 中转实例规格有哪些](~~121707~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.c5.large',
- ],
- ],
- [
- 'name' => 'LaunchTemplateId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例启动模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'lt-bp16jovvln1cgaaq****',
- ],
- ],
- [
- 'name' => 'LaunchTemplateVersion',
+ 'name' => 'SyncData',
'in' => 'query',
- 'schema' => [
- 'description' => '实例启动模板的版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Latest',
- ],
+ 'schema' => ['description' => '是否需要进行最后一次全量数据迁移。取值范围：'."\n"
+ ."\n"
+ .'- true：需要进行最后一次全量数据迁移。'."\n"
+ .'- false：不需要进行最后一次全量数据迁移。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
- [
- 'name' => 'InstanceRamRole',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例RAM角色名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMCAdmin',
+ 'description' => '请求ID。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ ],
],
],
- [
- 'name' => 'ContainerNamespace',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Docker的命名空间。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testNamespace',
- ],
+ ],
+ '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.', 'description' => '迁移任务的状态：%s 是无效的。该操作只能在以下状态进行：%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.', 'description' => '迁移任务的业务状态：%s 是无效的。该操作只能在以下业务状态进行：%s。'],
+ ['errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移源的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
],
- [
- 'name' => 'ContainerRepository',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Docker的镜像仓库。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testRepository',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
- [
- 'name' => 'ContainerTag',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Docker的镜像标签。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CentOS:v1',
+ ],
+ 'title' => '停止周期执行自动增量任务',
+ 'summary' => '将指定的自动增量迁移任务停止周期执行，并完成迁移任务。',
+ 'description' => "\n"
+ ."\n\n"
+ .'## 接口说明'."\n"
+ ."\n\n"
+ .'- 自动增量迁移任务的状态必须处于等待中（Waiting）。'."\n"
+ ."\n"
+ .'- 调用该接口后，自动增量迁移任务将不再周期执行，而是根据`SyncData`参数取值进行判断。当`SyncData=false`时，不再进行数据迁移，直接自动清理中转资源后，完成迁移任务；当`SyncData=true`时，将进行最后一次全量数据迁移，然后自动清理中转资源，完成迁移任务。'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:CutOverReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<CutOverReplicationJobResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</CutOverReplicationJobResponse>","errorExample":""}]',
+ ],
+ 'DeleteAccessToken' => [
+ 'summary' => '调用DeleteAccessToken删除激活码。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ValidTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的过期时间。取值范围：迁移任务创建时间+7天~迁移任务创建时间+90天'."\n"
- ."\n"
- .'- 过期时间只允许迁移任务在Ready（未开始）、Running（运行中）、Stopped（已暂停）、InError（出错）或Waiting（等待中）状态下修改。'."\n"
- .'- 过期时间须遵循ISO8601标准，并需要使用UTC+0时间，格式为`YYYY-MM-DDThh:mm:ssZ`。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
- .'- 过期时间设置为空，表示任务无限期有效。'."\n"
- .'- 任务到期后会被标记为过期状态，保存7天，7天后系统会自动清理。'."\n"
- ."\n"
- .'默认值：迁移任务创建时间+30天（表示迁移任务的默认有效期为创建后30天）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-06-04T13:35:00Z',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '144985',
+ 'abilityTreeNodes' => ['FEATUREsmcWZM4IC'],
+ ],
+ 'parameters' => [
[
- 'name' => 'SystemDiskPart',
+ 'name' => 'AccessTokenId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '系统盘分区列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '系统盘分区列表。',
- 'type' => 'object',
- 'properties' => [
- 'SizeBytes' => [
- 'description' => '目标系统盘分区N大小。单位：Byte。默认为源系统盘分区大小。'."\n"
- .'> 分区空间大小不能超过系统盘空间大小，并且在系统盘下所有分区空间大小之和不能超过系统盘空间大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '254803968',
- ],
- 'Block' => [
- 'description' => '目标系统盘分区N是否开启块复制。取值范围：'."\n"
- .'- true。'."\n"
- .'- false。'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Device' => [
- 'description' => '目标系统盘分区N设备标识。'."\n"
- .'> N的实际取值请参考迁移源的分区设备标识。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0_1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 32,
- ],
+ 'schema' => ['description' => '激活码ID。', 'type' => 'string', 'required' => true, 'example' => 'at-bp1akz2zp67r0k6r****'],
],
- [
- 'name' => 'DataDisk',
- 'in' => 'query',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '数据盘列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据盘列表。',
- 'type' => 'object',
- 'properties' => [
- 'Index' => [
- 'description' => '目标阿里云服务器ECS的数据盘顺序。取值范围为1~16。'."\n"
- ."\n"
- .'初始值为1。'."\n"
- ."\n"
- .'>您只能为源服务器中存在的数据盘创建目标数据盘。'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'Part' => [
- 'description' => '分区列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '分区列表。',
- 'type' => 'object',
- 'properties' => [
- 'SizeBytes' => [
- 'description' => '目标数据盘N分区N的大小。单位：Byte。默认为源数据盘分区大小。'."\n"
- .'> 分区空间大小不能超过数据盘空间大小，并且在同一数据盘下所有分区空间大小之和不能超过数据盘空间大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '254803968',
- ],
- 'Block' => [
- 'description' => '目标数据盘N分区N是否开启块复制。取值范围：'."\n"
- .'- true。'."\n"
- .'- false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Device' => [
- 'description' => '目标数据盘N分区N对应的分区设备标识。'."\n"
- .'> N的实际取值请参考迁移源的分区设备标识。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0_1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 32,
- ],
- 'Size' => [
- 'description' => '目标阿里云服务器ECS的数据盘大小，单位：GiB。取值范围为20~32768。'."\n"
- ."\n"
- .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- ],
- 'required' => false,
+ 'description' => '请求ID。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DB4A7EA2-6FDA-5655-B067-854532FB****'],
],
- 'required' => false,
- 'maxItems' => 16,
],
],
- [
- 'name' => 'NetMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据传输网络模式。取值范围：'."\n"
- ."\n"
- .'- 0：表示公网传输模式。此时要求您的源服务器能够访问公网，迁云数据从公网传输。'."\n"
- .'- 2：表示内网传输模式，选用此模式必须设置VSwitchId参数（VpcId参数可以不设置，服务内部可以通过接口反查出来）。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
- [
- 'name' => 'VSwitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定VPC下的虚拟交换机ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-bp1ddbrxdlrcbim46****',
+ ],
+ 'title' => '删除激活码',
+ 'description' => '如果后续您不再通过激活码的方式导入迁移源，或者激活码已过期等场景，可以使用此接口删除激活码。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteAccessToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DB4A7EA2-6FDA-5655-B067-854532FB****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAccessTokenResponse>\\n <RequestId>DB4A7EA2-6FDA-5655-B067-854532FB****</RequestId>\\n</DeleteAccessTokenResponse>","errorExample":""}]',
+ ],
+ 'DeleteReplicationJob' => [
+ 'summary' => '调用DeleteReplicationJob删除一个迁移任务。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'VpcId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '已配置高速通道服务或者VPN网关的VPC ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc-bp1vwnn14rqpyiczj****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '18562',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ReplicationParameters',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '复制驱动器的参数信息。参数信息为JSON格式键值对，键值固定。最大长度：2048个字符。'."\n"
- ."\n"
- .'复制驱动器是指，复制源服务器数据到中转实例时所使用的工具。不同复制驱动器支持参数可能不同。复制驱动器SMT目前支持以下参数：'."\n"
- ."\n"
- .'- bandwidth_limit：传输速度带宽限制。'."\n"
- .'- compress_level：传输压缩率。'."\n"
- .'- checksum：是否开启checksum校验。'."\n"
- ."\n"
- .'复制驱动器的取值，请参见[DescribeSourceServers](~~2402126~~)的返回参数`SourceServers.ReplicationDriver`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"bandwidth_limit":0,"compress_level":1,"checksum":true}',
- ],
+ 'schema' => ['description' => '迁移任务ID。', 'type' => 'string', 'required' => true, 'example' => 'j-bp17m1vi6x21qhqk****'],
],
],
'responses' => [
@@ -2353,74 +1116,50 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1C488B66-B819-4D14-8711-C4EAAA13AC01',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
'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.',
- ],
+ ['errorCode' => 'ReplicationJob.InvalidStatus', 'errorMessage' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移任务的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyReplicationJobAttributeResponse>\\n <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>\\n</ModifyReplicationJobAttributeResponse>","errorExample":""}]',
- 'title' => '修改迁移任务',
+ 'title' => '删除一个迁移任务',
'description' => '## 接口说明'."\n"
."\n"
- .'修改迁移任务之前，请阅读以下注意事项：'."\n"
- ."\n"
- .'- 参数`Name`和`Description`在迁移任务的整个生命周期内均可以修改。'."\n"
- ."\n"
- .'- 参数`Frequency`和`MaxNumberOfImageToKeep`只能在迁移任务执行前或任务状态为`等待中`时修改。'."\n"
- ."\n"
- .'- 其他参数只能在迁移任务执行前修改。',
+ .'- 迁移任务删除后不可恢复。'."\n"
+ .'- 迁移任务删除后自动释放已创建的相关资源，如中转实例等。'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'StartReplicationJob' => [
- 'summary' => '调用StartReplicationJob启动一个迁移任务。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteReplicationJobResponse>\\r\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\r\\n</DeleteReplicationJobResponse>","errorExample":""}]',
+ ],
+ 'DeleteSourceServer' => [
+ 'summary' => '调用DeleteSourceServer删除一个迁移源。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2429,76 +1168,76 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '18576',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '18563',
+ 'abilityTreeNodes' => ['FEATUREsmcWZM4IC'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'SourceId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'j-bw526m1vi6x21q****',
- ],
+ 'schema' => ['description' => '迁移源ID。', 'type' => 'string', 'required' => true, 'example' => 's-bp17m1vi6x20c6g6****'],
+ ],
+ [
+ 'name' => 'Force',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否强制删除迁移源。'."\n"
+ ."\n"
+ .'- true：强制删除迁移源、迁移源关联的迁移任务及任务对应的中转资源。'."\n"
+ .'- false：无法删除已关联迁移任务的迁移源。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '请求ID。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['description' => '请求ID。', '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.',
- ],
+ ['errorCode' => 'SourceServer.WithRunningReplicationJob', 'errorMessage' => 'The specified source server has related replication jobs that are running.', 'description' => '迁移源关联正在运行的迁移任务。'],
+ ['errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移源的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ['errorCode' => 'ReplicationJob.Related', 'errorMessage' => 'The specified source server has related replication jobs. Please delete replication jobs: %s before delete this source server.', 'description' => '迁移源有相关的迁移任务。请删除迁移任务：%s 后再删除该迁移源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<StartReplicationJobResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</StartReplicationJobResponse>","errorExample":""}]',
- 'title' => '启动一个迁移任务',
+ 'title' => '删除一个迁移源',
'description' => '## 接口说明'."\n"
."\n"
- .'您只能使用该API启动**Ready（未开始）**、**Stopped（已暂停）**或**InError（出错）**状态的迁移任务。',
+ .'- 迁移源若关联了Running（运行中）状态的迁移任务，则无法删除。'."\n"
+ .'- 迁移源若关联了除Running状态外的其他状态的迁移任务，则需设置`Force=true`删除。'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'StopReplicationJob' => [
- 'summary' => '调用StopReplicationJob停止一个迁移任务。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteSourceServer',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSourceServerResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DeleteSourceServerResponse>","errorExample":""}]',
+ ],
+ 'DeleteWorkgroup' => [
+ 'summary' => '如果您后期不再需要工作组，可以删除工作组。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2507,75 +1246,68 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '18577',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '240401',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'WorkgroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'j-bw526m1vi6x21qh****',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '工作组ID。', 'type' => 'string', 'required' => true, 'example' => 'w-bp10geepnj916e3d****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '410E6073-66D0-45D3-AB3E-4DC3F5E4****'],
],
],
],
],
'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.',
- ],
+ 403 => [
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '删除工作组',
+ 'description' => '删除工作组前，必须先删除或取消关联工作组中的迁移源，否则无法删除工作组。具体操作，请参见[删除一个迁移源](~~2402124~~)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteWorkgroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<StopReplicationJobResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</StopReplicationJobResponse>","errorExample":""}]',
- 'title' => '停止一个迁移任务',
- 'description' => '## 接口说明'."\n"
- ."\n"
- .'您只能使用该API停止正在运行中（Running）且处于同步中（Syncing）状态的迁移任务。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"410E6073-66D0-45D3-AB3E-4DC3F5E4****\\"\\n}","type":"json"}]',
],
'DescribeReplicationJobs' => [
'summary' => '调用DescribeReplicationJobs查询一个或多个迁移任务的详细信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2588,96 +1320,59 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '18568',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testMigrationTaskName',
- ],
+ 'schema' => ['description' => '迁移任务的名称。', 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移源需迁入的目标阿里云地域ID。'."\n"
- ."\n"
- .'例如，您需要迁移源服务器至杭州，则RegionId为`cn-hangzhou`。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '迁移源需迁入的目标阿里云地域ID。'."\n"
+ ."\n"
+ .'例如，您需要迁移源服务器至杭州，则RegionId为`cn-hangzhou`。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的主状态。取值范围：'."\n"
- ."\n"
- .'- Ready：未开始。'."\n"
- .'- Running：运行中。'."\n"
- .'- Stopped：已暂停。'."\n"
- .'- InError：出错。'."\n"
- .'- Finished：已完成。'."\n"
- .'- Waiting：等待中。'."\n"
- .'- Expired：已过期。'."\n"
- .'- Deleting：删除中。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Ready',
- ],
+ 'schema' => ['description' => '迁移任务的主状态。取值范围：'."\n"
+ ."\n"
+ .'- Ready：未开始。'."\n"
+ .'- Running：运行中。'."\n"
+ .'- Stopped：已暂停。'."\n"
+ .'- InError：出错。'."\n"
+ .'- Finished：已完成。'."\n"
+ .'- Waiting：等待中。'."\n"
+ .'- Expired：已过期。'."\n"
+ .'- Deleting：删除中。', 'type' => 'string', 'required' => false, 'example' => 'Ready'],
],
[
'name' => 'BusinessStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的业务状态。取值范围：'."\n"
- ."\n"
- .'- Preparing：准备中。'."\n"
- .'- Syncing：同步中。'."\n"
- .'- Processing：处理中。'."\n"
- .'- Cleaning：清理中。'."\n"
- ."\n\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Preparing',
- ],
+ 'schema' => ['description' => '迁移任务的业务状态。取值范围：'."\n"
+ ."\n"
+ .'- Preparing：准备中。'."\n"
+ .'- Syncing：同步中。'."\n"
+ .'- Processing：处理中。'."\n"
+ .'- Cleaning：清理中。'."\n"
+ ."\n\n", 'type' => 'string', 'required' => false, 'example' => 'Preparing'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '返回结果中，迁移任务列表的页码。起始值：1。'."\n"
- ."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '返回结果中，迁移任务列表的页码。起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。最大值：50。'."\n"
- ."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '50',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。最大值：50。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10', 'default' => '10'],
],
[
'name' => 'SourceId',
@@ -2686,12 +1381,7 @@
'schema' => [
'description' => '迁移源ID列表。N的最大值为50。',
'type' => 'array',
- 'items' => [
- 'description' => '迁移源ID列表。N的最大值为50。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp1bjhkwk2j5hlbn****',
- ],
+ 'items' => ['description' => '迁移源ID列表。N的最大值为50。', 'type' => 'string', 'required' => false, 'example' => 's-bp1bjhkwk2j5hlbn****'],
'required' => false,
'example' => 's-bp1e2fsl57knvuug****',
'maxItems' => 100,
@@ -2704,12 +1394,7 @@
'schema' => [
'description' => '迁移任务ID列表。N的最大值：50。',
'type' => 'array',
- 'items' => [
- 'description' => '迁移任务ID列表。N的最大值：50。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'j-bp1h3d33mekxwu0n****',
- ],
+ 'items' => ['description' => '迁移任务ID列表。N的最大值：50。', 'type' => 'string', 'required' => false, 'example' => 'j-bp1h3d33mekxwu0n****'],
'required' => false,
'example' => 'j-bp19vlwm0tyigbmj****',
'maxItems' => 100,
@@ -2718,18 +1403,12 @@
[
'name' => 'JobType',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务的类型。取值范围：'."\n"
- ."\n"
- .'- 0：服务器迁移。'."\n"
- .'- 1：操作系统迁移。'."\n"
- .'- 2：跨可用区迁移。'."\n"
- .'- 3：VMware无代理迁移。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '迁移任务的类型。取值范围：'."\n"
+ ."\n"
+ .'- 0：服务器迁移。'."\n"
+ .'- 1：操作系统迁移。'."\n"
+ .'- 2：跨可用区迁移。'."\n"
+ .'- 3：VMware无代理迁移。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'InstanceId',
@@ -2738,12 +1417,7 @@
'schema' => [
'description' => '实例ID。',
'type' => 'array',
- 'items' => [
- 'description' => '目标实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-bp1f1dvfto1sigz5****',
- ],
+ 'items' => ['description' => '目标实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-bp1f1dvfto1sigz5****'],
'required' => false,
'maxItems' => 21,
],
@@ -2751,12 +1425,7 @@
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmw3ty5y7****',
- ],
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****'],
],
[
'name' => 'Tag',
@@ -2769,22 +1438,12 @@
'description' => '为SMC资源指定的标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '为SMC资源指定的标签键。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http:\\//或者https:\\//。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '为SMC资源指定的标签键。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http:\\//或者https:\\//。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -2798,12 +1457,7 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '迁移任务总个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'TotalCount' => ['description' => '迁移任务总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'ReplicationJobs' => [
'type' => 'object',
'itemNode' => true,
@@ -2815,55 +1469,25 @@
'description' => '迁移任务详情的集合。',
'type' => 'object',
'properties' => [
- 'Frequency' => [
- 'description' => '增量迁移任务自动执行的时间间隔，单位：小时。取值范围：1~168。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'VpcId' => [
- 'description' => '已配置高速通道服务或者VPN网关的VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-bp1vwnn14rqpyiczj****',
- ],
- 'CreationTime' => [
- 'description' => '迁移任务的创建时间。',
- 'type' => 'string',
- 'example' => '2014-07-24T13:00:52Z',
- ],
- 'Status' => [
- 'description' => '迁移任务的主状态。可能值：'."\n"
- .'- Ready：未开始。'."\n"
- .'- Running：运行中。'."\n"
- .'- Stopped：已暂停。'."\n"
- .'- InError：出错。'."\n"
- .'- Finished：已完成。'."\n"
- .'- Waiting：等待中。'."\n"
- .'- Expired：已过期。'."\n"
- .'- Deleting：删除中。',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'ScheduledStartTime' => [
- 'description' => '迁移任务的执行时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。该参数值的设置需满足以下要求：'."\n"
- ."\n"
- .'- 该参数值必须晚于当前时间，并且需要设置在30天以内。'."\n"
- ."\n"
- .'- 如果该参数值为空，则SMC不会启动迁移任务，需要您调用[StartReplicationJob](~~121823~~)启动任务。',
- 'type' => 'string',
- 'example' => '2019-06-04T13:35:00Z',
- ],
- 'MaxNumberOfImageToKeep' => [
- 'description' => '增量迁移任务默认保留的最大镜像数。取值范围：1~10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'ContainerNamespace' => [
- 'description' => 'Docker的命名空间。',
- 'type' => 'string',
- 'example' => 'testNamespace',
- ],
+ 'Frequency' => ['description' => '增量迁移任务自动执行的时间间隔，单位：小时。取值范围：1~168。', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
+ 'VpcId' => ['description' => '已配置高速通道服务或者VPN网关的VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1vwnn14rqpyiczj****'],
+ 'CreationTime' => ['description' => '迁移任务的创建时间。', 'type' => 'string', 'example' => '2014-07-24T13:00:52Z'],
+ 'Status' => ['description' => '迁移任务的主状态。可能值：'."\n"
+ .'- Ready：未开始。'."\n"
+ .'- Running：运行中。'."\n"
+ .'- Stopped：已暂停。'."\n"
+ .'- InError：出错。'."\n"
+ .'- Finished：已完成。'."\n"
+ .'- Waiting：等待中。'."\n"
+ .'- Expired：已过期。'."\n"
+ .'- Deleting：删除中。', 'type' => 'string', 'example' => 'Running'],
+ 'ScheduledStartTime' => ['description' => '迁移任务的执行时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。该参数值的设置需满足以下要求：'."\n"
+ ."\n"
+ .'- 该参数值必须晚于当前时间，并且需要设置在30天以内。'."\n"
+ ."\n"
+ .'- 如果该参数值为空，则SMC不会启动迁移任务，需要您调用[StartReplicationJob](~~121823~~)启动任务。', 'type' => 'string', 'example' => '2019-06-04T13:35:00Z'],
+ 'MaxNumberOfImageToKeep' => ['description' => '增量迁移任务默认保留的最大镜像数。取值范围：1~10。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'ContainerNamespace' => ['description' => 'Docker的命名空间。', 'type' => 'string', 'example' => 'testNamespace'],
'DataDisks' => [
'type' => 'object',
'itemNode' => true,
@@ -2875,18 +1499,8 @@
'description' => '目标阿里云服务器ECS的数据盘。',
'type' => 'object',
'properties' => [
- 'Index' => [
- 'description' => '数据盘顺序。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'description' => '数据盘大小。单位：GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
+ 'Index' => ['description' => '数据盘顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['description' => '数据盘大小。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
'Parts' => [
'type' => 'object',
'itemNode' => true,
@@ -2898,22 +1512,9 @@
'description' => '数据盘分区信息。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '数据盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21474836480',
- ],
- 'Block' => [
- 'description' => '分区是否开启块复制。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Device' => [
- 'description' => '数据盘分区设备标识。',
- 'type' => 'string',
- 'example' => '0_1',
- ],
+ 'SizeBytes' => ['description' => '数据盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'],
+ 'Block' => ['description' => '分区是否开启块复制。', 'type' => 'boolean', 'example' => 'true'],
+ 'Device' => ['description' => '数据盘分区设备标识。', 'type' => 'string', 'example' => '0_1'],
],
],
],
@@ -2924,103 +1525,32 @@
],
],
],
- 'StatusInfo' => [
- 'description' => ' 迁移状态的详细信息。',
- 'type' => 'string',
- 'example' => 'statusinfo',
- ],
- 'InstanceRamRole' => [
- 'description' => '实例RAM角色名称。',
- 'type' => 'string',
- 'example' => 'SMCAdmin',
- ],
- 'SystemDiskSize' => [
- 'description' => '目标阿里云服务器ECS的系统盘大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Description' => [
- 'description' => '迁移任务的描述。',
- 'type' => 'string',
- 'example' => 'This is my migration task.',
- ],
- 'ReplicationParameters' => [
- 'description' => '复制驱动器参数信息。',
- 'type' => 'string',
- 'example' => 'BandWidthLimit:0',
- ],
- 'ErrorCode' => [
- 'description' => '迁移任务的错误码。',
- 'type' => 'string',
- 'example' => 'InternalError',
- ],
- 'ValidTime' => [
- 'description' => ' 迁移任务的过期时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的时间。',
- 'type' => 'string',
- 'example' => '2019-06-08T14:40:52Z',
- ],
- 'NetMode' => [
- 'description' => '迁移时使用的网络类型。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ContainerTag' => [
- 'description' => 'Docker的镜像标签。',
- 'type' => 'string',
- 'example' => 'CentOS:v1',
- ],
- 'LicenseType' => [
- 'description' => '迁移任务的许可证类型。可能值：'."\n"
- ."\n"
- .'- 空值：无许可证。'."\n"
- .'- BYOL：自带许可。',
- 'type' => 'string',
- 'example' => 'BYOL',
- ],
- 'Name' => [
- 'description' => '迁移任务名称。',
- 'type' => 'string',
- 'example' => 'testMigrationTaskName',
- ],
- 'ImageId' => [
- 'description' => '迁移任务交付的目标镜像ID。',
- 'type' => 'string',
- 'example' => 'm-o6w3gy99qf89rkga****',
- ],
- 'Progress' => [
- 'description' => '迁移任务总进度。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
- ],
- 'RunOnce' => [
- 'description' => '区分一次性迁移任务和增量迁移任务。可能值：'."\n"
- ."\n"
- .'- true：一次性迁移任务。任务创建后仅执行一次。'."\n"
- ."\n"
- .'- false：增量迁移任务。任务创建后，按照`Frequency`设置的时间间隔，周期性自动执行。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'LaunchTemplateId' => [
- 'description' => '实例启动模板ID。',
- 'type' => 'string',
- 'example' => 'lt-launchtemplateid',
- ],
- 'ContainerRepository' => [
- 'description' => 'Docker的镜像仓库。',
- 'type' => 'string',
- 'example' => 'testRepository',
- ],
- 'InstanceId' => [
- 'description' => '目标实例ID。',
- 'type' => 'string',
- 'example' => 'i-bp1ff25rzvnul6kr****',
- ],
+ 'StatusInfo' => ['description' => ' 迁移状态的详细信息。', 'type' => 'string', 'example' => 'statusinfo'],
+ 'InstanceRamRole' => ['description' => '实例RAM角色名称。', 'type' => 'string', 'example' => 'SMCAdmin'],
+ 'SystemDiskSize' => ['description' => '目标阿里云服务器ECS的系统盘大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
+ 'Description' => ['description' => '迁移任务的描述。', 'type' => 'string', 'example' => 'This is my migration task.'],
+ 'ReplicationParameters' => ['description' => '复制驱动器参数信息。', 'type' => 'string', 'example' => 'BandWidthLimit:0'],
+ 'ErrorCode' => ['description' => '迁移任务的错误码。', 'type' => 'string', 'example' => 'InternalError'],
+ 'ValidTime' => ['description' => ' 迁移任务的过期时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的时间。', 'type' => 'string', 'example' => '2019-06-08T14:40:52Z'],
+ 'NetMode' => ['description' => '迁移时使用的网络类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ContainerTag' => ['description' => 'Docker的镜像标签。', 'type' => 'string', 'example' => 'CentOS:v1'],
+ 'LicenseType' => ['description' => '迁移任务的许可证类型。可能值：'."\n"
+ ."\n"
+ .'- 空值：无许可证。'."\n"
+ .'- BYOL：自带许可。', 'type' => 'string', 'example' => 'BYOL'],
+ 'Name' => ['description' => '迁移任务名称。', 'type' => 'string', 'example' => 'testMigrationTaskName'],
+ 'ImageId' => ['description' => '迁移任务交付的目标镜像ID。', 'type' => 'string', 'example' => 'm-o6w3gy99qf89rkga****'],
+ 'Progress' => ['description' => '迁移任务总进度。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ 'RunOnce' => ['description' => '区分一次性迁移任务和增量迁移任务。可能值：'."\n"
+ ."\n"
+ .'- true：一次性迁移任务。任务创建后仅执行一次。'."\n"
+ ."\n"
+ .'- false：增量迁移任务。任务创建后，按照`Frequency`设置的时间间隔，周期性自动执行。', 'type' => 'boolean', 'example' => 'true'],
+ 'LaunchTemplateId' => ['description' => '实例启动模板ID。', 'type' => 'string', 'example' => 'lt-launchtemplateid'],
+ 'ContainerRepository' => ['description' => 'Docker的镜像仓库。', 'type' => 'string', 'example' => 'testRepository'],
+ 'InstanceId' => ['description' => '目标实例ID。', 'type' => 'string', 'example' => 'i-bp1ff25rzvnul6kr****'],
'SystemDiskParts' => [
'type' => 'object',
'itemNode' => true,
@@ -3032,90 +1562,33 @@
'description' => '系统盘分区信息。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '系统盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '254803968',
- ],
- 'Block' => [
- 'description' => '系统盘分区是否开启块复制。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Device' => [
- 'description' => '系统盘分区设备标识符。',
- 'type' => 'string',
- 'example' => '0_1',
- ],
+ 'SizeBytes' => ['description' => '系统盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '254803968'],
+ 'Block' => ['description' => '系统盘分区是否开启块复制。', 'type' => 'boolean', 'example' => 'true'],
+ 'Device' => ['description' => '系统盘分区设备标识符。', 'type' => 'string', 'example' => '0_1'],
],
],
],
],
],
- 'InstanceType' => [
- 'description' => '中转实例的实例规格。',
- 'type' => 'string',
- 'example' => 'ecs.sn1ne.large',
- ],
- 'SourceId' => [
- 'description' => '迁移源ID。',
- 'type' => 'string',
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
- 'LaunchTemplateVersion' => [
- 'description' => '一个或多个实例启动模板版本。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RegionId' => [
- 'description' => '迁移源需迁入的目标阿里云地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'TransitionInstanceId' => [
- 'description' => '迁移中转实例ID。',
- 'type' => 'string',
- 'example' => 'i-bp1ff25rzvnul6kr****',
- ],
- 'EndTime' => [
- 'description' => '迁移任务的完成时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的时间。',
- 'type' => 'string',
- 'example' => '2019-06-04T16:00:52Z',
- ],
- 'StartTime' => [
- 'description' => '迁移任务的开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的时间。',
- 'type' => 'string',
- 'example' => '2019-06-04T14:40:52Z',
- ],
- 'VSwitchId' => [
- 'description' => '指定VPC下的虚拟交换机ID。',
- 'type' => 'string',
- 'example' => 'vsw-bp1ddbrxdlrcbim46****',
- ],
- 'JobId' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'example' => 'j-bp19vlwm0tyigbmj****',
- ],
- 'ImageName' => [
- 'description' => '迁移任务交付的目标镜像名称。',
- 'type' => 'string',
- 'example' => 'testAliCloudImageName',
- ],
- 'BusinessStatus' => [
- 'description' => '迁移任务的业务状态。可能值：'."\n"
- .'- Preparing：准备中。'."\n"
- .'- Syncing：同步中。'."\n"
- .'- Processing：处理中。'."\n"
- .'- Cleaning：清理中。',
- 'type' => 'string',
- 'example' => 'Preparing',
- ],
+ 'InstanceType' => ['description' => '中转实例的实例规格。', 'type' => 'string', 'example' => 'ecs.sn1ne.large'],
+ 'SourceId' => ['description' => '迁移源ID。', 'type' => 'string', 'example' => 's-bp1e2fsl57knvuug****'],
+ 'LaunchTemplateVersion' => ['description' => '一个或多个实例启动模板版本。', 'type' => 'string', 'example' => '1'],
+ 'RegionId' => ['description' => '迁移源需迁入的目标阿里云地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'TransitionInstanceId' => ['description' => '迁移中转实例ID。', 'type' => 'string', 'example' => 'i-bp1ff25rzvnul6kr****'],
+ 'EndTime' => ['description' => '迁移任务的完成时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的时间。', 'type' => 'string', 'example' => '2019-06-04T16:00:52Z'],
+ 'StartTime' => ['description' => '迁移任务的开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的时间。', 'type' => 'string', 'example' => '2019-06-04T14:40:52Z'],
+ 'VSwitchId' => ['description' => '指定VPC下的虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-bp1ddbrxdlrcbim46****'],
+ 'JobId' => ['description' => '迁移任务ID。', 'type' => 'string', 'example' => 'j-bp19vlwm0tyigbmj****'],
+ 'ImageName' => ['description' => '迁移任务交付的目标镜像名称。', 'type' => 'string', 'example' => 'testAliCloudImageName'],
+ 'BusinessStatus' => ['description' => '迁移任务的业务状态。可能值：'."\n"
+ .'- Preparing：准备中。'."\n"
+ .'- Syncing：同步中。'."\n"
+ .'- Processing：处理中。'."\n"
+ .'- Cleaning：清理中。', 'type' => 'string', 'example' => 'Preparing'],
'ReplicationJobRuns' => [
'type' => 'object',
'itemNode' => true,
@@ -3127,64 +1600,35 @@
'description' => '迁移任务运行记录。',
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '迁移任务运行的结束时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的时间。',
- 'type' => 'string',
- 'example' => '2019-10-04T13:35:00Z',
- ],
- 'Type' => [
- 'description' => '迁移任务的执行方式。可能值：'."\n"
- ."\n"
- .'- Manual：手动执行。'."\n"
- ."\n"
- .'- Schedule：定时执行或周期执行。',
- 'type' => 'string',
- 'example' => 'Schedule',
- ],
- 'StartTime' => [
- 'description' => '迁移任务运行的开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
- ."\n"
- .'> +8小时后是控制台上显示的时间。',
- 'type' => 'string',
- 'example' => '2019-10-01T13:35:00Z',
- ],
- 'ImageId' => [
- 'description' => '迁移任务生成的镜像ID。',
- 'type' => 'string',
- 'example' => 'm-o6w3gy99qf89rkga****',
- ],
+ 'EndTime' => ['description' => '迁移任务运行的结束时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的时间。', 'type' => 'string', 'example' => '2019-10-04T13:35:00Z'],
+ 'Type' => ['description' => '迁移任务的执行方式。可能值：'."\n"
+ ."\n"
+ .'- Manual：手动执行。'."\n"
+ ."\n"
+ .'- Schedule：定时执行或周期执行。', 'type' => 'string', 'example' => 'Schedule'],
+ 'StartTime' => ['description' => '迁移任务运行的开始时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n"
+ ."\n"
+ .'> +8小时后是控制台上显示的时间。', 'type' => 'string', 'example' => '2019-10-01T13:35:00Z'],
+ 'ImageId' => ['description' => '迁移任务生成的镜像ID。', 'type' => 'string', 'example' => 'm-o6w3gy99qf89rkga****'],
],
],
],
],
],
- 'TargetType' => [
- 'description' => '迁移交付的目标类型。可能值：'."\n"
- ."\n"
- .'- Image：迁移成功后，SMC为您的迁移源生成阿里云镜像。'."\n"
- .'- ContainerImage：迁移成功后，SMC为您的迁移源生成Docker容器镜像。'."\n"
- .'- TargetInstance：迁移成功后，SMC将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定InstanceId参数。',
- 'type' => 'string',
- 'example' => 'Image',
- ],
- 'JobType' => [
- 'description' => '迁移任务的类型。可能值：'."\n"
- ."\n"
- .'- 0：服务器迁移。'."\n"
- .'- 1：操作系统迁移。'."\n"
- .'- 2：跨可用区迁移。'."\n"
- .'- 3：VMware无代理迁移。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ResourceGroupId' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-acfmw3ty5y7****',
- ],
+ 'TargetType' => ['description' => '迁移交付的目标类型。可能值：'."\n"
+ ."\n"
+ .'- Image：迁移成功后，SMC为您的迁移源生成阿里云镜像。'."\n"
+ .'- ContainerImage：迁移成功后，SMC为您的迁移源生成Docker容器镜像。'."\n"
+ .'- TargetInstance：迁移成功后，SMC将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定InstanceId参数。', 'type' => 'string', 'example' => 'Image'],
+ 'JobType' => ['description' => '迁移任务的类型。可能值：'."\n"
+ ."\n"
+ .'- 0：服务器迁移。'."\n"
+ .'- 1：操作系统迁移。'."\n"
+ .'- 2：跨可用区迁移。'."\n"
+ .'- 3：VMware无代理迁移。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfmw3ty5y7****'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
@@ -3196,20 +1640,12 @@
'description' => '为SMC资源指定的标签。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '为SMC资源指定的标签键。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '为SMC资源指定的标签键。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。', 'type' => 'string', 'example' => 'TestValue'],
],
],
],
@@ -3223,28 +1659,15 @@
'description' => '系统盘信息。',
'type' => 'object',
'properties' => [
- 'Size' => [
- 'description' => '迁移源系统盘的大小，单位：GiB。取值范围为20~32768。'."\n"
- ."\n"
- .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'LVM' => [
- 'description' => '是否使用LVM。可能值：'."\n"
- ."\n"
- .'- true：使用LVM。'."\n"
- ."\n"
- .'- false：不使用LVM。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DiskId' => [
- 'description' => '系统盘ID。',
- 'type' => 'string',
- 'example' => 'd-2zeh4twm100qskw7z41z',
- ],
+ 'Size' => ['description' => '迁移源系统盘的大小，单位：GiB。取值范围为20~32768。'."\n"
+ ."\n"
+ .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'LVM' => ['description' => '是否使用LVM。可能值：'."\n"
+ ."\n"
+ .'- true：使用LVM。'."\n"
+ ."\n"
+ .'- false：不使用LVM。', 'type' => 'boolean', 'example' => 'false'],
+ 'DiskId' => ['description' => '系统盘ID。', 'type' => 'string', 'example' => 'd-2zeh4twm100qskw7z41z'],
'Parts' => [
'type' => 'object',
'itemNode' => true,
@@ -3256,25 +1679,12 @@
'description' => '系统盘分区信息。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '系统盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21474836480'."\n",
- ],
- 'Block' => [
- 'description' => '系统盘分区是否开启块复制。取值：'."\n"
- ."\n"
- .'- true：系统盘分区开启块复制。'."\n"
- .'- false：系统盘分区不开启块复制。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Path' => [
- 'description' => '系统盘分区路径。',
- 'type' => 'string',
- 'example' => '/boot',
- ],
+ 'SizeBytes' => ['description' => '系统盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'."\n"],
+ 'Block' => ['description' => '系统盘分区是否开启块复制。取值：'."\n"
+ ."\n"
+ .'- true：系统盘分区开启块复制。'."\n"
+ .'- false：系统盘分区不开启块复制。', 'type' => 'boolean', 'example' => 'true'],
+ 'Path' => ['description' => '系统盘分区路径。', 'type' => 'string', 'example' => '/boot'],
],
],
],
@@ -3293,27 +1703,14 @@
'description' => '数据盘信息。',
'type' => 'object',
'properties' => [
- 'Size' => [
- 'description' => '目标阿里云服务器ECS的数据盘大小，单位为GiB。取值范围：20~32768。'."\n"
- .'>该参数取值需要大于迁移源数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22548578304',
- ],
- 'LVM' => [
- 'description' => '是否使用LVM。取值：'."\n"
- ."\n"
- .'- true：使用LVM。'."\n"
- ."\n"
- .'- false：不使用LVM。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DiskId' => [
- 'description' => '数据盘ID。',
- 'type' => 'string',
- 'example' => 'd-2zeh4twm100qskw7z41z',
- ],
+ 'Size' => ['description' => '目标阿里云服务器ECS的数据盘大小，单位为GiB。取值范围：20~32768。'."\n"
+ .'>该参数取值需要大于迁移源数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22548578304'],
+ 'LVM' => ['description' => '是否使用LVM。取值：'."\n"
+ ."\n"
+ .'- true：使用LVM。'."\n"
+ ."\n"
+ .'- false：不使用LVM。', 'type' => 'boolean', 'example' => 'false'],
+ 'DiskId' => ['description' => '数据盘ID。', 'type' => 'string', 'example' => 'd-2zeh4twm100qskw7z41z'],
'Parts' => [
'type' => 'object',
'itemNode' => true,
@@ -3325,25 +1722,12 @@
'description' => '数据盘分区信息。',
'type' => 'object',
'properties' => [
- 'SizeBytes' => [
- 'description' => '数据盘分区大小。单位：Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21474836480'."\n",
- ],
- 'Block' => [
- 'description' => '数据盘分区是否开启块复制。取值：'."\n"
- ."\n"
- .'- true：数据盘分区开启块复制。'."\n"
- .'- false：数据盘分区不开启块复制。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Path' => [
- 'description' => '数据盘分区路径。',
- 'type' => 'string',
- 'example' => '/home/data'."\n",
- ],
+ 'SizeBytes' => ['description' => '数据盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'."\n"],
+ 'Block' => ['description' => '数据盘分区是否开启块复制。取值：'."\n"
+ ."\n"
+ .'- true：数据盘分区开启块复制。'."\n"
+ .'- false：数据盘分区不开启块复制。', 'type' => 'boolean', 'example' => 'false'],
+ 'Path' => ['description' => '数据盘分区路径。', 'type' => 'string', 'example' => '/home/data'."\n"],
],
],
],
@@ -3356,49 +1740,25 @@
],
],
],
- 'WorkgroupId' => [
- 'description' => '工作组 ID。',
- 'type' => 'string',
- 'example' => 'w-bp1ja22kdqphehlj****',
- ],
+ 'WorkgroupId' => ['description' => '工作组 ID。', 'type' => 'string', 'example' => 'w-bp1ja22kdqphehlj****'],
],
],
],
],
],
- 'PageSize' => [
- 'description' => '每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6E1187E8-843A-4850-B97E-2F17F00D48F7',
- ],
- 'PageNumber' => [
- 'description' => '迁移任务列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'PageSize' => ['description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6E1187E8-843A-4850-B97E-2F17F00D48F7'],
+ 'PageNumber' => ['description' => '迁移任务列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'Forbidden.Unauthorized',
- 'errorMessage' => 'A required authorization for the specified action is not supplied.',
- ],
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
'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":"<DescribeReplicationJobsResponse>\\n <TotalCount>5</TotalCount>\\n <ReplicationJobs>\\n <Frequency>15</Frequency>\\n <VpcId>vpc-bp1vwnn14rqpyiczj****</VpcId>\\n <CreationTime>2014-07-24T13:00:52Z</CreationTime>\\n <Status>Running</Status>\\n <ScheduledStartTime>2019-06-04T13:35:00Z</ScheduledStartTime>\\n <MaxNumberOfImageToKeep>8</MaxNumberOfImageToKeep>\\n <ContainerNamespace>testNamespace</ContainerNamespace>\\n <DataDisks>\\n <Index>1</Index>\\n <Size>40</Size>\\n <Parts>\\n <SizeBytes>21474836480</SizeBytes>\\n <Block>true</Block>\\n <Device>0_1</Device>\\n </Parts>\\n </DataDisks>\\n <StatusInfo>statusinfo</StatusInfo>\\n <InstanceRamRole>SMCAdmin</InstanceRamRole>\\n <SystemDiskSize>40</SystemDiskSize>\\n <Description>This is my migration task.</Description>\\n <ReplicationParameters>BandWidthLimit:0</ReplicationParameters>\\n <ErrorCode>InternalError</ErrorCode>\\n <ValidTime>2019-06-08T14:40:52Z</ValidTime>\\n <NetMode>0</NetMode>\\n <ContainerTag>CentOS:v1</ContainerTag>\\n <LicenseType>BYOL</LicenseType>\\n <Name>testMigrationTaskName</Name>\\n <ImageId>m-o6w3gy99qf89rkga****</ImageId>\\n <Progress>100</Progress>\\n <RunOnce>true</RunOnce>\\n <LaunchTemplateId>lt-launchtemplateid</LaunchTemplateId>\\n <ContainerRepository>testRepository</ContainerRepository>\\n <InstanceId>i-bp1ff25rzvnul6kr****</InstanceId>\\n <SystemDiskParts>\\n <SizeBytes>254803968</SizeBytes>\\n <Block>true</Block>\\n <Device>0_1</Device>\\n </SystemDiskParts>\\n <InstanceType>ecs.sn1ne.large</InstanceType>\\n <SourceId>s-bp1e2fsl57knvuug****</SourceId>\\n <LaunchTemplateVersion>1</LaunchTemplateVersion>\\n <RegionId>cn-hangzhou</RegionId>\\n <TransitionInstanceId>i-bp1ff25rzvnul6kr****</TransitionInstanceId>\\n <EndTime>2019-06-04T16:00:52Z</EndTime>\\n <StartTime>2019-06-04T14:40:52Z</StartTime>\\n <VSwitchId>vsw-bp1ddbrxdlrcbim46****</VSwitchId>\\n <JobId>j-bp19vlwm0tyigbmj****</JobId>\\n <ImageName>testAliCloudImageName</ImageName>\\n <BusinessStatus>Preparing</BusinessStatus>\\n <ReplicationJobRuns>\\n <EndTime>2019-10-04T13:35:00Z</EndTime>\\n <Type>Schedule</Type>\\n <StartTime>2019-10-01T13:35:00Z</StartTime>\\n <ImageId>m-o6w3gy99qf89rkga****</ImageId>\\n </ReplicationJobRuns>\\n <TargetType>Image</TargetType>\\n <JobType>0</JobType>\\n <ResourceGroupId>rg-acfmw3ty5y7****</ResourceGroupId>\\n <Tags>\\n <Key>TestKey</Key>\\n <Value>TestValue</Value>\\n </Tags>\\n </ReplicationJobs>\\n <PageSize>10</PageSize>\\n <RequestId>6E1187E8-843A-4850-B97E-2F17F00D48F7</RequestId>\\n <PageNumber>1</PageNumber>\\n</DescribeReplicationJobsResponse>","errorExample":""}]',
@@ -3410,266 +1770,112 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CutOverReplicationJob' => [
- 'summary' => '将指定的自动增量迁移任务停止周期执行，并完成迁移任务。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '18561',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'JobId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '自动增量迁移任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'j-bp1fnx5y3djc4cop****',
- ],
- ],
- [
- 'name' => 'SyncData',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否需要进行最后一次全量数据迁移。取值范围：'."\n"
- ."\n"
- .'- true：需要进行最后一次全量数据迁移。'."\n"
- .'- false：不需要进行最后一次全量数据迁移。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '请求ID。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:DescribeReplicationJobs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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":"<CutOverReplicationJobResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</CutOverReplicationJobResponse>","errorExample":""}]',
- 'title' => '停止周期执行自动增量任务',
- 'description' => "\n"
- ."\n\n"
- .'## 接口说明'."\n"
- ."\n\n"
- .'- 自动增量迁移任务的状态必须处于等待中（Waiting）。'."\n"
- ."\n"
- .'- 调用该接口后，自动增量迁移任务将不再周期执行，而是根据`SyncData`参数取值进行判断。当`SyncData=false`时，不再进行数据迁移，直接自动清理中转资源后，完成迁移任务；当`SyncData=true`时，将进行最后一次全量数据迁移，然后自动清理中转资源，完成迁移任务。'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'DeleteReplicationJob' => [
- 'summary' => '调用DeleteReplicationJob删除一个迁移任务。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeSourceServers' => [
+ 'summary' => '调用DescribeSourceServers查询一个或多个迁移源信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '18562',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '18569',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '迁移任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'j-bp17m1vi6x21qhqk****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- ],
- ],
+ 'schema' => ['description' => '迁移任务ID。', 'type' => 'string', 'required' => false, 'example' => 'j-bp19vlwm0tyigbmj****'],
],
- ],
- '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.',
- ],
+ [
+ 'name' => 'State',
+ 'in' => 'query',
+ 'schema' => ['description' => '迁移源状态。取值范围：'."\n"
+ ."\n"
+ .'- Unavailable：不可用，包括离线和出错。'."\n"
+ .'- Available：在线。'."\n"
+ .'- InUse：迁移中。'."\n"
+ .'- Deleting：删除中。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Available'],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteReplicationJobResponse>\\r\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\r\\n</DeleteReplicationJobResponse>","errorExample":""}]',
- 'title' => '删除一个迁移任务',
- 'description' => '## 接口说明'."\n"
- ."\n"
- .'- 迁移任务删除后不可恢复。'."\n"
- .'- 迁移任务删除后自动释放已创建的相关资源，如中转实例等。'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateWorkgroup' => [
- 'summary' => '工作组可以同时管理多个迁移任务的生命周期，适用于需要批量迁移服务器的场景。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '迁移源名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以http:\\//和https:\\//开头。可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。'."\n"
+ ."\n"
+ .'默认值：空', 'type' => 'string', 'required' => false, 'example' => 'testSourceServerName'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '240381',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '返回的迁移源列表的页码。起始值：1。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'ClientToken',
+ 'name' => 'PageSize',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'title' => '幂等参数',
- 'description' => '保证请求幂等性。您可以从客户端生成一个不超过64个ASCII字符的参数值，并将值赋予ClientToken，保证重试请求的幂等性。更多详情，请参见[如何保证幂等性](~~25693~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。最大值：50。'."\n"
+ ."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10', 'default' => '10'],
],
[
- 'name' => 'Name',
+ 'name' => 'SourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '工作组名称。名称需满足以下要求：'."\n"
- ."\n"
- .'- 任务名称必须唯一。'."\n"
- .'- 长度为2~64个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、点号（.）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
+ 'description' => '迁移源ID，可以输入多个。',
+ 'type' => 'array',
+ 'items' => ['description' => '迁移源ID，可以输入多个。', 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****'],
'required' => false,
- 'example' => 'testWorkgroupName',
+ 'example' => 's-bp1e2fsl57knvuug****',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'Description',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '工作组描述。长度为 2～256 个英文或中文字符，不能以`http://`和`https://`开头。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw3ty5y7****'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '标签数组。数组长度：1~20。如果数组中有多个标签对象，标签键Key不允许重复。',
+ 'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签对象。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '工作组的标签键。最多支持128个字符，一旦传入该值，则不允许为空字符串，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '工作组的标签值。最多支持128个字符，一旦传入该值，可以为空字符串，不能包含`http://`或`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '为SMC资源指定的标签键。N的取值范围：1~20'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以aliyun和acs:开头，不能包含http:\\//或者https:\\//。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http:\\//或者https:\\//。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -3677,253 +1883,308 @@
'maxItems' => 21,
],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C8B26B44-0189-443E-9816-D951F59623A9',
- ],
- 'WorkgroupId' => [
- 'title' => 'Id of the request',
- 'description' => '工作组ID。',
- 'type' => 'string',
- 'example' => 'w-bp10geepnj916e3d****',
- ],
- ],
- ],
- ],
- ],
- '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' => '创建工作组',
- 'description' => '- 每个阿里云账号最多可创建50个工作组。'."\n"
- .'- 一个工作组最多可以关联50个迁移源。'."\n"
- .'- 一个迁移源只能关联一个工作组。',
- ],
- 'AssociateSourceServers' => [
- 'summary' => '如果您需要通过工作组批量迁移服务器，需要先将迁移源关联到工作组。',
- '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' => '工作组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'w-bp10geepnj916e3d****',
- ],
- ],
[
- 'name' => 'SourceId',
+ 'name' => 'RelatedJobType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '迁移源ID。一个工作组最多可以关联50个迁移源。',
+ 'description' => '关联任务类型。',
'type' => 'array',
- 'items' => [
- 'description' => '迁移源ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
- 'required' => true,
+ 'items' => ['description' => '关联任务类型。取值如下：'."\n"
+ ."\n"
+ .'- Not_Related：未关联任务。'."\n"
+ .'- Server：服务器迁移任务。'."\n"
+ .'- Os：操作系统迁移任务。'."\n"
+ .'- Cross_Zone：跨可用区迁移任务。'."\n"
+ .'- VMWare：VMWare迁移任务。'."\n"
+ .'- Desktop：桌面任务。', 'type' => 'string', 'required' => false, 'example' => 'Server'],
+ 'required' => false,
'maxItems' => 100,
],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数信息。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- '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' => '迁移源关联工作组',
- 'description' => '一个迁移源只能关联一个工作组。',
- ],
- 'DisassociateSourceServers' => [
- 'summary' => '如果某个迁移源后期无需通过工作组批量迁移或者需要删除工作组，则可以取消关联工作组。',
- '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' => '工作组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'w-bp10geepnj916e3d****',
- ],
- ],
- [
- 'name' => 'SourceId',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '待取消关联工作组的迁移源ID。最多可以输入50个。',
- 'type' => 'array',
- 'items' => [
- 'description' => '迁移源ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp17m1vi6x20c6g6****',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '工作组ID。', 'type' => 'string', 'required' => false, 'example' => 'w-bp1ja22kdqphehlj****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数信息。',
+ 'description' => '信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****',
+ 'SourceServers' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SourceServer' => [
+ 'description' => '迁移源数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '迁移源数组。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreationTime' => ['description' => '迁移源的注册时间。', 'type' => 'string', 'example' => '2019-06-27T02:58:09Z'],
+ 'HeartbeatRate' => ['description' => 'SMC客户端（SMC Agent）心跳频率。单位：秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'State' => ['description' => '迁移源状态。', 'type' => 'string', 'example' => 'InUse'],
+ 'DataDisks' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DataDisk' => [
+ 'description' => '迁移源的数据盘数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '迁移源的数据盘数组。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => ['description' => '数据盘顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['description' => '数据盘N大小。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Parts' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Part' => [
+ 'description' => '数据盘分区信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据盘分区信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanBlock' => ['description' => '数据盘分区是否支持块复制。', 'type' => 'boolean', 'example' => 'false'],
+ 'SizeBytes' => ['description' => '数据盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'],
+ 'Need' => ['description' => '数据盘分区是否必须选择。', 'type' => 'boolean', 'example' => 'false'],
+ 'Device' => ['description' => '数据盘分区设备标识。', 'type' => 'string', 'example' => '1_0'],
+ 'Path' => ['description' => '数据盘分区路径。', 'type' => 'string', 'example' => '/home/data'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Path' => ['description' => '数据盘N路径。', 'type' => 'string', 'example' => '/home/data'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SystemDiskParts' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SystemDiskPart' => [
+ 'description' => '系统盘分区信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '系统盘分区信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanBlock' => ['description' => '系统盘分区是否支持块复制。', 'type' => 'boolean', 'example' => 'true'],
+ 'SizeBytes' => ['description' => '系统盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '254803968'],
+ 'Need' => ['description' => '系统盘分区是否必须选择。', 'type' => 'boolean', 'example' => 'true'],
+ 'Device' => ['description' => '系统盘分区设备标识符。', 'type' => 'string', 'example' => '0_0'],
+ 'Path' => ['description' => '系统盘分区路径。', 'type' => 'string', 'example' => '/boot'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'KernelLevel' => ['description' => '内核版本级别。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SourceId' => ['description' => '迁移源ID。', 'type' => 'string', 'example' => 's-bp1e2fsl57knvuug****'],
+ 'AgentVersion' => ['description' => 'SMC客户端版本号。', 'type' => 'string', 'example' => '1.5.2.3'],
+ 'StatusInfo' => ['description' => '迁移源状态详细信息。该参数在迁移源状态为异常时返回。JSON格式键值对，如：'."\n"
+ .'```'."\n"
+ .'- error_code：错误码。'."\n"
+ .'- error_msg：错误信息。'."\n"
+ .'```', 'type' => 'string', 'example' => '{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}'],
+ 'SystemDiskSize' => ['description' => '迁移源的系统盘大小。单位：GiB', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
+ 'Description' => ['description' => '迁移源描述。', 'type' => 'string', 'example' => 'Server Source Imported By GotoAliyun.'],
+ 'ErrorCode' => ['description' => '迁移源状态错误码。', 'type' => 'string', 'example' => 'SourceServer.Offline'],
+ 'JobId' => ['description' => '最近一次的迁移任务ID。', 'type' => 'string', 'example' => 'j-bp19vlwm0tyigbmj****'],
+ 'Platform' => ['description' => '迁移源的系统平台。', 'type' => 'string', 'example' => 'OpenSUSE'],
+ 'ReplicationDriver' => ['description' => '复制驱动器。默认值：SMT（迁云工具）', 'type' => 'string', 'example' => 'SMT'],
+ 'Name' => ['description' => '迁移源的名称。', 'type' => 'string', 'example' => 'SourceServerName'],
+ 'SystemInfo' => ['description' => '迁移源系统信息。JSON格式键值对，可扩展，键值固定。大小不超过1 KB。如：'."\n"
+ ."\n"
+ .'```'."\n"
+ .'agent_mode：运行模式。'."\n"
+ .'agent_type：运行类型。'."\n"
+ .'client_type：客户端类型。'."\n"
+ .'hostname ：主机名。'."\n"
+ .'ipv4：IPv4地址。'."\n"
+ .'ipv6： IPv6地址。'."\n"
+ .'cores：CPU核数。'."\n"
+ .'cpu_usage： CPU使用率。'."\n"
+ .'memory：内存。'."\n"
+ .'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' => '迁移源的系统架构。', 'type' => 'string', 'example' => 'x86_64'],
+ 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfmw3ty5y7****'],
+ 'Tags' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Tag' => [
+ 'description' => '标签信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '为SMC资源指定的标签键。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以aliyun和acs:开头，不能包含http:\\//或者https:\\//。', 'type' => 'string', 'example' => 'TestKey'],
+ 'Value' => ['description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http:\\//或者https:\\//。', 'type' => 'string', 'example' => 'TestValue'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Disks' => [
+ 'description' => '磁盘信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'System' => [
+ 'description' => '系统盘信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Size' => ['description' => '迁移源系统盘的大小，单位：GiB。取值范围为20~32768。'."\n"
+ ."\n"
+ .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Offset' => ['description' => '系统盘首个分区的起始偏移。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'],
+ 'Parts' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Part' => [
+ 'description' => '系统盘分区信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '分区信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanBlock' => ['description' => '系统盘分区是否支持块复制。可能值：'."\n"
+ ."\n"
+ .'- true：系统盘分区支持块复制。'."\n"
+ .'- false：系统盘分区不支持块复制。', 'type' => 'boolean', 'example' => 'false'],
+ 'SizeBytes' => ['description' => '系统盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'],
+ 'Path' => ['description' => '系统盘分区路径。', 'type' => 'string', 'example' => '/home/data'],
+ 'Type' => ['description' => '系统盘分区类型。可能值：'."\n"
+ .'- Normal：普通分区。'."\n"
+ .'- System：系统分区。'."\n"
+ .'- Boot：启动分区。', 'type' => 'string', 'example' => 'Normal'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Data' => [
+ 'description' => '数据盘信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据盘信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Size' => ['description' => '迁移源的数据磁盘大小。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
+ 'Offset' => ['description' => '数据盘首个分区的起始偏移。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'],
+ 'Parts' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Part' => [
+ 'description' => '数据盘分区信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据盘分区信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanBlock' => ['description' => '数据盘分区是否开启块复制。可能值：'."\n"
+ ."\n"
+ .'- true：数据盘分区开启块复制。'."\n"
+ .'- false：数据盘分区不开启块复制。', 'type' => 'boolean', 'example' => 'false'],
+ 'SizeBytes' => ['description' => '数据盘分区大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '21474836480'],
+ 'Path' => ['description' => '数据盘分区路径。', 'type' => 'string', 'example' => '/home/data'],
+ 'Type' => ['description' => '数据盘分区类型。可能值：'."\n"
+ .'- Normal：普通分区。'."\n"
+ .'- System：系统分区。'."\n"
+ .'- Boot：启动分区。', 'type' => 'string', 'example' => 'Normal'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'WorkgroupId' => ['description' => '工作组ID。', 'type' => 'string', 'example' => 'w-bp1ja22kdqphehlj****'],
+ ],
+ ],
+ ],
+ ],
],
+ 'TotalCount' => ['description' => '迁移源总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '410E6073-66D0-45D3-AB3E-4DC3F5E4****'],
+ 'PageNumber' => ['description' => '迁移源列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'Forbidden.Unauthorized',
- 'errorMessage' => 'A required authorization for the specified action is not supplied.',
- ],
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","type":"json"}]',
- 'title' => '迁移源取消关联工作组',
+ 'title' => '查询一个或多个迁移源信息',
+ 'description' => '## 接口说明'."\n"
+ ."\n"
+ .'请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:DescribeSourceServers',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}'],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeSourceServersResponse>\\n <SourceServers>\\n <CreationTime>2019-06-27T02:58:09Z</CreationTime>\\n <HeartbeatRate>30</HeartbeatRate>\\n <State>InUse</State>\\n <DataDisks>\\n <Index>1</Index>\\n <Size>20</Size>\\n <Parts>\\n <CanBlock>false</CanBlock>\\n <SizeBytes>21474836480</SizeBytes>\\n <Need>false</Need>\\n <Device>1_0</Device>\\n <Path>/home/data</Path>\\n </Parts>\\n <Path>/home/data</Path>\\n </DataDisks>\\n <SystemDiskParts>\\n <CanBlock>true</CanBlock>\\n <SizeBytes>254803968</SizeBytes>\\n <Need>true</Need>\\n <Device>0_0</Device>\\n <Path>/boot</Path>\\n </SystemDiskParts>\\n <KernelLevel>1</KernelLevel>\\n <SourceId>s-bp1e2fsl57knvuug****</SourceId>\\n <AgentVersion>1.5.2.3</AgentVersion>\\n <StatusInfo>{\\"error_code\\": \\"S1\\", \\"error_msg\\": \\"Rsync not found. Please install rsync.\\"}</StatusInfo>\\n <SystemDiskSize>40</SystemDiskSize>\\n <Description>Server Source Imported By GotoAliyun.</Description>\\n <ErrorCode>SourceServer.Offline</ErrorCode>\\n <JobId>j-bp19vlwm0tyigbmj****</JobId>\\n <Platform>OpenSUSE</Platform>\\n <ReplicationDriver>SMT</ReplicationDriver>\\n <Name>SourceServerName</Name>\\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\\\\\\"}</SystemInfo>\\n <Architecture>x86_64</Architecture>\\n <ResourceGroupId>rg-acfmw3ty5y7****</ResourceGroupId>\\n <Tags>\\n <Key>TestKey</Key>\\n <Value>TestValue</Value>\\n </Tags>\\n </SourceServers>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>410E6073-66D0-45D3-AB3E-4DC3F5E4****</RequestId>\\n <PageNumber>1</PageNumber>\\n</DescribeSourceServersResponse>","errorExample":""}]',
],
'DescribeWorkgroups' => [
'summary' => '创建工作组后，您可以查看工作组的相关信息，包括工作组名称、工作组描述、告警信息等。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3934,9 +2195,7 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '240404',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
@@ -3946,12 +2205,7 @@
'schema' => [
'description' => '工作组ID列表，最多可以输入50个工作组ID。',
'type' => 'array',
- 'items' => [
- 'description' => '工作组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'w-bp10geepnj916e3d****',
- ],
+ 'items' => ['description' => '工作组ID。', 'type' => 'string', 'required' => false, 'example' => 'w-bp10geepnj916e3d****'],
'required' => false,
'maxItems' => 100,
],
@@ -3959,54 +2213,29 @@
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '工作组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '工作组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '工作组的状态。取值范围：'."\n"
- ."\n"
- .'- NotStarted：未开始。'."\n"
- .'- InProgress：进行中。'."\n"
- .'- Cutover：割接中。'."\n"
- .'- Completed：已完成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'InProgress',
- ],
+ 'schema' => ['description' => '工作组的状态。取值范围：'."\n"
+ ."\n"
+ .'- NotStarted：未开始。'."\n"
+ .'- InProgress：进行中。'."\n"
+ .'- Cutover：割接中。'."\n"
+ .'- Completed：已完成。', 'type' => 'string', 'required' => false, 'example' => 'InProgress'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '工作组列表的页码。起始值：1。'."\n"
- .'默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '工作组列表的页码。起始值：1。'."\n"
+ .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。最大值：50。'."\n"
- .'默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '50',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。最大值：50。'."\n"
+ .'默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Tag',
@@ -4019,18 +2248,8 @@
'description' => '标签对象。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '工作组的标签键。最多支持 128 个字符，一旦传入该值，则不允许为空字符串，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '工作组的标签值。最多支持 128 个字符，一旦传入该值，可以为空字符串，不能包含`http://`或`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '工作组的标签键。最多支持 128 个字符，一旦传入该值，则不允许为空字符串，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '工作组的标签值。最多支持 128 个字符，一旦传入该值，可以为空字符串，不能包含`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -4046,29 +2265,10 @@
'description' => '返回参数信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****',
- ],
- 'TotalCount' => [
- 'description' => '工作组总个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。最大值：50。默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '工作组列表的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****'],
+ 'TotalCount' => ['description' => '工作组总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。最大值：50。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '工作组列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Workgroups' => [
'type' => 'object',
'itemNode' => true,
@@ -4080,31 +2280,15 @@
'description' => '工作组对象。',
'type' => 'object',
'properties' => [
- 'WorkgroupId' => [
- 'description' => '工作组ID。',
- 'type' => 'string',
- 'example' => 'w-bp10geepnj916e3d****',
- ],
- 'Name' => [
- 'description' => '工作组名称。',
- 'type' => 'string',
- 'example' => 'testWorkgroupName',
- ],
- 'Description' => [
- 'description' => '工作组的描述信息。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Status' => [
- 'description' => '工作组的状态。可能值：'."\n"
- ."\n"
- .'- NotStarted：未开始。'."\n"
- .'- InProgress：进行中。'."\n"
- .'- Cutover：割接中。'."\n"
- .'- Completed：已完成。',
- 'type' => 'string',
- 'example' => 'InProgress',
- ],
+ 'WorkgroupId' => ['description' => '工作组ID。', 'type' => 'string', 'example' => 'w-bp10geepnj916e3d****'],
+ 'Name' => ['description' => '工作组名称。', 'type' => 'string', 'example' => 'testWorkgroupName'],
+ 'Description' => ['description' => '工作组的描述信息。', 'type' => 'string', 'example' => 'test'],
+ 'Status' => ['description' => '工作组的状态。可能值：'."\n"
+ ."\n"
+ .'- NotStarted：未开始。'."\n"
+ .'- InProgress：进行中。'."\n"
+ .'- Cutover：割接中。'."\n"
+ .'- Completed：已完成。', 'type' => 'string', 'example' => 'InProgress'],
'Warnings' => [
'type' => 'object',
'itemNode' => true,
@@ -4116,15 +2300,11 @@
'description' => '告警信息。',
'type' => 'object',
'properties' => [
- 'WarningType' => [
- 'description' => '告警类型，可能值：'."\n"
- ."\n"
- .'- InError：存在失败的迁移任务。'."\n"
- .'- UnRelated：存在迁移源未关联迁移任务。'."\n"
- .'- NotPassed：存在任务迁移演练未通过。',
- 'type' => 'string',
- 'example' => 'InError',
- ],
+ 'WarningType' => ['description' => '告警类型，可能值：'."\n"
+ ."\n"
+ .'- InError：存在失败的迁移任务。'."\n"
+ .'- UnRelated：存在迁移源未关联迁移任务。'."\n"
+ .'- NotPassed：存在任务迁移演练未通过。', 'type' => 'string', 'example' => 'InError'],
'SourceIds' => [
'type' => 'object',
'itemNode' => true,
@@ -4132,11 +2312,7 @@
'SourceId' => [
'description' => '存在问题的迁移源列表。',
'type' => 'array',
- 'items' => [
- 'description' => '存在问题的迁移源ID。',
- 'type' => 'string',
- 'example' => 's-bp1h7ymebl7swbt4****',
- ],
+ 'items' => ['description' => '存在问题的迁移源ID。', 'type' => 'string', 'example' => 's-bp1h7ymebl7swbt4****'],
],
],
],
@@ -4156,17 +2332,9 @@
'description' => '工作组的标签信息。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '工作组的标签键。',
- 'type' => 'string',
- 'example' => ' '."\n"
- .'TestKey',
- ],
- 'Value' => [
- 'description' => '工作组的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => '工作组的标签键。', 'type' => 'string', 'example' => ' '."\n"
+ .'TestKey'],
+ 'Value' => ['description' => '工作组的标签值。', 'type' => 'string', 'example' => 'TestValue'],
],
],
],
@@ -4183,156 +2351,125 @@
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'Forbidden.Unauthorized',
- 'errorMessage' => 'A required authorization for the specified action is not supplied.',
- ],
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查看工作组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'smc:DescribeWorkgroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'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' => '查看工作组',
],
- 'ModifyWorkgroupAttribute' => [
- 'summary' => '创建工作组后，您可以修改工作组的名称和描述信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DisableAccessToken' => [
+ 'summary' => '调用DisableAccessToken禁用激活码。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'abilityTreeCode' => '240380',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'abilityTreeCode' => '144984',
+ 'abilityTreeNodes' => ['FEATUREsmcWZM4IC'],
],
'parameters' => [
[
- 'name' => 'WorkgroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'w-bp10geepnj916e3d****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作组名称。名称需满足以下要求：'."\n"
- ."\n"
- .'- 任务名称必须唯一。'."\n"
- .'- 长度为 2~64 个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、点号（.）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testMigrationTaskName',
- ],
- ],
- [
- 'name' => 'Description',
+ 'name' => 'AccessTokenId',
'in' => 'query',
- 'schema' => [
- 'description' => '输入新的工作组描述信息。长度为 2～256 个英文或中文字符，不能以`http://`和`https://`开头。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '激活码ID。', 'type' => 'string', 'required' => true, 'example' => 'at-bp12g5gwup0yzmce****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数信息。',
+ 'description' => '请求ID。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****'],
],
],
],
],
'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.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => '禁用激活码',
+ 'description' => '如果您担心已创建的激活码存在泄露的风险，可以通过该接口禁用激活码。禁用后无法再通过该激活码注册新的迁移源，但不会影响已经注册的迁移源。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:DisableAccessToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","type":"json"}]',
- 'title' => '修改工作组',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"686BB8A6-BBA5-47E5-8A75-D2ADE433****\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAccessTokenResponse>\\n <RequestId>686BB8A6-BBA5-47E5-8A75-D2ADE433****</RequestId>\\n</DisableAccessTokenResponse>","errorExample":""}]',
],
- 'DeleteWorkgroup' => [
- 'summary' => '如果您后期不再需要工作组，可以删除工作组。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DisassociateSourceServers' => [
+ 'summary' => '如果某个迁移源后期无需通过工作组批量迁移或者需要删除工作组，则可以取消关联工作组。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '240401',
- 'abilityTreeNodes' => [
- 'FEATUREsmcTXNBS6',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '240400',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
'name' => 'WorkgroupId',
'in' => 'query',
'allowEmptyValue' => false,
+ 'schema' => ['title' => '幂等参数', 'description' => '工作组ID。', 'type' => 'string', 'required' => true, 'example' => 'w-bp10geepnj916e3d****'],
+ ],
+ [
+ 'name' => 'SourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '工作组ID。',
- 'type' => 'string',
+ 'description' => '待取消关联工作组的迁移源ID。最多可以输入50个。',
+ 'type' => 'array',
+ 'items' => ['description' => '迁移源ID。', 'type' => 'string', 'required' => false, 'example' => 's-bp17m1vi6x20c6g6****'],
'required' => true,
- 'example' => 'w-bp10geepnj916e3d****',
+ 'maxItems' => 100,
],
],
],
@@ -4343,196 +2480,169 @@
'description' => '返回参数信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '410E6073-66D0-45D3-AB3E-4DC3F5E4****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'Forbidden.Unauthorized',
- 'errorMessage' => 'A required authorization for the specified action is not supplied.',
- ],
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"410E6073-66D0-45D3-AB3E-4DC3F5E4****\\"\\n}","type":"json"}]',
- 'title' => '删除工作组',
- 'description' => '删除工作组前，必须先删除或取消关联工作组中的迁移源，否则无法删除工作组。具体操作，请参见[删除一个迁移源](~~2402124~~)。',
- ],
- 'TagResources' => [
- 'summary' => '调用TagResources为指定的SMC资源（迁移源和迁移任务）列表统一创建并绑定标签。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '迁移源取消关联工作组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:DisassociateSourceServers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","type":"json"}]',
+ ],
+ 'ListAccessTokens' => [
+ 'summary' => '调用ListAccessTokens查询已创建的激活码以及激活码的使用情况。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '18578',
- 'abilityTreeNodes' => [
- 'FEATUREsmc6EK4ZG',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '144510',
+ 'abilityTreeNodes' => ['FEATUREsmcWZM4IC'],
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'AccessTokenId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'SMC资源类型。取值范围：'."\n"
- ."\n"
- .'- sourceserver：迁移源'."\n"
- ."\n"
- .'- replicationjob：迁移任务',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sourceserver',
+ 'description' => '激活码信息集合。',
+ 'type' => 'array',
+ 'items' => ['description' => '激活码信息集合。', 'type' => 'string', 'required' => false, 'example' => 'at-bp1akz2zp67r0k6r****'],
+ 'required' => false,
+ 'maxItems' => 100,
],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'Name',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务。N的取值范围：1~50',
- 'type' => 'array',
- 'items' => [
- 'description' => 'smc资源id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bw526m1vi6x20c6g****',
- ],
- 'required' => true,
- 'example' => 's-bw526m1vi6x20c6g****',
- 'maxItems' => 51,
- ],
+ 'schema' => ['description' => '激活码名称。', 'type' => 'string', 'required' => false, 'example' => 'test_name'],
],
[
- 'name' => 'Tag',
+ 'name' => 'Status',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '标签信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签信息列表。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '为SMC资源指定的标签键。N的取值范围：1~20'."\n"
- ."\n"
- .'一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以aliyun和acs:开头，不能包含http:\\//或者https:\\//。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
- ."\n"
- .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => '激活码状态。取值范围：'."\n"
+ ."\n"
+ .'- activated：已激活。'."\n"
+ ."\n"
+ .'- unactivated：未激活。'."\n"
+ .'- expired：已过期。', 'type' => 'string', 'required' => false, 'example' => 'activated'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '响应参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E2DA3097-79B9-53AE-B0DF-281DC54F****'],
+ 'AccessTokens' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AccessToken' => [
+ 'description' => '迁移源数组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '迁移源数组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessTokenId' => ['description' => '激活码ID。', 'type' => 'string', 'example' => 'at-bp1akz2zp67r0k6r****'],
+ 'TimeToLiveInDays' => ['description' => '激活码的有效期。有效期为1~90天，默认为30天。', 'type' => 'string', 'example' => '30'],
+ 'Count' => ['description' => '激活码使用次数上限。取值范围为1~1000。'."\n"
+ ."\n"
+ .'默认值为100。', 'type' => 'string', 'example' => '100'],
+ 'RegisteredCount' => ['description' => '已注册的迁移源数。', 'type' => 'string', 'example' => '5'],
+ 'CreationTime' => ['description' => '激活码创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2022-09-09T02:35:44Z'],
+ 'Status' => ['description' => '激活码状态。可能值：'."\n"
+ ."\n"
+ .'- activated：已激活。'."\n"
+ ."\n"
+ .'- unactivated：未激活。'."\n"
+ .'- expired：已过期。', 'type' => 'string', 'example' => 'activated'],
+ 'Name' => ['description' => '激活码名称。', 'type' => 'string', 'example' => 'test_name'],
+ 'Description' => ['description' => '激活码描述信息。', 'type' => 'string', 'example' => '这是激活码'],
+ ],
+ ],
+ ],
+ ],
],
+ 'TotalCount' => ['description' => '迁移源总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageSize' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageNumber' => ['description' => '每页行数。可能值：'."\n"
+ ."\n"
+ .'- 10'."\n"
+ .'- 20'."\n"
+ .'- 50'."\n"
+ ."\n"
+ .'默认值：20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
],
'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.',
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '查询激活码',
+ 'description' => '查询已创建的激活码以及激活码的使用情况。'."\n"
+ .'激活码的状态包括已激活、未激活和已过期三种。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:ListAccessTokens',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>3E8B9ABB-289A-44E6-942D-8AA9E493****</RequestId>\\n</TagResourcesResponse>","errorExample":""}]',
- 'title' => '绑定标签',
- 'description' => '## 接口说明'."\n"
- ."\n"
- .'每个SMC资源可绑定的标签限额为20。'."\n"
- ."\n"
- .'绑定标签前，阿里云会校验资源已有标签数量，超过限额后返回报错信息。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ '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":"<ListAccessTokensResponse>\\n <RequestId>E2DA3097-79B9-53AE-B0DF-281DC54F****</RequestId>\\n <AccessTokens>\\n <AccessTokenId>at-bp1akz2zp67r0k6r****</AccessTokenId>\\n <TimeToLiveInDays>30</TimeToLiveInDays>\\n <Count>100</Count>\\n <RegisteredCount>5</RegisteredCount>\\n <CreationTime>2022-09-09T02:35:44Z</CreationTime>\\n <Status>activated</Status>\\n <Name>test_name</Name>\\n <Description>这是激活码</Description>\\n </AccessTokens>\\n <TotalCount>2</TotalCount>\\n <PageSize>1</PageSize>\\n <PageNumber>20</PageNumber>\\n</ListAccessTokensResponse>","errorExample":""}]',
],
'ListTagResources' => [
- 'summary' => '调用ListTagResources查询一个或多个SMC资源（迁移源和迁移任务）已经绑定的标签列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4543,33 +2653,21 @@
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '18571',
- 'abilityTreeNodes' => [
- 'FEATUREsmc6EK4ZG',
- ],
+ 'abilityTreeNodes' => ['FEATUREsmc6EK4ZG'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'description' => 'SMC资源类型。取值范围：'."\n"
- ."\n"
- .'- sourceserver：表示迁移源'."\n"
- .'- replicationjob：表示迁移任务',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sourceserver',
- ],
+ 'schema' => ['description' => 'SMC资源类型。取值范围：'."\n"
+ ."\n"
+ .'- sourceserver：表示迁移源'."\n"
+ .'- replicationjob：表示迁移任务', 'type' => 'string', 'required' => true, 'example' => 'sourceserver'],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '下一个查询开始Token。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
- ],
+ 'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'ResourceId',
@@ -4578,12 +2676,7 @@
'schema' => [
'description' => 'SMC资源ID列表。SMC资源包括迁移源和迁移任务。列表最大长度 50',
'type' => 'array',
- 'items' => [
- 'description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
+ 'items' => ['description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务', 'type' => 'string', 'required' => false, 'example' => 's-bp1e2fsl57knvuug****'],
'required' => false,
'example' => 's-bp1e2fsl57knvuug****',
'maxItems' => 51,
@@ -4599,25 +2692,15 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'SMC资源的标签键。标签键长度的取值范围：1~64。N的取值范围：1~20。'."\n"
- ."\n"
- .'Tag.N用于精确查找绑定了指定标签的SMC资源，由一个键值对组成。'."\n"
- .'- 标签键和标签值严格区分大小写。'."\n"
- .'- 仅指定Tag.N.Key时，则返回关联该标签键的所有资源。'."\n"
- .'- 仅指定Tag.N.Value时，则报错InvalidParameter.TagValue。'."\n"
- .'- 同时指定多个标签键值对时，仅同时满足所有标签键值对的SMC资源会被查找到。'."\n"
- ."\n\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestKey',
- ],
- 'Value' => [
- 'description' => 'SMC资源的标签值。标签值长度的取值范围：1~64。N的取值范围：1~20。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestValue',
- ],
+ 'Key' => ['description' => 'SMC资源的标签键。标签键长度的取值范围：1~64。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'Tag.N用于精确查找绑定了指定标签的SMC资源，由一个键值对组成。'."\n"
+ .'- 标签键和标签值严格区分大小写。'."\n"
+ .'- 仅指定Tag.N.Key时，则返回关联该标签键的所有资源。'."\n"
+ .'- 仅指定Tag.N.Value时，则报错InvalidParameter.TagValue。'."\n"
+ .'- 同时指定多个标签键值对时，仅同时满足所有标签键值对的SMC资源会被查找到。'."\n"
+ ."\n\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => 'SMC资源的标签值。标签值长度的取值范围：1~64。N的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
@@ -4631,18 +2714,10 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '下一个查询开始Token。'."\n"
- ."\n"
- .'NextToken为空，说明当页已显示完所有信息。',
- 'type' => 'string',
- 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '17743161-66F3-4E7F-B8AE-845FB28B928F',
- ],
+ 'NextToken' => ['description' => '下一个查询开始Token。'."\n"
+ ."\n"
+ .'NextToken为空，说明当页已显示完所有信息。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '17743161-66F3-4E7F-B8AE-845FB28B928F'],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
@@ -4653,26 +2728,10 @@
'items' => [
'type' => 'object',
'properties' => [
- 'ResourceType' => [
- 'description' => '资源类型。',
- 'type' => 'string',
- 'example' => 'ALIYUN::SMC::SOURCESERVER',
- ],
- 'TagValue' => [
- 'description' => '资源的标签值。',
- 'type' => 'string',
- 'example' => 'TestValue',
- ],
- 'ResourceId' => [
- 'description' => '资源ID。',
- 'type' => 'string',
- 'example' => 's-bp1e2fsl57knvuug****',
- ],
- 'TagKey' => [
- 'description' => '资源的标签键。',
- 'type' => 'string',
- 'example' => 'TestKey',
- ],
+ 'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'ALIYUN::SMC::SOURCESERVER'],
+ 'TagValue' => ['description' => '资源的标签值。', 'type' => 'string', 'example' => 'TestValue'],
+ 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 's-bp1e2fsl57knvuug****'],
+ 'TagKey' => ['description' => '资源的标签键。', 'type' => 'string', 'example' => 'TestKey'],
],
],
],
@@ -4684,48 +2743,42 @@
],
'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.',
- ],
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of the Tag parameters cannot exceed 20.', 'description' => '标签列表参数不能超过20个。'],
+ ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => '资源类型参数不存在。'],
+ ['errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The specified ResourceType does not exist.', 'description' => '指定的资源类型不存在。'],
+ ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceId parameters cannot exceed 50.', 'description' => '资源ID参数不能超过50个。'],
+ ['errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The ResourceId contains duplicate values.', 'description' => '资源ID中存在重复的值。'],
+ ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds do not exist.', 'description' => '资源不存在'],
],
],
- '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":"<ListTagResourcesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>17743161-66F3-4E7F-B8AE-845FB28B928F</RequestId>\\n <TagResources>\\n <ResourceType>ALIYUN::SMC::SOURCESERVER</ResourceType>\\n <TagValue>TestValue</TagValue>\\n <ResourceId>s-bp1e2fsl57knvuug****</ResourceId>\\n <TagKey>TestKey</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]',
'title' => '查询标签列表',
+ 'summary' => '调用ListTagResources查询一个或多个SMC资源（迁移源和迁移任务）已经绑定的标签列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UntagResources' => [
- 'summary' => '为指定的SMC资源（迁移源和迁移任务）统一解绑并删除标签。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#AccountId}:replicationjob/{#ReplicationJobId}'],
+ ],
+ ],
+ ],
],
+ '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":"<ListTagResourcesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>17743161-66F3-4E7F-B8AE-845FB28B928F</RequestId>\\n <TagResources>\\n <ResourceType>ALIYUN::SMC::SOURCESERVER</ResourceType>\\n <TagValue>TestValue</TagValue>\\n <ResourceId>s-bp1e2fsl57knvuug****</ResourceId>\\n <TagKey>TestKey</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]',
+ ],
+ 'ModifyReplicationJobAttribute' => [
+ 'summary' => '调用ModifyReplicationJobAttribute修改迁移任务信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4734,271 +2787,480 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '18579',
- 'abilityTreeNodes' => [
- 'FEATUREsmc6EK4ZG',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '18572',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'SMC资源类型。取值范围：'."\n"
- ."\n"
- .'- sourceserver：迁移源。'."\n"
- ."\n"
- .'- replicationjob：迁移任务。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sourceserver',
- ],
+ 'schema' => ['description' => '迁移任务ID。', 'type' => 'string', 'required' => true, 'example' => 'j-bp19vlwm0tyigbmj****'],
],
[
- 'name' => 'All',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '是否删除SMC资源绑定的全部标签。仅当请求中未设置`TagKey.N`时该参数有效。取值范围：'."\n"
- ."\n"
- .'- true：删除指定SMC资源绑定的全部标签。若指定的SMC资源未绑定任何标签，则不做处理。'."\n"
- .'- false：不删除指定SMC资源绑定的任何标签。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '迁移任务名称。迁移任务的名称需满足以下要求：'."\n"
+ ."\n"
+ .'- 任务名称必须唯一。'."\n"
+ .'- 长度为2~128个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName'],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '迁移任务描述。'."\n"
+ ."\n"
+ .'长度应为2~128个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'This_is_my_migration_task'],
+ ],
+ [
+ 'name' => 'TargetType',
+ 'in' => 'query',
+ 'schema' => ['description' => '迁移交付的目标类型。仅支持在迁移任务启动前修改。取值范围：'."\n"
+ .'- Image：迁移成功后，SMC为您的源服务器生成阿里云镜像，您可使用该镜像创建ECS实例达到迁移至阿里云的目的。'."\n"
+ .'- ContainerImage：迁移成功后，SMC为您的源服务器生成容器镜像，您可以在容器镜像服务中使用该镜像。'."\n"
+ ."\n"
+ .'- TargetInstance：迁移成功后，SMC将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定`InstanceId`参数。'."\n"
+ ."\n"
+ .'> - 该参数的取值不区分大小写。'."\n"
+ .'- Windows操作系统和Arm架构操作系统不支持迁移至容器镜像。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Image'],
+ ],
+ [
+ 'name' => 'ScheduledStartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '设置迁移任务的执行时间。SMC在指定时间自动为您启动迁移任务。'."\n"
+ ."\n"
+ .'执行时间遵循ISO8601标准，并需要使用UTC时间，格式为YYYY-MM-DDThh:mm:ssZ。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
+ ."\n"
+ .'>当执行时间为空时，SMC不自动启动迁移任务，您需要调用[StartReplicationJob](~~121823~~)启动。', 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z'],
+ ],
+ [
+ 'name' => 'ImageName',
+ 'in' => 'query',
+ 'schema' => ['description' => '迁移任务交付的目标镜像名称。目标镜像的名称需满足以下要求：'."\n"
+ ."\n"
+ .'- 同一阿里云地域下，镜像名称必须唯一。'."\n"
+ .'- 长度为2~128个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n"
+ ."\n"
+ .'>如果迁移任务运行过程中，当前地域已经存在相同名称的镜像，则系统默认在镜像名称后面添加迁移任务ID（JobId）作为后缀，如：ImageName-JobId。', 'type' => 'string', 'required' => false, 'example' => 'testAliCloudImageName'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-bp1f1dvfto1sigz5****'],
+ ],
+ [
+ 'name' => 'SystemDiskSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标阿里云服务器ECS的系统盘大小，单位：GiB。取值范围为20~500。'."\n"
+ ."\n"
+ .'> 参数取值需要大于源服务器系统盘实际占用大小，例如，源系统盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ [
+ 'name' => 'Frequency',
+ 'in' => 'query',
+ 'schema' => ['description' => '增量迁移任务运行的时间间隔，单位：小时。取值范围为1~168。'."\n"
+ ."\n"
+ .'`RunOnce`参数值为false时，该参数为必填参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'MaxNumberOfImageToKeep',
+ 'in' => 'query',
+ 'schema' => ['description' => '增量迁移任务默认保留的最大镜像数。取值范围为1~10。'."\n"
+ ."\n"
+ .'`RunOnce`参数值为false时，该参数为必填参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '中转实例的实例规格。'."\n"
+ ."\n"
+ .'调用[DescribeInstanceTypes](~~25620~~)可查询云服务器ECS提供的实例规格。'."\n"
+ ."\n"
+ .'- 指定该参数后，系统会选择该实例规格创建中转实例。若该实例规格库存不足，则迁移任务创建失败。'."\n"
+ .'- 不指定该参数时，系统会默认按照一定顺序选择实例规格来创建中转实例，详情请参见[SMC'."\n"
+ .' FAQ 中转实例规格有哪些](~~121707~~)。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c5.large'],
+ ],
+ [
+ 'name' => 'LaunchTemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例启动模板ID。', 'type' => 'string', 'required' => false, 'example' => 'lt-bp16jovvln1cgaaq****'],
+ ],
+ [
+ 'name' => 'LaunchTemplateVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例启动模板的版本。', 'type' => 'string', 'required' => false, 'example' => 'Latest'],
+ ],
+ [
+ 'name' => 'InstanceRamRole',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例RAM角色名称。', 'type' => 'string', 'required' => false, 'example' => 'SMCAdmin'],
+ ],
+ [
+ 'name' => 'ContainerNamespace',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Docker的命名空间。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。', 'type' => 'string', 'required' => false, 'example' => 'testNamespace'],
+ ],
+ [
+ 'name' => 'ContainerRepository',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Docker的镜像仓库。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。', 'type' => 'string', 'required' => false, 'example' => 'testRepository'],
+ ],
+ [
+ 'name' => 'ContainerTag',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Docker的镜像标签。关于Docker容器镜像详情请参见[容器镜像服务](~~60744~~)。', 'type' => 'string', 'required' => false, 'example' => 'CentOS:v1'],
+ ],
+ [
+ 'name' => 'ValidTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '迁移任务的过期时间。取值范围：迁移任务创建时间+7天~迁移任务创建时间+90天'."\n"
+ ."\n"
+ .'- 过期时间只允许迁移任务在Ready（未开始）、Running（运行中）、Stopped（已暂停）、InError（出错）或Waiting（等待中）状态下修改。'."\n"
+ .'- 过期时间须遵循ISO8601标准，并需要使用UTC+0时间，格式为`YYYY-MM-DDThh:mm:ssZ`。例如，2018-01-01T12:00:00Z，表示北京时间2018年01月01日20点00分00秒。'."\n"
+ .'- 过期时间设置为空，表示任务无限期有效。'."\n"
+ .'- 任务到期后会被标记为过期状态，保存7天，7天后系统会自动清理。'."\n"
+ ."\n"
+ .'默认值：迁移任务创建时间+30天（表示迁移任务的默认有效期为创建后30天）。', 'type' => 'string', 'required' => false, 'example' => '2019-06-04T13:35:00Z'],
+ ],
+ [
+ 'name' => 'SystemDiskPart',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务。N的取值范围：1~50。',
+ 'description' => '系统盘分区列表。',
'type' => 'array',
'items' => [
- 'description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务。N的取值范围：1~50。',
- 'type' => 'string',
+ 'description' => '系统盘分区列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SizeBytes' => ['description' => '目标系统盘分区N大小。单位：Byte。默认为源系统盘分区大小。'."\n"
+ .'> 分区空间大小不能超过系统盘空间大小，并且在系统盘下所有分区空间大小之和不能超过系统盘空间大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968'],
+ 'Block' => ['description' => '目标系统盘分区N是否开启块复制。取值范围：'."\n"
+ .'- true。'."\n"
+ .'- false。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Device' => ['description' => '目标系统盘分区N设备标识。'."\n"
+ .'> N的实际取值请参考迁移源的分区设备标识。', 'type' => 'string', 'required' => false, 'example' => '0_1'],
+ ],
'required' => false,
- 'example' => 's-bp12tueadp5ndleg****',
],
- 'required' => true,
- 'example' => 's-bw526m1vi6x20c6g****',
- 'maxItems' => 51,
+ 'required' => false,
+ 'maxItems' => 32,
],
],
[
- 'name' => 'TagKey',
+ 'name' => 'DataDisk',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'SMC资源的标签键。标签键大小写敏感。N的取值范围：1~20。'."\n"
- ."\n\n",
+ 'description' => '数据盘列表。',
'type' => 'array',
'items' => [
- 'description' => 'SMC资源的标签键。标签键大小写敏感。N的取值范围：1~20。',
- 'type' => 'string',
+ 'description' => '数据盘列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => ['description' => '目标阿里云服务器ECS的数据盘顺序。取值范围为1~16。'."\n"
+ ."\n"
+ .'初始值为1。'."\n"
+ ."\n"
+ .'>您只能为源服务器中存在的数据盘创建目标数据盘。'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'Part' => [
+ 'description' => '分区列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '分区列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SizeBytes' => ['description' => '目标数据盘N分区N的大小。单位：Byte。默认为源数据盘分区大小。'."\n"
+ .'> 分区空间大小不能超过数据盘空间大小，并且在同一数据盘下所有分区空间大小之和不能超过数据盘空间大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '254803968'],
+ 'Block' => ['description' => '目标数据盘N分区N是否开启块复制。取值范围：'."\n"
+ .'- true。'."\n"
+ .'- false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Device' => ['description' => '目标数据盘N分区N对应的分区设备标识。'."\n"
+ .'> N的实际取值请参考迁移源的分区设备标识。', 'type' => 'string', 'required' => false, 'example' => '0_1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 32,
+ ],
+ 'Size' => ['description' => '目标阿里云服务器ECS的数据盘大小，单位：GiB。取值范围为20~32768。'."\n"
+ ."\n"
+ .'>参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为500 GiB，实际占用100 GiB，则该参数取值需大于100 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ ],
'required' => false,
- 'example' => 'smc',
],
'required' => false,
- 'example' => 'TestKey',
- 'maxItems' => 21,
+ 'maxItems' => 16,
],
],
+ [
+ 'name' => 'NetMode',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据传输网络模式。取值范围：'."\n"
+ ."\n"
+ .'- 0：表示公网传输模式。此时要求您的源服务器能够访问公网，迁云数据从公网传输。'."\n"
+ .'- 2：表示内网传输模式，选用此模式必须设置VSwitchId参数（VpcId参数可以不设置，服务内部可以通过接口反查出来）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'VSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定VPC下的虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1ddbrxdlrcbim46****'],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => ['description' => '已配置高速通道服务或者VPN网关的VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1vwnn14rqpyiczj****'],
+ ],
+ [
+ 'name' => 'ReplicationParameters',
+ 'in' => 'query',
+ 'schema' => ['description' => '复制驱动器的参数信息。参数信息为JSON格式键值对，键值固定。最大长度：2048个字符。'."\n"
+ ."\n"
+ .'复制驱动器是指，复制源服务器数据到中转实例时所使用的工具。不同复制驱动器支持参数可能不同。复制驱动器SMT目前支持以下参数：'."\n"
+ ."\n"
+ .'- bandwidth_limit：传输速度带宽限制。'."\n"
+ .'- compress_level：传输压缩率。'."\n"
+ .'- checksum：是否开启checksum校验。'."\n"
+ ."\n"
+ .'复制驱动器的取值，请参见[DescribeSourceServers](~~2402126~~)的返回参数`SourceServers.ReplicationDriver`。', 'type' => 'string', 'required' => false, 'example' => '{"bandwidth_limit":0,"compress_level":1,"checksum":true}'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1C488B66-B819-4D14-8711-C4EAAA13AC01'],
],
],
],
],
'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.',
- ],
+ ['errorCode' => 'DataDisk.DuplicateIndex', 'errorMessage' => 'The source server data disk cannot contain the same index.', 'description' => '迁移源数据盘包含相同的索引，请检查磁盘索引是否重复。'],
+ ['errorCode' => 'ReplicationJobDataDiskIndex.Invalid', 'errorMessage' => 'The specified replication job contains data disk index not found in source server.', 'description' => '迁移任务包含的数据盘索引在迁移源中不存在。'],
+ ['errorCode' => 'ReplicationJobName.Duplicate', 'errorMessage' => 'The specified replication job name already exists.', 'description' => '迁移任务名称已存在，请修改迁移任务名称。'],
+ ['errorCode' => 'ReplicationJob.InvalidStatus', 'errorMessage' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移任务的状态：%s 是无效的。该操作只能在以下状态进行：%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.', 'description' => '迁移任务的业务状态：%s 是无效的。该操作只能在以下业务状态进行：%s。'],
+ ['errorCode' => 'ImageName.UsedByReplicationJob', 'errorMessage' => 'The specified imageName: "%s" was used by another replication job in the current region.', 'description' => '镜像名称“%s”被当前地域的另一个迁移任务使用。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]',
- 'title' => '解绑并删除标签',
- 'description' => '如果标签不再使用，您可以使用此接口为迁移源和迁移任务统一解绑并删除标签。',
+ 'title' => '修改迁移任务',
+ 'description' => '## 接口说明'."\n"
+ ."\n"
+ .'修改迁移任务之前，请阅读以下注意事项：'."\n"
+ ."\n"
+ .'- 参数`Name`和`Description`在迁移任务的整个生命周期内均可以修改。'."\n"
+ ."\n"
+ .'- 参数`Frequency`和`MaxNumberOfImageToKeep`只能在迁移任务执行前或任务状态为`等待中`时修改。'."\n"
+ ."\n"
+ .'- 其他参数只能在迁移任务执行前修改。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateAccessToken' => [
- 'summary' => '调用CreateAccessToken创建激活码。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:ModifyReplicationJobAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyReplicationJobAttributeResponse>\\n <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>\\n</ModifyReplicationJobAttributeResponse>","errorExample":""}]',
+ ],
+ 'ModifySourceServerAttribute' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '144505',
- 'abilityTreeNodes' => [
- 'FEATUREsmcWZM4IC',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '18573',
+ 'abilityTreeNodes' => ['FEATUREsmcBBDD6M'],
],
'parameters' => [
[
+ 'name' => 'SourceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '迁移源ID。', 'type' => 'string', 'required' => true, 'example' => 's-bp17m1vi6x20c6g6****'],
+ ],
+ [
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '激活码名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_name',
- ],
+ 'schema' => ['description' => '迁移源名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`或`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'testSourceServerName'],
],
[
'name' => 'Description',
'in' => 'query',
+ 'schema' => ['description' => '迁移源描述。长度为0~256个字符，不能以`http://`或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'This is a source server.'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '激活码描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是导入迁移源激活码',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'SourceServerName.Duplicate', 'errorMessage' => 'The specified source server name already exists. Please modify the source server name.', 'description' => '迁移源名称已存在，请修改迁移源名称。'],
+ ['errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移源的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '修改一个迁移源的名称和描述',
+ 'summary' => '调用ModifySourceServerAttribute修改一个迁移源的名称和描述。',
+ 'description' => '## 接口说明'."\n"
+ ."\n"
+ .'使用该API修改迁移源的名称和描述时，对迁移源的状态没有要求。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:ModifySourceServerAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteReplicationJobResponse>\\r\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\r\\n</DeleteReplicationJobResponse>","errorExample":""}]',
+ ],
+ 'ModifyWorkgroupAttribute' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Count',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '240380',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkgroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '激活码用于注册迁移源的使用次数上限。取值范围为1~1000。'."\n"
- ."\n"
- .'默认值为100。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '工作组ID。', 'type' => 'string', 'required' => true, 'example' => 'w-bp10geepnj916e3d****'],
],
[
- 'name' => 'TimeToLiveInDays',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '激活码的有效使用时间，过期后将不能用于注册新的实例。单位：天。取值范围为1~90。'."\n"
- ."\n"
- .'默认值为30。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => '工作组名称。名称需满足以下要求：'."\n"
+ ."\n"
+ .'- 任务名称必须唯一。'."\n"
+ .'- 长度为 2~64 个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、点号（.）、下划线（_）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'testMigrationTaskName'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '输入新的工作组描述信息。长度为 2～256 个英文或中文字符，不能以`http://`和`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '响应参数',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DB4A7EA2-6FDA-5655-B067-854532FB****',
- ],
- 'AccessTokenCode' => [
- 'description' => '激活码的代码。该代码仅在调用接口时返回一次，后续无法被查询。因此，请您务必妥善保存返回值。',
- 'type' => 'string',
- 'example' => 'B57QoTXEA2Tytr0uZWoNY5Aju5Jt****',
- ],
- 'AccessTokenId' => [
- 'description' => '激活码ID。',
- 'type' => 'string',
- 'example' => 'at-bp1akz2zp67r0k6r****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****'],
],
],
],
],
'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'Forbidden.Unauthorized', 'errorMessage' => 'A required authorization for the specified action is not supplied.', 'description' => '用户未授权操作指定的资源。'],
+ ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DB4A7EA2-6FDA-5655-B067-854532FB****\\",\\n \\"AccessTokenCode\\": \\"B57QoTXEA2Tytr0uZWoNY5Aju5Jt****\\",\\n \\"AccessTokenId\\": \\"at-bp1akz2zp67r0k6r****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccessTokenResponse>\\n <RequestId>DB4A7EA2-6FDA-5655-B067-854532FB****</RequestId>\\n <AccessTokenCode>B57QoTXEA2Tytr0uZWoNY5Aju5Jt****</AccessTokenCode>\\n <AccessTokenId>at-bp1akz2zp67r0k6r****</AccessTokenId>\\n</CreateAccessTokenResponse>","errorExample":""}]',
- 'title' => '创建激活码',
- 'description' => '如果您使用激活码导入迁移源，需使用此接口创建激活码。',
- ],
- 'DisableAccessToken' => [
- 'summary' => '调用DisableAccessToken禁用激活码。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '修改工作组',
+ 'summary' => '创建工作组后，您可以修改工作组的名称和描述信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:ModifyWorkgroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","type":"json"}]',
+ ],
+ 'StartReplicationJob' => [
+ 'summary' => '调用StartReplicationJob启动一个迁移任务。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'abilityTreeCode' => '144984',
- 'abilityTreeNodes' => [
- 'FEATUREsmcWZM4IC',
- ],
+ 'abilityTreeCode' => '18576',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
- 'name' => 'AccessTokenId',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '激活码ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'at-bp12g5gwup0yzmce****',
- ],
+ 'schema' => ['description' => '迁移任务ID。', 'type' => 'string', 'required' => true, 'example' => 'j-bw526m1vi6x21q****'],
],
],
'responses' => [
@@ -5007,480 +3269,754 @@
'description' => '请求ID。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****',
- ],
+ 'RequestId' => ['description' => '请求ID。', '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.', 'description' => '迁移任务的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ['errorCode' => 'SourceServerState.Invalid', 'errorMessage' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', 'description' => '迁移源的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '启动一个迁移任务',
+ 'description' => '## 接口说明'."\n"
+ ."\n"
+ .'您只能使用该API启动**Ready（未开始）**、**Stopped（已暂停）**或**InError（出错）**状态的迁移任务。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:StartReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"686BB8A6-BBA5-47E5-8A75-D2ADE433****\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAccessTokenResponse>\\n <RequestId>686BB8A6-BBA5-47E5-8A75-D2ADE433****</RequestId>\\n</DisableAccessTokenResponse>","errorExample":""}]',
- 'title' => '禁用激活码',
- 'description' => '如果您担心已创建的激活码存在泄露的风险，可以通过该接口禁用激活码。禁用后无法再通过该激活码注册新的迁移源，但不会影响已经注册的迁移源。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<StartReplicationJobResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</StartReplicationJobResponse>","errorExample":""}]',
],
- 'ListAccessTokens' => [
- 'summary' => '调用ListAccessTokens查询已创建的激活码以及激活码的使用情况。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StopReplicationJob' => [
+ 'summary' => '调用StopReplicationJob停止一个迁移任务。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '144510',
- 'abilityTreeNodes' => [
- 'FEATUREsmcWZM4IC',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '18577',
+ 'abilityTreeNodes' => ['FEATUREsmcTXNBS6'],
],
'parameters' => [
[
- 'name' => 'AccessTokenId',
+ 'name' => 'JobId',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '迁移任务ID。', 'type' => 'string', 'required' => true, 'example' => 'j-bw526m1vi6x21qh****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '激活码信息集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '激活码信息集合。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'at-bp1akz2zp67r0k6r****',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
- 'required' => false,
- 'maxItems' => 100,
],
],
+ ],
+ '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.', 'description' => '迁移任务的状态：%s 是无效的。该操作只能在以下状态进行：%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.', 'description' => '迁移任务的业务状态：%s 是无效的。该操作只能在以下业务状态进行：%s。'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ],
+ ],
+ 'title' => '停止一个迁移任务',
+ 'description' => '## 接口说明'."\n"
+ ."\n"
+ .'您只能使用该API停止正在运行中（Running）且处于同步中（Syncing）状态的迁移任务。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:StopReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<StopReplicationJobResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</StopReplicationJobResponse>","errorExample":""}]',
+ ],
+ 'TagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Name',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '18578',
+ 'abilityTreeNodes' => ['FEATUREsmc6EK4ZG'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceType',
'in' => 'query',
+ 'schema' => ['description' => 'SMC资源类型。取值范围：'."\n"
+ ."\n"
+ .'- sourceserver：迁移源'."\n"
+ ."\n"
+ .'- replicationjob：迁移任务', 'type' => 'string', 'required' => true, 'example' => 'sourceserver'],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '激活码名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_name',
+ 'description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务。N的取值范围：1~50',
+ 'type' => 'array',
+ 'items' => ['description' => 'smc资源id。', 'type' => 'string', 'required' => false, 'example' => 's-bw526m1vi6x20c6g****'],
+ 'required' => true,
+ 'example' => 's-bw526m1vi6x20c6g****',
+ 'maxItems' => 51,
],
],
[
- 'name' => 'Status',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '激活码状态。取值范围：'."\n"
- ."\n"
- .'- activated：已激活。'."\n"
- ."\n"
- .'- unactivated：未激活。'."\n"
- .'- expired：已过期。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'activated',
+ 'description' => '标签信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签信息列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '为SMC资源指定的标签键。N的取值范围：1~20'."\n"
+ ."\n"
+ .'一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以aliyun和acs:开头，不能包含http:\\//或者https:\\//。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
+ 'Value' => ['description' => '为SMC资源指定的标签值。N的取值范围：1~20。'."\n"
+ ."\n"
+ .'一旦传入该值，可以为空字符串。最多支持64个字符，不能包含http://或者https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '响应参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E2DA3097-79B9-53AE-B0DF-281DC54F****',
- ],
- 'AccessTokens' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'AccessToken' => [
- 'description' => '迁移源数组信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '迁移源数组信息。',
- 'type' => 'object',
- 'properties' => [
- 'AccessTokenId' => [
- 'description' => '激活码ID。',
- 'type' => 'string',
- 'example' => 'at-bp1akz2zp67r0k6r****',
- ],
- 'TimeToLiveInDays' => [
- 'description' => '激活码的有效期。有效期为1~90天，默认为30天。',
- 'type' => 'string',
- 'example' => '30',
- ],
- 'Count' => [
- 'description' => '激活码使用次数上限。取值范围为1~1000。'."\n"
- ."\n"
- .'默认值为100。',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'RegisteredCount' => [
- 'description' => '已注册的迁移源数。',
- 'type' => 'string',
- 'example' => '5',
- ],
- 'CreationTime' => [
- 'description' => '激活码创建时间。按照[ISO 8601](~~25696~~)标准表示，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-09-09T02:35:44Z',
- ],
- 'Status' => [
- 'description' => '激活码状态。可能值：'."\n"
- ."\n"
- .'- activated：已激活。'."\n"
- ."\n"
- .'- unactivated：未激活。'."\n"
- .'- expired：已过期。',
- 'type' => 'string',
- 'example' => 'activated',
- ],
- 'Name' => [
- 'description' => '激活码名称。',
- 'type' => 'string',
- 'example' => 'test_name',
- ],
- 'Description' => [
- 'description' => '激活码描述信息。',
- 'type' => 'string',
- 'example' => '这是激活码',
- ],
- ],
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '迁移源总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageSize' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageNumber' => [
- 'description' => '每页行数。可能值：'."\n"
- ."\n"
- .'- 10'."\n"
- .'- 20'."\n"
- .'- 50'."\n"
- ."\n"
- .'默认值：20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3E8B9ABB-289A-44E6-942D-8AA9E493****'],
],
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
+ 400 => [
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of the Tag parameters cannot exceed 20.', 'description' => '标签列表参数不能超过20个。'],
+ ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => '资源类型参数不存在。'],
+ ['errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The specified ResourceType does not exist.', 'description' => '指定的资源类型不存在。'],
+ ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceId parameters cannot exceed 50.', 'description' => '资源ID参数不能超过50个。'],
+ ['errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The ResourceId contains duplicate values.', 'description' => '资源ID中存在重复的值。'],
+ ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds do not exist.', 'description' => '资源不存在'],
+ ],
+ ],
+ 'title' => '绑定标签',
+ 'summary' => '调用TagResources为指定的SMC资源（迁移源和迁移任务）列表统一创建并绑定标签。',
+ 'description' => '## 接口说明'."\n"
+ ."\n"
+ .'每个SMC资源可绑定的标签限额为20。'."\n"
+ ."\n"
+ .'绑定标签前，阿里云会校验资源已有标签数量，超过限额后返回报错信息。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:TagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#ReplicationJobId}'],
+ ],
],
],
],
- '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":"<ListAccessTokensResponse>\\n <RequestId>E2DA3097-79B9-53AE-B0DF-281DC54F****</RequestId>\\n <AccessTokens>\\n <AccessTokenId>at-bp1akz2zp67r0k6r****</AccessTokenId>\\n <TimeToLiveInDays>30</TimeToLiveInDays>\\n <Count>100</Count>\\n <RegisteredCount>5</RegisteredCount>\\n <CreationTime>2022-09-09T02:35:44Z</CreationTime>\\n <Status>activated</Status>\\n <Name>test_name</Name>\\n <Description>这是激活码</Description>\\n </AccessTokens>\\n <TotalCount>2</TotalCount>\\n <PageSize>1</PageSize>\\n <PageNumber>20</PageNumber>\\n</ListAccessTokensResponse>","errorExample":""}]',
- 'title' => '查询激活码',
- 'description' => '查询已创建的激活码以及激活码的使用情况。'."\n"
- .'激活码的状态包括已激活、未激活和已过期三种。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E8B9ABB-289A-44E6-942D-8AA9E493****\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>3E8B9ABB-289A-44E6-942D-8AA9E493****</RequestId>\\n</TagResourcesResponse>","errorExample":""}]',
],
- 'DeleteAccessToken' => [
- 'summary' => '调用DeleteAccessToken删除激活码。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UntagResources' => [
+ 'summary' => '为指定的SMC资源（迁移源和迁移任务）统一解绑并删除标签。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
- 'abilityTreeCode' => '144985',
- 'abilityTreeNodes' => [
- 'FEATUREsmcWZM4IC',
- ],
+ 'abilityTreeCode' => '18579',
+ 'abilityTreeNodes' => ['FEATUREsmc6EK4ZG'],
],
'parameters' => [
[
- 'name' => 'AccessTokenId',
+ 'name' => 'ResourceType',
'in' => 'query',
+ 'schema' => ['description' => 'SMC资源类型。取值范围：'."\n"
+ ."\n"
+ .'- sourceserver：迁移源。'."\n"
+ ."\n"
+ .'- replicationjob：迁移任务。', 'type' => 'string', 'required' => true, 'example' => 'sourceserver'],
+ ],
+ [
+ 'name' => 'All',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否删除SMC资源绑定的全部标签。仅当请求中未设置`TagKey.N`时该参数有效。取值范围：'."\n"
+ ."\n"
+ .'- true：删除指定SMC资源绑定的全部标签。若指定的SMC资源未绑定任何标签，则不做处理。'."\n"
+ .'- false：不删除指定SMC资源绑定的任何标签。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '激活码ID。',
- 'type' => 'string',
+ 'description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务。N的取值范围：1~50。',
+ 'type' => 'array',
+ 'items' => ['description' => 'SMC资源ID。SMC资源包括迁移源和迁移任务。N的取值范围：1~50。', 'type' => 'string', 'required' => false, 'example' => 's-bp12tueadp5ndleg****'],
'required' => true,
- 'example' => 'at-bp1akz2zp67r0k6r****',
+ 'example' => 's-bw526m1vi6x20c6g****',
+ 'maxItems' => 51,
+ ],
+ ],
+ [
+ 'name' => 'TagKey',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'SMC资源的标签键。标签键大小写敏感。N的取值范围：1~20。'."\n"
+ ."\n\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'SMC资源的标签键。标签键大小写敏感。N的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'smc'],
+ 'required' => false,
+ 'example' => 'TestKey',
+ 'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '请求ID。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DB4A7EA2-6FDA-5655-B067-854532FB****',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF518948****'],
],
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.',
+ 400 => [
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of the Tag parameters cannot exceed 20.', 'description' => '标签列表参数不能超过20个。'],
+ ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => '资源类型参数不存在。'],
+ ['errorCode' => 'InvalidResourceType.NotFound', 'errorMessage' => 'The specified ResourceType does not exist.', 'description' => '指定的资源类型不存在。'],
+ ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceId parameters cannot exceed 50.', 'description' => '资源ID参数不能超过50个。'],
+ ['errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The ResourceId contains duplicate values.', 'description' => '资源ID中存在重复的值。'],
+ ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds do not exist.', 'description' => '资源不存在'],
+ ],
+ ],
+ 'title' => '解绑并删除标签',
+ 'description' => '如果标签不再使用，您可以使用此接口为迁移源和迁移任务统一解绑并删除标签。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:UntagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#ReplicationJobId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DB4A7EA2-6FDA-5655-B067-854532FB****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAccessTokenResponse>\\n <RequestId>DB4A7EA2-6FDA-5655-B067-854532FB****</RequestId>\\n</DeleteAccessTokenResponse>","errorExample":""}]',
- 'title' => '删除激活码',
- 'description' => '如果后续您不再通过激活码的方式导入迁移源，或者激活码已过期等场景，可以使用此接口删除激活码。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518948****\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]',
],
],
'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' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'smc.aliyuncs.com', 'endpoint' => 'smc.aliyuncs.com', 'vpc' => 'smc.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'DataDisk.DuplicateIndex', 'message' => 'The source server data disk cannot contain the same index.', 'http_code' => 400, 'description' => '迁移源数据盘包含相同的索引，请检查磁盘索引是否重复。'],
+ ['code' => 'DataDisk.DuplicatePath', 'message' => 'The source server data disk cannot contain duplicate paths.', 'http_code' => 400, 'description' => '迁移源数据盘参数中不能存在相同的磁盘路径'],
+ ['code' => 'Duplicate.ResourceId', 'message' => 'The specified ResourceId contains duplicate values.', 'http_code' => 400, 'description' => '重复的资源ID'],
+ ['code' => 'Duplicate.ResourceId', 'message' => 'The ResourceId contains duplicate values.', 'http_code' => 400, 'description' => '资源ID中存在重复的值。'],
+ ['code' => 'Duplicate.TagKey', 'message' => 'Tag.N.Key contains duplicate values.', 'http_code' => 400, 'description' => '存在重复的TagKey'],
+ ['code' => 'EntityNotExist.Role', 'message' => 'The account is unauthorized. Please assign the role AliyunSMCDefaultRole to your account.', 'http_code' => 403, 'description' => '账号不具备操作权限，请赋予账户AliyunSMCDefaultRole角色'],
+ ['code' => 'EntityNotExist.Role', 'message' => 'The account is unauthorized. Please assign the role AliyunServiceRoleForSMC to your account.', 'http_code' => 403, 'description' => '账号不具备操作权限，请赋予账户AliyunServiceRoleForSMC角色。'."\n"],
+ ['code' => 'Forbidden.Unauthorized', 'message' => 'A required authorization for the specified action is not supplied.', 'http_code' => 403, 'description' => '用户未授权操作指定的资源。'],
+ ['code' => 'ImageName.Exist', 'message' => 'The specified imageName already exists in the current region.', 'http_code' => 400, 'description' => '当前地域已经存在同名镜像'],
+ ['code' => 'ImageName.UsedByReplicationJob', 'message' => 'The specified imageName was used by another replication job in the current region.', 'http_code' => 400, 'description' => '当前地域已经存在迁移任务使用了当前镜像名称。'],
+ ['code' => 'ImageName.UsedByReplicationJob', 'message' => '%s.', 'http_code' => 400, 'description' => '当前地域已经存在迁移任务使用了当前镜像名称。'."\n"],
+ ['code' => 'ImageName.UsedByReplicationJob', 'message' => 'The specified imageName: "%s" was used by another replication job in the current region.', 'http_code' => 400, 'description' => '镜像名称“%s”被当前地域的另一个迁移任务使用。'],
+ ['code' => 'InternalError', 'message' => 'An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.', 'http_code' => 500, 'description' => '内部错误，请重试。如果多次尝试失败，请提交工单。'],
+ ['code' => 'InvalidOsMigrationType.NotMatched', 'message' => '%s.', 'http_code' => 400, 'description' => '源系统不能升级到目标系统。'],
+ ['code' => 'InvalidOsMigrationType.NotMatched', 'message' => 'The SourceOsType: %s and TargetOsType: %s are not matched. The supported TargetOsType list is: %s.', 'http_code' => 400, 'description' => '源操作系统类型：%s 和目标操作系统类型：%s 不匹配。支持的目标操作系统类型列表是：%s。'],
+ ['code' => 'InvalidResourceId.NotFound', 'message' => 'The specified ResourceIds do not exist.', 'http_code' => 400, 'description' => '资源不存在'],
+ ['code' => 'InvalidResourceType.NotFound', 'message' => 'The specified ResourceType does not exist.', 'http_code' => 400, 'description' => '指定的资源类型不存在。'],
+ ['code' => 'InvalidSecurityGroupId.IncorrectNetworkType', 'message' => 'The network type of the specified security group does not support this action.', 'http_code' => 400, 'description' => '安全组网络类型不支持该操作，请检查安全组网络类型。'],
+ ['code' => 'InvalidSecurityGroupId.VPCMismatch', 'message' => 'The specified security group and the specified virtual switch are not in the same VPC.', 'http_code' => 400, 'description' => '指定的安全组和交换机不在一个专有网络。'],
+ ['code' => 'InvalidTagKey.Malformed', 'message' => 'The specified format of TagKey is invalid.', 'http_code' => 400, 'description' => 'TagKey格式不规范'],
+ ['code' => 'InvalidTagValue.Malformed', 'message' => 'The specified format of TagValue is invalid.', 'http_code' => 400, 'description' => 'TagValue格式不规范'],
+ ['code' => 'MissingParameter.ResourceIds', 'message' => 'You must specify ResourceId.N.', 'http_code' => 400, 'description' => '资源列表不能为空'],
+ ['code' => 'MissingParameter.ResourceIdsOrTags', 'message' => 'Either ResourceId.N or Tags should be specified.', 'http_code' => 400, 'description' => '资源列表与标签参数不能同时为空'],
+ ['code' => 'MissingParameter.ResourceType', 'message' => 'You must specify ResourceType.', 'http_code' => 400, 'description' => '资源类型参数不存在。'],
+ ['code' => 'MissingParameter.TagKey', 'message' => 'You must specify Tag.N.Key.', 'http_code' => 400, 'description' => 'TagKey为必填参数'],
+ ['code' => 'MissingParameter.Tags', 'message' => 'You must specify Tags.', 'http_code' => 400, 'description' => '缺少Tag参数'],
+ ['code' => 'MissingParameter.TagValue', 'message' => 'You must specify Tag.N.Value.', 'http_code' => 400, 'description' => 'TagValue不能为空'],
+ ['code' => 'NotAllowed.PrivateIPHasReverseDependency', 'message' => 'The private IP address of the instance has reverse dependency.', 'http_code' => 400, 'description' => '实例的私有IP地址存在反向依赖。'],
+ ['code' => 'NumberExceed.ResourceIds', 'message' => 'The maximum number of ResourceIds is exceeded. The maximum value is 50.', 'http_code' => 400, 'description' => '资源列表超过最大列表长度'],
+ ['code' => 'NumberExceed.ResourceIds', 'message' => 'The maximum number of ResourceId parameters cannot exceed 50.', 'http_code' => 400, 'description' => '资源ID参数不能超过50个。'],
+ ['code' => 'NumberExceed.Tags', 'message' => 'The maximum number of Tags is exceeded. The maximum value is 20.', 'http_code' => 400, 'description' => '标签列表超过最大列表长度'],
+ ['code' => 'NumberExceed.Tags', 'message' => 'The maximum number of the Tag parameters cannot exceed 20.', 'http_code' => 400, 'description' => '标签列表参数不能超过20个。'],
+ ['code' => 'QuotaExceeded.ReplicationJob', 'message' => 'The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota.', 'http_code' => 400, 'description' => '迁移任务的数量已超过最大允许值，请提交工单。'],
+ ['code' => 'QuotaExceeded.SourceServer', 'message' => 'The maximum number of source servers is exceeded. Please submit a ticket.', 'http_code' => 400, 'description' => '迁移源数量已超过最大允许值，请提交工单。'],
+ ['code' => 'RealNameAuthenticationError', 'message' => 'You must perform real-name verification for your account.', 'http_code' => 403, 'description' => '账户未实名认证，请先进行实名认证'],
+ ['code' => 'ReplicationJob.InvalidBusinessStatus', 'message' => 'The specified business status of the replication job is invalid.', 'http_code' => 400, 'description' => '迁移任务businessStatus无效'],
+ ['code' => 'ReplicationJob.InvalidBusinessStatus', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的迁移任务业务状态。'],
+ ['code' => 'ReplicationJob.InvalidBusinessStatus', 'message' => 'The specified business status: %s of the replication job is invalid. This operation can only be performed in the following status: %s.', 'http_code' => 400, 'description' => '迁移任务的业务状态：%s 是无效的。该操作只能在以下业务状态进行：%s。'],
+ ['code' => 'ReplicationJob.InvalidStatus', 'message' => 'The specified replication job status is invalid.', 'http_code' => 400, 'description' => '无效的迁移任务状态。'],
+ ['code' => 'ReplicationJob.InvalidStatus', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的迁移任务状态。'."\n"],
+ ['code' => 'ReplicationJob.InvalidStatus', 'message' => 'The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.', 'http_code' => 400, 'description' => '迁移任务的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ['code' => 'ReplicationJob.NotFound', 'message' => 'The specified replication job does not exist.', 'http_code' => 400, 'description' => '指定的迁移任务不存在'],
+ ['code' => 'ReplicationJob.Related', 'message' => 'The specified source server has related replication jobs.', 'http_code' => 400, 'description' => '存在关联的迁移任务。'],
+ ['code' => 'ReplicationJob.Related', 'message' => '%s.', 'http_code' => 400, 'description' => '存在关联的迁移任务。'],
+ ['code' => 'ReplicationJob.Related', 'message' => 'The specified source server has related replication jobs. Please delete replication jobs: %s before delete this source server.', 'http_code' => 400, 'description' => '迁移源有相关的迁移任务。请删除迁移任务：%s 后再删除该迁移源。'],
+ ['code' => 'ReplicationJobAttribute.InvalidForModify', 'message' => 'The current replication job status is not ready. Only Name and Description in the replication job attribute can be modified.', 'http_code' => 400, 'description' => '当前迁移源非Ready状态，只允许修改Name和Description属性。'],
+ ['code' => 'ReplicationJobDataDiskIndex.Invalid', 'message' => 'The specified replication job contains data disk index not found in source server.', 'http_code' => 400, 'description' => '迁移任务包含的数据盘索引在迁移源中不存在。'],
+ ['code' => 'ReplicationJobName.Duplicate', 'message' => 'The specified replication job name already exists.', 'http_code' => 400, 'description' => '迁移任务名称已存在，请修改迁移任务名称。'],
+ ['code' => 'ReplicationJobRunningNum.Exceeded', 'message' => 'The maximum number of replication jobs that can be run simultaneously by the current user is exceeded.', 'http_code' => 400, 'description' => '当前用户允许同时运行的迁移任务数量超过最大值限制。'],
+ ['code' => 'SourceServer.WithRunningReplicationJob', 'message' => 'The specified source server has related replication jobs that are running.', 'http_code' => 400, 'description' => '迁移源关联正在运行的迁移任务。'],
+ ['code' => 'SourceServerId.NotExist', 'message' => 'The specified sourceServerId does not exist.', 'http_code' => 404, 'description' => '迁移源不存在'],
+ ['code' => 'SourceServerId.NotExist', 'message' => 'The specified source server ID does not exist.', 'http_code' => 400, 'description' => '指定的迁移源不存在'],
+ ['code' => 'SourceServerName.Duplicate', 'message' => 'The specified source server name already exists. Please modify the source server name.', 'http_code' => 400, 'description' => '迁移源名称已存在，请修改迁移源名称。'],
+ ['code' => 'SourceServerState.Invalid', 'message' => 'The specified source server status is invalid.', 'http_code' => 400, 'description' => '无效的迁移源状态。'],
+ ['code' => 'SourceServerState.Invalid', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的迁移源状态。'."\n"],
+ ['code' => 'SourceServerState.Invalid', 'message' => 'The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.', 'http_code' => 400, 'description' => '迁移源的状态：%s 是无效的。该操作只能在以下状态进行：%s。'],
+ ['code' => 'VSwitchIdVpcId.Mismatch', 'message' => 'The specified VSwitchId and VpcId does not match.', 'http_code' => 400, 'description' => '指定的VSwitchId和VpcId不匹配。'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCrossZoneMigrationJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccessToken'],
],
- [
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'smc.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'SMC',
+ 'productName' => '服务器迁移中心',
+ 'ramCodes' => ['smc'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DeleteAccessToken',
+ 'description' => '删除激活码',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteAccessToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagResources',
+ 'description' => '查询标签列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#AccountId}:replicationjob/{#ReplicationJobId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeReplicationJobs',
+ 'description' => '查询一个或多个迁移任务的详细信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:DescribeReplicationJobs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAccessTokens',
+ 'description' => '查询激活码',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:ListAccessTokens',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateReplicationJob',
+ 'description' => '创建一个迁移任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/*'],
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisassociateSourceServers',
+ 'description' => '迁移源取消关联工作组',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:DisassociateSourceServers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagResources',
+ 'description' => '绑定标签',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:TagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#ReplicationJobId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartReplicationJob',
+ 'description' => '启动一个迁移任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:StartReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyWorkgroupAttribute',
+ 'description' => '修改工作组',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:ModifyWorkgroupAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWorkgroup',
+ 'description' => '创建工作组',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateWorkgroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopReplicationJob',
+ 'description' => '停止一个迁移任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:StopReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CutOverReplicationJob',
+ 'description' => 'CutOverReplicationJob',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:CutOverReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeWorkgroups',
+ 'description' => '查看工作组',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'smc:DescribeWorkgroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSourceServers',
+ 'description' => '查询一个或多个迁移源信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'smc:DescribeSourceServers',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAccessToken',
+ 'description' => '创建激活码',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateAccessToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AssociateSourceServers',
+ 'description' => '迁移源关联工作组',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:AssociateSourceServers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCrossZoneMigrationJob',
+ 'description' => '创建跨可用区迁移任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'smc:CreateCrossZoneMigrationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteReplicationJob',
+ 'description' => '删除一个迁移任务',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteReplicationJob',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableAccessToken',
+ 'description' => '禁用激活码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:DisableAccessToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UntagResources',
+ 'description' => '解绑并删除标签',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:UntagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#ReplicationJobId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyReplicationJobAttribute',
+ 'description' => '修改迁移任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:ModifyReplicationJobAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifySourceServerAttribute',
+ 'description' => '修改一个迁移源的名称和描述',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'smc:ModifySourceServerAttribute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSourceServer',
+ 'description' => 'DeleteSourceServer',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteSourceServer',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWorkgroup',
+ 'description' => '删除工作组',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'smc:DeleteWorkgroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SMC', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- [
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'smc.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#AccountId}:replicationjob/{#ReplicationJobId}'],
+ ['validationType' => 'always', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/*'],
+ ['validationType' => 'always', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}'],
+ ['validationType' => 'always', 'resourceType' => 'ReplicationJob', 'arn' => 'acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}'],
+ ['validationType' => 'always', 'resourceType' => 'SourceServer', 'arn' => 'acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceId}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 22:50:15 +0000