全部产品
Search

搜索本产品

    私网连接 PrivateLink：AttachSecurityGroupToVpcEndpoint - 将终端节点加入安全组

    文档中心

    私网连接 PrivateLink：AttachSecurityGroupToVpcEndpoint - 将终端节点加入安全组

    更新时间：Sep 26, 2024

    调用AttachSecurityGroupToVpcEndpoint接口，将终端节点加入安全组。

    接口说明

    • AttachSecurityGroupToVpcEndpoint 接口属于异步接口，即系统会返回一个请求 ID，但终端节点加入安全组尚未完成，系统后台添加任务仍在进行中。您可以调用 ListVpcEndpoints 查询终端节点的状态：

      • 当终端节点处于 Pending 状态时，表示终端节点正在添加中。
      • 当终端节点处于 Active 状态时，表示终端节点添加完成。

    • AttachSecurityGroupToVpcEndpoint 接口不支持将同一个终端节点实例并发加入安全组。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    privatelink:AttachSecurityGroupToVpcEndpointupdate
    • VpcEndpoint
      acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}
    • SecurityGroup
      acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    要加入安全组的终端节点所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。

    		eu-west-1
    SecurityGroupIdstring是

    要加入的安全组的 ID。

    		sg-hp3c8qj1tyct90ej****
    EndpointIdstring是

    要加入安全组的终端节点的 ID。

    		ep-hp33b2e43fays7s8****
    DryRunboolean否

    是否只预检此次请求。取值：

    • true：发送检查请求，不会加入安全组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
    • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。
    		false
    ClientTokenstring否

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

    从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

    		0c593ea1-3bea-11e9-b96b-88e9fe637760

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		8D778FF9-7640-4C13-BCD6-9265CA9A2F81

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "8D778FF9-7640-4C13-BCD6-9265CA9A2F81"
}

    错误码

    HTTP status code错误码错误信息描述
    400EndpointNotFoundThe specified Endpoint does not exist.当前终端节点未找到。
    400EndpointOperationDeniedThe specified operation of endpoint is not allowed.当前终端节点正在处理中，不允许操作。
    400EndpointLockedThe specified Endpoint is locked.当前终端节点已经被锁定。
    400EndpointConnectionOperationDeniedThe endpoint is being connected.终端节点连接正在处理中，不允许操作。
    400SecurityGroupExistThe specified security group already exists.当前安全组已经存在。
    400EndpointServiceDeletedThe specified Service is already deleted.终端节点服务已经被删除
    400SecurityGroupNotFoundThe specified security group does not exist.当前安全组未找到。
    400SecurityGroupTypeNotSupportThe specified security group type is not supported.该安全组类型不支持
    400SecurityGroupTypeOnlySingleTypeSupportededThe specified security group only support one type.安全组只支持一种类型
    400GatewayLoadBalancerNotSupportSecurityGroupThe gateway load balancer not support security group.网关型负载均衡类型不支持设置安全组

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

    变更历史

    变更时间变更内容概要操作
    2024-09-18OpenAPI 错误码发生变更查看变更详情