文档

AddUserToVpcEndpointService - 添加服务白名单

更新时间:

调用AddUserToVpcEndpointService接口,为终端节点服务添加服务白名单。

接口说明

  • 添加服务白名单之前,请确保终端节点服务处于 Active 状态,您可以通过调用 GetVpcEndpointServiceAttribute 接口,查询终端节点服务状态。
  • AddUserToVpcEndpointService 接口不支持在同一个阿里云账号(主账号)下并发添加服务白名单。

调试

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

授权信息

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

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

请求参数

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

要添加服务白名单的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

eu-west-1
UserIdlong

服务白名单账号 ID。

132193271328****
ServiceIdstring

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
DryRunboolean

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

  • true:发送检查请求,不会添加服务白名单。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

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

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

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

ARN 格式的用户白名单。

acs:ram:*:<account-id>:*

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

示例

正常返回示例

JSON格式

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

错误码

HTTP status code错误码错误信息描述
400EndpointServiceNotFoundThe specified Service does not exist.当前终端节点服务不存在
400MissingParam.UserArnThe param of UserArn is missing.参数UserArn缺失。
400Mismatch.UserIdAndUserArnThe %s and %s are mismatched.参数%s和%s不匹配。

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

变更历史

变更时间变更内容概要操作
2023-07-31OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-09-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-06-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:UserARN
  • 本页导读 (1)
文档反馈