项目 API 密钥

项目 API 密钥独立于用户，非常适合自动化工具和 CI/CD。项目中的用户成员资格可能会随时间而变化，并且用户可以随时离开项目。如果用户离开时，其 API 密钥曾在项目功能中使用，则这些密钥将失去对项目资源的访问权限，从而导致意外的自动化故障。通过使用项目 API 密钥并在适当的时间轮换这些密钥，可以避免这些情况。

项目 API 密钥可以访问项目内的资源，但无法访问管理或拥有组织或用户的资源。这意味着项目 API 密钥不能用于获取账单详情，也不能用于邀请新成员加入项目或创建新的项目 API 密钥。如果项目 API 密钥被盗用，项目成员可以轮换密钥，从而降低风险。

创建项目 API 密钥

可以通过在Equinix Metal控制台或 API 本身中创建项目 API 密钥来获取。

Console

您可以在“项目设置”的“API 密钥”选项卡中创建项目 API 密钥。单击“添加 API 密钥”。添加密钥描述，并选择其权限是“读/写”还是“只读”。

API

要创建项目 API 密钥，请向 /projects/{id}/api-keys 端点发送 POST 请求。使用请求体参数添加描述或将密钥设置为只读。

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}/api-keys" \
-d '{
    "description": "string",
    "read_only": false    
}'

管理项目 API 密钥

Console

项目的 API 密钥列在“项目设置”的“API 密钥”选项卡中。

API

要检索与项目关联的所有 API 密钥，请向 /projects/{id}api-keys 端点发送 GET 请求。

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/projects/{id}/api-keys"

删除项目 API 密钥

您可以通过删除项目 API 密钥来撤销使用项目 API 密钥授予的访问权限。这不会影响使用该密钥创建的任何资源。

Console

要从控制台中删除 API 密钥，请导航到“项目设置”的“API 密钥”选项卡，然后单击要删除的密钥旁边的“删除”。

API

要从 API 中删除 API 密钥，请向 api-keys/{id} 端点发送 DELETE 请求。

curl -X DELETE -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/api-keys/{id}"

端点参考

项目 API 密钥对端点具有有限的访问权限，并且范围仅限于创建它们的项目。项目 API 密钥可以执行以下操作：

一般信息

/capacity/metros	获取，发布
/operating-systems	获取 /plans

项目信息

/projects	获取、发布
/projects/{id}	获取、放置、删除 /projects/{id}/batches
/projects/{id}/transfers	帖子 /projects/{id}/usages

设备信息

/projects/{id}/devices	获取、发布
/projects/{id}/devices/batch	帖子
/devices/{id}	获取、放置、删除 /devices/{id}/actions

API 密钥

/api-keys/{id}	删除 /projects/{id}/api-keys

SSH 密钥

/projects/{id}/ssh-keys	获取、发布
/devices/{id}/ssh-keys	获取
/ssh-keys	获取
/ssh-keys	帖子
/ssh-keys/{id}	获取、放置、删除

硬件预订

/hardware-reservations/{id}	获取 /hardware-reservations/{id}/activate
/projects/{project_id}/self-service/reservations	获取，发布 /projects/{project_id}/self-service/reservations/{id}

现货市场

/market/spot/prices	获取 /market/spot/prices/history

IP地址

/devices/{id}/ips	获取、发布
/ips/{id}	获取、修补、删除 /ips/{id}/available
/projects/{project_id}/ips/{id}/customdata	获取 /devices/{instance_id}/ips/{id}/customdata

BGP

/devices/{id}/bgp/neighbors	获取
/projects/{id}/global-bgp-ranges	获取
/projects/{id}/bgp-config	获取、发布
/projects/{id}/bgp/sessions	获取 /devices/{id}/bgp/sessions

第 2 层网络模式和 VLAN

/ports/{id}	获取 /ports/{id}/assign
/virtual-networks/{id}	获取、删除
/projects/{id}/virtual-networks	获取、发布
/ports/{id}/vlan-assignments	获取 /ports/{id}/vlan-assignments/{assignment_id}

Metal网关

/metal-gateways/{id}	获取、删除 /metal-gateways/{id}/ips
/projects/{project_id}/metal-gateways	获取、发布

互联

/connections/{connection_id}	获取、放入、删除
/connections/{connection_id}/events	获取
/connections/{connection_id}/ports	获取 /connections/{connection_id}/virtual-circuits
/virtual-circuits/{id}/events	获取 /virtual-circuits/{id}
/projects/{project_id}/connections	获取，发布

VRF

/projects/{id}/vrfs	获取、发布
/vrfs/{id}	获取、放置、删除 /vrfs/{id}/ips
/routes/{id}	获取、放置、删除 /routes/{id}/events
/metal-gateways/{id}/bgp-dynamic-neighbors	获取，发布
/bgp-dynamic-neighbors/{id}	获取、删除