create-address (创建数据地址)

更新时间:
复制为 MD 格式

使用mgwutil create-address命令通过指定参数创建支持多种存储类型(如OSS、S3、COS等)的数据地址。

命令格式

mgwutil create-address <address-name> --address-type <value> [--bucket <value>] [--domain <value>]...

参数说明

参数

必填

说明

address-name

待创建的数据地址名称。

--address-type

数据地址类型。

可取值可参考文档AddressDetail

--data-type

当 AddressType = "inv" 时,DataType 表示该清单项所关联的实际对象存储服务类型。

可取值为:

oss、s3、cos等。

--bucket

源端或目的端的 Bucket 名称,用于指定数据传输所使用的对象存储桶。

--prefix

前缀,当源端为local类型时该参数必填。

--domain

源端或目的端对应的对象存储服务访问域名(Endpoint),用于指定数据传输的接入地址。

--region-id

源端或目的端的区域 ID,当对应端存储类型为 OSS 时必填,用于指定阿里云 OSS 所在地域(如 oss-cn-hangzhou)。

--access-id

源端或目的端的 AccessId,用于访问对应对象存储服务的身份认证凭证。

--access-secret

源端或目的端的 AccessSecret,用于访问源对象存储服务的身份认证密钥。

--role

授权角色。数据存储空间为 OSS 时,可以指定授权角色,无需指定存储空间的 AK。

授权角色可参考文档 迁移实施

--agent-list

源端或目的端地址关联的代理列表(例如:agent1,agent2,agent3)。

--inv-access-id

创建清单类型地址时,用于访问清单存放 Bucket 的 AccessId。

--inv-access-secret

创建清单类型地址时,用于访问清单存放 Bucket 的 AccessSecret。

--inv-domain

清单域名,用于指定创建清单类型地址时清单文件所在存储服务的访问 Endpoint。

--inv-region-id

OSS 清单源(ossinv)的 Region ID,用于指定清单所在阿里云 OSS 的地域(如 cn-hangzhou)。

--inv-bucket

清单存放 Bucket 名称,用于指定创建清单类型地址时清单文件的存储位置。

--inv-location

清单源类型,用于指定创建清单类型地址时清单文件所在存储服务的类型,通常填写 oss

--inv-path

清单文件路径,用于指定创建清单类型地址时 manifest.json 文件在存储桶中的完整对象路径(如 path/to/manifest.json)。

--inv-role

清单列表存储空间授权角色。列表存储空间是 OSS 时,可以指定授权角色,无需指定列表存储空间的 AK。

清单列表存储空间授权角色可参考文档 迁移实施

使用示例

OSS

以下示例用于创建数据源为OSS的数据地址。

mgwutil create-address "mgwutil_src_agent-1" --address-type oss --bucket "bucket-beijing" --role "oss-import-*" --region-id "oss-cn-beijing"

LOCAL

以下示例用于创建数据源为LOCAL的数据地址。

mgwutil create-address "mgwutil_src_agent-1" --address-type local  --prefix "/mnt/abc/" --agent-list "local-agent" 

INV

说明

通用清单源支持云存储原生清单和迁移服务自定义清单。

以下示例用于创建数据源为OSS清单的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type inv  --data-type oss --bucket "bucket-oss" --role "oss-import-*" --region-id "oss-cn-beijing" --inv-bucket "bucket-beijing" --inv-location "oss" --inv-path "dir/manifest.json" --inv-region-id "oss-cn-beijing" --inv-role "oss-import-*"

以下示例用于创建数据源为S3清单的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type inv  --data-type s3 --bucket "bucket-beijing"--domain "s3.us-east-1.amazonaws.com" --bucket "bucket-s3"  --access-id "*******" --access-secret "*******" --inv-bucket "bucket-s3" --inv-location "s3" --inv-path "dir/manifest.json" --inv-domaim "s3.us-east-1.amazonaws.com" 

以下示例用于创建数据源为S3-COMPAT清单的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type inv  --data-type s3-compat --bucket "bucket-s3-compat"   --inv-bucket "bucket-beijing" --inv-location "oss" --inv-path "dir/manifest.json" --inv-region-id "oss-cn-beijing" 

以下示例用于创建数据源为COS清单的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type inv  --data-type cos --domain "cos.ap-nanjing.myqcloud.com" --bucket "bucket-cos" --access-id "*******" --access-secret "*******" --inv-bucket "bucket-beijing" --inv-location "cos" --inv-path "dir/manifest.json" --inv-domain "cos.ap-nanjing.myqcloud.com" 

以下示例用于创建数据源为TOS清单的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type inv  --data-type tos --address-type tos --domain "tos-s3-cn-beijing.volces.com" --bucket "bucket-tos" --access-id "*******" --access-secret "*******" --inv-bucket "bucket-beijing" --inv-location "tos" --inv-path "dir/manifest.json" --inv-domain "tos-s3-cn-beijing.volces.com" 

以下示例用于创建数据源为OBS清单的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type inv  --data-type obs --domain "obs.cn-north-1.myhuaweicloud.com" --bucket "bucket-obs" --access-id "*******" --access-secret "*******" --inv-bucket "bucket-obs" --inv-location "obs" --inv-path "dir/manifest.json" --inv-domain "obs.cn-north-1.myhuaweicloud.com" 

HTTP

以下示例用于创建数据源为HTTP清单的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type http  --bucket "bucket-http" --role "oss-import-*" --region-id "oss-cn-beijing" --inv-bucket "bucket-beijing" --inv-location "oss" --inv-path "dir/manifest.json" --inv-region-id "oss-cn-beijing" 

S3

以下示例用于创建数据源为S3的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type s3 --domain "s3.us-east-1.amazonaws.com" --bucket "bucket-s3"  --access-id "*******" --access-secret "*******"

S3COMPAT

以下示例用于创建数据源为S3COMPAT(兼容S3)的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type s3compat --domain "<s3-compat-url>" --bucket "bucket-s3-compat"  --access-id "*******" --access-secret "*******"

COS

以下示例用于创建数据源为COS的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type cos --domain "cos.ap-nanjing.myqcloud.com" --bucket "bucket-cos" --access-id "*******" --access-secret "*******"

OBS

以下示例用于创建数据源为OBS的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type obs --domain "obs.cn-north-1.myhuaweicloud.com" --bucket "bucket-obs" --access-id "*******" --access-secret "*******"

TOS

以下示例用于创建数据源为TOS的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type tos --domain "tos-s3-cn-beijing.volces.com" --bucket "bucket-tos" --access-id "*******" --access-secret "*******"

BOS

以下示例用于创建数据源为BOS的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type bos --domain "bj.bcebos.com" --bucket "bucket-bos" --access-id "*******" --access-secret "*******"

QINIU

以下示例用于创建数据源为QINIU的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type qiniu --domain "<七牛自定义源站或者CDN域名>" --bucket "bucket-qiniu" --access-id "*******" --access-secret "*******"

KS3

以下示例用于创建数据源为KS3的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type ks3 --domain "ks3-cn-beijing.ksyuncs.com" --bucket "bucket-ks3" --access-id "*******" --access-secret "*******"

AZURE

以下示例用于创建数据源为AZURE的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type azure --domain "https://<存储账号>.blob.core.windows.net" --bucket "bucket-azure" --access-secret "*******"

GCP

以下示例用于创建数据源为GCP的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type gcp --domain "<存储桶(Bucket)的请求端点(Cloud Storage URI)>" --bucket "bucket-gcp" --access-id "*******" --access-secret "*******"

YOUPAI

以下示例用于创建数据源为YOUPAI的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type upyun  --bucket "youpai-bucket" --domain "s3.api.upyun.com" --access-id "*******" --access-secret "*******"

UClOUD

以下示例用于创建数据源为UClOUD的数据地址。

mgwutil create-address  "mgwutil_src_agent-1" --address-type ucloud  --bucket "us3-bucket" --domain "cn-bj.ufileos.com" --access-id "*******" --access-secret "*******"

FTP

以下示例用于创建数据源为FTP的数据地址。

mgwutil create-address "ftp-ss-src-0127" --address-type ftp --agent-list "ftp-server-test" --prefix "/home/normal/" --domain "127.0.0.1:21" --access-id "drs_e2e" --access-secret "******"

OSSINV

以下示例用于创建数据源为OSSINV的数据地址。

mgwutil create-address "ossinv-oss-src-0127" --address-type ossinv --bucket "src-common-cn-hangzhou" --role "src-common-cn-hangzhou" --region-id "oss-cn-hangzhou" --inv-bucket "ossinv-src-common-cn-hangzhou" --inv-location oss --inv-path "ossinv-common/manifest.json" --inv-role "import-ossinv-src-common-cn-han" --inv-region-id "oss-cn-hangzhou"

S3INV

以下示例用于创建数据源为S3INV的数据地址。

mgwutil create-address "s3inv-oss-src-0127" --address-type s3inv --domain "s3.ap-southeast-1.amazonaws.com" --bucket "src-common-ap-southeast-1" --access-id "AK******" --access-secret "SK******" --inv-bucket "s3inv-src-common-ap-southeast-1" --inv-location s3 --inv-path "s3inv-common/common/manifest.json" --inv-access-id "AK******" --inv-access-secret "SK*******" --inv-domain "s3.ap-southeast-1.amazonaws.com"

返回结果

成功返回

{
  "Code":      "success" ,
  "StatusCode": 200,
  "LogTime": "2025-12-25 17:51:37",
  "Data":       {
    "AddrName": "mgwutil_src_agent-1",
    "Version": "***-2713-4cdc-88c7-***",
    "CreateTime": "2025-07-17T13:36:37.000Z",
    "Status": "notVerify",
    "AddrType": "oss",
    "AgentList": "mgwutil_agent_1"
  }
}

失败返回

{
  "Code": "fail",
  "StatusCode": 400,
  "LogTime": "2026-01-16 11:31:03",
  "ErrorMsg": "SDKError:    StatusCode: 400    Code: InvalidArgument    Message: AddressType is invalid    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1****96***69****.cn-hangzhou.mgw.aliyuncs.com','requestId':'6969B0F79367063435CAC345','statusCode':400} ",
  "ErrorCode": "InvalidArgument",
  "RequestId": "6969B0F79367063435CAC345"
}

错误码

说明
  • 错误码表示错误类别,详情请参考错误信息(ErrorMsg)。

  • 此错误码包含 通用错误码

ErrorCode

说明

MissingArgument

缺少必要参数,请根据命令要求提供所有必需的参数。

InvalidArgument

参数名无效或者参数值不合法。

ImportAddressAlreadyExist

同名地址已存在,请使用唯一名称或先删除现有地址。

NoSuchImportAgent

关联的代理不存在,请确认--agent-list代理列表名称输入无误。

ImportAddressNumExceed

用户数据地址个数超过限制。

默认限制:200个。