华为云用户手册

  • 请求参数 表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 服务器已成功处理了请求 { "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" } ]}
  • 状态码 状态码 描述 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-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
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 否 String 发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json
  • 请求示例 查询终端节点服务列表 GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}&status={status}
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 响应示例 状态码: 200 服务器已成功处理了请求 { "endpoint_services" : [ { "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88", "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80", "status" : "available", "approval_enabled" : false, "service_name" : "test123", "server_type" : "VM", "service_type" : "interface", "ports" : [ { "client_port" : "8080", "server_port" : "80", "protocol" : "TCP" }, { "client_port" : "8081", "server_port" : "80", "protocol" : "TCP" } ], "project_id" : "6e9dfd51d1124e8d8498dce894923a0d", "created_at" : "2022-04-14T09:35:47Z", "updated_at" : "2022-04-14T09:36:47Z", "public_border_group" : "br-abc-aaa1" } ], "total_count" : 1}
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 EndPoint.0002 Parameter error. 参数异常。 校验参数是否正确。 400 EndPoint.0006 Invalid limit. 无效的数量限制。 请输入正确的limit参数。 400 EndPoint.0007 Invalid action. 无效的操作。 请输入正确的action参数。 400 EndPoint.0009 The remote address does not match. 访问远端地址不匹配。 请确认是否有权访问。 400 EndPoint.0010 Invalid offset. 无效的分页。 请输入正确的offset参数。 400 EndPoint.0014 Invalid project ID. project_id无效。 请输入正确的project_id。 400 EndPoint.0015 Invalid specification. 规格无效。 请输入正确的规格。 400 EndPoint.0016 The number of batch operated resources exceeded the limit. 批量操作资源数量超过限制。 请缩小您批量操作资源的数量。 400 EndPoint.0017 Invalid sort_key. sort_key无效。 请输入正确的sort_key。 400 EndPoint.0018 Invalid sort_dir. sort_dir无效。 请输入正确的sort_dir。 400 EndPoint.0019 Invalid status. 状态无效。 请输入正确的status。 400 EndPoint.0020 Invalid VPC ID. vpcId无效。 请输入正确的vpcId。 400 EndPoint.0021 Invalid marker_id. marker_id无效。 请输入正确的marker ID。 400 EndPoint.0022 The number of requests exceeded the limit. Please try later. 请求次数太多,请稍后重试。 请稍后重试。 400 EndPoint.0023 Invalid subnet_id. 无效的subnet_id。 请输入正确的subnet_id。 400 EndPoint.1003 Invalid service name. 服务名称无效。 请输入正确的服务名称。 400 EndPoint.1004 Invalid request. 创建终端节点请求无效。 请输入正确的请求体。 400 EndPoint.1005 DNS service Failed: Failed to create a DNS zone. DNS服务失败:创建DNS zone失败。 请联系技术支持。 400 EndPoint.1008 Failed to obtain the token. 获取token失败。 请联系技术支持。 400 Endpoint.1018 Quota exceeded. 申请资源数量超出配额。 请联系技术支持。 400 EndPoint.1019 Invalid route table ID. 无效的routetable ID。 请输入正确的routetable ID参数。 400 EndPoint.2001 The VPC does not exist. 当前用户下不存在该VPC。 请输入正确的当前用户下的VPC ID。 400 EndPoint.2002 The request input parameter is empty. 请求入参为空。 参数不能不空,请输入正确的参数。 400 EndPoint.2003 The endpoint service does not exist. 终端节点服务不存在。 请输入终端节点服务。 400 EndPoint.2004 The endpoint service is unavailable. 终端节点服务不可用。 请稍后重试,如若不行请联系技术支持。 400 EndPoint.2009 The specification information does not exist. 规格不存在。 请输入正确规格。 400 EndPoint.2010 The input parameter subnet ID is empty. 输入参数子网ID为空。 请输入有效的子网ID。 400 EndPoint.2011 The input parameter VPC ID is empty. 输入参数VPC ID为空。 请输入有效的参数VPC ID。 400 EndPoint.2012 You have no permission to connect to the VPC endpoint service. 您没有权限连接该终端节点服务。 请确认是否有权访问。 400 EndPoint.2013 The endpoint does not belong to the endpoint service. 终端节点不属于终端节点服务。 请确认终端节点是否正确。 400 EndPoint.2014 The endpoint has connected to the endpoint service. 终端节点已连接终端节点服务。 已经连接,无需再次连接。 400 EndPoint.2015 The endpoint has been frozen. 终端节点被冻结。 请确认冻结原因,联系技术支持。 400 EndPoint.2016 The endpoint pool IP address does not exist. 终端节点pool IP不存在。 请联系技术支持。 400 EndPoint.2017 Invalid endpoint ID. 终端节点ID无效。 请输入正确的Endpoint ID。 400 EndPoint.2018 The endpoint is being deleted. 终端节点正在删除中。 请选择可用的终端节点。 400 EndPoint.2019 The endpoint is being created. 终端节点正在创建中。 请稍后重试。 400 EndPoint.2020 qrMac or sgMac does not exist. 查询qrMac或sgMac不存在。 请联系技术支持。 400 EndPoint.2021 Failed to query the VPC. 查询VPC失败。 请联系技术支持。 400 EndPoint.2022 Failed to create an endpoint. 终端节点创建失败。 请联系技术支持。 400 EndPoint.2023 CIDR is not found. 终端节点未获取cidr。 请联系技术支持。 400 EndPoint.2024 shadowVpc or shadowPort does not exist. shadowVpc 或shadowPort为空。 请联系技术支持。 400 EndPoint.2025 The endpoint port does not exist. 终端节点端口不存在。 请联系技术支持。 400 EndPoint.2026 VNI is empty. VNI为空。 请联系技术支持。 400 EndPoint.2027 Invalid action. 操作类型不存在。 请输入有效的操作类型。 400 EndPoint.2028 The endpoint service port or protocol is empty. 终端节点服务端口或协议为空。 请输入有效的终端节点服务端口或协议。 400 EndPoint.2029 The requested endpoint service ID is empty. 被请求的终端节点服务ID为空。 请输入有效的终端节点服务ID。 400 EndPoint.2031 Only one endpoint is allowed. 当前只支持单个业务。 接受/拒绝终端节点服务的连接只支持单个业务。 400 EndPoint.2033 The entered parameter enable_dns is invalid. 输入参数enable_dns无效。 请输入有效的enable_dns。 400 EndPoint.2034 The entered parameter enable_dns is incorrect. 输入参数enable_dns错误。 请输入正确的enable_dns。 400 EndPoint.2035 The system parameter dns.enable is invalid. 系统参数dns.enable无效。 请联系技术支持。 400 EndPoint.2037 The current network does not belong to the VPC. 当前Network不属于该VPC。 请核对参数是否正确。 400 EndPoint.2038 The pool does not exist. 资源池不存在。 请联系技术支持。 400 EndPoint.2039 The route table is being used by another VPC endpoint. 路由表已被终端节点使用。 请联系技术支持。 400 EndPoint.2040 The VPC endpoint has no route table bound. 当前终端节点未绑定路由表。 请联系技术支持。 400 EndPoint.2041 Invalid Port IP address. 端口IP地址无效。 请输入正确的端口IP。 400 EndPoint.2042 The Port IP is in use. 端口IP正在使用。 请输入正确的端口IP。 400 EndPoint.2043 The Port IP is not valid for the subnet. 端口IP对子网无效。 请输入正确的端口IP。 400 EndPoint.2044 Invalid whitelist. 白名单无效。 请输入正确的参数。 400 EndPoint.2045 The maximum number of whitelist records has been reached. 已达到白名单记录的最大数量。 请联系技术支持。 400 EndPoint.2046 Can not modify a specified mac endpoint. 无法修改指定的mac终端节点。 请联系技术支持。 400 EndPoint.2047 The VPC endpoint in the Failed status cannot be modified. 状态为“失败”的VPC终端节点不能修改。 请选择有效的VPC终端节点。 400 EndPoint.2048 The VPC endpoint policy is invalid. VPC终端节点策略无效。 请输入正确的参数。 400 EndPoint.2049 The VPC endpoint has no policy associated. VPC终端节点没有已关联的策略。 请联系技术支持。 400 EndPoint.2050 The endpoint has been disabled. 终端节点已被禁用。 请联系技术支持。 400 EndPoint.2051 The current endpoint is switching to new pool. 终端端点正在切换到新资源池。 请稍后重试。 400 EndPoint.2052 The current endpoint does not need to be rolled back. 终端节点无法回退。 请联系技术支持。 400 EndPoint.3001 Failed to create a port. 创建端口失败。 请联系技术支持。 400 EndPoint.3002 Invalid permission. 权限无效。 请联系技术支持。 400 EndPoint.3003 Invalid port ID. 端口ID无效。 请联系技术支持。 400 EndPoint.3004 Invalid port. 无效的port。 请联系技术支持。 400 EndPoint.3005 Failed to delete the endpoint service. 无法删除终端节点服务。 请联系技术支持。 400 EndPoint.3006 The endpoint service is being used. 终端节点服务被终端节点使用。 请联系技术支持。 400 EndPoint.3008 The port does not exist. 端口不存在。 请联系技术支持。 400 EndPoint.3009 Invalid CIDR. cidr无效。 请联系技术支持。 400 EndPoint.3010 Invalid IP address. IP无效。 请输入正确的IP。 400 EndPoint.3011 Parameter IP is not required to create an endpoint service (interface). 在创建interface类型终端节点服务时,不需要参数IP。 请输入正确的请求体。 400 EndPoint.3013 endpointService interface vlan can't have vpcId. vlan类型的终端节点服务请求不能包含vpcId。 请输入正确的请求体。 400 EndPoint.3014 endpointService interface can't have cidr. interface类型终端节点服务请求不能包含cidr。 请输入正确的请求体。 400 EndPoint.3015 endpointService gateway vlan can't have portId. vlan类型的终端节点服务请求不能包含portId。 请输入正确的请求体。 400 EndPoint.3016 endpointService gateway vlan can't have ip. vlan类型的终端节点服务请求不能包含ip。 请输入正确的请求体。 400 EndPoint.3017 Invalid CIDRs. 无效的CIDRs。 请输入正确的CIDRs参数。 400 EndPoint.3018 endpointService gateway vlan can't have vpcId. vlan类型的终端节点服务请求不能包含vpcId。 请输入正确的请求体。 400 EndPoint.3021 Invalid serverType. serverType参数无效。 请输入有效的serverType。 400 EndPoint.3022 Failed to create a network. 创建网络失败。 请联系技术支持。 400 EndPoint.3023 Failed to create a subnet. 创建子网失败。 请联系技术支持。 400 EndPoint.3035 Invalid action. 终端节点服务授权操作错误。 请输入正确的授权操作。 400 EndPoint.3036 Invalid permissions. 权限列表不能为空。 请输入正确的请求体。 400 EndPoint.3040 Failed to add a rollback task. 添加回滚任务失败。 请联系技术支持。 400 EndPoint.3042 The port ID does not belong to the current VPC. 端口ID不属于当前VPC。 请输入正确的请求体。 400 EndPoint.3043 The service port is invalid. 服务端口无效。 请输入正确的请求体。 400 EndPoint.3044 The parameter ports conflicted with ports in an existing endpoint service. Ports与已有endpoint service的Ports冲突。 请输入正确的请求体。 400 EndPoint.3045 Other properties cannot be modified in the current endpoint service state. 终端节点服务目前的状态不支持修改其他属性。 请输入正确的请求体。 400 EndPoint.3046 The IP address conflicted with an existing endpoint service. IP和已有的终端节点服务冲突。 请输入正确的请求体。 400 EndPoint.3048 Invalid netType. netType无效。 请输入有效的netType。 400 EndPoint.3049 The maximum number of whitelist records has been reached. 终端节点服务白名单记录总量超过限制。 删除无效 白名单或将白名单权限设置为*。 400 EndPoint.3051 Endpoint service vip port id is invalid. vip port id无效。 请输入正确的vip port id。 400 EndPoint.3052 portId and ip cannot be modified at the same time. portId和ip不能同时修改。 请输入正确的请求体。 400 EndPoint.3053 vipPortId and ip cannot be modified at the same time. vipPortId和ip不能同时修改。 请输入正确的请求体。 400 EndPoint.3054 portId or vipPortId cannot be modified. 不能修改portId或vipPortId。 请输入正确的请求体。 400 EndPoint.3055 ip cannot be modified. 不能修改ip。 请输入正确的请求体。 400 EndPoint.3056 The maximum of VPC endpoint services using the same IP address has been reached. 单个后端资源支持的终端节点服务数量超过限制。 请联系技术支持。 400 EndPoint.3057 cidr cannot be modified. 不能修改cidr。 请输入正确的请求体。 400 EndPoint.3058 The domain name is invalid. dns name不合法。 请输入正确的dns name参数。 400 EndPoint.3059 The domain name already exists. dns name已经存在。 请联系技术支持。 400 EndPoint.3060 You have no permission to add domain names. 没有权限添加dns name。 请联系技术支持。 400 EndPoint.3061 The maximum number of domain names has reached. dns name个数超过限制。 请联系技术支持。 400 EndPoint.3062 Invalid endpoint service ID. 终端节点服务ID无效。 请输入正确的endpoint_service_id参数。 400 EndPoint.3063 Invalid port ID. 端口ID无效。 请输入正确的端口ID。 400 EndPoint.3066 The tag cannot be empty. 标签不能为空。 请输入正确的请求体。 400 EndPoint.3067 The tag key cannot be duplicated. 标签键不能重复。 请输入正确的请求体。 400 EndPoint.3068 Tag keys and values should meet relevant requirements. 标签键和值必须符合规范。 请输入正确的请求体。 400 EndPoint.3069 The maximum number of tags has been reached. 标签总数超出限制。 请联系技术支持。 400 EndPoint.3070 Invalid resource type. 资源类型错误。 请联系技术支持。 400 EndPoint.3071 The tag value cannot be duplicated. 标签值不能重复。 请联系技术支持。 400 EndPoint.3072 The tag key size is invalid. 标签键长度不符合规范。 请输入规范的标签键。 400 EndPoint.3073 The tag value size is invalid. 标签值长度不符合规范。 请输入规范的标签值。 400 EndPoint.3074 The maximum of ports has been reached. 端口映射个数超出限制。 请联系技术支持。 400 EndPoint.3075 The protocol is invalid. 协议无效。 请联系技术支持。 400 EndPoint.3076 Invalid service name. service name是非法的。 请输入合法的service name。 400 EndPoint.4001 Failed to query the subnet. 查询子网失败。 请联系技术支持。 400 EndPoint.4002 Failed to create a subnet. 创建子网失败。 请联系技术支持。 400 EndPoint.4003 Failed to delete the subnet. 删除子网失败。 请联系技术支持。 400 EndPoint.4005 Failed to query the network. 查询netWork失败。 请联系技术支持。 400 EndPoint.4006 Failed to create a network. 创建netWork失败。 请联系技术支持。 400 EndPoint.4007 Failed to delete the network. 删除netWork失败。 请联系技术支持。 400 EndPoint.4009 Failed to query the port. 查询端口失败。 请联系技术支持。 400 EndPoint.4010 Failed to create a port. 创建端口失败。 请联系技术支持。 400 EndPoint.4011 Failed to delete the port. 删除端口失败。 请联系技术支持。 400 EndPoint.4013 Failed to query the proxy. 查询代理失败。 请联系技术支持。 400 EndPoint.4014 Failed to query the router. 查询路由失败。 请联系技术支持。 400 EndPoint.4015 The router is not found. 未找到路由。 请联系技术支持。 400 EndPoint.4016 Failed to add an interface router. 添加interface路由失败。 请联系技术支持。 400 EndPoint.4017 Failed to delete the interface router. 删除interface路由失败。 请联系技术支持。 400 EndPoint.4018 Failed to add an extension router. 添加扩展路由失败。 请联系技术支持。 400 EndPoint.4019 Failed to delete the extension router. 删除扩展路由失败。 请联系技术支持。 400 EndPoint.4020 Failed to query Neutron L3 Agent. 查询路由L3-agent失败。 请联系技术支持。 400 EndPoint.4025 The specification is being used. 规格已经被使用。 请联系技术支持。 400 EndPoint.4026 Failed to query the default route table of the VPC. 查询VPC默认路由表失败。 请联系技术支持。 400 EndPoint.4027 Failed to query route tables of the VPC. 查询VPC路由表列表失败。 请联系技术支持。 400 EndPoint.4028 Failed to add routes to the VPC's route table. 添加路由到VPC路由表失败。 请联系技术支持。 400 EndPoint.4029 Failed to remove routes from the VPC's route table. 从VPC路由表中删除路由失败。 请联系技术支持。 401 EndPoint.0003 Authentication failed or authentication information is invalid. 鉴权失败或未提供有效鉴权信息。 确认是否开通权限。 403 EndPoint.0004 Authentication information is incorrect or you have no permissions. 鉴权信息错误或无相应权限。 确认是否开通权限。 404 EndPoint.0005 The requested resource is unavailable. 请求的相关资源不存在。 确认输入的参数是否正确。 404 EndPoint.2006 The requested endpoint does not exist. 请求的终端节点不存在。 请输入正确的终端节点。 404 EndPoint.2007 The endpoint information does not exist. 终端节点信息不存在。 请输入正确的终端节点,确认终端节点是否被删除。 404 EndPoint.2008 The endpoint has been deleted. 终端节点已经被删除。 确认终端节点是否被删除。 404 EndPoint.2030 markerId is empty. 查询markerId为空。 请输入有效的marker ID。 404 EndPoint.4004 The subnet is not found. 子网未找到。 请核对输入的subnet_id,如若不行请联系技术支持。 404 EndPoint.4008 Network is unavailable. 获取不到network。 请联系技术支持。 404 EndPoint.4012 The port is not found. 端口未找到。 请联系技术支持。 404 EndPoint.4021 Neutron L3 Agent is not found. 路由L3-agen不存在。 请联系技术支持。 404 EndPoint.4030 The route table is not found. 未找到路由表。 请联系技术支持。 500 EndPoint.0001 System error. Please retry. 系统异常,请重试。 请重试,如若再次出现异常,请联系技术支持。 504 EndPoint.0011 The request body is null. 请求体为空。 请重新输入请求体。 504 EndPoint.0012 The request header is null. 请求体头为空。 请输入请求头。 504 EndPoint.0013 The request timed out. 请求超时。 重试失败请联系技术支持。 父主题: 附录
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • URI GET /v1/{project_id}/vpc-endpoint-services/describe 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 endpoint_service_name 否 String 终端节点服务的名称。说明:该字段和id字段必须二选一,否则会出现错误。 最小长度:1 最大长度:128 id 否 String 终端节点服务的ID,唯一标识。 说明:该字段必须和endpoint_service_name字段二选一,否则会出现错误。 最小长度:1 最大长度:64
  • 请求参数 表3 请求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 表4 响应Body参数 参数 参数类型 描述 id String 终端节点服务的ID,唯一标识。 service_name String 终端节点服务的名称。 service_type String 终端节点服务类型。仅支持将用户私有服务创建为interface类型的终端节点服务。 ● gataway:由运维人员配置。用户无需创建,可直接使用。 ● interface:包括运维人员配置的云服务和用户自己创建的私有服务。 其中,运维人员配置的云服务无需创建,用户可直接使用。 您可以通过创建终端节点创建访问Gateway和Interface类型终端节点服务的终端节点。 created_at String 终端节点服务的创建时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ is_charge Boolean 连接该终端节点服务的终端节点是否计费。 ● true:计费 ● false:不计费 public_border_group String 终端节点对应Pool的Public Border Group信息 enable_policy Boolean 是否开启终端节点策略。 ● false:不支持设置终端节点策略 ● true:支持设置终端节点策略 默认为false 是否开启终端节点策略。 ● false:不支持设置终端节点策略 ● true:支持设置终端节点策略 默认为false 状态码: 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 任务异常错误信息编码
  • 状态码 状态码 描述 200 服务器已成功处理了请求 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突,请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时
  • 响应示例 状态码: 200 服务器已成功处理了请求 – action为filter时响应体{"resources": [{"resource_id": "cdfs_cefs_wesas_12_dsad","resource_name": "resource1","tags": [{"key": "key1", "value": "value1"},{"key": "key2", "value": "value1"}]}],"total_count": 1000}
  • 请求参数 表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 TagValuesList objects 包含标签,最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复, 同一个key中values不能重复。结果返回包含所有标签的资源列表, key之间是与的关系,key-value结构中value是或的关系。 无tag过滤条件时返回全量数据。 tags_any 否 Array of TagValuesList objects 包含任意标签,最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。 Key不能重复,同一个key中values不能重复。 结果返回包含标签的资源列表,key之间是或的关系,key、value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags 否 Array of TagValuesList objects 不包含标签,最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复, 同一个key中values不能重复。结果返回不包含标签的资源列表,key之间是与的关系, key、value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags_any 否 Array of TagValuesList objects 不包含任意标签,最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复, 同一个key中values不能重复。结果返回不包含标签的资源列表, key之间是与的关系,key、value结构中value是或的关系。 无过滤条件时返回全量数据。 sys_tags 否 Array of TagValuesList objects 系统标签, limit 否 String 查询记录数(action为count时无此参数)如果action为filter默认为1000, limit最多为1000,不能为负数,最小值为1。 offset 否 String 索引位置,偏移量(action为count时无此参数)从第一条数据偏移offset条数据后开始查询, 如果action为filter默认为0(偏移0条数据,表示从第一条数据开始查询), 必须为数字,不能为负数。 action 是 String 操作标识(仅限于filter,count):filter(过滤), count(查询总条数)如果是filter就按照过滤条件查询, 如果是count,只需要返回总条数,禁止返回其他字段。 matches 否 Array of Match objects 搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。 key为固定字典值,不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配,如resource_name默认为模糊搜索(不区分大小写), 如果value为空字符串精确匹配(多数服务不存在资源名称为空的情况, 因此此类情况返回空列表)。resource_id为精确匹配。 第一期只做resource_name,后续再扩展。 without_any_tag 否 Boolean 默认为false,取值【true/false】,当withoutAnyTag=true, 忽略tags、tagsAny、notTags、notTagsAny参数校验。 表4 TagValuesList 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。key不能为空。(搜索时不对此参数做字符集校), key不能为空或者空字符串,不能为空格,校验和使用之前先trim前后半角空格。 最小长度:1 最大长度:36 values 是 Array of strings 值列表。 每个值最大长度255个unicode字符,校验和使用之前先trim前后半角空格。 value可为空数组但不可缺省。如果values为空列表,则表示any_value(查询任意value)。 value之间为或的关系。(搜索时不对此参数做字符集校验,只做长度校验)。 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。第一期限定为resource_name,后续扩展。 最小长度:1 最大长度:36 value 是 String 值。每个值最大长度255个unicode字符。不校验字符集范。 最小长度:1 最大长度:43
共100000条