文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 策略组/ 创建接入策略
更新时间：2025-07-09 GMT+08:00
查看PDF
分享

创建接入策略

功能介绍

该接口用于创建接入策略。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/access-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

发送的实体的MIME类型，如：application/json。
表3 请求Body参数

参数

是否必选

参数类型

描述

policy

是

AccessPolicyInfo object

接入策略信息。

policy_objects_list

否

Array of AccessPolicyObjectInfo objects

策略应用对象列表。
表4 AccessPolicyInfo

参数

是否必选

参数类型

描述

policy_name

否

String

策略名。

blacklist_type

否

String

黑名单类型，当前黑名单只支持互联网。

  • INTERNET： 互联网

access_control_type

否

String

访问控制类型。默认为接入类型

  • ACCESS_TYPE： 接入类型

  • IP_WHITE_LIST： IP白名单

ip_list

否

Array of IpInfo objects

策略的ip列表。

is_enable

否

Boolean

IP白名单是否生效。只能单独更新，此值的优先级最高，传此值只修改该策略是否生效。

is_block_all

否

Boolean

IP白名单是否禁止所有Ip接入。is_enable为false时，无法修改此值。此值也只能单独更新。
表5 IpInfo

参数

是否必选

参数类型

描述

ip_address

是

String

ip地址。

subnet_mask

是

String

子网掩码。
表6 AccessPolicyObjectInfo

参数

是否必选

参数类型

描述

object_id

是

String

黑名单中的对象id。

object_type

是

String

对象类型。

  • USER： 用户

  • USERGROUP： 用户组

object_name

否

String

对象名。后续此参数不会校验。

响应参数

状态码：200

正常。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

post /v2/{project_id}/access-policy

{
  "policy" : {
    "policy_name" : "PRIVATE_ACCESS",
    "blacklist_type" : "INTERNET"
  }
}

响应示例

无

状态码

状态码

描述

200

正常。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 策略组