diff options
Diffstat (limited to 'data/en_us/hcs-mgw/2024-06-26/api-docs.php')
| -rw-r--r-- | data/en_us/hcs-mgw/2024-06-26/api-docs.php | 4049 |
1 files changed, 1181 insertions, 2868 deletions
diff --git a/data/en_us/hcs-mgw/2024-06-26/api-docs.php b/data/en_us/hcs-mgw/2024-06-26/api-docs.php index 25eb16d..8b6cadf 100644 --- a/data/en_us/hcs-mgw/2024-06-26/api-docs.php +++ b/data/en_us/hcs-mgw/2024-06-26/api-docs.php @@ -1,471 +1,165 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'hcs-mgw', - 'version' => '2024-06-26', - ], + 'info' => ['style' => 'ROA', 'product' => 'hcs-mgw', 'version' => '2024-06-26'], 'directories' => [ [ - 'id' => 194059, - 'title' => 'Tasks', + 'children' => ['ListJobHistory'], 'type' => 'directory', - 'children' => [ - 'CreateJob', - 'GetJob', - 'ListJob', - 'UpdateJob', - 'DeleteJob', - 'ListJobHistory', - 'CreateReport', - 'GetReport', - 'GetJobResult', - ], + 'title' => 'Node', ], [ - 'id' => 194069, - 'title' => 'Data address', + 'children' => ['GetAddress', 'ListAddress', 'VerifyAddress'], 'type' => 'directory', - 'children' => [ - 'CreateAddress', - 'GetAddress', - 'ListAddress', - 'UpdateAddress', - 'DeleteAddress', - 'VerifyAddress', - ], - ], - [ - 'id' => 194075, - 'title' => 'Agent', - 'type' => 'directory', - 'children' => [ - 'CreateAgent', - 'GetAgent', - 'ListAgent', - 'GetAgentStatus', - 'DeleteAgent', - ], + 'title' => 'Data address', ], [ - 'id' => 194082, - 'title' => 'Tunnel', - 'type' => 'directory', 'children' => [ - 'CreateTunnel', - 'GetTunnel', + 'CreateAddress', 'CreateAgent', 'CreateJob', 'CreateReport', 'CreateTunnel', 'DeleteAddress', 'DeleteAgent', 'DeleteJob', 'DeleteTunnel', 'GetAgent', 'GetAgentStatus', 'GetJob', 'GetJobResult', 'GetReport', 'GetTunnel', 'ListAgent', 'ListJob', 'ListTunnel', 'UpdateAddress', 'UpdateJob', 'UpdateTunnel', - 'ListTunnel', - 'DeleteTunnel', ], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ 'schemas' => [ 'AddressDetail' => [ - 'title' => '', - 'description' => 'The details of the data address.'."\n", - 'visibility' => 'Public', + 'title' => '数据地址详情。', + 'description' => 'Contains the address details.', 'type' => 'object', 'properties' => [ - 'AddressType' => [ - 'title' => '', - 'description' => 'The type of the data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ossinv', - ], - 'Bucket' => [ - 'title' => '', - 'description' => 'The bucket name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_bucket', - ], - 'Domain' => [ - 'title' => '', - 'description' => 'The domain name of the bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_domain', - ], - 'Prefix' => [ - 'title' => '', - 'description' => 'The bucket prefix.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_prefix', - ], - 'AccessId' => [ - 'title' => '', - 'description' => 'The AccessKey ID that is used to access the bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_access_id', - ], - 'AccessSecret' => [ - 'title' => '', - 'description' => 'The AccessKey secret that is used to access the bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_secret_key', - ], - 'Role' => [ - 'title' => '', - 'description' => 'The role that is used to migrate data. If the bucket is an Object Storage Service (OSS) bucket, you must specify a role. You do not need to specify an AccessKey pair that is used to access the bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_role', - ], - 'InvDomain' => [ - 'title' => '', - 'description' => 'The domain name of the bucket in which the inventory list resides.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_inv_domain', - ], - 'InvBucket' => [ - 'title' => '', - 'description' => 'The name of the bucket in which the inventory list resides.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_inv_bucket', - ], - 'InvAccessId' => [ - 'title' => '', - 'description' => 'The AccessKey ID that is used to access the bucket in which the inventory list resides.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_inv_access_id', - ], - 'InvAccessSecret' => [ - 'title' => '', - 'description' => 'The AccessKey secret that is used to access the bucket in which the inventory list resides.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_inv_secret_key', - ], - 'InvPath' => [ - 'title' => '', - 'description' => 'The inventory list. You must specify the file name and file name extension of the inventory list.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'manifest.json', - ], - 'InvRole' => [ - 'title' => '', - 'description' => 'The role that is used to migrate data for the bucket in which the inventory list resides. If the bucket in which the inventory list resides is an OSS bucket, you must specify a role. You do not need to specify an AccessKey pair that is used to access the bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_inv_role', - ], - 'InvLocation' => [ - 'title' => '', - 'description' => 'The type of the bucket in which the inventory list resides.\\'."\n" - .'Valid values: oss, s3, and cos.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss', - ], - 'AgentList' => [ - 'title' => '', - 'description' => 'The associated agents. If you want to access data over an Express Connect circuit or a VPN gateway, you must associate agents.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'agent1,agent2', - ], - 'RegionId' => [ - 'title' => '', - 'description' => 'The region ID of the bucket. If the bucket is an OSS bucket, you must specify the ID of the region in which the bucket resides. You do not need to specify the domain name of the bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_region_id', - ], - 'InvRegionId' => [ - 'title' => '', - 'description' => 'The region ID of the bucket in which the inventory list resides. If the bucket in which the inventory list resides is an OSS bucket, you must specify the ID of the region in which the inventory list resides. You do not need to specify the domain name of the inventory list.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_inv_region_id', - ], - ], + 'AddressType' => ['title' => '数据地址类型。', 'description' => 'The address type. Valid values:'."\n" + ."\n" + .'Object storage: `oss`, `s3`, `qiniu`, `cos`, `bos`, `obs`, `ks3`, `ucloud`, `upyun`, `azure`, `gcp`, and `tos`.'."\n" + ."\n" + .'File storage: `local`, `obsfs`, and `ftp`.'."\n" + ."\n" + .'Inventory: `inv`.', 'type' => 'string', 'required' => true, 'example' => 'oss'], + 'Bucket' => ['title' => '数据存储空间。', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_bucket'], + 'Domain' => ['title' => '数据存储空间的域名。', 'description' => 'The domain of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_domain'], + 'Prefix' => ['title' => '数据地址前缀。', 'description' => 'The object prefix in the bucket.', 'type' => 'string', 'example' => 'test_prefix'], + 'AccessId' => ['title' => '数据存储空间AccessKeyId。', 'description' => 'The AccessKey ID used to access the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_access_id'], + 'AccessSecret' => ['title' => '数据存储空间SecretAccessKey。', 'description' => 'The AccessKey Secret used to access the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_secret_key'], + 'Role' => ['title' => '授权角色。数据存储空间是OSS时，可以指定授权角色，无需指定存储空间的AK。', 'description' => 'The authorization role. If the bucket is an OSS bucket, you can use this role to grant access instead of an AccessKey.', 'type' => 'string', 'example' => 'test_role'], + 'InvDomain' => ['title' => '列表存储空间的域名。', 'description' => 'The domain of the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_domain'], + 'InvBucket' => ['title' => '列表存储空间。', 'description' => 'The name of the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_bucket'], + 'InvAccessId' => ['title' => '列表存储空间AccessKeyId。', 'description' => 'The AccessKey ID used to access the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_access_id'], + 'InvAccessSecret' => ['title' => '列表存储空间SecretAccessKey。', 'description' => 'The AccessKey Secret used to access the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_secret_key'], + 'InvPath' => ['title' => '列表清单文件。指定清单列表和格式。', 'description' => 'The path to the manifest file, which lists the objects and their format.', 'type' => 'string', 'example' => 'manifest.json'], + 'InvRole' => ['title' => '列表存储空间授权角色。列表存储空间是OSS时，可以指定授权角色，无需指定列表存储空间的AK。', 'description' => 'The authorization role for the inventory bucket. If the inventory bucket is an OSS bucket, you can use this role to grant access instead of an AccessKey.', 'type' => 'string', 'example' => 'test_inv_role'], + 'InvLocation' => ['title' => '列表存储空间类型。取值：oss，s3，cos。', 'description' => 'The type of the inventory bucket.<br>'."\n" + .'Valid values: `oss` and `s3`.<br>', 'type' => 'string', 'example' => 'oss'], + 'AgentList' => ['title' => '关联代理。通过专线/VPN等方式访问数据，需要关联代理。', 'description' => 'A list of agents required to access data over a leased line or a VPN connection.', 'type' => 'string', 'example' => 'agent1,agent2'], + 'RegionId' => ['title' => '数据存储空间区域。数据存储空间是OSS时，必须指定存储空间区域，无需指定存储空间域名。', 'description' => 'The region of the bucket. This parameter is required for OSS buckets and eliminates the need to specify a domain. Use the OSS-specific region ID format.', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], + 'InvRegionId' => ['title' => '列表存储空间区域。列表存储空间是OSS时，必须指定列表存储空间区域，无需指定列表存储空间域名。', 'description' => 'The region of the inventory bucket. This parameter is required for OSS inventory buckets and eliminates the need to specify a domain. Use the OSS-specific region ID format.', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], + 'DataType' => ['title' => '通用清单使用，当AddressType是inv时，DataType表示实际的存储类型，可取值为： oss、s3等', 'description' => 'Specifies the underlying storage type, such as `oss`, `s3`, or `obs`, when `AddressType` is `inv`.', 'type' => 'string', 'example' => 'oss'], + 'HdfsAuthConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/HdfsAuthConfig'], + ], + 'example' => '', ], 'Audit' => [ - 'title' => '', + 'title' => '审计方式。', 'description' => 'The audit method.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'LogMode' => [ - 'title' => '', - 'description' => 'Specifies whether to push migration logs to Simple Log Service (SLS). To push migration logs to SLS, you must create the AliyunOSSImportSlsAuditRole role and grant the required permissions to the role. Valid values: off, basic, and detail. off: does not push migration logs. basic: pushes only migration failure logs. detail: pushes migration success logs and migration failure logs.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'off', - ], + 'LogMode' => ['title' => '日志推送。取值： off，不推送日志；basic，仅推送文件迁移失败日志；detail，推送文件迁移成功和失败日志。推送迁移日志到SLS，需要创建AliyunOSSImportSlsAuditRole角色，并对角色完成授权。', 'description' => 'Specifies whether to push migration logs to Simple Log Service (SLS). To push migration logs to SLS, you must create the AliyunOSSImportSlsAuditRole role and grant the required permissions to the role. Valid values: off, basic, and detail. off: does not push migration logs. basic: pushes only migration failure logs. detail: pushes migration success logs and migration failure logs.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'off'], ], ], 'CreateAddressInfo' => [ - 'title' => '', + 'title' => '创建数据地址详情。', 'description' => 'The information about the data address.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '', - 'description' => 'The name of the data address.\\'."\n" - .'The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name must be 3 to 63 characters in length. The name is case-sensitive and encoded in UTF-8. The name cannot start with a hyphen (-) or an underscore (\\_). You must specify a name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_name', - ], - 'AddressDetail' => [ - 'title' => '', - 'description' => 'The details of the data address.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/AddressDetail', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags in the key:value format.\\'."\n" - .'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'K1:V1,K2:V2', - ], + 'Name' => ['title' => '数据地址名称。取值：英文小写字母、数字和特殊字符-和_，最短 3 字符， 最长 63 个字符，区分大小写，utf8 编码并且不可以- 和_开头，不能为空。', 'description' => 'The name of the data address.\\'."\n" + .'The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name must be 3 to 63 characters in length. The name is case-sensitive and encoded in UTF-8. The name cannot start with a hyphen (-) or an underscore (\\_). You must specify a name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test_name'], + 'AddressDetail' => ['title' => '数据地址详情。', 'description' => 'The details of the data address.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/AddressDetail'], + 'Tags' => ['title' => '标签，KeyValue格式。 允许字符：英文大小写字母、数字和特殊字符-_,。长度限制：1KB。', 'description' => 'The tags in the key:value format.\\'."\n" + .'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], ], 'parseType' => 'struct', ], 'CreateAgentInfo' => [ - 'title' => '', + 'title' => '创建代理详情。', 'description' => 'The information about the agent.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '', - 'description' => 'The name of the agent.\\'."\n" - .'The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name must be 3 to 63 characters in length. The name is case-sensitive and encoded in UTF-8. The name cannot start with a hyphen (-) or an underscore (\\_). You must specify a name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_name', - ], - 'DeployMethod' => [ - 'title' => '', - 'description' => 'The deployment mode of the agent.\\'."\n" - .'Set the value to default, which specifies the independent process mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - 'AgentEndpoint' => [ - 'title' => '', - 'description' => 'The method that is used to access the agent.\\'."\n" - .'Valid values: public and vpc.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags in the key:value format.\\'."\n" - .'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'K1:V1,K2:V2', - ], - 'TunnelId' => [ - 'title' => '', - 'description' => 'The tunnel ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_tunnel_id', - ], + 'Name' => ['title' => '代理名称。取值：英文小写字母、数字和特殊字符-和_，最短 3 字符， 最长 63 个字符，区分大小写，utf8 编码并且不可以- 和_开头，不能为空。', 'description' => 'The name of the agent.\\'."\n" + .'The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name must be 3 to 63 characters in length. The name is case-sensitive and encoded in UTF-8. The name cannot start with a hyphen (-) or an underscore (\\_). You must specify a name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test_name'], + 'DeployMethod' => ['title' => '代理的部署方式。取值：default。', 'description' => 'The deployment mode of the agent.\\'."\n" + .'Set the value to default, which specifies the independent process mode.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'default'], + 'AgentEndpoint' => ['title' => '代理访问方式，支持公网，专线/VPN等。取值：public，vpc。', 'description' => 'The method that is used to access the agent.\\'."\n" + .'Valid values: public and vpc.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'vpc'], + 'Tags' => ['title' => '标签，KeyValue格式。 允许字符：英文大小写字母、数字和特殊字符-_,。长度限制：1KB。', 'description' => 'The tags in the key:value format.\\'."\n" + .'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], + 'TunnelId' => ['title' => '通道ID。', 'description' => 'The tunnel ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test_tunnel_id'], ], ], 'CreateJobInfo' => [ - 'title' => '', - 'description' => 'The information about the migration task.'."\n", - 'visibility' => 'Public', + 'title' => '创建迁移任务详情。', + 'description' => 'Details of the migration task to create.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '', - 'description' => 'The task name.\\'."\n" - .'The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name must be 3 to 63 characters in length. The name is case-sensitive and encoded in UTF-8. The name cannot start with a hyphen (-) or an underscore (\\_). You must specify a name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_name', - ], - 'SrcAddress' => [ - 'title' => '', - 'description' => 'The name of the source data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_src_address', - ], - 'DestAddress' => [ - 'title' => '', - 'description' => 'The name of the destination data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test_dest_address', - ], - 'OverwriteMode' => [ - 'title' => '', - 'description' => 'The file overwriting mode.\\'."\n" - .'Valid values: never and always.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'always', - ], - 'TransferMode' => [ - 'title' => '', - 'description' => 'The file transfer mode.\\'."\n" - .'Valid values: all and lastmodified. all: transfers the full data of files. lastmodified: transfers the incremental data of files.\\'."\n" - .'Valid values if OverwriteMode and TransferMode are used together:'."\n" - ."\n" - .'* A combination of always and all indicates that all files are forcefully overwritten.'."\n" - .'* A combination of always and lastmodified indicates that files are overwritten based on the last modification time.'."\n" - .'* A combination of never and all indicates that the files with the same name are not overwritten.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'all', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags in the key:value format.\\'."\n" - .'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'K1:V1,K2:V2', - ], - 'ParentVersion' => [ - 'title' => '', - 'description' => 'The ID of the parent task. When you create a subtask to migrate a file that failed to be migrated, you can specify the ID of the parent task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '6af62558-970d-4f44-8663-4e297170fd6a', - ], - 'ConvertSymlinkTarget' => [ - 'title' => '', - 'description' => 'Indicates whether the Target attribute value of the symbolic links at the source data address is converted. You can convert the Target attribute value of the symbolic links at the source data address in one of the following scenarios: The source data address is an Object Storage Service (OSS) data address and the destination data address is a local data address. The source data address is a local data address and the destination data address is an OSS data address. The source data address is a local data address and the destination data address is another local data address. This ensures that the symbolic links at the destination data address can point to their objects as expected.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Audit' => [ - 'title' => '', - 'description' => 'The audit method.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/Audit', - ], - 'EnableMultiVersioning' => [ - 'title' => '', - 'description' => 'Specifies whether to enable multi-version migration. Multi-version migration is not supported.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'FilterRule' => [ - 'title' => '', - 'description' => 'The filtering rule.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/FilterRule', - ], - 'ImportQos' => [ - 'title' => '', - 'description' => 'The throttling settings of the task.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/ImportQos', - ], - 'ScheduleRule' => [ - 'title' => '', - 'description' => 'The scheduling rule.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/ScheduleRule', - ], - 'CreateReport' => [ - 'title' => '', - 'description' => 'Specifies whether to create a migration report.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Name' => ['title' => '任务名称。取值：英文小写字母、数字和特殊字符-和_，最短 3 字符， 最长 63 个字符，区分大小写，utf8 编码并且不可以- 和_开头，不能为空。', 'description' => 'The task name.<br>'."\n" + .'The name must be 3 to 63 characters in length and can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name is case-sensitive and must be UTF-8 encoded. It cannot start with a hyphen (-) or an underscore (\\_). This parameter cannot be empty.<br>', 'type' => 'string', 'required' => true, 'example' => 'test_name'], + 'SrcAddress' => ['title' => '源数据地址名称。', 'description' => 'The name of the source data address.', 'type' => 'string', 'required' => true, 'example' => 'test_src_address'], + 'DestAddress' => ['title' => '目的数据地址名称。', 'description' => 'The name of the destination data address.', 'type' => 'string', 'required' => true, 'example' => 'test_dest_address'], + 'OverwriteMode' => ['title' => '文件覆盖方式。取值：never，不覆盖；always，覆盖；', 'description' => 'The file overwrite mode.<br>'."\n" + .'Valid values: \\`never\\` and \\`always\\`. \\`never\\`: Does not overwrite existing files. \\`always\\`: Overwrites existing files.<br>', 'type' => 'string', 'required' => true, 'example' => 'always'], + 'TransferMode' => ['title' => '文件传输方式。取值：all，强制覆盖；lastmodified，根据最后修改时间覆盖。 OverwriteMode与TransferMode结合使用，分别设置： always，all：强制覆盖 always, lastmodified：根据文件最后修改时间覆盖 never，all：不覆盖。', 'description' => 'The file transfer mode.<br>'."\n" + .'Valid values: \\`all\\` (full transfer) and \\`lastmodified\\` (incremental transfer).<br>'."\n" + .'\\`OverwriteMode\\` and \\`TransferMode\\` are used together:<br><br>'."\n" + ."\n" + .'- \\`always\\` and \\`all\\`: Forces a full overwrite.'."\n" + ."\n" + .'- \\`always\\` and \\`lastmodified\\`: Overwrites files based on their last modified time.'."\n" + ."\n" + .'- \\`never\\` and an empty value for \\`TransferMode\\`: Does not overwrite files with the same name.', 'type' => 'string', 'required' => true, 'example' => 'all'], + 'Tags' => ['title' => '标签，KeyValue格式。 允许字符：英文大小写字母、数字和特殊字符-_,。长度限制：1KB。', 'description' => 'The tags, in key-value format.<br>'."\n" + .'Allowed characters include uppercase and lowercase letters, digits, hyphens (-), and underscores (\\_). The maximum length is 1024 characters.<br>', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], + 'ParentVersion' => ['title' => '父任务ID。创建失败文件重试子任务时可以指定父任务ID。', 'description' => 'The parent task ID. Specify this ID when you create a subtask to retry failed file transfers.', 'type' => 'string', 'example' => '6af62558-970d-4f44-8663-4e297170fd6a'], + 'ConvertSymlinkTarget' => ['title' => '是否转换软链接Target。当源和目的数据地址是oss到local，local到oss，local到local时，可以指定转换软链接Target，使得迁移后的软链接能够正常访问。', 'description' => 'Specifies whether to transform the target of a symbolic link. When migrating data from OSS to a local server, from a local server to OSS, or between two local servers, set this parameter to \\`true\\` to ensure that symbolic links can be accessed after migration.', 'type' => 'boolean', 'example' => 'false'], + 'Audit' => ['title' => '审计方式。', 'description' => 'The audit method.', '$ref' => '#/components/schemas/Audit', 'example' => ''], + 'EnableMultiVersioning' => ['title' => '是否迁移多版本。暂不支持多版本迁移。', 'description' => 'Specifies whether to migrate multiple object versions. Multi-version migration is not supported.', 'type' => 'boolean', 'example' => 'false'], + 'FilterRule' => ['title' => '过滤规则。', 'description' => 'The filter rule.', '$ref' => '#/components/schemas/FilterRule', 'example' => ''], + 'ImportQos' => ['title' => '任务限流。', 'description' => 'The task throttling settings.', '$ref' => '#/components/schemas/ImportQos', 'example' => ''], + 'ScheduleRule' => ['title' => '调度规则。', 'description' => 'The scheduling rule.', '$ref' => '#/components/schemas/ScheduleRule', 'example' => ''], + 'CreateReport' => ['title' => '是否创建迁移报告。', 'description' => 'Specifies whether to create a migration report.', 'type' => 'boolean', 'example' => 'true'], + 'WithStorageClass' => ['description' => 'Specifies whether to migrate the StorageClass property. This is allowed only for OSS-to-OSS migration.', 'title' => '是否迁移StorageClass属性，只允许oss->oss', 'type' => 'boolean', 'example' => 'false'], + 'TargetStorageClass' => ['description' => 'Specifies the StorageClass for destination files. The destination address can only be OSS. Valid values: Standard, IA, Archive, ColdArchive, DeepColdArchive.', 'title' => '指定设置目的文件的storageClass，目的地址只能是oss。 合法值：Standard IA Archive ColdArchive DeepColdArchive', 'type' => 'string', 'example' => 'Standard'], + 'WithLastModifyTime' => ['description' => 'Specifies whether to preserve the lastModifyTime. Default value: true.', 'title' => '是否保留lastModifyTime，默认true', 'type' => 'boolean', 'example' => 'true'], + 'AppendableToNormal' => ['description' => 'Specifies whether to migrate appendable files as normal or multipart files. Default value: false.', 'title' => '是否把appendable文件迁成normal/multipart文件，默认false', 'type' => 'boolean', 'example' => 'false'], + ], + 'example' => '', ], 'CreateReportInfo' => [ - 'title' => '', + 'title' => '创建迁移报告详情。', 'description' => 'The information about the migration report.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'JobName' => [ - 'title' => '', - 'description' => 'The task name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_job_name', - ], - 'Version' => [ - 'title' => '', - 'description' => 'The task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_job_id', - ], - 'RuntimeId' => [ - 'title' => '', - 'description' => 'The execution ID of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'JobName' => ['title' => '任务名称。', 'description' => 'The task name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_job_name'], + 'Version' => ['title' => '任务ID。', 'description' => 'The task ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_job_id'], + 'RuntimeId' => ['title' => '任务执行ID。', 'description' => 'The execution ID of the task.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], 'CreateTunnelInfo' => [ - 'title' => '', + 'title' => '创建通道详情。', 'description' => 'The information about the tunnel.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'TunnelQos' => [ - 'title' => '', - 'description' => 'The throttling settings of the tunnel.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/TunnelQos', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags in the key:value format.\\'."\n" - .'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'a:a', - ], + 'TunnelQos' => ['title' => '通道限流。', 'description' => 'The throttling settings of the tunnel.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/TunnelQos'], + 'Tags' => ['title' => '标签，KeyValue格式。 允许字符：英文大小写字母、数字和特殊字符-_,。长度限制：1KB。', 'description' => 'The tags in the key:value format.\\'."\n" + .'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'a:a'], ], 'required' => false, ], 'Excludes' => [ 'title' => 'A short description of struct', - 'description' => '', + 'description' => '排除过滤器', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ @@ -474,717 +168,231 @@ 'description' => 'timeFilter', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TimeFilter', - ], + 'items' => ['visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TimeFilter'], ], 'Regex' => [ 'title' => 'regex', 'description' => 'regex', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], + 'items' => ['visibility' => 'Public', 'type' => 'string', 'extendType' => 'true'], ], ], ], 'FileTypeFilters' => [ - 'title' => 'A short description of struct', + 'title' => '文件类型过滤器。', 'description' => 'The filter based on the file type.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ExcludeSymlink' => [ - 'title' => '', - 'description' => 'Specifies whether to filter out symbolic links.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'fasle', - ], - 'ExcludeDir' => [ - 'title' => '', - 'description' => 'Specifies whether to filter out files in directories.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'fasle', - ], + 'ExcludeSymlink' => ['title' => '过滤软链接。', 'description' => 'Specifies whether to filter out symbolic links.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'fasle'], + 'ExcludeDir' => ['title' => '过滤目录文件。', 'description' => 'Specifies whether to filter out files in directories.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'fasle'], ], ], 'FilterRule' => [ - 'title' => 'A short description of struct', + 'title' => '过滤规则。', 'description' => 'The filtering rule.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'KeyFilters' => [ - 'title' => '', - 'description' => 'The filter based on the file name.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/KeyFilters', - ], - 'LastModifiedFilters' => [ - 'title' => '', - 'description' => 'The filter based on the file modification time.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/LastModifiedFilters', - ], - 'FileTypeFilters' => [ - 'title' => '', - 'description' => 'The filter based on the file type.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/FileTypeFilters', - ], + 'KeyFilters' => ['title' => '文件名过滤器。', 'description' => 'The filter based on the file name.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/KeyFilters'], + 'LastModifiedFilters' => ['title' => '文件修改时间过滤器。', 'description' => 'The filter based on the file modification time.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/LastModifiedFilters'], + 'FileTypeFilters' => ['title' => '文件类型过滤器。', 'description' => 'The filter based on the file type.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/FileTypeFilters'], ], ], 'GetAddressResp' => [ - 'title' => '', + 'title' => '获取数据地址详情。', 'description' => 'The queried data address.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Owner' => [ - 'title' => '', - 'description' => 'The owner of the data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_owner', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_name', - ], - 'AddressDetail' => [ - 'title' => '', - 'description' => 'The details of the data address.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/AddressDetail', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the data address was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'The time when the data address was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'VerifyTime' => [ - 'title' => '', - 'description' => 'The time when the data address was verified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'Version' => [ - 'title' => '', - 'description' => 'The ID of the data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_id', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'K1:V1,K2:V2', - ], + 'Owner' => ['title' => '数据地址拥有者。', 'description' => 'The owner of the data address.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_owner'], + 'Name' => ['title' => '数据地址名称。', 'description' => 'The name of the data address.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_name'], + 'AddressDetail' => ['title' => '数据地址详情。', 'description' => 'The details of the data address.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/AddressDetail'], + 'CreateTime' => ['title' => '创建时间', 'description' => 'The time when the data address was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01 12:00:00'], + 'ModifyTime' => ['title' => '修改时间。', 'description' => 'The time when the data address was last modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01 12:00:00'], + 'VerifyTime' => ['title' => '数据地址校验时间。', 'description' => 'The time when the data address was verified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01 12:00:00'], + 'Version' => ['title' => '数据地址ID', 'description' => 'The ID of the data address.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_id'], + 'Tags' => ['title' => '标签。', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], 'Status' => [ - 'title' => '', + 'title' => '数据地址状态。', 'description' => 'The state of the data address.'."\n", 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'unavailable' => 'unavailable', - 'available' => 'available', - 'notVerify' => 'notVerify', - ], + 'enumValueTitles' => ['unavailable' => 'unavailable', 'available' => 'available', 'notVerify' => 'notVerify'], 'example' => 'avaliable', ], - 'VerifyResult' => [ - 'title' => '', - 'description' => 'The verification result of the data address.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/VerifyResp', - ], + 'VerifyResult' => ['title' => '数据地址校验结果。', 'description' => 'The verification result of the data address.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/VerifyResp'], ], ], 'GetAgentResp' => [ - 'title' => '', + 'title' => '获取代理详情。', 'description' => 'The queried agent.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Owner' => [ - 'title' => '', - 'description' => 'The agent owner.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_owner', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The agent name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_name', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the agent was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01T12:00:00.000Z', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'The time when the agent was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01T12:00:00.000Z', - ], - 'DeployMethod' => [ - 'title' => '', - 'description' => 'The deployment mode of the agent.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default', - ], - 'AgentEndpoint' => [ - 'title' => '', - 'description' => 'The method that is used to access the agent.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc', - ], - 'ActivationKey' => [ - 'title' => '', - 'description' => 'The security code of the agent.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '6af62558-970d-4f44-8663-4e297170fd6a', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'K1:V1,K2:V2', - ], - 'Version' => [ - 'title' => '', - 'description' => 'The agent ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_agent_id', - ], - 'TunnelId' => [ - 'title' => '', - 'description' => 'The tunnel ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_tunnel_id', - ], + 'Owner' => ['title' => '代理拥有者。', 'description' => 'The agent owner.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_owner'], + 'Name' => ['title' => '代理名称。', 'description' => 'The agent name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_name'], + 'CreateTime' => ['title' => '创建时间', 'description' => 'The time when the agent was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'ModifyTime' => ['title' => '修改时间', 'description' => 'The time when the agent was last modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'DeployMethod' => ['title' => '代理部署方式。', 'description' => 'The deployment mode of the agent.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'default'], + 'AgentEndpoint' => ['title' => '代理访问方式。', 'description' => 'The method that is used to access the agent.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'vpc'], + 'ActivationKey' => ['title' => '代理安全码。', 'description' => 'The security code of the agent.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '6af62558-970d-4f44-8663-4e297170fd6a'], + 'Tags' => ['title' => '标记。', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], + 'Version' => ['title' => '代理ID。', 'description' => 'The agent ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_agent_id'], + 'TunnelId' => ['title' => '通道ID。', 'description' => 'The tunnel ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_tunnel_id'], ], ], 'GetAgentStatusResp' => [ - 'title' => '', + 'title' => '获取代理状态详情。', 'description' => 'The queried state of the agent.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '', - 'description' => 'The agent state.\\'."\n" - .'Valid values: OK, Disconnected, and NoResponse.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OK', - ], + 'Status' => ['title' => '代理状态。取值：OK，Disconnected，NoResponse。', 'description' => 'The agent state.\\'."\n" + .'Valid values: OK, Disconnected, and NoResponse.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'OK'], ], 'parseType' => 'struct', ], 'GetJobResp' => [ - 'title' => '', - 'description' => 'The task details.'."\n", - 'visibility' => 'Public', + 'title' => '任务详情。', + 'description' => 'The details of the job.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '', - 'description' => 'The task name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_name', - ], - 'SrcAddress' => [ - 'title' => '', - 'description' => 'The name of the source data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_src_address', - ], - 'DestAddress' => [ - 'title' => '', - 'description' => 'The name of the destination data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_dest_address', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The task state. Valid values:'."\n" - ."\n" - .'IMPORT_JOB_BEGIN: The task is created.'."\n" - ."\n" - .'IMPORT_JOB_LAUNCHING: The task is being started.'."\n" - ."\n" - .'IMPORT_JOB_PREPARING: The system is preparing for the task.'."\n" - ."\n" - .'IMPORT_JOB_DOING: The task is running.'."\n" - ."\n" - .'IMPORT_JOB_SUSPEND: The task is paused.'."\n" - ."\n" - .'IMPORT_JOB_CLOSING: The task is being closed.'."\n" - ."\n" - .'IMPORT_JOB_FINISHED: The task is complete.'."\n" - ."\n" - .'IMPORT_JOB_INTERRUPTED: The task is abnormally interrupted.'."\n" - ."\n" - .'IMPORT_JOB_CONFIRMED: The task is complete and the user has confirmed the data integrity and consistency.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'IMPORT_JOB_DOING', - ], - 'EnableMultiVersioning' => [ - 'title' => '', - 'description' => 'Indicates whether multi-version migration is enabled.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the task was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'The time when the task was modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'Version' => [ - 'title' => '', - 'description' => 'The task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_id', - ], - 'Audit' => [ - 'title' => '', - 'description' => 'The audit method.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/Audit', - ], - 'OverwriteMode' => [ - 'title' => '', - 'description' => 'The file overwriting mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'always', - ], - 'TransferMode' => [ - 'title' => '', - 'description' => 'The file transfer mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'all', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'K1:V1,K2:V2', - ], - 'ParentName' => [ - 'title' => '', - 'description' => 'The name of the parent task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_parent_name', - ], - 'ParentVersion' => [ - 'title' => '', - 'description' => 'The ID of the parent task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '7db93837-a5ee-4e3a-b3c8-800e7947dabc', - ], - 'ConvertSymlinkTarget' => [ - 'title' => '', - 'description' => 'Indicates whether the Target attribute value of the symbolic links at the source data address is converted.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateReport' => [ - 'title' => '', - 'description' => 'Indicates whether a migration report is created.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Owner' => [ - 'title' => '', - 'description' => 'The task owner.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_owner', - ], - 'FilterRule' => [ - 'title' => '', - 'description' => 'The filtering rule.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/FilterRule', - ], - 'ImportQos' => [ - 'title' => '', - 'description' => 'The throttling settings of the task.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/ImportQos', - ], - 'ScheduleRule' => [ - 'title' => '', - 'description' => 'The scheduling rule.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/ScheduleRule', - ], - ], + 'Name' => ['title' => '任务名称。', 'description' => 'The name of the job.', 'type' => 'string', 'example' => 'test_name'], + 'SrcAddress' => ['title' => '源数据地址名称。', 'description' => 'The name of the source data address.', 'type' => 'string', 'example' => 'test_src_address'], + 'DestAddress' => ['title' => '目的数据地址名称。', 'description' => 'The name of the destination data address.', 'type' => 'string', 'example' => 'test_dest_address'], + 'Status' => ['title' => '任务状态。', 'description' => 'The status of the job.'."\n" + ."\n" + .'IMPORT\\_JOB\\_BEGIN: The job is created.'."\n" + ."\n" + .'IMPORT\\_JOB\\_LAUNCHING: The job is starting.'."\n" + ."\n" + .'IMPORT\\_JOB\\_PREPARING: The job is preparing.'."\n" + ."\n" + .'IMPORT\\_JOB\\_DOING: The job is running.'."\n" + ."\n" + .'IMPORT\\_JOB\\_SUSPEND: The job is paused.'."\n" + ."\n" + .'IMPORT\\_JOB\\_CLOSING: The job is shutting down.'."\n" + ."\n" + .'IMPORT\\_JOB\\_FINISHED: The job is finished.'."\n" + ."\n" + .'IMPORT\\_JOB\\_INTERRUPTED: The job is abnormally interrupted.'."\n" + ."\n" + .'IMPORT\\_JOB\\_CONFIRMED: The migration is complete, and the user has confirmed data integrity and consistency.'."\n" + ."\n" + .'IMPORT\\_JOB\\_DELETING: The job is being deleted.', 'type' => 'string', 'example' => 'IMPORT_JOB_DOING'], + 'EnableMultiVersioning' => ['title' => '是否开启多版本。', 'description' => 'Indicates whether multi-versioning is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'CreateTime' => ['title' => '任务创建时间。', 'description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'ModifyTime' => ['title' => '任务修改时间。', 'description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'Version' => ['title' => '任务ID。', 'description' => 'The ID of the job.', 'type' => 'string', 'example' => 'test_id'], + 'Audit' => ['title' => '审计方式。', 'description' => 'The audit method.', '$ref' => '#/components/schemas/Audit', 'example' => ''], + 'OverwriteMode' => ['title' => '文件覆盖方式。', 'description' => 'The file overwrite mode.', 'type' => 'string', 'example' => 'always'], + 'TransferMode' => ['title' => '文件传输方式。', 'description' => 'The file transfer mode.', 'type' => 'string', 'example' => 'all'], + 'Tags' => ['title' => '标记。', 'description' => 'The tags.', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], + 'ParentName' => ['title' => '父任务名称，非重试任务该。值为空', 'description' => 'The name of the parent job.', 'type' => 'string', 'example' => 'test_parent_name'], + 'ParentVersion' => ['title' => '父任务ID，非重试任务该值为空', 'description' => 'The ID of the parent job.', 'type' => 'string', 'example' => '7db93837-a5ee-4e3a-b3c8-800e7947dabc'], + 'ConvertSymlinkTarget' => ['title' => '是否转换软链接Target。', 'description' => 'Indicates whether to convert the target of the symbolic link.', 'type' => 'boolean', 'example' => 'false'], + 'CreateReport' => ['title' => '是否生成迁移报告。', 'description' => 'Indicates whether to generate a migration report.', 'type' => 'boolean', 'example' => 'false'], + 'Owner' => ['title' => '拥有者，即迁移服务控制台主账号', 'description' => 'The owner.', 'type' => 'string', 'example' => 'test_owner'], + 'FilterRule' => ['title' => '过滤规则。', 'description' => 'The filter rule.', '$ref' => '#/components/schemas/FilterRule', 'example' => ''], + 'ImportQos' => ['title' => '任务限流。', 'description' => 'The rate limiting rule for the job.', '$ref' => '#/components/schemas/ImportQos', 'example' => ''], + 'ScheduleRule' => ['title' => '调度规则。', 'description' => 'The scheduling rule.', '$ref' => '#/components/schemas/ScheduleRule', 'example' => ''], + 'WithStorageClass' => ['title' => '是否迁移StorageClass属性，只允许oss->oss。', 'description' => 'Specifies whether to migrate the StorageClass property. This is allowed only for migrations from OSS to OSS.', 'type' => 'boolean', 'example' => 'false'], + 'TargetStorageClass' => ['title' => '指定设置目的文件的storageClass，目的地址只能是oss。 合法值：Standard IA Archive ColdArchive DeepColdArchive。', 'description' => 'Specifies the StorageClass of the destination file. The destination address must be an OSS address. Valid values: Standard, IA, Archive, ColdArchive, and DeepColdArchive.', 'type' => 'string', 'example' => 'Standard'], + 'WithLastModifyTime' => ['title' => '是否保留lastModifyTime，默认true', 'description' => 'Specifies whether to retain the lastModifyTime property. The default value is true.', 'type' => 'boolean', 'example' => 'true'], + 'AppendableToNormal' => ['title' => '是否把appendable文件迁成normal/multipart文件，默认false', 'description' => 'Specifies whether to migrate appendable files as normal or multipart files. The default value is false.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], 'GetJobResultResp' => [ - 'title' => '', - 'description' => 'The retry information about the migration task.'."\n", - 'visibility' => 'Public', + 'title' => '任务重试信息详情。', + 'description' => 'The results of a migration job, including retry information for failed files and migration statistics.', 'type' => 'object', 'properties' => [ - 'ReadyRetry' => [ - 'title' => '', - 'description' => 'Indicates whether the files that failed to be migrated can be migrated again.\\'."\n" - .'Valid values: NoNeed, Ready, and NotReady.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Ready', - ], - 'InvPath' => [ - 'title' => '', - 'description' => 'The inventory list of files that failed to be migrated. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mainfest.json', - ], - 'InvBucket' => [ - 'title' => '', - 'description' => 'The name of the bucket in which the inventory list of files that failed to be migrated resides. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_sys_bucket', - ], - 'InvDomain' => [ - 'title' => '', - 'description' => 'The domain name of the bucket in which the inventory list of files that failed to be migrated resides. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_domain', - ], - 'InvLocation' => [ - 'title' => '', - 'description' => 'The type of the bucket in which the inventory list of files that failed to be migrated resides. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss', - ], - 'InvAccessId' => [ - 'title' => '', - 'description' => 'The AccessKey ID that is used to access the bucket in which the inventory list of files that failed to be migrated resides. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_access_id', - ], - 'InvAccessSecret' => [ - 'title' => '', - 'description' => 'The AccessKey secret that is used to access the bucket in which the inventory list of files that failed to be migrated resides. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_secret_key', - ], - 'InvRegionId' => [ - 'title' => '', - 'description' => 'The region ID of the bucket in which the inventory list of files that failed to be migrated resides. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_region_id', - ], - 'AddressType' => [ - 'title' => '', - 'description' => 'The type of the data address created based on the files that failed to be migrated. This parameter is required if you create a data address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ossinv', - ], - 'TotalObjectCount' => [ - 'title' => '', - 'description' => 'The total number of files.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'CopiedObjectCount' => [ - 'title' => '', - 'description' => 'The number of files that are migrated. The number includes the number of files that are successfully migrated and the number of files that are skipped.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - ], - 'FailedObjectCount' => [ - 'title' => '', - 'description' => 'The number of files that failed to be migrated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'TotalObjectSize' => [ - 'title' => '', - 'description' => 'The total data size of files.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'CopiedObjectSize' => [ - 'title' => '', - 'description' => 'The data size of files that are migrated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - ], - 'Version' => [ - 'title' => '', - 'description' => 'The task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_job_id', - ], - ], + 'ReadyRetry' => ['title' => '失败文件是否可重试。取值：NoNeed，无需重试；Ready，失败文件列表准备完成；NotReady，失败文件列表准备中。', 'description' => 'The retry readiness status for failed files. Valid values: NoNeed indicates that all files were migrated successfully and no retry is required. Ready indicates that the failed file list has been generated and is available for retry. NotReady indicates that the failed file list is being generated.<br><br>', 'type' => 'string', 'example' => 'Ready'], + 'InvPath' => ['title' => '失败文件列表清单文件。构造新的数据地址时，填入InvPath字段。', 'description' => 'The path to the manifest file that lists the failed files. Use this value as the InvPath parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'mainfest.json'], + 'InvBucket' => ['title' => '失败文件列表存储空间。构造新的数据地址时，填入InvBucket字段。', 'description' => 'The name of the bucket that stores the failed file list. Use this value as the InvBucket parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_sys_bucket'], + 'InvDomain' => ['title' => '失败文件列表存储空间域名。构造新的数据地址时，填入InvDomain字段。', 'description' => 'The endpoint of the bucket that stores the failed file list. Use this value as the InvDomain parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_domain'], + 'InvLocation' => ['title' => '失败文件列表存储空间类型。构造新的数据地址时，填入InvLocation字段。', 'description' => 'The storage type of the bucket that stores the failed file list, such as oss. Use this value as the InvLocation parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'oss'], + 'InvAccessId' => ['title' => '失败文件列表存储空间的AccessKeyId。构造新的数据地址时，填入InvAccessId字段。', 'description' => 'The AccessKey ID that is used to access the bucket where the failed file list is stored. Use this value as the InvAccessId parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_access_id'], + 'InvAccessSecret' => ['title' => '失败文件列表存储空间的SecretAccessKey。构造新的数据地址时，填入InvAccessSecret字段。', 'description' => 'The AccessKey secret that is used to access the bucket where the failed file list is stored. Use this value as the InvAccessSecret parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_secret_key'], + 'InvRegionId' => ['title' => '失败文件存储空间区域。构造新的数据地址时，填入InvRegionId字段。', 'description' => 'The region ID of the bucket that stores the failed file list. Use this value as the InvRegionId parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_region_id'], + 'AddressType' => ['title' => '根据失败文件列表构造的地址类型。构造新的数据地址时，填入AddressType字段。', 'description' => 'The data address type for the retry job. This value indicates that the data address is constructed from a failed file inventory. Use this value as the AddressType parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'ossinv'], + 'TotalObjectCount' => ['title' => '总文件数量。', 'description' => 'The total number of objects in the source data address.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'CopiedObjectCount' => ['title' => '迁移成功的文件数量。包括成功和跳过的文件。', 'description' => 'The number of objects that were processed successfully. This value includes both migrated objects and skipped objects.', 'type' => 'integer', 'format' => 'int64', 'example' => '800'], + 'FailedObjectCount' => ['title' => '迁移失败的文件数量。', 'description' => 'The number of objects that failed to migrate.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'TotalObjectSize' => ['title' => '文件总数据量。', 'description' => 'The total size of all objects in the source data address. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'CopiedObjectSize' => ['title' => '迁移成功的文件数据量。', 'description' => 'The total size of objects that were processed successfully. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '800'], + 'Version' => ['title' => '任务ID。', 'description' => 'The unique identifier of the migration job.', 'type' => 'string', 'example' => 'test_job_id'], + 'SkippedObjectCount' => ['title' => '跳过的文件数量。', 'description' => 'The number of objects that were skipped during migration. Objects are skipped when they already exist at the destination and meet the configured skip conditions.', 'type' => 'integer', 'example' => '5000', 'format' => 'int64'], + 'SkippedObjectSize' => ['title' => '跳过的文件size。', 'description' => 'The total size of objects that were skipped during migration. Unit: bytes.', 'type' => 'integer', 'example' => '1000000', 'format' => 'int64'], + ], + 'example' => '', ], 'GetReportResp' => [ - 'title' => '', + 'title' => '迁移报告详情。', 'description' => 'The queried migration report.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '', - 'description' => 'The state of the migration report.\\'."\n" - .'Valid values: Running, NotExist, Finished, and Failed.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - ], - 'ReportCreateTime' => [ - 'title' => '', - 'description' => 'The time when the migration report was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'ReportEndTime' => [ - 'title' => '', - 'description' => 'The time when the migration report was generated.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'TotalCount' => [ - 'title' => '', - 'description' => 'The total number of files.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'CopiedCount' => [ - 'title' => '', - 'description' => 'The number of files that are migrated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - ], - 'SkippedCount' => [ - 'title' => '', - 'description' => 'The number of files that are skipped.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'FailedCount' => [ - 'title' => '', - 'description' => 'The number of files that failed to be migrated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'JobCreateTime' => [ - 'title' => '', - 'description' => 'The time when the task was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'JobEndTime' => [ - 'title' => '', - 'description' => 'The time when the task ended.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'JobExecuteTime' => [ - 'title' => '', - 'description' => 'The task duration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1000', - ], - 'TotalListPrefix' => [ - 'title' => '', - 'description' => 'The path of files.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_total_prefix/', - ], - 'SkippedListPrefix' => [ - 'title' => '', - 'description' => 'The path of files that are skipped.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_skipped_prefix/', - ], - 'FailedListPrefix' => [ - 'title' => '', - 'description' => 'The path of files that failed to be migrated.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_failed_prefix/', - ], - 'ErrorMessage' => [ - 'title' => '', - 'description' => 'The error message.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test error msg.', - ], - ], + 'Status' => ['title' => '迁移报告状态。取值：Running，生成中；NotExist，不存在；Finished，生成完成；Failed，生成失败。', 'description' => 'The state of the migration report.\\'."\n" + .'Valid values: Running, NotExist, Finished, and Failed.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running'], + 'ReportCreateTime' => ['title' => '迁移报告创建时间。', 'description' => 'The time when the migration report was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'ReportEndTime' => ['title' => '迁移报告生成结束时间。', 'description' => 'The time when the migration report was generated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'TotalCount' => ['title' => '迁移文件总数量。', 'description' => 'The total number of files.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'CopiedCount' => ['title' => '迁移文件成功数量。', 'description' => 'The number of files that are migrated.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '800'], + 'SkippedCount' => ['title' => '迁移文件跳过数量。', 'description' => 'The number of files that are skipped.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'FailedCount' => ['title' => '迁移文件失败数量。', 'description' => 'The number of files that failed to be migrated.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'JobCreateTime' => ['title' => '任务创建时间。', 'description' => 'The time when the task was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'JobEndTime' => ['title' => '任务结束时间。', 'description' => 'The time when the task ended.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'JobExecuteTime' => ['title' => '任务执行时间。', 'description' => 'The task duration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '1000s'], + 'TotalListPrefix' => ['title' => '文件列表所在位置。', 'description' => 'The path of files.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_total_prefix/'], + 'SkippedListPrefix' => ['title' => '跳过文件列表所在位置。', 'description' => 'The path of files that are skipped.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_skipped_prefix/'], + 'FailedListPrefix' => ['title' => '失败文件列表所在位置。', 'description' => 'The path of files that failed to be migrated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_failed_prefix/'], + 'ErrorMessage' => ['title' => '异常信息。', 'description' => 'The error message.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test error msg.'], + ], + 'example' => '', ], 'GetTunnelResp' => [ - 'title' => '', + 'title' => '获取通道详情。', 'description' => 'The queried tunnel.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Owner' => [ - 'title' => '', - 'description' => 'The tunnel owner.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_owner', - ], - 'TunnelId' => [ - 'title' => '', - 'description' => 'The tunnel ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_tunnel_id', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the tunnel was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'The time when the tunnel was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'key1:value1,key2:value2', - ], - 'TunnelQos' => [ - 'title' => '', - 'description' => 'The throttling settings of the tunnel.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/TunnelQos', - ], + 'Owner' => ['title' => '通道拥有者。', 'description' => 'The tunnel owner.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_owner'], + 'TunnelId' => ['title' => '通道ID。', 'description' => 'The tunnel ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_tunnel_id'], + 'CreateTime' => ['title' => '创建时间。', 'description' => 'The time when the tunnel was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'ModifyTime' => ['title' => '修改时间。', 'description' => 'The time when the tunnel was last modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'Tags' => ['title' => '标签。', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], + 'TunnelQos' => ['title' => '通道限流。', 'description' => 'The throttling settings of the tunnel.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/TunnelQos', 'example' => ''], ], + 'example' => '', ], - 'ImportQos' => [ + 'HdfsAuthConfig' => [ + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => 'The username for HDFS authentication.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AuthType' => ['description' => 'The authentication type for HDFS.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'Authentication configuration for HDFS.', 'title' => '', + 'example' => '', + ], + 'ImportQos' => [ + 'title' => '任务限流。', 'description' => 'The throttling settings of the task.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'MaxBandWidth' => [ - 'title' => '', - 'description' => 'The maximum bandwidth. Unit: bit/s.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1073741824', - ], - 'MaxImportTaskQps' => [ - 'title' => 'QPS', - 'description' => 'The number of files that are migrated per second.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], + 'MaxBandWidth' => ['title' => '带宽，单位bit/s。', 'description' => 'The maximum bandwidth. Unit: bit/s.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824'], + 'MaxImportTaskQps' => ['title' => '每秒迁移文件数。', 'description' => 'The number of files that are migrated per second.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], ], ], 'Includes' => [ 'title' => 'A short description of struct', - 'description' => '', + 'description' => '包含过滤器。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ @@ -1193,459 +401,231 @@ 'description' => 'timeFilter', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TimeFilter', - ], + 'items' => ['visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TimeFilter', 'description' => '最后修改时间过滤器。'], ], 'Regex' => [ 'title' => 'regex match', 'description' => 'regex match', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], + 'items' => ['visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'description' => '文件名正则表达式。'], ], ], ], 'JobHistory' => [ - 'title' => '', - 'description' => 'The execution history of the migration task.'."\n", - 'visibility' => 'Public', + 'title' => '任务运行历史。', + 'description' => 'The details of the job run history.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '', - 'description' => 'The task name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_name', - ], - 'JobVersion' => [ - 'title' => '', - 'description' => 'The task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_id', - ], - 'RuntimeId' => [ - 'title' => '', - 'description' => 'The execution ID of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - ], - 'CommitId' => [ - 'title' => '', - 'description' => 'The ID of the task status change.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - ], - 'StartTime' => [ - 'title' => '', - 'description' => 'The time when the current state started.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'EndTime' => [ - 'title' => '', - 'description' => 'The time when the current state ended.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01 12:00:00', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The task state.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'IMPORT_JOB_DOING', - ], - 'TotalCount' => [ - 'title' => '', - 'description' => 'The total number of files.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - 'default' => '0', - ], - 'CopiedCount' => [ - 'title' => '', - 'description' => 'The number of files that are migrated. The number includes the number of files that are successfully migrated and the number of files that are skipped.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '900', - 'default' => '0', - ], - 'FailedCount' => [ - 'title' => '', - 'description' => 'The number of files that failed to be migrated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'default' => '0', - ], - 'TotalSize' => [ - 'title' => '', - 'description' => 'The total data size of files. Unit: bytes.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - 'default' => '0', - ], - 'CopiedSize' => [ - 'title' => '', - 'description' => 'The data size of files that are migrated. Unit: bytes.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - 'default' => '0', - ], - 'RuntimeState' => [ - 'title' => '', - 'description' => 'The runtime state.\\'."\n" - .'Valid values: Normal and Interrupt.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normal', - ], - 'Message' => [ - 'title' => '', - 'description' => 'The error message.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test error msg.', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The operator.\\'."\n" - .'Valid values: user and system.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user', - ], - 'ListStatus' => [ - 'title' => '', - 'description' => 'The state of data listing.\\'."\n" - .'Valid values: Listing and Finished.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Listing', - ], + 'Name' => ['title' => '任务名称。', 'description' => 'The job name.', 'type' => 'string', 'example' => 'test_name'], + 'JobVersion' => ['title' => '任务ID。', 'description' => 'The job ID.', 'type' => 'string', 'example' => 'test_id'], + 'RuntimeId' => ['title' => '执行记录ID。', 'description' => 'The task execution ID.', 'type' => 'string', 'example' => '1'], + 'CommitId' => ['title' => '状态变更ID。', 'description' => 'The ID of the job status change.', 'type' => 'string', 'example' => '2'], + 'StartTime' => ['title' => '当前状态开始时间。', 'description' => 'The start time of the current status.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'EndTime' => ['title' => '当前状态结束时间。', 'description' => 'The end time of the current status.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'Status' => ['title' => '任务状态。', 'description' => 'The job status.', 'type' => 'string', 'example' => 'IMPORT_JOB_DOING'], + 'TotalCount' => ['title' => '迁移文件总数量。', 'description' => 'The total number of files.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'default' => '0'], + 'CopiedCount' => ['title' => '迁移文件完成数量。', 'description' => 'The number of files whose migration is complete. This includes files that were successfully migrated and files that were skipped.', 'type' => 'integer', 'format' => 'int64', 'example' => '900', 'default' => '0'], + 'FailedCount' => ['title' => '迁移文件失败数量。', 'description' => 'The number of files that failed to be migrated.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'default' => '0'], + 'TotalSize' => ['title' => '迁移文件总Size，单位Byte。', 'description' => 'The total size of the files, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'default' => '0'], + 'CopiedSize' => ['title' => '迁移文件Size，单位Byte。', 'description' => 'The size of the migrated files, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'default' => '0'], + 'RuntimeState' => ['title' => '运行状态。取值：Normal/Interrupt。', 'description' => 'The running status.<br>'."\n" + .'Valid values: \\`Normal\\` (Normal) and \\`Interrupt\\` (Abnormal interruption).<br><br>', 'type' => 'string', 'example' => 'Normal'], + 'Message' => ['title' => '异常信息。', 'description' => 'The exception message.', 'type' => 'string', 'example' => 'test error msg.'], + 'Operator' => ['title' => '操作者。', 'description' => 'The operator.<br>'."\n" + .'Valid values: \\`user\\` and \\`system\\`.<br><br>', 'type' => 'string', 'example' => 'user'], + 'ListStatus' => ['title' => '数据列举状态。取值：Listing，Finished。', 'description' => 'The data listing status.<br>'."\n" + .'Valid values: \\`Listing\\` (Listing in progress) and \\`Finished\\` (Listing complete).<br><br>', 'type' => 'string', 'example' => 'Listing'], + 'SkippedCount' => ['title' => '跳过的文件数', 'description' => 'The number of skipped files.', 'type' => 'integer', 'example' => '1000', 'format' => 'int64'], + 'SkippedSize' => ['title' => '跳过的文件大小', 'description' => 'The size of skipped files.', 'type' => 'integer', 'example' => '100000', 'format' => 'int64'], ], 'required' => false, + 'example' => '', ], 'KeyExcludes' => [ 'title' => 'A short description of struct', - 'description' => '', + 'description' => '排除文件名。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Regex' => [ - 'title' => '', - 'description' => '', + 'title' => '过滤规则', + 'description' => '正则表达式列表。', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], + 'items' => ['description' => '正则表达式。', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true'], ], ], ], 'KeyFilterItem' => [ - 'title' => 'A short description of struct', + 'title' => '文件名过滤项。', 'description' => 'The filter based on the file name.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Regex' => [ - 'title' => '', + 'title' => '正则表达式列表。', 'description' => 'The regular expressions.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The regular expression.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '.*\\.jpg$', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The regular expression.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '.*\\.jpg$', 'extendType' => 'true'], ], ], ], 'KeyFilters' => [ - 'title' => 'A short description of struct', + 'title' => '文件名过滤器。', 'description' => 'The filter based on the file name.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Includes' => [ - 'title' => '', - 'description' => 'The included file name.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/KeyFilterItem', - ], - 'Excludes' => [ - 'title' => '', - 'description' => 'The excluded file name.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/KeyFilterItem', - ], + 'Includes' => ['title' => '包含文件名', 'description' => 'The included file name.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/KeyFilterItem'], + 'Excludes' => ['title' => '排除文件名。', 'description' => 'The excluded file name.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/KeyFilterItem'], ], ], 'KeyIncludes' => [ 'title' => 'A short description of struct', - 'description' => '', + 'description' => '包含文件名。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Regex' => [ - 'title' => '', - 'description' => '', + 'title' => '过滤规则', + 'description' => '正则表达式列表。', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], + 'items' => ['description' => '正则表达式。', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true'], ], ], ], 'LastModifiedFilters' => [ - 'title' => 'A short description of struct', + 'title' => '文件修改时间过滤器。', 'description' => 'The filter based on the file modification time.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Includes' => [ - 'title' => '', - 'description' => 'The included file modification time.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/Includes', - ], - 'Excludes' => [ - 'title' => '', - 'description' => 'The excluded file modification time.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/Excludes', - ], + 'Includes' => ['title' => '包含文件修改时间。', 'description' => 'The included file modification time.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/LastModifyFilterItem'], + 'Excludes' => ['title' => '排除文件修改时间。', 'description' => 'The excluded file modification time.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/LastModifyFilterItem'], ], ], 'LastModifyFilterItem' => [ - 'title' => 'A short description of struct', + 'title' => '文件修改时间过滤项。', 'description' => 'The filter based on the file modification time.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TimeFilter' => [ - 'title' => '', + 'title' => '时间过滤器列表。', 'description' => 'The time filters.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The time filter.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TimeFilter', - ], + 'items' => ['description' => 'The time filter.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TimeFilter'], ], ], ], 'ListAddressResp' => [ - 'title' => '', + 'title' => '数据地址列表详情。', 'description' => 'The queried data addresses.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Truncated' => [ - 'title' => '', - 'description' => 'Indicates whether the queried results are truncated.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NextMarker' => [ - 'title' => '', - 'description' => 'The position from which the next list operation starts.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_marker', - ], + 'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], + 'NextMarker' => ['title' => '下次列举数据地址的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_marker'], 'ImportAddress' => [ - 'title' => '', + 'title' => '数据地址列表。', 'description' => 'The data addresses.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The data address.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/GetAddressResp', - ], + 'items' => ['description' => 'The data address.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetAddressResp', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'ListAgentResp' => [ - 'title' => '', + 'title' => '代理列表详情。', 'description' => 'The queried agents.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Truncated' => [ - 'title' => '', - 'description' => 'Indicates whether the queried results are truncated.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NextMarker' => [ - 'title' => '', - 'description' => 'The position from which the next list operation starts.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_next_marker', - ], + 'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], + 'NextMarker' => ['title' => '下次列举代理的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_next_marker'], 'ImportAgent' => [ - 'title' => '', + 'title' => '代理列表。', 'description' => 'The agents.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The agent.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/GetAgentResp', - ], + 'items' => ['description' => 'The agent.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetAgentResp', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'ListJobHistoryResp' => [ - 'title' => '', + 'title' => '任务运行历史列表详情。', 'description' => 'The execution history of migration tasks.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Truncated' => [ - 'title' => '', - 'description' => 'Indicates whether the queried results are truncated.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - ], - 'NextMarker' => [ - 'title' => '', - 'description' => 'The position from which the next list operation starts.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_next_marker', - ], + 'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'true'], + 'NextMarker' => ['title' => '下次列举任务运行历史的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_next_marker'], 'JobHistory' => [ - 'title' => '', + 'title' => '任务运行历史列表。', 'description' => 'The execution history of migration tasks.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The execution history of the migration task.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/JobHistory', - ], + 'items' => ['description' => 'The execution history of the migration task.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/JobHistory', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'ListJobInfo' => [ - 'title' => '', + 'title' => '任务列表详情。', 'description' => 'The queried tasks.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Truncated' => [ - 'title' => '', - 'description' => 'Indicates whether the queried results are truncated.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NextMarker' => [ - 'title' => '', - 'description' => 'The position from which the next list operation starts.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_next_marker', - ], + 'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], + 'NextMarker' => ['title' => '下次列举任务的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_next_marker'], 'ImportJob' => [ - 'title' => '', + 'title' => '任务列表。', 'description' => 'The tasks.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The task details.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/CreateJobInfo', - ], + 'items' => ['description' => 'The task details.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/CreateJobInfo', 'title' => '', 'example' => ''], + 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'ListJobResp' => [ - 'title' => 'A short description of struct', + 'title' => '任务列表详情。', 'description' => 'The queried tasks.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'NextMarker' => [ - 'title' => '', - 'description' => 'The position from which the next list operation starts.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_nex_marker', - ], - 'Truncated' => [ - 'title' => '', - 'description' => 'Indicates whether the queried results are truncated.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], + 'NextMarker' => ['title' => '下次列举任务的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_nex_marker'], + 'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], 'ImportJob' => [ - 'title' => '', + 'title' => '任务详情列表。', 'description' => 'The queried tasks.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The task details.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/GetJobResp', - ], + 'items' => ['description' => 'The task details.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetJobResp', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'ListTunnelResp' => [ - 'title' => '', + 'title' => '通道列表详情。', 'description' => 'The queried tunnels.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Truncated' => [ - 'title' => '', + 'title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n" ."\n" .'Valid values:'."\n" @@ -1654,167 +634,79 @@ .'* false'."\n", 'visibility' => 'Public', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], - 'NextMarker' => [ - 'title' => '', - 'description' => 'The position from which the next list operation starts.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_marker', - ], + 'NextMarker' => ['title' => '下次列举通道的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_marker'], 'ImportTunnel' => [ - 'title' => '', + 'title' => '通道列表。', 'description' => 'The queried tunnels.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The tunnel details.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/GetTunnelResp', - ], + 'items' => ['description' => 'The tunnel details.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetTunnelResp'], ], ], ], 'ScheduleRule' => [ - 'title' => 'A short description of struct', + 'title' => '调度规则。', 'description' => 'The scheduling rule.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'StartCronExpression' => [ - 'title' => '', - 'description' => 'The time when the migration task started. You can use a CRON expression to specify the time. The interval at which the migration task is run is at least 1 hour.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0 0 * * * ?', - ], - 'SuspendCronExpression' => [ - 'title' => '', - 'description' => 'The time when the migration task paused. You can use a CRON expression to specify the time. The interval at which the migration task is run is at least 1 hour.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0 0 * * * ?', - ], - 'MaxScheduleCount' => [ - 'title' => '', - 'description' => 'The maximum number of times that the migration task is automatically scheduled. Each time the migration task is run, the execution ID increases by one until the task is run the specified number of times. The task is automatically scheduled based on the specified start time and pause time. The task is no longer automatically scheduled after the task is run the specified number of times. However, you can still manually start the task.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'StartCronExpression' => ['title' => '启动时间，Cron表达式，间隔不低于1小时。', 'description' => 'The time when the migration task started. You can use a CRON expression to specify the time. The interval at which the migration task is run is at least 1 hour.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0 0 * * * ?'], + 'SuspendCronExpression' => ['title' => '暂停时间，Cron表达式，间隔不低于1小时。', 'description' => 'The time when the migration task paused. You can use a CRON expression to specify the time. The interval at which the migration task is run is at least 1 hour.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0 0 * * * ?'], + 'MaxScheduleCount' => ['title' => '自动调度轮次限制，任务执行ID在轮次限制内（任务从开始到结束为一轮执行）会根据启动时间和暂停时间自动调度，超过轮次限制不再自动调度，但是依然可以手动执行。', 'description' => 'The maximum number of times that the migration task is automatically scheduled. Each time the migration task is run, the execution ID increases by one until the task is run the specified number of times. The task is automatically scheduled based on the specified start time and pause time. The task is no longer automatically scheduled after the task is run the specified number of times. However, you can still manually start the task.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], 'TimeFilter' => [ - 'title' => 'A short description of struct', + 'title' => '时间过滤器。', 'description' => 'The time filter.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'StartTime' => [ - 'title' => 'start time', - 'description' => 'The time when the migration task started.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2006-01-01T00:00:00Z', - ], - 'EndTime' => [ - 'title' => 'end time', - 'description' => 'The time when the migration task ended.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2006-12-31T59:59:59Z', - ], + 'StartTime' => ['title' => '开始时间。', 'description' => 'The time when the migration task started.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2006-01-01T00:00:00Z'], + 'EndTime' => ['title' => '结束时间。', 'description' => 'The time when the migration task ended.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2006-12-31T59:59:59Z'], ], ], 'TunnelQos' => [ - 'title' => '', + 'title' => '通道限流。', 'description' => 'The throttling settings of the tunnel.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'MaxQps' => [ - 'title' => '', - 'description' => 'The maximum queries per second (QPS) of the tunnel.\\'."\n" - .'Valid values: values greater than or equal to 0. Default value: 0. The default value indicates that the QPS of the tunnel is not limited.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'MaxBandwidth' => [ - 'title' => '', - 'description' => 'The maximum bandwidth of the tunnel. Unit: byte/s.\\'."\n" - .'Valid values: values greater than or equal to 10485760. Default value: 0. The default value indicates that the bandwidth of the tunnel is not limited.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1073741824', - ], + 'MaxQps' => ['title' => '通道的Qps限流，取值大于等于0。默认值是0，表示不受限制。', 'description' => 'The maximum queries per second (QPS) of the tunnel.\\'."\n" + .'Valid values: values greater than or equal to 0. Default value: 0. The default value indicates that the QPS of the tunnel is not limited.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'MaxBandwidth' => ['title' => '通道的带宽限流，单位 Byte/s。 取值：不低于10485760 （10MBps) 。默认值是0，表示不受限制。', 'description' => 'The maximum bandwidth of the tunnel. Unit: byte/s.\\'."\n" + .'Valid values: values greater than or equal to 10485760. Default value: 0. The default value indicates that the bandwidth of the tunnel is not limited.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824'], ], ], 'UpdateAddressInfo' => [ - 'title' => 'A short description of struct', + 'title' => '更新数据地址详情。', 'description' => 'The information about the data address.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'AgentList' => [ - 'title' => '', - 'description' => 'The agents.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'agent1,agent2,agent3', - ], + 'AgentList' => ['title' => '代理列表。', 'description' => 'The agents.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'agent1,agent2,agent3'], ], ], 'UpdateJobInfo' => [ - 'title' => '', - 'description' => 'The information about the migration task.'."\n", - 'visibility' => 'Public', + 'title' => '更新任务详情。', + 'description' => 'The details of the migration job to update.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '', - 'description' => 'The task state.\\'."\n" - .'Valid values: IMPORT_JOB_LAUNCHING, IMPORT_JOB_SUSPEND, and IMPORT_JOB_CLOSING.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'IMPORT_JOB_LAUNCHING', - ], - 'ImportQos' => [ - 'title' => '', - 'description' => 'The throttling settings of the task.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/ImportQos', - ], + 'Status' => ['title' => '任务状态。 取值： IMPORT_JOB_LAUNCHING，启动任务； IMPORT_JOB_SUSPEND，暂停任务； IMPORT_JOB_CLOSING，关闭任务。', 'description' => 'The status of the migration job. Valid values: `IMPORT_JOB_LAUNCHING` (starts the job), `IMPORT_JOB_SUSPEND` (pauses the job), and `IMPORT_JOB_CLOSING` (stops the job).', 'type' => 'string', 'example' => 'IMPORT_JOB_LAUNCHING'], + 'ImportQos' => ['title' => '任务限流。', 'description' => 'The throttling configuration of the migration job.', '$ref' => '#/components/schemas/ImportQos', 'example' => ''], ], + 'example' => '', ], 'UpdateTunnelInfo' => [ - 'title' => '', + 'title' => '更新通道详情。', 'description' => 'The information about the tunnel.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'TunnelQos' => [ - 'title' => '', - 'description' => 'The throttling settings of the tunnel.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/TunnelQos', - ], - 'Tags' => [ - 'title' => '', - 'description' => 'The tags.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'K1:V1,K2:V2', - ], + 'TunnelQos' => ['title' => '通道限流', 'description' => 'The throttling settings of the tunnel.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/TunnelQos'], + 'Tags' => ['title' => '标签', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'], ], ], 'VerifyAddressResp' => [ @@ -1823,106 +715,46 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '数据地址校验状态。', - 'description' => 'The status of the data address verification.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'avaliable', - ], - 'VerifyTime' => [ - 'title' => '数据地址校验时间。', - 'description' => 'The time when the data address is verified.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-01T12:00:00.000Z', - ], - 'ErrorCode' => [ - 'title' => '数据校验错误码。', - 'description' => 'Data verification error code.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMessage' => [ - 'title' => '数据校验错误信息。', - 'description' => 'Data validation error message.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Invalid argument.', - ], + 'Status' => ['title' => '数据地址校验状态。', 'description' => 'The status of the data address verification.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'avaliable'], + 'VerifyTime' => ['title' => '数据地址校验时间。', 'description' => 'The time when the data address is verified.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'], + 'ErrorCode' => ['title' => '数据校验错误码。', 'description' => 'Data verification error code.', 'visibility' => 'Public', 'type' => 'string', 'example' => '400'], + 'ErrorMessage' => ['title' => '数据校验错误信息。', 'description' => 'Data validation error message.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Invalid argument.'], ], ], 'VerifyResp' => [ - 'title' => '', + 'title' => '数据地址校验详情。', 'description' => 'The verification result of the data address.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'title' => 'http status', - 'description' => 'The HTTP status code.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorCode' => [ - 'title' => '', - 'description' => 'The error code.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'InvalidArgument', - ], - 'ErrorMsg' => [ - 'title' => '', - 'description' => 'The error message.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Invalid argument.', - ], + 'HttpCode' => ['title' => 'Http Status。', 'description' => 'The HTTP status code.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '200'], + 'ErrorCode' => ['title' => '校验失败的错误码。', 'description' => 'The error code.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'InvalidArgument'], + 'ErrorMsg' => ['title' => '校验失败的错误信息。', 'description' => 'The error message.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Invalid argument.'], ], ], ], ], 'apis' => [ - 'CreateJob' => [ - 'summary' => 'Creates a migration task.', - 'path' => '/job', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAddress' => [ + 'summary' => 'Creates a data address.', + 'path' => '/address', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227788', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227759', + 'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ @@ -1930,255 +762,197 @@ 'in' => 'body', 'style' => 'xml', 'schema' => [ - 'description' => 'The request body for creating the migration task.', + 'description' => 'The request body for creating the data address.'."\n", 'type' => 'object', 'properties' => [ - 'ImportJob' => [ - 'description' => 'The details for creating the migration task.', - 'required' => true, - '$ref' => '#/components/schemas/CreateJobInfo', - ], + 'ImportAddress' => ['description' => 'The details for creating the data address.'."\n", 'required' => false, '$ref' => '#/components/schemas/CreateAddressInfo', 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'CreateJob', - 'description' => '* To create a migration task, you must have the permission on mgw:CreateImportJob.'."\n" - .'* Before you create a migration task, you must create data addresses.'."\n" - .'* A migration task can run multiple rounds. Each round has an execution ID.'."\n", - ], - 'GetJob' => [ - 'summary' => 'Obtains the details of a migration task.', - 'path' => '/job/{jobName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'CreateAddress', + 'description' => '* To create a data address, you must have the permission on mgw:CreateImportAddress.'."\n" + .'* If you want to use an agent to migrate data, you must create an agent first and then associate the agent with a data address when you create the data address.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddress'], + ], ], + ], + 'CreateAgent' => [ + 'summary' => 'The request boy for creating the agent.', + 'path' => '/agent', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'read', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227824', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227652', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'byVersion', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether to obtain the details of the migration task by using the task ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'jobName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the migration task. If the byVersion parameter is set to true, this parameter indicates the ID of the migration task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_job_name', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response body.'."\n", + 'description' => 'The request body for creating the agent.', 'type' => 'object', 'properties' => [ - 'ImportJob' => [ - 'description' => 'The details for obtaining the details of the migration task.'."\n", - '$ref' => '#/components/schemas/GetJobResp', - ], + 'ImportAgent' => ['description' => 'The details for creating the agent.', 'required' => false, '$ref' => '#/components/schemas/CreateAgentInfo', 'title' => ''], ], + 'required' => false, + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'CreateAgent', + 'description' => '* To create an agent, you must have the permission on mgw:CreateImportAgent.'."\n" + .'* If you want to migrate data to Alibaba Cloud over an Express Connect circuit or a VPN gateway, or migrate data from a self-managed storage space to Alibaba Cloud, you can deploy an agent.'."\n" + .'* Before you create an agent, you must create a tunnel. An agent must be associated with a tunnel.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAgent'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJob>\\n <Name><your-job-name></Name>\\n <SrcAddress><your-src-address-name></SrcAddress>\\n <DestAddress><your-dest-address-name></DestAddress>\\n <Status>IMPORT_JOB_DOING</Status>\\n <EnableMultiVersioning>false</EnableMultiVersioning>\\n <CreateTime>2025-07-04T06:02:21.000Z</CreateTime>\\n <ModifyTime>2025-07-05T06:02:22.000Z</ModifyTime>\\n <Version>31***a7f-188f-****-b266-215***8e49d7</Version>\\n <Audit>\\n <LogMode>off</LogMode>\\n </Audit>\\n <OverwriteMode>always</OverwriteMode>\\n <TransferMode>all</TransferMode>\\n <Tags>K1:V1,K2:V2</Tags>\\n <ParentName><your-parent-job-name></ParentName>\\n <ParentVersion>3***1a7f-18**-41d9-****-21591***49**</ParentVersion>\\n <ConvertSymlinkTarget>false</ConvertSymlinkTarget>\\n <CreateReport>false</CreateReport>\\n <Owner>11***9*38***34**</Owner>\\n <FilterRule>\\n <KeyFilters>\\n <Includes>\\n <Regex/>\\n </Includes>\\n <Excludes>\\n <Regex/>\\n </Excludes>\\n </KeyFilters>\\n <LastModifiedFilters>\\n <Includes>\\n <TimeFilter>\\n <StartTime/>\\n <EndTime/>\\n </TimeFilter>\\n </Includes>\\n <Excludes>\\n <TimeFilter>\\n <StartTime/>\\n <EndTime/>\\n </TimeFilter>\\n </Excludes>\\n </LastModifiedFilters>\\n <FileTypeFilters>\\n <ExcludeSymlink>true</ExcludeSymlink>\\n <ExcludeDir>true</ExcludeDir>\\n </FileTypeFilters>\\n </FilterRule>\\n <ImportQos>\\n <MaxBandWidth>1073741824</MaxBandWidth>\\n <MaxImportTaskQps>1000</MaxImportTaskQps>\\n </ImportQos>\\n <ScheduleRule>\\n <StartCronExpression/>\\n <SuspendCronExpression/>\\n <MaxScheduleCount>0</MaxScheduleCount>\\n </ScheduleRule>\\n <WithStorageClass>false</WithStorageClass>\\n <TargetStorageClass>Standard</TargetStorageClass>\\n <WithLastModifyTime>true</WithLastModifyTime>\\n <AppendableToNormal>true</AppendableToNormal>\\n</ImportJob>","type":"xml"}]', - 'title' => 'GetJob', - 'description' => '* To query the information about a migration task, you must have the permission on mgw:GetImportJob.'."\n", ], - 'ListJob' => [ - 'summary' => 'Lists the migration tasks created by a user in the specific region.', - 'path' => '/joblist', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateJob' => [ + 'summary' => 'Creates a migration task.', + 'path' => '/job', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'read', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227837', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227788', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'marker', - 'in' => 'query', - 'schema' => [ - 'description' => 'The marker after which the migration tasks are listed.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_marker', - ], - ], - [ - 'name' => 'count', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', 'schema' => [ - 'description' => 'Specifies the number of migration tasks to be returned.\\'."\n" - .'Valid values: 0 - 1000 (excluding 0).\\'."\n" - .'Default value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body for creating the migration task.', + 'type' => 'object', + 'properties' => [ + 'ImportJob' => ['description' => 'The details for creating the migration task.', 'required' => true, '$ref' => '#/components/schemas/CreateJobInfo', 'title' => ''], + ], 'required' => false, - 'example' => '1000', + 'title' => '', ], ], - [ - 'name' => 'parentName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the parent task. If this parameter is specified, all subtasks of the parent task are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_parent_job_name', - ], + ], + 'responses' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'CreateJob', + 'description' => '* To create a migration task, you must have the permission on mgw:CreateImportJob.'."\n" + .'* Before you create a migration task, you must create data addresses.'."\n" + .'* A migration task can run multiple rounds. Each round has an execution ID.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'], ], + ], + ], + 'CreateReport' => [ + 'summary' => 'Creates a migration report.', + 'path' => '/report', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'all', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return subtasks.\\'."\n" - .'Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], ], - 'responses' => [ - 200 => [ + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228203', + 'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The request body for creating the migration report.'."\n", 'type' => 'object', 'properties' => [ - 'ImportJobList' => [ - 'description' => 'The queried migration tasks.'."\n", - '$ref' => '#/components/schemas/ListJobResp', - ], + 'CreateReport' => ['description' => 'The details for creating the migration report.'."\n", 'required' => false, '$ref' => '#/components/schemas/CreateReportInfo', 'title' => ''], ], + 'required' => false, + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJobList>\\n <NextMarker><your-next-job-name></NextMarker>\\n <Truncated>true</Truncated>\\n <ImportJob>\\n <Name><your-job-name></Name>\\n <SrcAddress><your-src-address-name></SrcAddress>\\n <DestAddress><your-dest-address-name></DestAddress>\\n <Status>IMPORT_JOB_DOING</Status>\\n <EnableMultiVersioning>false</EnableMultiVersioning>\\n <CreateTime>2025-07-04T06:02:21.000Z</CreateTime>\\n <ModifyTime>2025-07-05T06:02:22.000Z</ModifyTime>\\n <Version>31***a7f-188f-****-b266-215***8e49d7</Version>\\n <Audit>\\n <LogMode>off</LogMode>\\n </Audit>\\n <OverwriteMode>always</OverwriteMode>\\n <TransferMode>all</TransferMode>\\n <Tags>K1:V1,K2:V2</Tags>\\n <ParentName><your-parent-job-name></ParentName>\\n <ParentVersion>3***1a7f-18**-41d9-****-21591***49**</ParentVersion>\\n <ConvertSymlinkTarget>false</ConvertSymlinkTarget>\\n <CreateReport>false</CreateReport>\\n <Owner>11***9*38***34**</Owner>\\n <FilterRule>\\n <KeyFilters>\\n <Includes>\\n <Regex/>\\n </Includes>\\n <Excludes>\\n <Regex/>\\n </Excludes>\\n </KeyFilters>\\n <LastModifiedFilters>\\n <Includes>\\n <TimeFilter>\\n <StartTime/>\\n <EndTime/>\\n </TimeFilter>\\n </Includes>\\n <Excludes>\\n <TimeFilter>\\n <StartTime/>\\n <EndTime/>\\n </TimeFilter>\\n </Excludes>\\n </LastModifiedFilters>\\n <FileTypeFilters>\\n <ExcludeSymlink>true</ExcludeSymlink>\\n <ExcludeDir>true</ExcludeDir>\\n </FileTypeFilters>\\n </FilterRule>\\n <ImportQos>\\n <MaxBandWidth>1073741824</MaxBandWidth>\\n <MaxImportTaskQps>1000</MaxImportTaskQps>\\n </ImportQos>\\n <ScheduleRule>\\n <StartCronExpression/>\\n <SuspendCronExpression/>\\n <MaxScheduleCount>0</MaxScheduleCount>\\n </ScheduleRule>\\n <WithStorageClass>false</WithStorageClass>\\n <TargetStorageClass>Standard</TargetStorageClass>\\n <WithLastModifyTime>true</WithLastModifyTime>\\n <AppendableToNormal>true</AppendableToNormal>\\n </ImportJob>\\n</ImportJobList>","type":"xml"}]', - 'title' => 'ListJob', - 'description' => '* To query a list of migration tasks, you must have the permission on mgw:ListImportJob.'."\n", + 'responses' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'CreateReport', + 'description' => '* To create a migration report, you must have the permission on mgw:CreateImportReport.'."\n" + .'* If you specify that a migration report is to be generated when you create a migration task, you do not need to call this operation. If you do not specify that a migration report is to be generated when you create a migration task, you can call this operation to create a migration report for an execution with the specified ID.'."\n", + 'changeSet' => [], ], - 'UpdateJob' => [ - 'summary' => 'Updates the status or throttling of a task.', - 'path' => '/job/{jobName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'CreateTunnel' => [ + 'summary' => 'Creates a tunnel.', + 'path' => '/tunnel', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227839', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '230272', + 'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ @@ -2186,1015 +960,698 @@ 'in' => 'body', 'style' => 'xml', 'schema' => [ - 'description' => 'The request body for updating the task.'."\n", + 'description' => 'The request body for creating the tunnel.'."\n", 'type' => 'object', 'properties' => [ - 'ImportJob' => [ - 'description' => 'The details for updating the task.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/UpdateJobInfo', - ], + 'ImportTunnel' => ['description' => 'The details for creating the tunnel.'."\n", 'required' => false, '$ref' => '#/components/schemas/CreateTunnelInfo', 'title' => ''], ], 'required' => false, + 'title' => '', ], ], - [ - 'name' => 'jobName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_job_name', + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-import-tunnel-id' => [ + 'schema' => ['title' => '', 'type' => 'string'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'UpdateJob', - 'description' => '* To update a migration task, you must have the permission on mgw:UpdateImportJob.'."\n" - .'* You can update only the status or throttling settings of a task in a single request.'."\n", - ], - 'DeleteJob' => [ - 'summary' => 'Deletes a migration task.', - 'path' => '/job/{jobName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + 'title' => 'CreateTunnel', + 'description' => '* To create a tunnel, you must have the permission on mgw:CreateImportTunnel.'."\n" + .'* When you use an agent to migrate data, the agent must be associated with a tunnel.'."\n" + .'* A tunnel can be associated with multiple agents. You can throttle the traffic of the agents that are associated with the same tunnel by setting the bandwidth and the number of requests per second for the tunnel.'."\n", + 'responseParamsDescription' => 'If the tunnel is created, a tunnel ID is returned in the response header x-oss-import-tunnel-id.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTunnel'], + ], ], + ], + 'DeleteAddress' => [ + 'summary' => 'Deletes a data address.', + 'path' => '/address/{addressName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227829', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227769', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ - 'name' => 'forceDelete', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether to force delete the subtask. If the task has subtasks and you set this parameter to true, the task and its subtasks are forcibly deleted. If this parameter is set to false, the task and its subtasks fail to be deleted.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'jobName', + 'name' => 'addressName', 'in' => 'path', - 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_job_name', - ], + 'schema' => ['description' => 'The name of the data address.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abc', 'title' => ''], ], ], 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'DeleteJob', - 'description' => '* To delete a migration task, you must have the permission on mgw:DeleteImportJob.'."\n" - .'* The operation to delete a migration task is asynchronous. The migration task remains in the Deleting state until it is deleted.'."\n", - ], - 'ListJobHistory' => [ - 'summary' => 'Lists the running history of a migration task.', - 'path' => '/jobhistory/{jobName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'DeleteAddress', + 'description' => '* To delete a data address, you must have the permission on mgw:DeleteImportAddress.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddress'], + ], ], + ], + 'DeleteAgent' => [ + 'summary' => 'Deletes an agent.', + 'path' => '/agent/{agentName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'read', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '228201', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227661', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ - 'name' => 'jobName', + 'name' => 'agentName', 'in' => 'path', - 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_job_name', - ], - ], - [ - 'name' => 'runtimeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution ID of the task. If you specify an execution ID, only the running history related to the execution ID is listed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'marker', - 'in' => 'query', - 'schema' => [ - 'description' => 'The marker after which the running history of the task is listed.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_marker', - ], - ], - [ - 'name' => 'count', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the number of running records of the migration task to be returned.\\'."\n" - .'Valid values: 0 - 1000.\\'."\n" - .'Default value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The agent name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobHistoryList' => [ - 'description' => 'The running history of the migration task.'."\n", - '$ref' => '#/components/schemas/ListJobHistoryResp', - ], - ], - ], + 'responses' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteAgent', + 'description' => '* To delete an agent, you must have the permission on mgw:DeleteImportAgent.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAgent'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<JobHistoryList>\\n <Truncated>true</Truncated>\\n <NextMarker>1#3</NextMarker>\\n <JobHistory>\\n <Name><your-job-name></Name>\\n <JobVersion>****-188f-***-b266-****</JobVersion>\\n <RuntimeId>1</RuntimeId>\\n <CommitId>2</CommitId>\\n <StartTime>2025-07-04T07:09:26.000Z</StartTime>\\n <EndTime>2025-07-04T08:09:26.000Z</EndTime>\\n <Status>IMPORT_JOB_DOING</Status>\\n <TotalCount>1000</TotalCount>\\n <CopiedCount>900</CopiedCount>\\n <FailedCount>100</FailedCount>\\n <TotalSize>1000</TotalSize>\\n <CopiedSize>1000</CopiedSize>\\n <RuntimeState>Normal</RuntimeState>\\n <Message/>\\n <Operator>user</Operator>\\n <ListStatus>Listing</ListStatus>\\n <SkippedCount>1000</SkippedCount>\\n <SkippedSize>100000</SkippedSize>\\n </JobHistory>\\n</JobHistoryList>","type":"xml"}]', - 'title' => 'ListJobHistory', - 'description' => '* To query the execution history of a migration task, you must have the permission on mgw:ListImportJobHistory.'."\n" - .'* A migration task can run multiple rounds. A unique execution ID is generated for each round.'."\n" - .'* The execution history of a migration task records the change history of the task status.'."\n", ], - 'CreateReport' => [ - 'summary' => 'Creates a migration report.', - 'path' => '/report', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteJob' => [ + 'summary' => 'Deletes a migration task.', + 'path' => '/job/{jobName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '228203', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '227829', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'xml', - 'schema' => [ - 'description' => 'The request body for creating the migration report.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateReport' => [ - 'description' => 'The details for creating the migration report.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/CreateReportInfo', - ], - ], - 'required' => false, - ], + 'name' => 'forceDelete', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to force delete the subtask. If the task has subtasks and you set this parameter to true, the task and its subtasks are forcibly deleted. If this parameter is set to false, the task and its subtasks fail to be deleted.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'jobName', + 'in' => 'path', + 'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''], ], ], 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'CreateReport', - 'description' => '* To create a migration report, you must have the permission on mgw:CreateImportReport.'."\n" - .'* If you specify that a migration report is to be generated when you create a migration task, you do not need to call this operation. If you do not specify that a migration report is to be generated when you create a migration task, you can call this operation to create a migration report for an execution with the specified ID.'."\n", - ], - 'GetReport' => [ - 'summary' => 'Obtains the details of a migration report.', - 'path' => '/report', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'DeleteJob', + 'description' => '* To delete a migration task, you must have the permission on mgw:DeleteImportJob.'."\n" + .'* The operation to delete a migration task is asynchronous. The migration task remains in the Deleting state until it is deleted.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJob'], + ], ], + ], + 'DeleteTunnel' => [ + 'summary' => 'Deletes a tunnel.', + 'path' => '/tunnel/{tunnelId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'read', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '228380', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '227642', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the migration task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_job_id', - ], - ], - [ - 'name' => 'runtimeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution ID of the migration task.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'tunnelId', + 'in' => 'path', + 'schema' => ['description' => 'The tunnel ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '0b583032-a495-452f-8c0d-692296b51bf9', 'title' => ''], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'GetReportResponse' => [ - 'description' => 'The details for obtaining the migration report.'."\n", - '$ref' => '#/components/schemas/GetReportResp', - ], - ], - ], + 'responses' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteTunnel', + 'description' => '* To delete a tunnel, you must have the permission on mgw:DeleteImportTunnel.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTunnel'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<GetReportResponse>\\n <Status>Finished</Status>\\n <ReportCreateTime>1748232558</ReportCreateTime>\\n <ReportEndTime>1748232845</ReportEndTime>\\n <TotalCount>1000</TotalCount>\\n <CopiedCount>800</CopiedCount>\\n <SkippedCount>100</SkippedCount>\\n <FailedCount>100</FailedCount>\\n <JobCreateTime>1754445355</JobCreateTime>\\n <JobEndTime>1754445355</JobEndTime>\\n <JobExecuteTime>1000</JobExecuteTime>\\n <TotalListPrefix>dest_prefix/aliyun_import_report/1**70*****795***/5b***8-148b-4be1-bf71-4****247088/1/total_list/</TotalListPrefix>\\n <SkippedListPrefix>dest_prefix/aliyun_import_report/1**70*****795***/5b***8-148b-4be1-bf71-4****247088/1/skipped_list/</SkippedListPrefix>\\n <FailedListPrefix>dest_prefix/aliyun_import_report/1**70*****795***/5b***8-148b-4be1-bf71-4****247088/1/failed_list/</FailedListPrefix>\\n <ErrorMessage/>\\n</GetReportResponse>","type":"xml"}]', - 'title' => 'GetReport', - 'description' => '* To query the information about a migration report, you must have the permission on mgw:GetImportReport.'."\n" - .'* The migration report is pushed to the destination data address. For more information, see the "View a migration report" section of the "Subsequent operations" topic in migration tutorials.'."\n", ], - 'GetJobResult' => [ - 'summary' => 'Obtains the list of files that fail to be migrated when files fail to be migrated during a migration task.', - 'path' => '/job/{jobName}?jobResult', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAddress' => [ + 'summary' => 'Obtains the details of a data address.', + 'path' => '/address/{addressName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '228198', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227766', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ - 'name' => 'jobName', + 'name' => 'addressName', 'in' => 'path', 'schema' => [ - 'description' => 'The task name.'."\n", + 'description' => 'The name of the data address.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'runtimeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution ID of the task.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', + 'example' => 'test_address_name', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response body.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- s:s.', 'type' => 'object', 'properties' => [ - 'ImportJobResult' => [ - 'description' => 'The details for obtaining the retries of the migration task.'."\n", - '$ref' => '#/components/schemas/GetJobResultResp', + 'ImportAddress' => [ + 'description' => 'The details for obtaining the data address.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- 1:1', + 'enumValueTitles' => [1 => '1'], + '$ref' => '#/components/schemas/GetAddressResp', + 'title' => '', + 'example' => '', ], ], + 'enumValueTitles' => ['s' => 's'], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAddress', + 'description' => '- To query the information about a data address, you must have the permission on mgw:GetImportAddress.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddress'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJobResult>\\n <ReadyRetry>Ready</ReadyRetry>\\n <InvPath>dir/mainfest.json</InvPath>\\n <InvBucket><your-bucket-name></InvBucket>\\n <InvDomain>oss-cn-hangzhou.aliyuncs.com</InvDomain>\\n <InvLocation>oss</InvLocation>\\n <InvAccessId>**********************</InvAccessId>\\n <InvAccessSecret>*************************</InvAccessSecret>\\n <InvRegionId>oss-cn-hangzhou</InvRegionId>\\n <AddressType>ossinv</AddressType>\\n <TotalObjectCount>1000</TotalObjectCount>\\n <CopiedObjectCount>800</CopiedObjectCount>\\n <FailedObjectCount>200</FailedObjectCount>\\n <TotalObjectSize>1000</TotalObjectSize>\\n <CopiedObjectSize>800</CopiedObjectSize>\\n <Version>******-188f-41d9-b266-******</Version>\\n <SkippedObjectCount>5000</SkippedObjectCount>\\n <SkippedObjectSize>1000000</SkippedObjectSize>\\n</ImportJobResult>","type":"xml"}]', - 'title' => 'GetJobResult', - 'description' => '* To query the retry information about a migration task, you must have the permission on mgw:GetImportJobResult.'."\n" - .'* If files fail to be migrated during a migration task, a list of files that fail to be migrated is generated. You can call this operation to query this list. You can create a data address based on this list and create a subtask. This way, you can migrate these files again.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAddress>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <AddressDetail>\\n <AddressType>oss</AddressType>\\n <Bucket>test_bucket</Bucket>\\n <Domain>test_domain</Domain>\\n <Prefix>test_prefix</Prefix>\\n <AccessId>test_access_id</AccessId>\\n <AccessSecret>test_secret_key</AccessSecret>\\n <Role>test_role</Role>\\n <InvDomain>test_inv_domain</InvDomain>\\n <InvBucket>test_inv_bucket</InvBucket>\\n <InvAccessId>test_inv_access_id</InvAccessId>\\n <InvAccessSecret>test_inv_secret_key</InvAccessSecret>\\n <InvPath>manifest.json</InvPath>\\n <InvRole>test_inv_role</InvRole>\\n <InvLocation>oss</InvLocation>\\n <AgentList>agent1,agent2</AgentList>\\n <RegionId>oss-cn-hangzhou</RegionId>\\n <InvRegionId>oss-cn-hangzhou</InvRegionId>\\n <DataType>oss</DataType>\\n <HdfsAuthConfig>\\n <UserName/>\\n <AuthType/>\\n </HdfsAuthConfig>\\n </AddressDetail>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <VerifyTime>2024-05-01 12:00:00</VerifyTime>\\n <Version>test_id</Version>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Status>avaliable</Status>\\n <VerifyResult>\\n <HttpCode>200</HttpCode>\\n <ErrorCode>InvalidArgument</ErrorCode>\\n <ErrorMsg>Invalid argument.</ErrorMsg>\\n </VerifyResult>\\n</ImportAddress>","type":"xml"}]', ], - 'CreateAddress' => [ - 'summary' => 'Creates a data address.', - 'path' => '/address', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetAgent' => [ + 'summary' => 'Obtains the details of an agent.', + 'path' => '/agent/{agentName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'write', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227759', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgwXWJG7U', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '227655', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'xml', + 'name' => 'agentName', + 'in' => 'path', + 'schema' => ['description' => 'The agent name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The request body for creating the data address.'."\n", + 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'ImportAddress' => [ - 'description' => 'The details for creating the data address.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/CreateAddressInfo', - ], + 'ImportAgent' => ['description' => 'The details for obtaining the details of the agent.'."\n", '$ref' => '#/components/schemas/GetAgentResp', 'title' => ''], ], - 'required' => false, + 'title' => '', ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgent>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <CreateTime>2024-05-01T12:00:00.000Z</CreateTime>\\n <ModifyTime>2024-05-01T12:00:00.000Z</ModifyTime>\\n <DeployMethod>default</DeployMethod>\\n <AgentEndpoint>vpc</AgentEndpoint>\\n <ActivationKey>6af62558-970d-4f44-8663-4e297170fd6a</ActivationKey>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Version>test_agent_id</Version>\\n <TunnelId>test_tunnel_id</TunnelId>\\n</ImportAgent>","type":"xml"}]', + 'title' => 'GetAgent', + 'description' => '* To query the information about an agent, you must have the permission on mgw:GetImportAgent.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgent'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'CreateAddress', - 'description' => '* To create a data address, you must have the permission on mgw:CreateImportAddress.'."\n" - .'* If you want to use an agent to migrate data, you must create an agent first and then associate the agent with a data address when you create the data address.'."\n", ], - 'GetAddress' => [ - 'summary' => 'Obtains the details of a data address.', - 'path' => '/address/{addressName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAgentStatus' => [ + 'summary' => 'Obtains the running status of an agent.', + 'path' => '/agent/{agentName}?status', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227766', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '227750', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ - 'name' => 'addressName', + 'name' => 'agentName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the data address.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'test', - ], + 'schema' => ['description' => 'The agent name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* s:s.'."\n", + 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'ImportAddress' => [ - 'description' => 'The details for obtaining the data address.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1:1'."\n", - 'enumValueTitles' => [ - 1 => '1', - ], - '$ref' => '#/components/schemas/GetAddressResp', - ], - ], - 'enumValueTitles' => [ - 's' => 's', + 'ImportAgentStatus' => ['description' => 'The details for obtaining the status of the agent.'."\n", '$ref' => '#/components/schemas/GetAgentStatusResp', 'title' => ''], ], + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgentStatus>\\n <Status>OK</Status>\\n</ImportAgentStatus>","type":"xml"}]', + 'title' => 'GetAgentStatus', + 'description' => '* To query the status of an agent, you must have the permission on mgw:GetImportAgent.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentStatus'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAddress>\\n <Owner>1***90**87***53*</Owner>\\n <Name><your-address-name></Name>\\n <AddressDetail>\\n <AddressType>ossinv</AddressType>\\n <Bucket><your-bucket-name></Bucket>\\n <Domain>oss-cn-hangzhou.aliyuncs.com</Domain>\\n <Prefix>dir1/dir2/</Prefix>\\n <AccessId>*******************</AccessId>\\n <AccessSecret>*******************</AccessSecret>\\n <Role><your-role-name></Role>\\n <InvDomain>oss-cn-hangzhou.aliyuncs.com</InvDomain>\\n <InvBucket><your-inv-bucket-name></InvBucket>\\n <InvAccessId>*******************</InvAccessId>\\n <InvAccessSecret>*******************</InvAccessSecret>\\n <InvPath>dir/manifest.json</InvPath>\\n <InvRole><your-role-name></InvRole>\\n <InvLocation>oss</InvLocation>\\n <AgentList>agnet1,agent2,agent3</AgentList>\\n <RegionId>oss-cn-hangzhou</RegionId>\\n <InvRegionId>oss-cn-hangzhou</InvRegionId>\\n <DataType>oss</DataType>\\n </AddressDetail>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <VerifyTime>2024-05-01 12:00:00</VerifyTime>\\n <Version>****sf-****-0078-****-drfg****df1334</Version>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Status>avaliable</Status>\\n <VerifyResult>\\n <HttpCode>200</HttpCode>\\n <ErrorCode/>\\n <ErrorMsg/>\\n </VerifyResult>\\n</ImportAddress>","type":"xml"}]', - 'title' => 'GetAddress', - 'description' => '* To query the information about a data address, you must have the permission on mgw:GetImportAddress.'."\n", ], - 'ListAddress' => [ - 'summary' => 'Lists the data addresses created by a user in the specific region.', - 'path' => '/addresslist', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetJob' => [ + 'summary' => 'Obtains the details of a migration task.', + 'path' => '/job/{jobName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227770', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '227824', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'marker', + 'name' => 'byVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The marker after which the migration addresses are listed.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_marker', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to obtain the details of the migration task by using the task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'count', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the number of migration addresses to be returned.\\'."\n" - .'Valid values: 0 - 1000 (excluding 0).\\'."\n" - .'Default value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'name' => 'jobName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the migration task. If the byVersion parameter is set to true, this parameter indicates the ID of the migration task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'ImportAddressList' => [ - 'description' => 'The details of migration addresses.'."\n", - '$ref' => '#/components/schemas/ListAddressResp', - ], + 'ImportJob' => ['description' => 'The details for obtaining the details of the migration task.'."\n", '$ref' => '#/components/schemas/GetJobResp', 'title' => ''], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJob>\\n <Name>test_name</Name>\\n <SrcAddress>test_src_address</SrcAddress>\\n <DestAddress>test_dest_address</DestAddress>\\n <Status>IMPORT_JOB_DOING</Status>\\n <EnableMultiVersioning>false</EnableMultiVersioning>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Version>test_id</Version>\\n <Audit>\\n <LogMode>off</LogMode>\\n </Audit>\\n <OverwriteMode>always</OverwriteMode>\\n <TransferMode>all</TransferMode>\\n <Tags>K1:V1,K2:V2</Tags>\\n <ParentName>test_parent_name</ParentName>\\n <ParentVersion>7db93837-a5ee-4e3a-b3c8-800e7947dabc</ParentVersion>\\n <ConvertSymlinkTarget>false</ConvertSymlinkTarget>\\n <CreateReport>false</CreateReport>\\n <Owner>test_owner</Owner>\\n <FilterRule>\\n <KeyFilters>\\n <Includes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Includes>\\n <Excludes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Excludes>\\n </KeyFilters>\\n <LastModifiedFilters>\\n <Includes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Includes>\\n <Excludes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Excludes>\\n </LastModifiedFilters>\\n <FileTypeFilters>\\n <ExcludeSymlink>true</ExcludeSymlink>\\n <ExcludeDir>true</ExcludeDir>\\n </FileTypeFilters>\\n </FilterRule>\\n <ImportQos>\\n <MaxBandWidth>1073741824</MaxBandWidth>\\n <MaxImportTaskQps>1000</MaxImportTaskQps>\\n </ImportQos>\\n <ScheduleRule>\\n <StartCronExpression>0 0 * * * ?</StartCronExpression>\\n <SuspendCronExpression>0 0 * * * ?</SuspendCronExpression>\\n <MaxScheduleCount>1</MaxScheduleCount>\\n </ScheduleRule>\\n</ImportJob>","type":"xml"}]', + 'title' => 'GetJob', + 'description' => '* To query the information about a migration task, you must have the permission on mgw:GetImportJob.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAddressList>\\n <Truncated>true</Truncated>\\n <NextMarker><your-next-address-name></NextMarker>\\n <ImportAddress>\\n <Owner>1***90**87***53*</Owner>\\n <Name><your-address-name></Name>\\n <AddressDetail>\\n <AddressType>ossinv</AddressType>\\n <Bucket><your-bucket-name></Bucket>\\n <Domain>oss-cn-hangzhou.aliyuncs.com</Domain>\\n <Prefix>dir1/dir2/</Prefix>\\n <AccessId>*******************</AccessId>\\n <AccessSecret>*******************</AccessSecret>\\n <Role><your-role-name></Role>\\n <InvDomain>oss-cn-hangzhou.aliyuncs.com</InvDomain>\\n <InvBucket><your-inv-bucket-name></InvBucket>\\n <InvAccessId>*******************</InvAccessId>\\n <InvAccessSecret>*******************</InvAccessSecret>\\n <InvPath>dir/manifest.json</InvPath>\\n <InvRole><your-role-name></InvRole>\\n <InvLocation>oss</InvLocation>\\n <AgentList>agnet1,agent2,agent3</AgentList>\\n <RegionId>oss-cn-hangzhou</RegionId>\\n <InvRegionId>oss-cn-hangzhou</InvRegionId>\\n <DataType>oss</DataType>\\n </AddressDetail>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <VerifyTime>2024-05-01 12:00:00</VerifyTime>\\n <Version>****sf-****-0078-****-drfg****df1334</Version>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Status>avaliable</Status>\\n <VerifyResult>\\n <HttpCode>200</HttpCode>\\n <ErrorCode/>\\n <ErrorMsg/>\\n </VerifyResult>\\n </ImportAddress>\\n</ImportAddressList>","type":"xml"}]', - 'title' => 'ListAddress', - 'description' => '* To query a list of data addresses, you must have the permission on mgw:ListImportAddress.'."\n", ], - 'UpdateAddress' => [ - 'summary' => 'Updates a data address.', - 'path' => '/address/{addressName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'GetJobResult' => [ + 'summary' => 'Obtains the list of files that fail to be migrated when files fail to be migrated during a migration task.', + 'path' => '/job/{jobName}?jobResult', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'write', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232066', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '228198', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'addressName', + 'name' => 'jobName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the data address.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_address_name', - ], + 'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'xml', + 'name' => 'runtimeId', + 'in' => 'query', + 'schema' => ['description' => 'The execution ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The request body for updating the data address.'."\n", + 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'ImportAddress' => [ - 'description' => 'The details for updating the data address.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/UpdateAddressInfo', - ], + 'ImportJobResult' => ['description' => 'The details for obtaining the retries of the migration task.'."\n", '$ref' => '#/components/schemas/GetJobResultResp', 'title' => ''], ], - 'required' => false, + 'title' => '', ], ], ], - 'responses' => [ - 200 => [], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJobResult>\\n <ReadyRetry>Ready</ReadyRetry>\\n <InvPath>mainfest.json</InvPath>\\n <InvBucket>test_sys_bucket</InvBucket>\\n <InvDomain>test_domain</InvDomain>\\n <InvLocation>oss</InvLocation>\\n <InvAccessId>test_access_id</InvAccessId>\\n <InvAccessSecret>test_secret_key</InvAccessSecret>\\n <InvRegionId>test_region_id</InvRegionId>\\n <AddressType>ossinv</AddressType>\\n <TotalObjectCount>1000</TotalObjectCount>\\n <CopiedObjectCount>800</CopiedObjectCount>\\n <FailedObjectCount>200</FailedObjectCount>\\n <TotalObjectSize>1000</TotalObjectSize>\\n <CopiedObjectSize>800</CopiedObjectSize>\\n <Version>test_job_id</Version>\\n</ImportJobResult>","type":"xml"}]', + 'title' => 'GetJobResult', + 'description' => '* To query the retry information about a migration task, you must have the permission on mgw:GetImportJobResult.'."\n" + .'* If files fail to be migrated during a migration task, a list of files that fail to be migrated is generated. You can call this operation to query this list. You can create a data address based on this list and create a subtask. This way, you can migrate these files again.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobResult'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'UpdateAddress', - 'description' => '* To update a data address, you must have the permission on mgw:UpdateImportAddress.'."\n" - .'* If the data address is associated with an agent, you can scale up or down the agent.'."\n", ], - 'DeleteAddress' => [ - 'summary' => 'Deletes a data address.', - 'path' => '/address/{addressName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'GetReport' => [ + 'summary' => 'Obtains the details of a migration report.', + 'path' => '/report', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'write', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227769', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '228380', + 'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ - 'name' => 'addressName', - 'in' => 'path', + 'name' => 'version', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_id', 'title' => ''], + ], + [ + 'name' => 'runtimeId', + 'in' => 'query', + 'schema' => ['description' => 'The execution ID of the migration task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the data address.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abc', + 'title' => 'Schema of Response', + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'GetReportResponse' => ['description' => 'The details for obtaining the migration report.'."\n", '$ref' => '#/components/schemas/GetReportResp', 'title' => ''], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<GetReportResponse>\\n <Status>Running</Status>\\n <ReportCreateTime>2024-05-01 12:00:00</ReportCreateTime>\\n <ReportEndTime>2024-05-01 12:00:00</ReportEndTime>\\n <TotalCount>1000</TotalCount>\\n <CopiedCount>800</CopiedCount>\\n <SkippedCount>100</SkippedCount>\\n <FailedCount>100</FailedCount>\\n <JobCreateTime>2024-05-01 12:00:00</JobCreateTime>\\n <JobEndTime>2024-05-01 12:00:00</JobEndTime>\\n <JobExecuteTime>1000</JobExecuteTime>\\n <TotalListPrefix>test_total_prefix/</TotalListPrefix>\\n <SkippedListPrefix>test_skipped_prefix/</SkippedListPrefix>\\n <FailedListPrefix>test_failed_prefix/</FailedListPrefix>\\n <ErrorMessage>test error msg.</ErrorMessage>\\n</GetReportResponse>","type":"xml"}]', + 'title' => 'GetReport', + 'description' => '* To query the information about a migration report, you must have the permission on mgw:GetImportReport.'."\n" + .'* The migration report is pushed to the destination data address. For more information, see the "View a migration report" section of the "Subsequent operations" topic in migration tutorials.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReport'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'DeleteAddress', - 'description' => '* To delete a data address, you must have the permission on mgw:DeleteImportAddress.'."\n", ], - 'VerifyAddress' => [ - 'summary' => 'Verifies whether a data address is available.', - 'path' => '/address/{addressName}?verify', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetTunnel' => [ + 'summary' => 'Obtains the details of a tunnel.', + 'path' => '/tunnel/{tunnelId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227775', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227629', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'addressName', + 'name' => 'tunnelId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the data address.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_address_name', - ], + 'schema' => ['description' => 'The tunnel ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '0b583032-a495-452f-8c0d-692296b51bf9', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'VerifyAddressResponse' => [ - 'description' => 'The details for verifying the data address.'."\n", - '$ref' => '#/components/schemas/VerifyAddressResp', - ], + 'ImportTunnel' => ['description' => 'The details for obtaining the details of the tunnel.'."\n", '$ref' => '#/components/schemas/GetTunnelResp', 'title' => ''], ], + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportTunnel>\\n <Owner>test_owner</Owner>\\n <TunnelId>test_tunnel_id</TunnelId>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Tags>key1:value1,key2:value2</Tags>\\n <TunnelQos>\\n <MaxQps>100</MaxQps>\\n <MaxBandwidth>1073741824</MaxBandwidth>\\n </TunnelQos>\\n</ImportTunnel>","type":"xml"}]', + 'title' => 'GetTunnel', + 'description' => '* To query the information about a tunnel, you must have the permission on mgw:GetImportTunnel.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTunnel'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<VerifyAddressResponse>\\n <Status>avaliable</Status>\\n <VerifyTime>2024-05-01 12:00:00</VerifyTime>\\n <ErrorCode/>\\n <ErrorMessage/>\\n</VerifyAddressResponse>","type":"xml"}]', - 'title' => 'VerifyAddress', - 'description' => '* To verify a data address, you must have the permission on mgw:VerifyImportAddress.'."\n" - .'* A data address may not be available even if the data address passes the availability verification. The data migration results prevail.'."\n", ], - 'CreateAgent' => [ - 'summary' => 'The request boy for creating the agent.', - 'path' => '/agent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListAddress' => [ + 'summary' => 'Lists the data addresses created by a user in the specific region.', + 'path' => '/addresslist', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'write', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227652', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227770', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'xml', + 'name' => 'marker', + 'in' => 'query', + 'schema' => ['description' => 'The marker after which the migration addresses are listed.<br>'."\n" + .'By default, this parameter is left empty.', 'type' => 'string', 'required' => false, 'example' => 'test_marker', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the number of migration addresses to be returned.<br>'."\n" + .'Valid values: 0 - 1000 (excluding 0).<br>'."\n" + .'Default value: 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The request body for creating the agent.', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'ImportAgent' => [ - 'description' => 'The details for creating the agent.', - 'required' => false, - '$ref' => '#/components/schemas/CreateAgentInfo', - ], + 'ImportAddressList' => ['description' => 'The details of migration addresses.', '$ref' => '#/components/schemas/ListAddressResp', 'title' => '', 'example' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAddress', + 'description' => '- To query a list of data addresses, you must have the permission on mgw:ListImportAddress.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddress'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'CreateAgent', - 'description' => '* To create an agent, you must have the permission on mgw:CreateImportAgent.'."\n" - .'* If you want to migrate data to Alibaba Cloud over an Express Connect circuit or a VPN gateway, or migrate data from a self-managed storage space to Alibaba Cloud, you can deploy an agent.'."\n" - .'* Before you create an agent, you must create a tunnel. An agent must be associated with a tunnel.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAddressList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_marker</NextMarker>\\n <ImportAddress>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <AddressDetail>\\n <AddressType>oss</AddressType>\\n <Bucket>test_bucket</Bucket>\\n <Domain>test_domain</Domain>\\n <Prefix>test_prefix</Prefix>\\n <AccessId>test_access_id</AccessId>\\n <AccessSecret>test_secret_key</AccessSecret>\\n <Role>test_role</Role>\\n <InvDomain>test_inv_domain</InvDomain>\\n <InvBucket>test_inv_bucket</InvBucket>\\n <InvAccessId>test_inv_access_id</InvAccessId>\\n <InvAccessSecret>test_inv_secret_key</InvAccessSecret>\\n <InvPath>manifest.json</InvPath>\\n <InvRole>test_inv_role</InvRole>\\n <InvLocation>oss</InvLocation>\\n <AgentList>agent1,agent2</AgentList>\\n <RegionId>oss-cn-hangzhou</RegionId>\\n <InvRegionId>oss-cn-hangzhou</InvRegionId>\\n <DataType>oss</DataType>\\n <HdfsAuthConfig>\\n <UserName/>\\n <AuthType/>\\n </HdfsAuthConfig>\\n </AddressDetail>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <VerifyTime>2024-05-01 12:00:00</VerifyTime>\\n <Version>test_id</Version>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Status>avaliable</Status>\\n <VerifyResult>\\n <HttpCode>200</HttpCode>\\n <ErrorCode>InvalidArgument</ErrorCode>\\n <ErrorMsg>Invalid argument.</ErrorMsg>\\n </VerifyResult>\\n </ImportAddress>\\n</ImportAddressList>","type":"xml"}]', ], - 'GetAgent' => [ - 'summary' => 'Obtains the details of an agent.', - 'path' => '/agent/{agentName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAgent' => [ + 'summary' => 'Lists the agents created by a user in the specific region.', + 'path' => '/agentlist', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227655', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227670', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'agentName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The agent name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a', - ], + 'name' => 'marker', + 'in' => 'query', + 'schema' => ['description' => 'The marker after which the agents are listed.\\'."\n" + .'By default, this parameter is left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_agent', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the number of agents to be returned.\\'."\n" + .'Valid values: 0 - 1000.\\'."\n" + .'Default value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ @@ -3203,404 +1660,345 @@ 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'ImportAgent' => [ - 'description' => 'The details for obtaining the details of the agent.'."\n", - '$ref' => '#/components/schemas/GetAgentResp', - ], + 'ImportAgentList' => ['description' => 'The details of the agents.'."\n", '$ref' => '#/components/schemas/ListAgentResp', 'title' => ''], ], + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgentList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_next_marker</NextMarker>\\n <ImportAgent>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <CreateTime>2024-05-01T12:00:00.000Z</CreateTime>\\n <ModifyTime>2024-05-01T12:00:00.000Z</ModifyTime>\\n <DeployMethod>default</DeployMethod>\\n <AgentEndpoint>vpc</AgentEndpoint>\\n <ActivationKey>6af62558-970d-4f44-8663-4e297170fd6a</ActivationKey>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Version>test_agent_id</Version>\\n <TunnelId>test_tunnel_id</TunnelId>\\n </ImportAgent>\\n</ImportAgentList>","type":"xml"}]', + 'title' => 'ListAgent', + 'description' => '* To query a list of agents, you must have the permission on mgw:ListImportAgent.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgent>\\n <Owner>1***90**87***53*</Owner>\\n <Name><your-agent-name></Name>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <DeployMethod>default</DeployMethod>\\n <AgentEndpoint>vpc</AgentEndpoint>\\n <ActivationKey/>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Version>****33f-****-4740-****-bc4f****332b3</Version>\\n <TunnelId>****13f-****-0567-****-af8d****446665</TunnelId>\\n</ImportAgent>","type":"xml"}]', - 'title' => 'GetAgent', - 'description' => '* To query the information about an agent, you must have the permission on mgw:GetImportAgent.'."\n", ], - 'ListAgent' => [ - 'summary' => 'Lists the agents created by a user in the specific region.', - 'path' => '/agentlist', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListJob' => [ + 'summary' => 'Lists the migration tasks created by a user in the specific region.', + 'path' => '/joblist', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227670', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227837', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ 'name' => 'marker', 'in' => 'query', - 'schema' => [ - 'description' => 'The marker after which the agents are listed.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_agent', - ], + 'schema' => ['description' => 'The marker after which the migration tasks are listed.\\'."\n" + .'By default, this parameter is left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_marker', 'title' => ''], ], [ 'name' => 'count', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the number of agents to be returned.\\'."\n" - .'Valid values: 0 - 1000.\\'."\n" - .'Default value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'Specifies the number of migration tasks to be returned.\\'."\n" + .'Valid values: 0 - 1000 (excluding 0).\\'."\n" + .'Default value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'parentName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the parent task. If this parameter is specified, all subtasks of the parent task are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_parent_job_name', 'title' => ''], + ], + [ + 'name' => 'all', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return subtasks.\\'."\n" + .'Valid values: true and false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'ImportAgentList' => [ - 'description' => 'The details of the agents.'."\n", - '$ref' => '#/components/schemas/ListAgentResp', - ], + 'ImportJobList' => ['description' => 'The queried migration tasks.'."\n", '$ref' => '#/components/schemas/ListJobResp', 'title' => ''], ], + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJobList>\\n <NextMarker>test_nex_marker</NextMarker>\\n <Truncated>true</Truncated>\\n <ImportJob>\\n <Name>test_name</Name>\\n <SrcAddress>test_src_address</SrcAddress>\\n <DestAddress>test_dest_address</DestAddress>\\n <Status>IMPORT_JOB_DOING</Status>\\n <EnableMultiVersioning>false</EnableMultiVersioning>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Version>test_id</Version>\\n <Audit>\\n <LogMode>off</LogMode>\\n </Audit>\\n <OverwriteMode>always</OverwriteMode>\\n <TransferMode>all</TransferMode>\\n <Tags>K1:V1,K2:V2</Tags>\\n <ParentName>test_parent_name</ParentName>\\n <ParentVersion>7db93837-a5ee-4e3a-b3c8-800e7947dabc</ParentVersion>\\n <ConvertSymlinkTarget>false</ConvertSymlinkTarget>\\n <CreateReport>false</CreateReport>\\n <Owner>test_owner</Owner>\\n <FilterRule>\\n <KeyFilters>\\n <Includes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Includes>\\n <Excludes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Excludes>\\n </KeyFilters>\\n <LastModifiedFilters>\\n <Includes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Includes>\\n <Excludes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Excludes>\\n </LastModifiedFilters>\\n <FileTypeFilters>\\n <ExcludeSymlink>true</ExcludeSymlink>\\n <ExcludeDir>true</ExcludeDir>\\n </FileTypeFilters>\\n </FilterRule>\\n <ImportQos>\\n <MaxBandWidth>1073741824</MaxBandWidth>\\n <MaxImportTaskQps>1000</MaxImportTaskQps>\\n </ImportQos>\\n <ScheduleRule>\\n <StartCronExpression>0 0 * * * ?</StartCronExpression>\\n <SuspendCronExpression>0 0 * * * ?</SuspendCronExpression>\\n <MaxScheduleCount>1</MaxScheduleCount>\\n </ScheduleRule>\\n </ImportJob>\\n</ImportJobList>","type":"xml"}]', + 'title' => 'ListJob', + 'description' => '* To query a list of migration tasks, you must have the permission on mgw:ListImportJob.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJob'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgentList>\\n <Truncated>true</Truncated>\\n <NextMarker><your-next-agent-name></NextMarker>\\n <ImportAgent>\\n <Owner>1***90**87***53*</Owner>\\n <Name><your-agent-name></Name>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <DeployMethod>default</DeployMethod>\\n <AgentEndpoint>vpc</AgentEndpoint>\\n <ActivationKey/>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Version>****33f-****-4740-****-bc4f****332b3</Version>\\n <TunnelId>****13f-****-0567-****-af8d****446665</TunnelId>\\n </ImportAgent>\\n</ImportAgentList>","type":"xml"}]', - 'title' => 'ListAgent', - 'description' => '* To query a list of agents, you must have the permission on mgw:ListImportAgent.'."\n", ], - 'GetAgentStatus' => [ - 'summary' => 'Obtains the running status of an agent.', - 'path' => '/agent/{agentName}?status', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListJobHistory' => [ + 'summary' => 'Lists the run history of a migration task.', + 'path' => '/jobhistory/{jobName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227750', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '228201', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'agentName', + 'name' => 'jobName', 'in' => 'path', - 'schema' => [ - 'description' => 'The agent name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a', - ], + 'schema' => ['description' => 'The name of the migration task whose run history to retrieve.', 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''], + ], + [ + 'name' => 'runtimeId', + 'in' => 'query', + 'schema' => ['description' => 'The execution ID of a specific run. Specify this parameter to retrieve the run history for only that execution.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'marker', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. Set this parameter to the marker value returned in the previous response to retrieve the next page of results. If not specified, results are returned from the beginning.', 'type' => 'string', 'required' => false, 'example' => 'test_marker', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of history entries to return.<br> Valid values: 1 to 1000.<br> Default value: 1000.<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'ImportAgentStatus' => [ - 'description' => 'The details for obtaining the status of the agent.'."\n", - '$ref' => '#/components/schemas/GetAgentStatusResp', - ], + 'JobHistoryList' => ['description' => 'The list of task run history entries.', '$ref' => '#/components/schemas/ListJobHistoryResp', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<JobHistoryList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_next_marker</NextMarker>\\n <JobHistory>\\n <Name>test_name</Name>\\n <JobVersion>test_id</JobVersion>\\n <RuntimeId>1</RuntimeId>\\n <CommitId>2</CommitId>\\n <StartTime>2024-05-01T12:00:00.000Z</StartTime>\\n <EndTime>2024-05-01T12:00:00.000Z</EndTime>\\n <Status>IMPORT_JOB_DOING</Status>\\n <TotalCount>1000</TotalCount>\\n <CopiedCount>900</CopiedCount>\\n <FailedCount>100</FailedCount>\\n <TotalSize>1000</TotalSize>\\n <CopiedSize>1000</CopiedSize>\\n <RuntimeState>Normal</RuntimeState>\\n <Message>test error msg.</Message>\\n <Operator>user</Operator>\\n <ListStatus>Listing</ListStatus>\\n <SkippedCount>1000</SkippedCount>\\n <SkippedSize>100000</SkippedSize>\\n </JobHistory>\\n</JobHistoryList>","type":"xml"}]', + 'title' => 'ListJobHistory', + 'description' => '- Call this operation to retrieve the run history of a specified migration task. A migration task can have multiple runs, each identified by a unique execution ID. The run history records status changes that occur during each execution.'."\n" + ."\n" + .'- Required permission: mgw:ListImportJobHistory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobHistory'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgentStatus>\\n <Status>OK</Status>\\n <AgentVersion>1.5.0</AgentVersion>\\n <AgentIP>192.168.0.2</AgentIP>\\n</ImportAgentStatus>","type":"xml"}]', - 'title' => 'GetAgentStatus', - 'description' => '* To query the status of an agent, you must have the permission on mgw:GetImportAgent.'."\n", ], - 'DeleteAgent' => [ - 'summary' => 'Deletes an agent.', - 'path' => '/agent/{agentName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListTunnel' => [ + 'summary' => 'Lists tunnels.', + 'path' => '/tunnellist', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'write', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227661', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '227644', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'agentName', - 'in' => 'path', + 'name' => 'marker', + 'in' => 'query', + 'schema' => ['description' => 'The marker after which tunnels are listed.\\'."\n" + .'By default, this parameter is left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the number of tunnels to be returned.\\'."\n" + .'Valid values: 0 - 1000.\\'."\n" + .'Default value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The agent name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'description' => 'The response body.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImportTunnelList' => ['description' => 'The details of the tunnels.'."\n", '$ref' => '#/components/schemas/ListTunnelResp', 'title' => ''], + ], + 'title' => '', ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportTunnelList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_marker</NextMarker>\\n <ImportTunnel>\\n <Owner>test_owner</Owner>\\n <TunnelId>test_tunnel_id</TunnelId>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Tags>key1:value1,key2:value2</Tags>\\n <TunnelQos>\\n <MaxQps>100</MaxQps>\\n <MaxBandwidth>1073741824</MaxBandwidth>\\n </TunnelQos>\\n </ImportTunnel>\\n</ImportTunnelList>","type":"xml"}]', + 'title' => 'ListTunnel', + 'description' => '* To query a list of tunnels, you must have the permission on mgw:ListImportTunnel.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTunnel'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'DeleteAgent', - 'description' => '* To delete an agent, you must have the permission on mgw:DeleteImportAgent.'."\n", ], - 'CreateTunnel' => [ - 'summary' => 'Creates a tunnel.', - 'path' => '/tunnel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAddress' => [ + 'summary' => 'Updates a data address.', + 'path' => '/address/{addressName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '230272', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeCode' => '232066', + 'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ + 'name' => 'addressName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the data address.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_address_name', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ - 'description' => 'The request body for creating the tunnel.'."\n", + 'description' => 'The request body for updating the data address.'."\n", 'type' => 'object', 'properties' => [ - 'ImportTunnel' => [ - 'description' => 'The details for creating the tunnel.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/CreateTunnelInfo', - ], + 'ImportAddress' => ['description' => 'The details for updating the data address.'."\n", 'required' => false, '$ref' => '#/components/schemas/UpdateAddressInfo', 'title' => ''], ], 'required' => false, + 'title' => '', ], ], ], 'responses' => [ - 200 => [ - 'headers' => [ - 'x-oss-import-tunnel-id' => [ - 'schema' => [ - 'title' => '', - 'type' => 'string', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 200 => [], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'CreateTunnel', - 'description' => '* To create a tunnel, you must have the permission on mgw:CreateImportTunnel.'."\n" - .'* When you use an agent to migrate data, the agent must be associated with a tunnel.'."\n" - .'* A tunnel can be associated with multiple agents. You can throttle the traffic of the agents that are associated with the same tunnel by setting the bandwidth and the number of requests per second for the tunnel.'."\n", - 'responseParamsDescription' => 'If the tunnel is created, a tunnel ID is returned in the response header x-oss-import-tunnel-id.'."\n", - ], - 'GetTunnel' => [ - 'summary' => 'Obtains the details of a tunnel.', - 'path' => '/tunnel/{tunnelId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'UpdateAddress', + 'description' => '* To update a data address, you must have the permission on mgw:UpdateImportAddress.'."\n" + .'* If the data address is associated with an agent, you can scale up or down the agent.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddress'], + ], ], + ], + 'UpdateJob' => [ + 'summary' => 'Updates the status or throttling of a task.', + 'path' => '/job/{jobName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'read', + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227629', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227839', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], ], 'parameters' => [ [ - 'name' => 'tunnelId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The tunnel ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0b583032-a495-452f-8c0d-692296b51bf9', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The request body for updating the task.'."\n", 'type' => 'object', 'properties' => [ - 'ImportTunnel' => [ - 'description' => 'The details for obtaining the details of the tunnel.'."\n", - '$ref' => '#/components/schemas/GetTunnelResp', - ], + 'ImportJob' => ['description' => 'The details for updating the task.'."\n", 'required' => false, '$ref' => '#/components/schemas/UpdateJobInfo', 'title' => ''], ], + 'required' => false, + 'title' => '', ], ], + [ + 'name' => 'jobName', + 'in' => 'path', + 'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateJob', + 'description' => '* To update a migration task, you must have the permission on mgw:UpdateImportJob.'."\n" + .'* You can update only the status or throttling settings of a task in a single request.'."\n", + 'changeSet' => [], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateJob'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportTunnel>\\n <Owner>1*5******7**43*</Owner>\\n <TunnelId>****33f-****-4740-****-bc4f****332b3</TunnelId>\\n <CreateTime>2025-08-03T07:09:25.000Z</CreateTime>\\n <ModifyTime>2025-08-04T07:09:26.000Z</ModifyTime>\\n <Tags>K1:V1,K2:V2</Tags>\\n <TunnelQos>\\n <MaxQps>100</MaxQps>\\n <MaxBandwidth>1073741824</MaxBandwidth>\\n </TunnelQos>\\n</ImportTunnel>","type":"xml"}]', - 'title' => 'GetTunnel', - 'description' => '* To query the information about a tunnel, you must have the permission on mgw:GetImportTunnel.'."\n", ], 'UpdateTunnel' => [ 'summary' => 'Updates a tunnel.', 'path' => '/tunnel/{tunnelId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ @@ -3608,17 +2006,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227625', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgwXWJG7U', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - ], + 'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -3626,13 +2014,7 @@ [ 'name' => 'tunnelId', 'in' => 'path', - 'schema' => [ - 'description' => 'The tunnel ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - 'title' => '通道ID。', - ], + 'schema' => ['description' => 'The tunnel ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'body', @@ -3642,218 +2024,149 @@ 'description' => 'The request body for updating the tunnel.'."\n", 'type' => 'object', 'properties' => [ - 'ImportTunnel' => [ - 'description' => 'The details for updating the tunnel.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/UpdateTunnelInfo', - 'title' => '更新通道详情。', - ], + 'ImportTunnel' => ['description' => 'The details for updating the tunnel.'."\n", 'required' => false, '$ref' => '#/components/schemas/UpdateTunnelInfo', 'title' => ''], ], 'required' => false, - 'title' => '更新通道请求体。', + 'title' => '', ], ], ], 'responses' => [ 200 => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', 'title' => 'UpdateTunnel', 'description' => '* To update a tunnel, you must have the permission on mgw:UpdateImportTunnel.'."\n", - ], - 'ListTunnel' => [ - 'summary' => 'Lists tunnels.', - 'path' => '/tunnellist', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTunnel'], + ], ], + ], + 'VerifyAddress' => [ + 'summary' => 'Verifies whether a data address is available.', + 'path' => '/address/{addressName}?verify', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], + 'consumes' => ['application/xml'], + 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227644', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], + 'abilityTreeCode' => '227775', + 'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'], ], 'parameters' => [ [ - 'name' => 'marker', - 'in' => 'query', - 'schema' => [ - 'description' => 'The marker after which tunnels are listed.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'count', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the number of tunnels to be returned.\\'."\n" - .'Valid values: 0 - 1000.\\'."\n" - .'Default value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'name' => 'addressName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the data address.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_address_name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'ImportTunnelList' => [ - 'description' => 'The details of the tunnels.'."\n", - '$ref' => '#/components/schemas/ListTunnelResp', - ], + 'VerifyAddressResponse' => ['description' => 'The details for verifying the data address.'."\n", '$ref' => '#/components/schemas/VerifyAddressResp', 'title' => ''], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportTunnelList>\\n <Truncated>true</Truncated>\\n <NextMarker/>\\n <ImportTunnel>\\n <Owner>1*5******7**43*</Owner>\\n <TunnelId>****33f-****-4740-****-bc4f****332b3</TunnelId>\\n <CreateTime>2025-08-03T07:09:25.000Z</CreateTime>\\n <ModifyTime>2025-08-04T07:09:26.000Z</ModifyTime>\\n <Tags>K1:V1,K2:V2</Tags>\\n <TunnelQos>\\n <MaxQps>100</MaxQps>\\n <MaxBandwidth>1073741824</MaxBandwidth>\\n </TunnelQos>\\n </ImportTunnel>\\n</ImportTunnelList>","type":"xml"}]', - 'title' => 'ListTunnel', - 'description' => '* To query a list of tunnels, you must have the permission on mgw:ListImportTunnel.'."\n", - ], - 'DeleteTunnel' => [ - 'summary' => 'Deletes a tunnel.', - 'path' => '/tunnel/{tunnelId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/xml', - ], - 'produces' => [ - 'application/xml', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '227642', - 'abilityTreeNodes' => [ - 'FEATUREhcs_mgwI6FP9O', - 'FEATUREhcs_mgwYHC96G', - 'FEATUREhcs_mgw6RQIAN', - 'FEATUREhcs_mgw3H53CV', - 'FEATUREhcs_mgw3ZWPXE', - 'FEATUREhcs_mgwXQ9G18', - 'FEATUREhcs_mgwBC9F99', - 'FEATUREhcs_mgw6BJDT2', - 'FEATUREhcs_mgwXWJG7U', - ], - ], - 'parameters' => [ - [ - 'name' => 'tunnelId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The tunnel ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0b583032-a495-452f-8c0d-692296b51bf9', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'VerifyAddress', + 'description' => '* To verify a data address, you must have the permission on mgw:VerifyImportAddress.'."\n" + .'* A data address may not be available even if the data address passes the availability verification. The data migration results prevail.'."\n", + 'changeSet' => [], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<VerifyAddressResponse>\\n <Status>avaliable</Status>\\n <VerifyTime>2024-05-01T12:00:00.000Z</VerifyTime>\\n <ErrorCode>400</ErrorCode>\\n <ErrorMessage>Invalid argument.</ErrorMessage>\\n</VerifyAddressResponse>","type":"xml"}]', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyAddress'], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', - 'title' => 'DeleteTunnel', - 'description' => '* To delete a tunnel, you must have the permission on mgw:DeleteImportTunnel.'."\n", ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cn-beijing.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'cn-wulanchabu.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'cn-hangzhou.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'cn-shanghai.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'cn-shenzhen.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'cn-chengdu.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'cn-hongkong.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'ap-northeast-1.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ap-southeast-1.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'us-east-1.mgw.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'eu-central-1.mgw.aliyuncs.com', + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-northeast-1.mgw.aliyuncs.com', 'endpoint' => 'ap-northeast-1.mgw.aliyuncs.com', 'vpc' => 'ap-northeast-1.mgw-internal.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-1.mgw.aliyuncs.com', 'endpoint' => 'ap-southeast-1.mgw.aliyuncs.com', 'vpc' => 'ap-southeast-1.mgw-internal.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-beijing.mgw.aliyuncs.com', 'endpoint' => 'cn-beijing.mgw.aliyuncs.com', 'vpc' => 'cn-beijing.mgw-internal.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-chengdu.mgw.aliyuncs.com', 'endpoint' => 'cn-chengdu.mgw.aliyuncs.com', 'vpc' => 'cn-chengdu.mgw-internal.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hangzhou.mgw.aliyuncs.com', 'endpoint' => 'cn-hangzhou.mgw.aliyuncs.com', 'vpc' => 'cn-hangzhou.mgw-internal.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hongkong.mgw.aliyuncs.com', 'endpoint' => 'cn-hongkong.mgw.aliyuncs.com', 'vpc' => 'cn-hongkong.mgw-internal.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shanghai.mgw.aliyuncs.com', 'endpoint' => 'cn-shanghai.mgw.aliyuncs.com', 'vpc' => 'cn-shanghai.mgw-internal.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shenzhen.mgw.aliyuncs.com', 'endpoint' => 'cn-shenzhen.mgw.aliyuncs.com', 'vpc' => 'cn-shenzhen.mgw-internal.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-wulanchabu.mgw.aliyuncs.com', 'endpoint' => 'cn-wulanchabu.mgw.aliyuncs.com', 'vpc' => 'cn-wulanchabu.mgw-internal.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-east-1.mgw.aliyuncs.com', 'endpoint' => 'us-east-1.mgw.aliyuncs.com', 'vpc' => 'us-east-1.mgw-internal.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eu-central-1.mgw.aliyuncs.com', 'endpoint' => 'eu-central-1.mgw.aliyuncs.com', 'vpc' => 'eu-central-1.mgw-internal.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'ApiAccessDeniedError', 'message' => 'This version of the online migration service is no longer supported since 2025-01-10 00:00:00 CST, please use our new service.', 'http_code' => 403, 'description' => 'The old version of the online migration service will be officially offline on January 10, 2025. Please go to the new version of the console to use.'], + ['code' => 'ImportAddressAlreadyExist', 'message' => 'The specified import address already exist.', 'http_code' => 409, 'description' => 'Data address with the same name already exists.'], + ['code' => 'ImportAddressIsOccupied', 'message' => 'The import address is occupied by import job.', 'http_code' => 409, 'description' => 'The data address is in use.'], + ['code' => 'ImportAddressNumExceed', 'message' => 'Import address num exceeded.', 'http_code' => 400, 'description' => 'The number of data addresses exceeds the limit.'], + ['code' => 'ImportAddressTypeInvalid', 'message' => 'Src or dest import address type is invalid.', 'http_code' => 400, 'description' => 'Illegal type of source or destination address.'], + ['code' => 'ImportAgentAlreadyExist', 'message' => 'The specified import agent already exist.', 'http_code' => 409, 'description' => 'An agent with the same name already exists.'], + ['code' => 'ImportAgentIsOccupied', 'message' => 'The import agent is occupied by import address.', 'http_code' => 409, 'description' => 'The agent is being used.'], + ['code' => 'ImportAgentNumExceed', 'message' => 'Import agent num exceeded.', 'http_code' => 400, 'description' => 'The number of agents exceeds the limit.'], + ['code' => 'ImportJobAlreadyExist', 'message' => 'The specified import job already exist.', 'http_code' => 409, 'description' => 'A task with the same name already exists.'], + ['code' => 'ImportJobConcurrencyExceed', 'message' => 'Concurrency running job exceed limit.', 'http_code' => 400, 'description' => 'The number of concurrent tasks exceeds the upper limit.'], + ['code' => 'ImportJobConflictOnUpdateStatus', 'message' => 'Update import job status conflict.', 'http_code' => 409, 'description' => 'Concurrent update task status conflict.'], + ['code' => 'ImportJobHasDescendants', 'message' => 'The job has descendants.', 'http_code' => 409, 'description' => 'There are subtasks for this task.'], + ['code' => 'ImportJobInDeleting', 'message' => 'Import job is in deleting.', 'http_code' => 409, 'description' => 'Task is being deleted.'], + ['code' => 'ImportJobNumExceed', 'message' => 'Import job num exceeded.', 'http_code' => 400, 'description' => 'The number of tasks exceeds the limit.'], + ['code' => 'ImportJobRepeatedOnSameAddress', 'message' => 'Already has job on the same srcAddress and destAddress.', 'http_code' => 409, 'description' => 'A task with the same origin and destination address already exists.'], + ['code' => 'ImportJobUpdateConcurrently', 'message' => 'There is other request update the job concurrently.', 'http_code' => 409, 'description' => 'Concurrent update task status conflict.'], + ['code' => 'ImportTunnelIsOccupied', 'message' => 'The import tunnel is occupied by import agent.', 'http_code' => 400, 'description' => 'The channel is being used.'], + ['code' => 'InternalError', 'message' => 'Internal server error.', 'http_code' => 500, 'description' => 'Internal server error.'], + ['code' => 'InvalidImportJobStatus', 'message' => 'The specified import job status is invalid.', 'http_code' => 400, 'description' => 'Illegal task status.'], + ['code' => 'MissingArgument', 'message' => 'Missing argument.', 'http_code' => 400, 'description' => 'Required parameters are missing.'], + ['code' => 'NoSuchImportAddress', 'message' => 'The specified import address does not exist.', 'http_code' => 404, 'description' => 'The data address does not exist.'], + ['code' => 'NoSuchImportAgent', 'message' => 'The specified import agent does not exist.', 'http_code' => 404, 'description' => 'Agent does not exist.'], + ['code' => 'NoSuchImportJob', 'message' => 'The specified import job does not exist.', 'http_code' => 404, 'description' => 'The task does not exist.'], + ['code' => 'NoSuchImportJobParent', 'message' => 'The specified import job\'s parent does not exist.', 'http_code' => 404, 'description' => 'The parent task does not exist.'], + ['code' => 'NoSuchImportJobRunTimeId', 'message' => 'The specified import job runtime id not exist.', 'http_code' => 404, 'description' => 'The specified task execution ID does not exist.'], + ['code' => 'QpsLimitExceeded', 'message' => 'Qps limit for the operation is exceeded.', 'http_code' => 503, 'description' => 'Request frequency exceeds limit.'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddress'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddress'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyAddress'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgent'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTunnel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAgent'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReport'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTunnel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobResult'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobHistory'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddress'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAgent'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddress'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddress'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTunnel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTunnel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTunnel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateReport'], ], ], ]; |