You need to enable JavaScript to run this app.
导航
专线连接
  • 文档首页
    • /
  • 专线连接

ApplyDirectConnectConnectionLoa

最近更新时间：2024.04.18 19:01:52

首次发布时间：2023.07.05 07:28:41

我的收藏

调用ApplyDirectConnectConnectionLoa提交专线LOA申请。

说明

LOA（Letter of Authorization）是一种授权函。专线连接的LOA用于授权第三方运营商进入火山引擎机房施工，搭建专线连接。

调用说明

a.N.b类型参数中（如Engineers.N.CertificateNo），N表示相关参数的序号，最多可同时传入16个，多个参数之间使用&分隔。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是ApplyDirectConnectConnectionLoa要执行的操作，取值：ApplyDirectConnectConnectionLoa。
VersionString是2020-04-01API版本信息。
DirectConnectConnectionIdString是dcc-3tehy13n2l4c6c0v****物理专线的ID。您可调用DescribeDirectConnectConnections查询物理专线的ID。

Bandwidth

Integer

否

1000

专线带宽，单位：Mbps，不传此参数则默认是端口的规格带宽。

取值不能大于物理专线的带宽。

PeerLocationString否浙江省杭州市余杭区XXXX专线对端地址。

LineType

String

是

MSTP

专线类型。

  • MSTP：MSTP专线
  • MPLSVPN：MPLSVPN专线
  • FIBRE：光纤直连
  • Other：其他类型专线
CompanyNameString是字节跳动物理专线接入的客户公司名称。
SystemIntegratorString是火山引擎施工方单位。
ConstructionTimeString是2023-04-09施工单位入场时间。

Engineers.N.Name

String

是

Engineers.1.Name=张三&Engineers.2.Name=李四

施工工程师的姓名。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、英文逗号（,）、中文逗号（，）、中文句号（。）。
  • 长度限制为60个字符。
Engineers.N.ContactPhoneString是Engineers.1.ContactPhone=1512876****=&Engineers.2.ContactPhone=1382456****施工工程师的联系方式。

Engineers.N.CertificateType

String

是

Engineers.1.CertificateType=IDCard&Engineers.2.CertificateType=IDCard

施工工程师的证件类型，支持：

  • IDCard：身份证
  • Passport：国际护照
Engineers.N.CertificateNoString是Engineers.1.CertificateNo=22222219990101****&Engineers.2.CertificateNo=33333319990101****施工工程师的证件号码，根据证件类型填入身份证号码或国际护照号码。

ClientToken

String

否

123e4567-e89b-12d3-a456-42665544****

客户端Token，用于保证请求幂等性。

  • 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 仅支持ASCII字符，且不能超过64个字符。
  • 若不传入ClientToken，则此次API调用不进行幂等校验。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。

请求示例

GET /？Action=ApplyDirectConnectConnectionLoa&Version=2020-04-01&DirectConnectConnectionId=dcc-3tehy13n2l4c6c0v****&LineType=MSTP&CompanyName=字节跳动&SystemIntegrator=火山引擎&ConstructionTime=2023-04-09&Engineers.1.Name=张三&Engineers.2.Name=李四&Engineers.1.Gender=Male&Engineers.2.Gender=Male&Engineers.1.ContactPhone=1512876****=&Engineers.2.ContactPhone=1382456****&Engineers.1.CertificateType=IDCard&Engineers.2.CertificateType=IDCardEngineers.1.CertificateNo=XXXXXXXXXXXXXXXXXX&Engineers.2.CertificateNo=XXXXXXXXXXXXXXXXXX HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220419155310010225243081****",
        "Action": "ApplyDirectConnectConnectionLoa",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20220419155310010225243081****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidDirectConnectConnection.InvalidStatusThe specified direct connect connection is not in the correct status for the request.指定的物理专线所处的状态无法响应该请求。
400InvalidDirectConnectConnectionLoa.BandwidthMalformedThe specified bandwidth is malformed.指定的带宽不合法。
400InvalidDirectConnectConnectionLoa.BandwidthTooLargeThe specified bandwidth is larger than the port spec of direct connect connection.指定的带宽不能大于物理专线的端口规格。
400InvalidDirectConnectConnectionLoa.CertificateNoMalformedThe specified engineer ID number is malformed.指定的施工工程师证件号码不合法。
400InvalidDirectConnectConnectionLoa.CompanyNameMalformedThe specified company name is malformed.指定的公司名称不合法。
400InvalidDirectConnectConnectionLoa.ConstructionTimeMalformedThe specified construction time is malformed.指定的施工时间不合法。
400InvalidDirectConnectConnectionLoa.EngineerCertificateTypeMalformedThe specified engineer ID type is malformed. Only support given values: IDCard and Passport.指定的施工工程师证件类型不合法，仅支持中国大陆身份证和护照。
400InvalidDirectConnectConnectionLoa.EngineerContactPhoneMalformedThe specified engineer contact phone is malformed.指定的施工工程师联系方式不合法。
400InvalidDirectConnectConnectionLoa.EngineerNameMalformedThe specified engineer name is malformed.指定的施工工程师姓名不合法。
400InvalidDirectConnectConnectionLoa.InvalidDirectConnectConnectionStatusThe specified direct connect connection does not support current operation.指定的物理专线状态不支持该操作。
400InvalidDirectConnectConnectionLoa.LineTypeMalformedThe specified line type is malformed. Only support given values: FIBRE, MSTP, MPLSVPN and Other.指定的线路类型不合法，仅支持光纤直连, MSTP, MPLSVPN, 其他。
400InvalidDirectConnectConnectionLoa.PeerLocationMalformedThe specified peer location is malformed.指定的物理专线对端位置格式不合法。
400InvalidDirectConnectConnectionLoa.SystemIntegratorMalformedThe specified system integrator is malformed.指定的施工单位格式不合法。
400InvalidDirectConnectConnectionLoa.TooManyEngineersYou've reached the limit on the number of engineers per direct connect connection LOA. The upper limit is 16.最多指定16名专线施工工程师。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
404InvalidDirectConnectConnection.NotFoundThe specified direct connect connection does not exist.指定的物理专线不存在。
409InvalidDirectConnectConnectionLoa.ExistedThe specified direct connect connection LOA already exists.指定的物理专线LOA已经申请。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。