华为云用户手册

  • 响应示例 状态码: 200 服务器已成功处理了请求 { "id" : "492c776f-2cb9-40a2-9735-d7279ab2bbb6", "status" : "accepted", "ip" : "172.16.0.154", "tags" : [ ], "whitelist" : [ ], "marker_id" : 302010104, "active_status" : [ "active" ], "vpc_id" : "0da03835-1dcf-4361-9b87-34139d58dd59", "service_type" : "interface", "project_id" : "0605767a3300d5762fb7c0186d9e1779", "subnet_id" : "fb1b8b7e-f34c-4ff1-b3a7-221acef3b3aa", "enable_dns" : false, "created_at" : "2022-04-28T02:44:50Z", "updated_at" : "2022-04-28T02:56:15Z", "endpoint_service_id" : "8843fac2-bc01-445a-a822-c8124ff3968c", "endpoint_service_name" : "br-abc-aaa1.vm_test.8843fac2-bc01-445a-a822-c8124ff3968c", "enable_whitelist" : false, "specification_name" : "default", "endpoint_pool_id" : "501f4a3b-6f96-4309-97d1-e291b8ca5b96", "enable_status" : "enable", "public_border_group" : "center"}
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 请求示例 批量删除终端节点服务的白名单 POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/c07132bf-4071-439a-9ff3-2068eb45092f/permissions/batch-delete{ "permissions" : [ { "id" : "b9b6f264-3562-4f62-ba84-c128da20d18d" }, { "id" : "c07132bf-4071-439a-9ff3-2068eb45092f" } ]}
  • 响应参数 状态码: 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 任务异常错误信息编码
  • URI POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1 最大长度:64 vpc_endpoint_service_id 是 String 终端节点服务的ID。 最小长度:1 最大长度:64
  • 请求参数 表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 EpsRemovePermissionRequest objects 删除终端节点服务白名单请求体。 表4 EpsRemovePermissionRequest 参数 是否必选 参数类型 描述 id 是 String 终端节点服务白名单表主键ID 最小长度:1 最大长度:64
  • 请求示例 接受终端节点的连接 POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/connections/action{ "endpoints" : [ "705290f3-0d00-41f2-aedc-71f09844e879" ], "action" : "receive"}
  • 响应示例 状态码: 200 服务器已成功处理了请求 { "connections" : [ { "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "status" : "accepted", "marker_id" : 422321321312321321, "domain_id" : "6e9dfd51d1124e8d8498dce894923a0d", "created_at" : "2022-04-14T09:35:47Z", "updated_at" : "2022-04-14T09:36:47Z" } ]}
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 connections Array of ConnectionEndpoints objects 连接列表 表5 ConnectionEndpoints 参数 参数类型 描述 id String 终端节点的ID,唯一标识。 marker_id Integer 终端节点的报文标识。 created_at String 终端节点的创建时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ updated_at String 终端节点的更新时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ domain_id String 用户的Domain ID。 error Array of QueryError objects 错误信息。 当终端节点服务状态异常,即“status”的值为“failed”时,会返回该字段。 status String 终端节点的连接状态。 ● pendingAcceptance:待接受 ● creating:创建中 ● accepted:已接受 ● rejected:已拒绝 ● failed:失败 ● deleting:删除中 description String 终端节点连接描述。 表6 QueryError 参数 参数类型 描述 error_code String 错误编码。 error_message 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 任务异常错误信息编码
  • URI POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1 最大长度:64 vpc_endpoint_service_id 是 String 终端节点服务的ID。 最小长度:1 最大长度:64
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 action 是 String 允许或拒绝连接。 ● receive:允许连接。 ● reject:拒绝连接。 最小长度:1 最大长度:32 endpoints 是 Array of strings 终端节点ID列表。 每次请求目前支持单条endpoint的接受或拒绝。
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 响应示例 状态码: 200 服务器已成功处理了请求 { "permissions" : [ { "id" : "ab42a58b-6f8e-43b3-9400-aaf0e393ee0d", "permission" : "iam:domain::4dbb0ce8766f44a9bfd08ccf8fc02397", "description" : "test", "created_at" : "2022-06-16T10:03:27Z" }, { "id" : "dfaaeff1-858d-4631-83c4-be3548a07935", "permission" : "*", "description" : "", "created_at" : "2022-06-16T10:03:27Z" } ]}
  • 请求示例 批量添加终端节点服务的白名单 POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/c07132bf-4071-439a-9ff3-2068eb45092f/permissions/batch-create{ "permissions" : [ { "permission" : "*", "description" : "批量添加终端节点服务白名单接口" }, { "permission" : "iam:domain::4dbb0ce8766f44a9bfd08ccf8fc02397", "description" : "test" } ]}
  • 请求参数 表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 EpsAddPermissionRequest objects 终端节点服务白名单列表 permission_type 否 String 终端节点服务白名单类型。 ● domainId:基于账户ID配置终端节点服务白名单。 ● orgPath:基于账户所在组织路径配置终端节点服务白名单。 表4 EpsAddPermissionRequest 参数 是否必选 参数类型 描述 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”或者“,最大长度可以传64; org_path类型支持“a~z”、“A~Z”、“0~9”、“/-?”或者“”,最大长度可以传1024; 例如:iam:domain::6e9dfd51d1124e8d8498dce894923a0dd或者organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/ description 是 String 终端节点服务白名单描述
  • 响应参数 状态码: 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 任务异常错误信息编码
  • URI POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/batch-create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1 最大长度:64 vpc_endpoint_service_id 是 String 终端节点服务的ID。 最小长度:1 最大长度:64
  • 请求示例 批量添加资源标签 POST https://{endpoint}/v1/{project_id}/endpoint_service/{resource_id}/tags/action{ "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key", "value" : "value3" } ]} 批量删除资源标签 POST https://{endpoint}/v1/{project_id}/endpoint/{resource_id}/tags/action{ "action" : "delete", "tags" : [ { "key" : "key1" }, { "key" : "key2", "value" : "value3" } ]}
  • 状态码 状态码 描述 204 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 响应参数 状态码: 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的值)。 Content-Type 否 String 发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of resource_tag objects 标签列表,没有标签默认为空数组。 action 是 String 操作标识:仅限于 create(创建) delete(删除) 表4 resource_tag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度36个unicode字符。 key需要满足标签字符集规范。 value 否 String 值。action为create时必选,每个值最大长度43个unicode字符, 删除时如果value有值按照key/value删除, 如果value没值,则按照key删除。 value需要满足标签字符集规范。
  • URI POST /v1/{project_id}/{resource_type}/{resource_id}/tags/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 resource_type 是 String 资源类型,值为:endpoint_service或endpoint。 resource_id 是 String 资源ID,Endpoint ServiceID或Endpoint ID。
  • 响应示例 状态码: 200 服务器已成功处理了请求 { "connections" : [ { "id" : "0d837f75-90d5-4528-bd11-5d974238ebca", "status" : "accepted", "description" : "终端节点节点2, 属于账户[7876999999999]abc_26", "marker_id" : 302008767, "domain_id" : "05b5408a0a80d2b10f06c0184a774460", "created_at" : "2022-04-14T02:09:08Z", "updated_at" : "2022-04-14T07:55:40Z" }, { "id" : "0df78897-35b0-4a93-ad17-0bc0585f546b", "status" : "accepted", "description" : "终端节点节点1, 属于账户[0605767a3300d5762fb7c0186d9e1779]abc_26", "marker_id" : 302001833, "domain_id" : "05b5408a0a80d2b10f06c0184a774460", "created_at" : "2022-04-14T01:59:31Z", "updated_at" : "2022-04-14T07:57:39Z" } ]}
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 请求示例 更新终端节点连接描述 https://{endpoint}/v1/{project_id}/vpc-endpoint-services/813d9300-8473-405b-bfcd-f711117bad65/connections/description{ "connections" : [ { "id" : "0df78897-35b0-4a93-ad17-0bc0585f546b", "description" : "终端节点节点1, 属于账户[0605767a3300d5762fb7c0186d9e1779]abc_26" }, { "id" : "0d837f75-90d5-4528-bd11-5d974238ebca", "description" : "终端节点节点2, 属于账户[7876999999999]abc_26" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 connections Array of ConnectionEndpoints objects 连接列表 表5 ConnectionEndpoints 参数 参数类型 描述 id String 终端节点的ID,唯一标识。 marker_id Integer 终端节点的报文标识。 created_at String 终端节点的创建时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ updated_at String 终端节点的更新时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ domain_id String 用户的Domain ID。 error Array of QueryError objects 错误信息。 当终端节点服务状态异常,即“status”的值为“failed”时,会返回该字段。 status String 终端节点的连接状态。 ● pendingAcceptance:待接受 ● creating:创建中 ● accepted:已接受 ● rejected:已拒绝 ● failed:失败 ● deleting:删除中 description String 终端节点连接描述。 表6 QueryError 参数 参数类型 描述 error_code String 错误编码。 error_message 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 任务异常错误信息编码
  • URI PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/description 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:32 最大长度:64 vpc_endpoint_service_id 是 String 终端节点服务ID 最小长度:36 最大长度:64
  • URI GET /v1/{project_id}/vpc-endpoint-services 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 endpoint_service_name 否 String 终端节点服务的名称,支持大小写,前后模糊匹配。 最小长度:1 最大长度:128 id 否 String 终端节点服务的ID,唯一标识。 status 否 String 终端节点服务的状态。 ● creating:创建中 ● available:可连接 ● failed:失败 ● deleting:删除中 sort_key 否 String 查询结果中终端节点服务列表的排序字段,取值为: ● create_at:终端节点服务的创建时间 ● update_at:终端节点服务的更新时间 默认值为create_at。 缺省值:create_at sort_dir 否 String 查询结果中终端节点服务列表的排序方式,取值为: ● desc:降序排序 ● asc:升序排序 默认值为desc。 缺省值:desc limit 否 Integer 查询返回的终端节点服务数量限制,即每页返回的终端节点服务的个数。 取值范围:0~1000,取值一般为10,20或者50,默认为10。 最小值:1 最大值:1000 缺省值:10 offset 否 Integer 偏移量。 偏移量为一个大于0小于终端节点服务总个数的整数, 表示从偏移量后面的终端节点服务开始查询。 最小值:0 public_border_group 否 String 筛选结果中匹配边缘属性的EPS
共100000条