通过API进行Milvus实例配置

更新Milvus各个组件的配置参数。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

​编辑调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

• 操作：是指具体的权限点。
• 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
• 资源类型：是指操作中支持授权的资源类型。具体说明如下：
  • 对于必选的资源类型，用背景高亮的方式表示。
  • 对于不支持资源级授权的操作，用全部资源表示。
• 条件关键字：是指云产品自身定义的条件关键字。
• 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
milvus:ModifyInstanceConfig	update	Instance acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

POST /webapi/config/modify_milvus_config

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	c-123xxx
Reason	string	是	更新原因。	for test
UserConfig	string	否	用户自定义配置。	dataCoord:\n segment:\n maxSize: 1024

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 请求状态码。	200
RequestId	string	请求 ID。	ABCD-1234-5678-EFGH
Success	boolean	请求是否成功。	true
ErrCode	string	错误码。	Instance.NotFound
ErrMessage	string	错误信息。	Failed to find instance c-123xxx
Data	boolean	返回数据。	true
AccessDeniedDetail	string	权限校验失败详情。	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }

示例

正常返回示例

JSON格式

{"HttpStatusCode": 200,"RequestId": "ABCD-1234-5678-EFGH","Success": true,"ErrCode": "Instance.NotFound","ErrMessage": "Failed to find instance c-123xxx","Data": true,"AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

DescribeInstanceConfigs - 获取实例配置信息

获取Milvus各个组件自定义配置的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

​编辑调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

• 操作：是指具体的权限点。
• 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
• 资源类型：是指操作中支持授权的资源类型。具体说明如下：
  • 对于必选的资源类型，用背景高亮的方式表示。
  • 对于不支持资源级授权的操作，用全部资源表示。
• 条件关键字：是指云产品自身定义的条件关键字。
• 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
milvus:DescribeInstanceConfigs	get	Instance acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

POST /webapi/config/describe_milvus_user_config

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	c-123xxx

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 请求状态码。	200
RequestId	string	请求 ID。	ABCD-1234-5678-EFGH
Success	boolean	请求是否成功。	true
ErrCode	string	错误码。	Instance.NotFound
ErrMessage	string	错误信息。	Failed to find instance c-123xxx.
Data	byte	返回数据。	dataCoord:\n enableCompaction: true
AccessDeniedDetail	string	权限校验失败详情。	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }

示例

正常返回示例

JSON格式

{"HttpStatusCode": 200,"RequestId": "ABCD-1234-5678-EFGH","Success": true,"ErrCode": "Instance.NotFound","ErrMessage": "Failed to find instance c-123xxx.","Data": "dataCoord:\\n  enableCompaction: true","AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

名称类型描述示例值