设置Milvus公网访问IP白名单。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
milvus:UpdateAccessControlList | update |
|
| 无 |
请求语法
POST /webapi/milvus/update_access_control_list
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 否 | 实例 ID。 | c-123xxx |
Cidr | string | 否 | Cidr 块。 | 192.168.**.**/24,172.1.**.**/16 |
AclId | string | 否 | 公网访问控制 ID。 | acl-123xxx |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | |||
HttpStatusCode | integer | HTTP 请求状态码。 | 200 |
RequestId | string | 请求 ID。 | ABCD-1234-5678-EFGH |
Success | boolean | 请求是否成功。 | true |
ErrorCode | string | 错误码。 | ILLEGAL.MilvusCidrFormat |
ErrMessage | string | 错误信息。 | The format of cidr is illegal. |
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,
"ErrorCode": "ILLEGAL.MilvusCidrFormat",
"ErrMessage": "The format of cidr is illegal.",
"Data": true,
"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxxx\", \"EncodedDiagnosticMessage\": \"xxxx\", \"AuthPrincipalType\": \"SubUser\", \"AuthPrincipalDisplayName\": \"xxxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"milvus:xxxx\" }"
}
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
milvus:DescribeAccessControlList | get |
|
| 无 |
请求语法
POST /webapi/milvus/describe_access_control_list
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 否 | 实例 ID。 | c-123xxx |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | |||
HttpStatusCode | integer | HTTP 请求状态码。 | 200 |
RequestId | string | 请求 ID。 | ABCD-1234-5678-EFGH |
Success | boolean | 请求是否成功。 | true |
ErrorCode | string | 错误码。 | Instance.NotFound |
ErrMessage | string | 错误信息。 | Failed to find instance c-123xxx |
Data | object | 返回数据。 | |
AclId | string | 公网访问控制的 AclId。 | acl-xxxx |
Cidr | array | Cidr 块。 | |
string | IP 段。 | 192.168.**.** | |
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,
"ErrorCode": "Instance.NotFound",
"ErrMessage": "Failed to find instance c-123xxx",
"Data": {
"AclId": "acl-xxxx",
"Cidr": [
"192.168.**.**"
]
},
"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxxx\", \"EncodedDiagnosticMessage\": \"xxxx\", \"AuthPrincipalType\": \"SubUser\", \"AuthPrincipalDisplayName\": \"xxxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"milvus:xxxx\" }"
}
错误码
访问错误中心查看更多错误码。
开启/关闭Milvus公网访问能力。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
milvus:UpdatePublicNetworkStatus | update |
|
| 无 |
请求语法
POST /webapi/network/updatePublicNetworkStatus
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | c-123xxx |
ComponentType | string | 是 | 组件类型。取值范围:
| Proxy |
PublicNetworkEnabled | boolean | 是 | 开启/关闭公网。 | true |
Cidr | string | 否 | Cidr 块 | 192.168.**.**/24,172.1.**.**/16 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | |||
HttpStatusCode | integer | HTTP 请求状态码。 | 200 |
RequestId | string | 请求 ID。 | ABCD-1234-5678-EFGH |
Success | boolean | 请求是否成功。 | true |
ErrCode | string | 错误码。 | Failed to find instance |
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": "Failed to find instance",
"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\" }"
}