You need to enable JavaScript to run this app.
文档中心
存储迁移服务

存储迁移服务

复制全文
下载 pdf
网络管理
ListSourceNetworks - 列举源端专线网络
复制全文
下载 pdf
ListSourceNetworks - 列举源端专线网络
分页列举当前账号的源端专线网络。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请参见公共参数。​
Action string 必选 示例值:ListSourceNetworks​
要执行的操作,取值:ListSourceNetworks。​
​
Version string 必选 示例值:2025-01-01​
API 的版本,取值:2025-01-01。​
​
PageNumber integer 可选 示例值:1​
页码,默认值为 1。页码分页从 1 开始;游标分页时保持为 1,避免同时叠加页码偏移。​
​
PageSize integer 可选 示例值:20​
每页返回的源端专线网络数量,默认值为 20。不传或传入非正值,则使用默认值。​
​
IdCursor string 可选 示例值:123456​
按资源 ID 降序分页的游标,首次查询省略,后续传上一页最后一项的 Id。请勿与 NameCursor 混用。​
​
FetchCount boolean 可选 示例值:true​
是否查询并返回 TotalCount。仅字符串 true 会启用统计,默认 false。​
​
NameCursor string 可选 示例值:source-private-network​
按名称升序分页的游标。首次传空字符串,后续传上一页最后一项名称;请勿与 IdCursor 混用。​
​
NamePattern string 可选 示例值:private​
名称包含匹配过滤条件,对当前账号专线网络资源进行模糊匹配。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
HasNext boolean 示例值:false​
是否存在下一页;为 true 时可继续按页码或游标查询。​
​
TotalCount integer 示例值:1​
符合查询条件的专线网络总数。FetchCount=true 时返回实际总数;FetchCount=false 或未传时返回 -1,表示未统计,不是 0,也不表示没有专线网络资源。总数不等于当前页 ItemList 长度,请使用 HasNext 判断是否还有下一页。​
​
ItemList object[] 示例值:[{"Id":"123456","AccountId":"1000000000","SourceNetworkName":"source-private-network","DedicatedLineConfig":{"VpcConfig":{"VpcId":"vpc-example","SubNetId":"subnet-example","SecurityGroupIds":["sg-example"]},"IdcIP":"192.0.2.10","IdcPort":443},"CreateAt":"1791939600000","UpdateAt":"1791939660000","ResourceStatus":"Ready"}]​
当前页源端专线网络详情列表,包括用户 DedicatedLineConfig 和 ResourceStatus,可能包含创建中、失败或删除中的专线网络资源。​
Id string 示例值:123456​
源端专线网络资源 ID,字符串形式的整数。​
​
AccountId string 示例值:1000000000​
专线网络资源所属账号 ID。​
​
SourceNetworkName string 示例值:source-private-network​
源端专线网络名称。​
​
CreateAt string 示例值:1791939600000​
创建时间,Unix 时间戳,单位为毫秒,字符串形式。​
​
UpdateAt string 示例值:1791939660000​
最近更新时间,Unix 时间戳,单位为毫秒,字符串形式。​
​
DedicatedLineConfig object 示例值:{"VpcConfig":{"VpcId":"vpc-example","SubNetId":"subnet-example","SecurityGroupIds":["sg-example"]},"IdcIP":"192.0.2.10","IdcPort":443}​
创建时传入的用户侧 VPC 和源端服务 IP/端口配置。​
VpcConfig object 示例值:{"VpcId":"vpc-example","SubNetId":"subnet-example","SecurityGroupIds":["sg-example"]}​
用户侧 VPC、子网和安全组配置。​
VpcId string 示例值:vpc-example​
用户侧 VPC ID。专线路由应覆盖源端服务。​
​
SubNetId string 示例值:subnet-example​
用户侧子网 ID,应属于指定 VPC。​
​
SecurityGroupIds string[] 示例值:["sg-example"]​
用户侧安全组 ID 列表,不能为空,应放通访问源端服务所需的端口。​
​
​
IdcIP string 示例值:192.0.2.10​
源端服务 IP 地址,对应控制台“源端 IP”。必须是可经所选 VPC 和专线访问的 IP,不支持填写域名或 URL。建议使用 IPv4 地址;如使用 IPv6 地址,请先确认专线及源端服务链路支持,不能仅凭 IP 格式校验通过判断连通性。示例地址为占位值,请替换为实际源端服务地址。​
​
IdcPort integer 示例值:443​
源端服务实际监听的 TCP 端口,对应控制台“源端端口”。取值范围为 1~65535 的整数,无默认值;例如 HTTPS 服务填写 443,HTTP 服务填写 80。安全组、专线路由和源端服务需放通该端口,具体取值以源端服务配置为准。​
​
​
ResourceStatus string 示例值:Ready​
专线网络资源状态:​
  • Creating:创建中。​
  • Ready:可用。​
  • Failed:创建或删除资源失败。​
  • Deleting:删除中。​
仅 Ready 可被源端地址绑定。Creating、Deleting 为处理中状态,需继续查询;删除完成后专线网络资源不再存在,调用 GetSourceNetwork 返回 404。Failed 不区分创建失败与删除失败,当前接口不返回具体失败原因。​
​
​
​
请求示例 1​
​
GET /?Action=ListSourceNetworks&Version=2025-01-01&PageNumber=1&PageSize=20&FetchCount=true​
​
返回示例 1​
​
{​
"ResponseMetadata": {​
"RequestId": "example-request-id",​
"Action": "ListSourceNetworks",​
"Version": "2025-01-01",​
"Service": "dms",​
"Region": "cn-beijing"​
},​
"Result": {​
"HasNext": false,​
"TotalCount": 1,​
"ItemList": [​
{​
"Id": "123456",​
"AccountId": "1000000000",​
"SourceNetworkName": "source-private-network",​
"DedicatedLineConfig": {​
"VpcConfig": {​
"VpcId": "vpc-example",​
"SubNetId": "subnet-example",​
"SecurityGroupIds": [​
"sg-example"​
]​
},​
"IdcIP": "192.0.2.10",​
"IdcPort": 443​
},​
"CreateAt": "1791939600000",​
"UpdateAt": "1791939660000",​
"ResourceStatus": "Ready"​
}​
]​
}​
}​
​
请求示例 2​
​
GET /?Action=ListSourceNetworks&Version=2025-01-01&IdCursor=123457&PageSize=20&FetchCount=false&NamePattern=private​
​
返回示例 2​
​
{​
"ResponseMetadata": {​
"RequestId": "example-request-id",​
"Action": "ListSourceNetworks",​
"Version": "2025-01-01",​
"Service": "dms",​
"Region": "cn-beijing"​
},​
"Result": {​
"HasNext": false,​
"TotalCount": -1,​
"ItemList": [​
{​
"Id": "123456",​
"AccountId": "1000000000",​
"SourceNetworkName": "source-private-network",​
"DedicatedLineConfig": {​
"VpcConfig": {​
"VpcId": "vpc-example",​
"SubNetId": "subnet-example",​
"SecurityGroupIds": [​
"sg-example"​
]​
},​
"IdcIP": "192.0.2.10",​
"IdcPort": 443​
},​
"CreateAt": "1791939600000",​
"UpdateAt": "1791939660000",​
"ResourceStatus": "Ready"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
2002-00000015​
invalid page context​
PageSize、PageNumber 或 IdCursor 不能解析为整数,分页参数无效。请使用页码或游标分页中的一种方式。​
500​
2001-00000001​
service internal error​
列举或统计时数据库、内部依赖失败。实际 Message 以响应为准,请记录 RequestId 并提交工单排查。​
​
​
最近更新时间:2026.11.04 15:04:38
这个页面对您有帮助吗?
有用
有用
无用
无用