华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：2048 Content-Type 否 String 发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json

状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：2048 Content-Type 否 String 发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json 最小长度：1 最大长度：64

响应示例 状态码： 200 服务器已成功处理了请求 { "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "service_type" : "interface", "marker_id" : 16777337, "status" : "accepted", "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "enable_dns" : false, "endpoint_service_name" : "test123", "endpoint_service_id" : "test123", "project_id" : "6e9dfd51d1124e8d8498dce894923a0d", "whitelist" : [ "127.0.0.1" ], "enable_whitelist" : true, "created_at" : "2022-04-14T09:35:47Z", "updated_at" : "2022-04-14T09:36:47Z"}

概述 欢迎使用 VPC终端节点 （VPC Endpoint）服务。VPC终端节点使您能够将VPC私密地连接到终端节点服务（云服务、用户私有服务），无需弹性公网IP，为您提供性能强大、组网灵活、安全稳定的网络环境。 您可以使用本文档提供的API对VPC终端节点的资源进行相关操作，如创建、查询、修改、删除等。支持的全部操作请参见2 API概览。 在调用VPC终端节点服务的API之前，请确保已经充分了解VPC终端节点服务的相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

状态码 正常 表1 正常时的返回值 状态码 返回值 状态码说明 200 OK POST、GET和PUT操作正常返回。 204 No Content DELETE操作正常返回。 异常 表2 异常时的返回值 状态码 返回值 状态码说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成，服务异常。 501 Not Implemented 请求未完成，服务器不支持所请求的功能。 502 Bad Gateway 请求未完成，服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成，系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 附录

请求示例 添加终端节点服务的白名单 POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/permissions/action{ "permissions" : [ "iam:domain::fc973eea581490997e82ea11a1d0101" ], "action" : "add"} 移除终端节点服务的白名单 POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/permissions/action{ "permissions" : [ "iam:domain::fc973eea581490997e82ea11a1d0101" ], "action" : "remove"}

状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 permissions Array of strings permission列表。 权限格式为：iam:domain::domain_id或者organizations:orgPath::org_path其中， ● “iam:domain::”和“organizations:orgPath::”为固定格式。 ● “domain_id”为可连接用户的帐号ID，org_path可连接用户的组织路径 domain_id类型支持输入包括“a~z”、“A~Z”、“0~9”或者“”，org_path类型支持“a~z”、“A~Z”、“0~9”、“/-?”或者“”。 “”表示所有终端节点可连接。 例如：iam:domain::6e9dfd51d1124e8d8498dce894923a0dd或者organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/* permission_type String 终端节点服务白名单类型。 ● domainId：基于账户ID配置终端节点服务白名单。 ● orgPath：基于账户所在组织路径配置终端节点服务白名单。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表6 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表8 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表10 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表12 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 405 表13 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表14 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 406 表15 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表16 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 407 表17 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表18 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 408 表19 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表20 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 409 表21 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表22 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 500 表23 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表24 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 501 表25 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表26 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 502 表27 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表28 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 503 表29 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表30 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 504 表31 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表32 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：2048 Content-Type 否 String 发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json 最小长度：1 最大长度：65 表3 请求Body参数 参数 是否必选 参数类型 描述 permissions 是 Array of strings permission列表。 权限格式为：iam:domain::domain_id或者organizations:orgPath::org_path其中， ● “iam:domain::”和“organizations:orgPath::”为固定格式。 ● “domain_id”为可连接用户的帐号ID，org_path可连接用户的组织路径 domain_id类型支持输入包括“a~z”、“A~Z”、“0~9”或者“，最大长度可以传64； org_path类型支持“a~z”、“A~Z”、“0~9”、“/-?”或者“”，最大长度可以传1024； “”表示所有终端节点可连接。 例如：iam:domain::6e9dfd51d1124e8d8498dce894923a0dd或者organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/* permission_type 否 String 终端节点服务白名单类型。 ● domainId：基于账户ID配置终端节点服务白名单。 ● orgPath：基于账户所在组织路径配置终端节点服务白名单。 action 是 String 要执行的操作。 add/remove。 最小长度：1 最大长度：32

URI POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：64 vpc_endpoint_service_id 是 String 终端节点服务的ID。 最小长度：1 最大长度：64

响应示例 状态码： 200 服务器已成功处理了请求 { "versions" : [ { "updated" : "2018-09-30T00:00:00Z", "version" : "1", "min_version" : "", "status" : "CURRENT", "id" : "v1", "links" : [ { "href" : "https://{vpcep_uri}/v1", "type" : "application/json", "rel" : "self" } ] } ]}

状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 versions Array of VersionObject objects VPC终端节点版本信息列表。 表3 VersionObject 参数 参数类型 描述 status String 版本状态。 ● CURRENT：表示该版本为主推版本。 ● SUPPORT：表示为老版本，但是现在还在继续支持。 ● DEPRECATED：表示为废弃版本，存在后续删除的可能。 id String 版本ID。 updated String 版本发布时间。采用UTC时间格式，格式为：YYYY-MMDDTHH:MM:SSZ version String 支持的版本号。 min_version String 支持的微版本号。若该版本API不支持微版本，则为空。 links Array of Link objects API的URL地址 表4 Link 参数 参数类型 描述 href String 当前API版本的引用地址。 type String 发送的实体的MIME类型，取值为application/json。 rel String 当前API版本和被引用地址的关系。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表6 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表8 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表10 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表12 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 405 表13 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表14 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 406 表15 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表16 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 407 表17 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表18 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 408 表19 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表20 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 409 表21 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表22 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 500 表23 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表24 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 501 表25 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表26 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 502 表27 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表28 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 503 表29 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表30 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 504 表31 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表32 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 12 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 91011121314151617181920212223242526 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应示例 状态码： 200 服务器已成功处理了请求 { "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "service_type" : "interface", "status" : "accepted", "ip" : "10.32.xx.xx", "marker_id" : 322312312312, "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "enable_dns" : true, "endpoint_service_name" : "test123", "endpoint_service_id" : "test123", "project_id" : "6e9dfd51d1124e8d8498dce894923a0d", "whitelist" : [ "192.168.1.1", "192.168.1.2" ], "enable_whitelist" : true, "created_at" : "2022-04-14T09:35:47Z", "updated_at" : "2022-04-14T09:36:47Z", "tags" : [ { "key" : "test1", "value" : "test1" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：2048 Content-Type 否 String 发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json 最小长度：1 最大长度：64 表3 请求Body参数 参数 是否必选 参数类型 描述 whitelist 否 Array of strings 更新或删除用于控制访问终端节点的白名单。此参数可以添加IPv4或CIDR： ● 当取值不为空时，表示将白名单更新为取值所示内容。 ● 当取值为空时，表示删除所有白名单。 默认为空列表。 enable_whitelist 否 Boolean 是否开启网络ACL隔离。 ● true：开启网络ACL隔离 ● false：不开启网络ACL隔离 默认值为false。

请求示例 更新终端节点，设置白名单信息为192.168.1.1、192.168.1.2，开启网络ACL隔离。 PUT https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83{ "whitelist": [ "192.168.1.1", "192.168.1.2" ], "enable_whitelist":true,}

请求示例 更新终端节点服务白名单描述 PUT https://{endpoint}/v1/{project_id}/vpc-endpoint-services/c07132bf-4071-439a-9ff3-2068eb45092f/permissions/849046d9-7342-44ba-b2d2-367d8de6311b{ "permission" : { "description" : "终端节点服务添加白名单" }}

响应示例 状态码： 200 服务器已成功处理了请求 { "permissions" : [ { "id" : "849046d9-7342-44ba-b2d2-367d8de6311b", "permission" : "*", "description" : "终端节点服务添加白名单", "created_at" : "2022-06-16T09:48:21Z" } ]}

状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 permissions Array of EpsPermission objects 终端节点服务白名单响应体。 表6 EpsPermission 参数 参数类型 描述 id String 白名单表主键ID permission String 权限格式为：iam:domain::domain_id或者organizations:orgPath::org_path其中， ● “iam:domain::”和“organizations:orgPath::”为固定格式。 ● “domain_id”为可连接用户的帐号ID，org_path可连接用户的组织路径 domain_id类型支持输入包括“a~z”、“A~Z”、“0~9”或者“”，org_path类型支持“a~z”、“A~Z”、“0~9”、“/-?”或者“”。 “”表示所有终端节点可连接。 例如：iam:domain::6e9dfd51d1124e8d8498dce894923a0dd或者organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/* 最小长度：1 最大长度：1024 permission_type String 终端节点服务白名单类型。 ● domainId：基于账户ID配置终端节点服务白名单。 ● orgPath：基于账户所在组织路径配置终端节点服务白名单。 description String 终端节点服务白名单描述 created_at String 白名单创建时间 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表8 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表10 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表12 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表14 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 405 表15 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表16 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 406 表17 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表18 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 407 表19 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表20 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 408 表21 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表22 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 409 表23 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表24 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 500 表25 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表26 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 501 表27 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表28 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 502 表29 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表30 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 503 表31 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表32 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码 状态码： 504 表33 响应Body参数 参数 参数类型 描述 error Error object 提交任务异常时返回的异常信息 表34 Error 参数 参数类型 描述 message String 任务异常错误信息描述 code String 任务异常错误信息编码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：2048 Content-Type 否 String 发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json 最小长度：1 最大长度：65 表3 请求Body参数 参数 是否必选 参数类型 描述 permission 是 EpsUpdatePermissionDesc object 更新终端节点服务白名单描述的请求体 表4 EpsUpdatePermissionDesc 参数 是否必选 参数类型 描述 description 是 String 终端节点服务白名单描述

URI PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/{permission_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：64 vpc_endpoint_service_id 是 String 终端节点服务的ID。 最小长度：1 最大长度：64 permission_id 是 String 白名单的ID。 最小长度：1 最大长度：64

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属帐号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } }} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 123 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。