创建 Z 端服务令牌
Z端服务令牌是允许Equinix Fabric上的其他客户与您建立连接的唯一密钥。
您可以为以下资产类型创建Z端令牌:
- Fabric端口(EVPL和EPL类型)
- Network Edge虚拟设备
- 多点网络- E - LAN,E - Tree和E - Access。
Z端服务令牌创建并与其他客户共享后,他们可以兑换令牌,以便与预定义为目标的资产建立连接。

创建虚拟连接后,兑换Z端令牌的客户(源A侧资产的所有者)将为虚拟连接收取费用。Z端服务令牌还可用于允许贵组织内在其他项目中拥有资产的其他用户连接到项目中的资产。
有关兑换Z端服务令牌的详细信息,请参阅兑换Z端服务令牌。
先决条件
创建服务令牌之前,您必须具备以下条件:
- 客户门户网站账户。
- 现有端口,虚拟设备或多点网络。
- 要为其创建服务令牌的资产的访问权限。
- Portal
- API
-
登录客户门户网站并导航至_Fabric控制面板_。
-
从_服务令牌_菜单中,选择创建服务令牌。

-
在“服务令牌类型”部分中,选择Z端服务令牌。

-
身份验证 - 提交您的 OAuth2 用户凭据、客户端 ID 和客户端密钥 验证。有关如何致电OAuth API以验证和验证您的凭据的说明,请参阅API验证。
-
确定Z侧资产信息。
-
如果您正在使用端口,请向端点发送
GET请求/fabric/v4/ports。您需要提供端口UUID,端口类型,链路协议类型(Dot1Q或QinQ)。 -
如果您使用的是虚拟设备,请向端点发送
GET请求/ne/v1/devices。您需要设备UUID。向端点发送GET请求/ne/v1/devices/{device_id}以获取设备详情。您可以在设备上选择任何可用接口进行连接。如果不指定接口,连接将自动分配给下一个可用接口。 -
如果您使用多点网络,请向端点发送
GET请求/fabric/v4/networks/{networkId}。您需要网络的类型和UUID。
-
为端口创建服务令牌
- Portal
- API
-
在_Z侧资产_下拉菜单中,选择端口。
-
单击**+选择端口**,然后从列表中选择服务令牌的特定端口。单击选择端口。

-
单击下一步。
-
在_连接设置_中:
- 输入Z侧资产上连接的VLAN ID。
- 选择供令牌用户使用的带宽。单击_添加其他带宽_以创建自定义_带宽_选项。
- 选择是否允许远程连接。选中“_允许远程连接_BOX”,以允许令牌用户从Z端资产所在位置以外的都会区进行连接。

-
在_服务令牌设置_中:
- 输入服务令牌的到期日期。令牌必须在该日期之前兑换,否则将过期。最大日期范围为90天。
- 输入有权使用服务令牌的用户的电子邮件地址。您最多可以输入12个收件人。任何收件人只能使用一次令牌。

-
单击下一步。
-
在“查看”页面上,查看“_服务令牌类型”_和“服务__令牌__设置”面板中的信息。

准备就绪后,单击创建服务令牌。
要为端口创建Z端服务令牌,请向端点发送POST请求/fabric/v4/serviceTokens。在请求正文中提供您的连接设置,端口详情和服务令牌设置。
-
在
connection对象中,指定:- 连接类型基于底层端口:
EVPL_VC或EPL_VC。 - 此令牌是否可用于创建远程连接。
- 连接允许的带宽。
- 此令牌是否允许将自定义带宽用于连接。
- 连接类型基于底层端口:
-
在
zSide对象中,指定:typeASCOLO。- 端口的UUID。
- 端口的链路协议类型和相应的VLAN信息。
-
使用
expirationDateTime该字段以ISO 8601格式指定令牌过期的日期和时间。 -
在
notifications对象中,指定令牌收件人的电子邮件地址。
cURL 请求示例:
curl -X POST 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <token>'
-d '{
"type": "VC_TOKEN",
"name": "<service_token_name>",
"description": "<service_token_description>",
"connection": {
"type": "EVPL_VC",
"allowRemoteConnection": <boolean>,
"allowCustomBandwidth": <boolean>,
"supportedBandwidths": [
<bandwidth_speed>,
<bandwidth_speed>,
<bandwidth_speed>
],
"zSide": {
"accessPointSelectors": [
{
"type": "COLO",
"port": {
"uuid": "<port_uuid>"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": "<vlan_ID>"
}
}
]
}
},
"expirationDateTime": "<expiration_date>",
"notifications": [
{
"type": "NOTIFICATION",
"emails": [
"<email_address>"
]
}
]
}'
为虚拟设备创建服务令牌
- Portal
- API
-
在_Z侧资产_下拉菜单中,选择虚拟设备。
-
选择虚拟设备类型:
- 单设备 - 单实例虚拟设备。
- 冗余设备-一对冗余虚拟设备。重要提示:要创建到冗余设备的冗余连接,您必须为冗余对中的每台设备创建单独的服务令牌。
- 集群 - 集群式虚拟设备。
-
单击**+选择虚拟设备并从列表中选择虚拟设备实例。单击选择虚拟设备**。

-
单击下一步。
-
在_连接设置_中:
- 配置用于连接的接口。选择是使用下一个可用接口,还是选择特定接口。
- 选择供令牌用户使用的带宽。单击_添加其他带宽_以创建自定义_带宽_选项。
- 选择是否允许远程连接。选中“_允许远程连接_BOX”,以允许令牌用户从Z端资产所在位置以外的都会区进行连接。

-
在_服务令牌设置_中:
- 输入服务令牌的到期日期。令牌必须在该日期之前兑换,否则将过期。最大日期范围为90天。
- 输入有权使用服务令牌的用户的电子邮件地址。您最多可以输入12个收件人。任何收件人只能使用一次令牌。

-
单击下一步。
-
在“查看”页面上,查看“_服务令牌类型”_和“服务__令牌__设置”面板中的信息。

准备就绪后,单击创建服务令牌。
要为虚拟设备创建Z端服务令牌,请向端点发送POST请求/fabric/v4/serviceTokens。在请求正文中提供您的连接设置,虚拟设备详情和服务令牌设置。
-
在
connection对象中,指定:- 此令牌是否可用于创建远程连接。
- 连接允许的带宽。
- 此令牌是否允许将自定义带宽用于连接。
-
在
zSide对象中,指定:typeASVD。- 您的虚拟设备UUID。
- 用于服务令牌连接的接口。如果省略该
interface对象,则将使用设备上的下一个可用接口进行连接。
-
使用
expirationDateTime该字段以ISO 8601格式指定令牌过期的日期和时间。 -
在
notifications对象中,指定令牌收件人的电子邮件地址。
cURL 请求示例:
curl -X POST 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <token>'
-d '{
"type": "VC_TOKEN",
"name": "<service_token_name>",
"description": "<service_token_description>",
"connection": {
"type": "EVPL_VC",
"allowRemoteConnection": <boolean>,
"allowCustomBandwidth": <boolean>,
"supportedBandwidths": [
<bandwidth_speed>,
<bandwidth_speed>,
<bandwidth_speed>
],
"zSide": {
"accessPointSelectors": [
{
"type": "VD",
"virtualDevice": {
"type": "EDGE",
"uuid": "<virtual_device_uuid>"
},
"interface": {
"type": "NETWORK",
"id": <interface_id>
}
}
]
}
},
"expirationDateTime": "<expiration_date>",
"notifications": [
{
"type": "NOTIFICATION",
"emails": [
"<email_address>"
]
}
]
}'
为多点网络创建服务令牌
- Portal
- API
-
在_Z侧资产_下拉菜单中,选择多点网络。
-
单击**+选择网络并从列表中选择多点网络。单击选择网络**。

-
单击下一步。
-
在_连接设置_中:
- 请注意,从E-Tree服务令牌创建的连接将默认为Leaf。作为网络所有者,您可以在服务令牌兑换且连接配置完毕后将连接角色编辑为“根”。
- 选择供令牌用户使用的带宽。单击_添加其他带宽_以创建自定义_带宽_选项。

-
在_服务令牌设置_中:
- 输入服务令牌的到期日期。令牌必须在该日期之前兑换,否则将过期。最大日期范围为90天。
- 输入有权使用服务令牌的用户的电子邮件地址。您最多可以输入12个收件人。任何收件人只能使用一次令牌。

-
单击下一步。
-
在“查看”页面上,查看“_服务令牌类型”_和“服务__令牌__设置”面板中的信息。

准备就绪后,单击创建服务令牌。
要为多点网络创建Z端服务令牌,请向端点发送POST请求/fabric/v4/serviceTokens。在请求正文中提供您的连接设置,网络详情和服务令牌设置。
-
在
connection对象中,指定:- 连接类型为
EVPLAN_VC,或EPTREE_VC``EPLAN_VC,EVPTREE_VC具体取决于您的网络配置。 - 此令牌是否可用于创建远程连接。
- 连接允许的带宽。
- 此令牌是否允许将自定义带宽用于连接。
- 连接类型为
-
在
zSide对象中:- 指定
type为NETWORK。 - 将网络类型指定为
EVPLAN,EPLAN,,EVPTREE或EPTREE。 - 提供网络的UUID。
- 指定
-
使用
expirationDateTime该字段以ISO 8601格式指定令牌过期的日期和时间。 -
在
notifications对象中,指定令牌收件人的电子邮件地址。
cURL 请求示例:
curl -X POST 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <token>'
-d '{
"type": "VC_TOKEN",
"name": "<service_token_name>",
"description": "<service_token_description>",
"connection": {
"type": "EVPLAN_VC",
"allowRemoteConnection": <boolean>,
"supportedBandwidths": [
<bandwidth_speed>,
<bandwidth_speed>,
<bandwidth_speed>
],
"zSide": {
"accessPointSelectors": [
{
"type": "NETWORK",
"network": {
"type": "EVPLAN",
"uuid": "<network_uuid>"
}
}
]
}
},
"expirationDateTime": "<token_expiration_date>",
"notifications": [
{
"type": "NOTIFICATION",
"emails": [
"<email_address>"
]
}
]
}'
服务令牌状态
服务令牌创建完毕后,可以检查其状态,包括是否已由其他客户兑换。如果状态为Inactive,则服务令牌尚未兑换。如果状态为Active,则表示服务令牌已兑换。
使用Z端令牌的连接创建者将为此连接收取费用。
如果状态为Expired,则服务令牌已到达到期日,但未兑换。
- Portal
- API
要检查服务令牌的状态,请向端点发送GET请求/fabric/v4/serviceTokens。响应包括您的服务令牌列表及其在字段中的状态state。
cURL 请求示例:
curl -X GET 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Authorization: Bearer <token>'
