AssociateMacSecKey - 关联MacSec密钥

更新时间:
复制 MD 格式

支持在独享物理专线端口上面关联MacSec密钥,通过专用加密芯片(如 NIC 或交换机)实现低延迟加密/解密,从而直接对物理链路(如光纤、以太网)进行加密,覆盖从发送方到接收方的全部流量。

接口说明

使用该功能需要满足以下条件:

  • 物理专线所在的设备支持 MacSec 特性

  • 物理专线需要付款完成

  • 只支持在独享物理专线配置

其他使用说明:

  • 最多只支持配置 3 组 Ckn 和 Cak

  • 关联当前处于 Disassociated 状态的密钥,会取消关联之前生效的密钥

  • 关联当前处于 AssociatedFailed 状态的密钥,会触发设备进行重新协商会话

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:AssociateMacSecKey

update

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

物理专线所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

PhysicalConnectionId

string

是

物理专线 ID。物理专线必须是已完成付费、设备支持 MACsec 的独享物理专线,并处于 Enabled 状态。可通过 DescribePhysicalConnections 查询当前状态和设备能力。

pc-bp1hp0wr072f6****

CipherSuite

string

是

加密算法类型,取值范围:

  • GCM-AES-128

  • GCM-AES-XPN-128

  • GCM-AES-256

  • GCM-AES-XPN-256

GCM-AES-128

Ckn

string

是

密钥名称,只支持十六进制字符,小写会自动转换为大写,当加密算法类型是 GCM-AES-128 或者 GCM-AES-XPN-128 时,长度要求为 32 个十六进制字符,当加密算法类型是 GCM-AES-256 或者 GCM-AES-XPN-256 时,长度要求为 64 个十六进制字符

0123456789ABCDEF0123456789ABCDEF

Cak

string

是

密钥密码,只支持十六进制字符,小写会自动转换为大写,当加密算法类型是 GCM-AES-128 或者 GCM-AES-XPN-128 时,长度要求为 32 个十六进制字符,当加密算法类型是 GCM-AES-256 或者 GCM-AES-XPN-256 时,长度要求为 64 个十六进制字符

0123456789ABCDEF0123456789ABCDEF

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

D32B3C26-6C6C-4988-93E9-D2A6444CE6AE

示例

正常返回示例

JSON格式

{
  "RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE"
}

错误码

HTTP status code

错误码

错误信息

描述

400 IllegalParam.%s The param of %s is illegal. 指定的参数非法
400 ResourceNotFound.PhysicalConnectionId The specified resource of [%s] is not found. PhysicalConnection不存在。
400 IncorrectStatus.PhysicalConnection The status of %s [%s] is incorrect. 物理专线的状态不支持此操作。
400 UnsupportedFeature.Macsec The feature of Macsec is not supported. 当前物理专线不支持MACSec特性。
400 IncorrectStatus.PconnMacsec The status of %s [%s] is incorrect. 不允许进行操作因为有MACSec秘钥处于非稳态。
400 QuotaExceeded.PconnMacsec The quota of PconnMacsec is exceeded, usage 3/3. 一条物理专线最多支持绑定3组MACSec秘钥。
400 UnsupportedFeature.Macsec.CipherSuite The feature of Macsec.CipherSuite is not supported. 当前物理专线支持MACSec,但是不支持选择的加密算法。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。