# 更新Ray联邦端点 - UpdateV2RayFederation #### 功能介绍 更新Ray联邦端点。此接口为同步接口。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-aidatalake/aidatalake_02_0003.html)。 #### URI PUT /v2/workspaces/{workspace_id}/ray-federations/{ray_federation_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 是 | String | **参数解释** ：工作空间ID，可通过[查询工作空间列表](https://support.huaweicloud.com/api-aidatalake/ListV2Workspaces.html)获取工作空间ID。 **约束限制**：不涉及。 **取值范围**：长度为32\~36的英文字符、数字和中划线的组合。 **默认取值**：不涉及。 | | ray_federation_id | 是 | String | **参数解释** ：Ray联邦端点ID，可通过[查询Ray联邦端点列表](https://support.huaweicloud.com/api-aidatalake/ListV2RayFederations.html)接口获取。 **约束限制**：不涉及。 **取值范围**：长度为32\~36的英文字符、数字和中划线的组合。 **默认取值**：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** ：用户Token，通过调用[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制**：不涉及。 **取值范围**：只能由英文字母、数字及特殊字符组成，长度不超过65534个字符。Token格式由IAM服务定义，具体字符集参见IAM服务相关文档。 **默认取值**：不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**：Ray联邦端点名称。 **约束限制**：不能修改。 **取值范围**：支持小写字母、数字、中划线，必须字母开头、字母或数字结尾，长度为1\~63个字符。 **默认取值**：不涉及。 | | display_name | 否 | String | **参数解释**：Ray联邦端点显示名称。 **约束限制**：不涉及。 **取值范围**：长度为1\~63个字符，支持字母、数字、中划线、汉字。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：Ray联邦端点描述。 **约束限制**：不涉及。 **取值范围**：不允许输入感叹号、小于号、大于号、等号、与号、双引号、单引号、艾特符、井号、百分号、分号、左括号、右括号、竖线、星号、反斜杠。长度为0\~1024个字符。 **默认取值**：不涉及。 | | ray_cluster_list | 否 | Array of [V2RayFederationRayClusterRequest] objects | **参数解释**：RayCluster端点列表。输入后，将覆盖原有列表。 **约束限制**：每个RayCluster只能属于一个Ray联邦端点。 **取值范围**：长度为0\~50个。 **默认取值**：不涉及。 | 表4V2RayFederationRayClusterRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释** ：RayCluster端点ID，可通过[查询Ray联邦端点列表](https://support.huaweicloud.com/api-aidatalake/ListV2RayFederations.html)接口获取。 **约束限制**：不涉及。 **取值范围**：长度为32\~36的英文、数字、中划线的组合。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：Ray联邦端点ID。 **取值范围**：长度为32\~36的英文字符、数字和中划线的组合。 | | name | String | **参数解释**：Ray联邦端点名称。 **取值范围**：支持小写字母、数字、中划线，必须字母开头、字母或数字结尾，长度为1\~63个字符。 | | display_name | String | **参数解释**：Ray联邦端点显示名称。 **取值范围**：长度为1\~63个字符，支持字母、数字、中划线、汉字。 | | description | String | **参数解释**：Ray联邦端点描述。 **取值范围**：不允许输入感叹号、小于号、大于号、等号、与号、双引号、单引号。字符长度为0\~1024个字符。 | | status | String | **参数解释**：Ray联邦端点状态。 **取值范围**： - RUNNING：运行中。 - LIMITED_AVAILABLE：部分端点可用。 - FAULT：故障。 - WAITING：等待中。 | | error | [Error] object | **参数解释**：失败时返回的文本消息内容，包含错误码、错误描述。 | | ray_cluster_list | Array of [V2RayFederationRayClusterResponse] objects | **参数解释**：RayCluster 端点信息列表。 | | create_time | String | **参数解释**：资源创建时间，使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。 **取值范围**：不涉及。 | | update_time | String | **参数解释**：资源更新时间，使用UTC时间，ISO 8601格式，例如：2025-01-10T03:37:12.000+00:00。 **取值范围**：不涉及。 | | creator | [Creator] object | **参数解释**：资源所有者信息。 | 表6Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：失败状态时的错误编码。 **取值范围**：支持英文字母、数字、小数点及下划线，长度为0\~36个字符。 | | error_msg | String | **参数解释**：失败状态时的错误信息。 **取值范围**：支持中文字符、英文字母、数字及特殊字符，长度为0\~1024个字符。 | 表7V2RayFederationRayClusterResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：RayCluster端点ID。 **取值范围**：长度为32\~36的英文字符、数字和中划线的组合。 | | name | String | **参数解释**：RayCluster端点名称。 **取值范围**：支持小写字母、数字、中划线，必须字母开头、字母或数字结尾，长度为1\~63个字符。 | | status | String | **参数解释**：RayCluster端点状态。 **取值范围**： - CREATING：创建中。 - RUNNING：运行中。 - CREATE_FAILED：创建失败。 - DELETING：删除中。 - DELETED：已删除。 - UPDATING：更新中。 - UPDATE_FAILED：更新失败。 - DELETE_FAILED：删除失败。 - FROZEN：冻结。 - INACTIVE：未激活。 - ON_DEMAND_FROZEN：按需冻结。 - ABNORMAL：异常。 | 表8Creator | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain_name | String | **参数解释**：租户名称。 **取值范围**：支持中文字符、英文字母、数字及特殊字符，长度为1\~64个字符。 | | domain_id | String | **参数解释**：租户ID。 **取值范围**：支持英文字母、数字及中划线，长度为1\~64个字符。 | | user_name | String | **参数解释**：用户名称。 **取值范围**：支持英文字母、数字、下划线的组合，长度为1\~64个字符。 | | user_id | String | **参数解释**：用户ID。 **取值范围**：支持英文字母、数字及中划线，长度为1\~64个字符。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 | **状态码：404** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 | #### 请求示例 更新Ray联邦端点RayCluster端点配置。 ``` PUT /v2/workspaces/{workspace_id}/ray-federations/{ray_federation_id} { "display_name" : "Ray联邦端点-生产01-更新", "description" : "Updated description", "ray_cluster_list" : [ { "id" : "0b5633ba2b904511ad514346f4d23d4b" }, { "id" : "1b5633ba2b904511ad514346f4d23d4b" } ] } ``` #### 响应示例 **状态码：200** ``` { "id" : "0b5633ba2b904511ad514346f4d23d4b", "display_name" : "Ray联邦端点-生产01-更新", "description" : "Updated description.", "status" : "RUNNING", "error" : { }, "ray_cluster_list" : [ { "id" : "0b5633ba2b904511ad514346f4d23d4b", "name" : "ray-cluster-example-01", "status" : "RUNNING" }, { "id" : "1b5633ba2b904511ad514346f4d23d4b", "name" : "ray-cluster-example-02", "status" : "RUNNING" } ], "create_time" : "2025-01-10T03:37:12.000+00:00", "update_time" : "2025-01-10T03:37:12.000+00:00", "creator" : { "domain_name" : "test", "domain_id" : "0676610f3a0a4c2c80c50bea7ddf18c1", "user_id" : "019e19fb78887b57b2f6c4174cd5a002", "user_name" : "developer" } } ``` **状态码：400** ``` { "error_code" : "AIDataLake.00010151", "error_msg" : "Parameter value is invalid.", "solution_msg" : "Please input valid parameter value." } ``` **状态码：401** ``` { "error_code" : "APIGW.0301", "error_msg" : "Incorrect IAM authentication information: decrypt token fail.", "solution_msg" : "Check whether the IAM authentication information is correct." } ``` **状态码：403** ``` { "error_code" : "AIDataLake.00010150", "error_msg" : "The operation is not allowed.", "solution_msg" : "Check whether the operation is allowed in the current status." } ``` **状态码：404** ``` { "error_code" : "AIDataLake.00010009", "error_msg" : "No resources found.", "solution_msg" : "Ensure the requested resource exists and the parameters are correct." } ``` **状态码：500** ``` { "error_code" : "AIDataLake.00011001", "error_msg" : "Internal error.", "solution_msg" : "Contact technical support or try again later." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 请求参数错误。 | | 401 | 未授权。 | | 403 | 禁止访问。 | | 404 | 资源未找到。 | | 500 | 内部服务器错误。 |