更新超节点元数据-UpdateHypernodeMetadata
功能介绍
更新超节点元数据。已存在的key更新value,不存在的key新增(非全量替换)。
单次请求最多10个键值对,更新后metadata总数不能超过80。
不允许传入黑名单中的key或以_sys_开头的key。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics:hypernode:updateMetadata | Write | hypernode * | g:ResourceTag/<tag-key> | - | - |
URI
POST /v2/{project_id}/hypernodes/{hypernode_id}/metadata
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| hypernode_id | 是 | String | 参数解释: 超节点唯一标识UUID。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| metadata | 是 | Array of Metadata objects | 参数解释: 元数据列表。 约束限制: 不允许传入重复key、黑名单中的key或以_sys_开头的key。更新后metadata总数不能超过80。 取值范围: 元数据数量为1-10。 默认取值: 不涉及。 |
响应参数
状态码:201
成功更新超节点元数据。
无
请求示例
更新超节点元数据请求示例。使用场景:用户需要为超节点添加或更新自定义元数据时,通过此接口更新。
POST https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/hypernodes/d6b9c4e2-5f3a-4b1c-9e7d-8a2f1c3b5e9f/metadata
{
"metadata" : [ {
"key" : "user_key1",
"value" : "value1"
}, {
"key" : "user_key2",
"value" : "value2"
} ]
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 201 | 成功更新超节点元数据。 |
错误码
请参见错误码。