diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/csas | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/csas')
| -rw-r--r-- | data/zh_cn/csas/2023-01-20/api-docs.php | 24780 |
1 files changed, 24780 insertions, 0 deletions
diff --git a/data/zh_cn/csas/2023-01-20/api-docs.php b/data/zh_cn/csas/2023-01-20/api-docs.php new file mode 100644 index 0000000..a01bdc6 --- /dev/null +++ b/data/zh_cn/csas/2023-01-20/api-docs.php @@ -0,0 +1,24780 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'csas', + 'version' => '2023-01-20', + ], + 'directories' => [ + [ + 'id' => 208884, + 'title' => '企业加速', + 'type' => 'directory', + 'children' => [ + 'DeleteEnterpriseAcceleratePolicy', + 'DisableEnterpriseAcceleratePolicy', + 'ListEnterpriseAcceleratePolicies', + 'ListEnterpriseAccelerateTargets', + 'ListEnterpriseAccelerateLogs', + 'ImportEnterpriseAccelerateTargets', + 'CreateEnterpriseAccelerateTarget', + 'EnableEnterpriseAcceleratePolicy', + 'DeleteEnterpriseAccelerateTarget', + 'ModifyEnterpriseAcceleratePolicy', + 'CreateEnterpriseAcceleratePolicy', + ], + ], + [ + 'id' => 204316, + 'title' => '动态决策', + 'type' => 'directory', + 'children' => [ + 'ListDynamicDisposalProcesses', + ], + ], + [ + 'id' => 201505, + 'title' => '审批报备', + 'type' => 'directory', + 'children' => [ + 'UpdateApprovalStatus', + 'UpdateApprovalProcess', + 'ListApprovals', + 'ListApprovalSchemasForApprovalProcesses', + 'ListApprovalSchemas', + 'ListApprovalProcessesForApprovalSchemas', + 'ListApprovalProcesses', + 'GetApprovalSchema', + 'GetApprovalProcess', + 'GetApproval', + 'DetachPolicy2ApprovalProcess', + 'DeleteApprovalProcesses', + 'AttachPolicy2ApprovalProcess', + 'CreateApprovalProcess', + ], + ], + [ + 'id' => 201520, + 'title' => '终端防卸载策略', + 'type' => 'directory', + 'children' => [ + 'ListUninstallApplications', + 'UpdateBootAndAntiUninstallPolicy', + 'UpdateUninstallApplicationsStatus', + 'GetBootAndAntiUninstallPolicy', + ], + ], + [ + 'id' => 193580, + 'title' => '网络准入', + 'type' => 'directory', + 'children' => [ + 'ListNacUserCert', + 'UpdateNacUserCertStatus', + ], + ], + [ + 'id' => 191724, + 'title' => '身份源配置管理', + 'type' => 'directory', + 'children' => [ + 'ListIdpConfigs', + 'GetIdpConfig', + 'GetActiveIdpConfig', + [ + 'id' => 191728, + 'title' => '自定义身份源', + 'type' => 'directory', + 'children' => [ + 'ListIdpDepartments', + 'CreateIdpDepartment', + 'ListClientUsers', + 'UpdateClientUser', + 'GetClientUser', + 'DeleteIdpDepartment', + 'CreateClientUser', + 'UpdateIdpDepartment', + 'UpdateClientUserStatus', + 'DeleteClientUser', + 'UpdateClientUserPassword', + ], + ], + ], + ], + [ + 'id' => 185976, + 'title' => '终端设备管理', + 'type' => 'directory', + 'children' => [ + 'UpdateUserDevicesStatus', + 'ListExcessiveDeviceRegistrationApplications', + 'UpdateExcessiveDeviceRegistrationApplicationsStatus', + 'UpdateUserDevicesSharingStatus', + 'ListUserDevices', + 'ExportUserDevices', + 'GetUserDevice', + 'DeleteUserDevices', + 'ListSoftwareForUserDevice', + ], + ], + [ + 'id' => 185984, + 'title' => '设备注册策略', + 'type' => 'directory', + 'children' => [ + 'ListRegistrationPolicies', + 'ListUserGroupsForRegistrationPolicy', + 'ListRegistrationPoliciesForUserGroup', + 'GetRegistrationPolicy', + 'DeleteRegistrationPolicies', + 'UpdateRegistrationPolicy', + 'CreateRegistrationPolicy', + ], + ], + [ + 'id' => 181189, + 'title' => '用户组', + 'type' => 'directory', + 'children' => [ + 'ListUserGroups', + 'ListPolicesForUserGroup', + 'GetUserGroup', + 'CreateUserGroup', + 'DeleteUserGroup', + 'UpdateUserGroup', + ], + ], + [ + 'id' => 190835, + 'title' => '用户管理', + 'type' => 'directory', + 'children' => [ + 'ListUserPrivateAccessPolicies', + 'ListUserApplications', + 'ListUsers', + 'UpdateUsersStatus', + ], + ], + [ + 'id' => 181191, + 'title' => '内网访问应用', + 'type' => 'directory', + 'children' => [ + 'ListPrivateAccessApplications', + 'ListTagsForPrivateAccessApplication', + 'ListPolicesForPrivateAccessApplication', + 'GetPrivateAccessApplication', + 'CreatePrivateAccessApplication', + 'DeletePrivateAccessApplication', + 'UpdatePrivateAccessApplication', + ], + ], + [ + 'id' => 181192, + 'title' => 'Connector', + 'type' => 'directory', + 'children' => [ + 'ListConnectors', + 'AttachApplication2Connector', + 'DetachApplication2Connector', + ], + ], + [ + 'id' => 181193, + 'title' => '内网访问标签', + 'type' => 'directory', + 'children' => [ + 'ListPrivateAccessTags', + 'ListApplicationsForPrivateAccessTag', + 'ListPolicesForPrivateAccessTag', + 'CreatePrivateAccessTag', + 'DeletePrivateAccessTag', + ], + ], + [ + 'id' => 181194, + 'title' => '内网访问策略', + 'type' => 'directory', + 'children' => [ + 'ListPrivateAccessPolices', + 'ListUserGroupsForPrivateAccessPolicy', + 'ListApplicationsForPrivateAccessPolicy', + 'ListTagsForPrivateAccessPolicy', + 'GetPrivateAccessPolicy', + 'CreatePrivateAccessPolicy', + 'DeletePrivateAccessPolicy', + 'UpdatePrivateAccessPolicy', + ], + ], + [ + 'id' => 182283, + 'title' => '全球办公', + 'type' => 'directory', + 'children' => [ + 'ListDynamicRoutes', + 'ListPrivateAccessApplicationsForDynamicRoute', + 'ListPrivateAccessTagsForDynamicRoute', + 'GetDynamicRoute', + 'ListDynamicRouteRegions', + 'CreateDynamicRoute', + 'UpdateDynamicRoute', + 'DeleteDynamicRoute', + ], + ], + [ + 'id' => 193109, + 'title' => '数字水印', + 'type' => 'directory', + 'children' => [ + 'LookupWmInfoMapping', + 'CreateWmInfoMapping', + 'CreateWmBaseImage', + 'GetWmExtractTask', + 'GetWmEmbedTask', + 'CreateWmExtractTask', + 'CreateWmEmbedTask', + ], + ], + [ + 'id' => 190079, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'RevokeUserSession', + 'ListPopTrafficStatistics', + 'DeleteOtpConfig', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AddressGroup' => [ + 'description' => '应用地址组。', + 'type' => 'object', + 'properties' => [ + 'Addresses' => [ + 'description' => '地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'mmtcafts.alipay.com', + ], + 'required' => false, + ], + 'Ports' => [ + 'description' => '端口信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '端口信息列表。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。小于等于结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'End' => [ + 'description' => '结束端口。大于等于起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1234', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'AuthReportInterval' => [ + 'title' => 'authReportInterval', + 'type' => 'object', + 'properties' => [ + 'TimeUnit' => [ + 'title' => 'timeUnit', + 'type' => 'string', + ], + 'Value' => [ + 'title' => 'value', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'CommonConfig' => [ + 'title' => 'common config', + 'type' => 'object', + 'properties' => [ + 'Idp' => [ + 'title' => 'idp common config', + 'type' => 'object', + 'properties' => [ + 'Feishu' => [ + 'title' => '飞书配置', + 'type' => 'object', + 'properties' => [ + 'HomePage' => [ + 'title' => '应用主页地址', + 'type' => 'string', + ], + 'EventLabel' => [ + 'type' => 'string', + ], + 'EventCallbackBase' => [ + 'title' => '事件回调地址', + 'type' => 'string', + ], + 'LoginRedirect' => [ + 'title' => '登录回调地址', + 'type' => 'string', + ], + ], + ], + 'ApOidcCallbackUrl' => [ + 'title' => 'oidc扩展认证源回调地址', + 'type' => 'string', + ], + 'Idaas2' => [ + 'title' => '新版IDaaS配置', + 'type' => 'object', + 'properties' => [ + 'EventLabel' => [ + 'type' => 'string', + ], + 'EventCallbackBase' => [ + 'type' => 'string', + ], + ], + ], + 'Saml' => [ + 'title' => 'saml配置', + 'type' => 'object', + 'properties' => [ + 'Acs' => [ + 'title' => 'acs URL', + 'type' => 'string', + ], + 'Metadata' => [ + 'title' => 'metadata URL', + 'type' => 'string', + ], + ], + ], + 'Dingtalk' => [ + 'title' => '钉钉配置', + 'type' => 'object', + 'properties' => [ + 'HomePage' => [ + 'title' => '应用主页地址', + 'type' => 'string', + ], + 'EventLabel' => [ + 'type' => 'string', + ], + 'EventCallbackBase' => [ + 'type' => 'string', + ], + 'LoginRedirect' => [ + 'title' => '登录回调地址', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'DeviceGroupDynamicRule' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'required' => false, + ], + 'Operator' => [ + 'type' => 'string', + 'required' => false, + ], + 'Args' => [ + 'type' => 'any', + 'required' => false, + ], + ], + ], + 'DisposalContent' => [ + 'title' => 'disposalContent', + 'type' => 'object', + 'properties' => [ + 'ProhibitActions' => [ + 'title' => 'prohibitActions', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + ], + 'NotifyActions' => [ + 'title' => 'notifyActions', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + ], + 'AlertTitle' => [ + 'title' => 'alertTitle', + 'type' => 'string', + 'required' => false, + ], + 'AlertContent' => [ + 'title' => 'alertContent', + 'type' => 'string', + 'required' => false, + ], + 'NoticeContent' => [ + 'title' => 'noticeContent', + 'type' => 'string', + ], + 'NoticeContentEn' => [ + 'title' => 'noticeContentEn', + 'type' => 'string', + ], + 'AlertTitleEn' => [ + 'title' => 'alertTitleEn', + 'type' => 'string', + ], + 'AlertContentEn' => [ + 'title' => 'alertContentEn', + 'type' => 'string', + ], + 'NacDemotionPolicyIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AlertIntervalSeconds' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ProhibitSoftwareIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ExecutePeriod' => [ + 'type' => 'object', + 'properties' => [ + 'ValidType' => [ + 'type' => 'string', + ], + 'EffectTime' => [ + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'type' => 'string', + ], + 'End' => [ + 'type' => 'string', + ], + ], + ], + 'EffectDay' => [ + 'type' => 'object', + 'properties' => [ + 'Monday' => [ + 'type' => 'boolean', + ], + 'Tuesday' => [ + 'type' => 'boolean', + ], + 'Wednesday' => [ + 'type' => 'boolean', + ], + 'Thursday' => [ + 'type' => 'boolean', + ], + 'Friday' => [ + 'type' => 'boolean', + ], + 'Saturday' => [ + 'type' => 'boolean', + ], + 'Sunday' => [ + 'type' => 'boolean', + ], + ], + ], + 'ScheduleEffect' => [ + 'type' => 'object', + 'properties' => [ + 'Frequency' => [ + 'type' => 'string', + ], + 'Interval' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'IdpAttrMapConfig' => [ + 'title' => 'A short description of struct', + 'description' => 'IdpAttrMapConfig', + 'type' => 'object', + 'properties' => [ + 'MapItems' => [ + 'title' => '映射配置项', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/IdpAttrMapConfigItem', + ], + ], + ], + ], + 'IdpAttrMapConfigItem' => [ + 'title' => '身份源同步字段映射配置项', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'title' => 'SASE的目标字段key', + 'type' => 'string', + ], + 'TargetType' => [ + 'title' => 'SASE的目标字段类型', + 'type' => 'string', + ], + 'Source' => [ + 'title' => '身份源字段key', + 'type' => 'string', + ], + ], + ], + 'IdpConfig' => [ + 'title' => '身份源配置', + 'type' => 'object', + 'properties' => [ + 'SyncStatus' => [ + 'title' => '同步状态', + 'type' => 'string', + 'enum' => [ + 'disabled', + 'running', + 'success', + 'failed', + ], + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'IdpConfigId' => [ + 'title' => '身份源配置ID', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + ], + 'LdapConfig' => [ + '$ref' => '#/components/schemas/IdpLdapSubConfig', + ], + 'Type' => [ + 'title' => '类型', + 'type' => 'string', + ], + 'LoginConfig' => [ + '$ref' => '#/components/schemas/IdpLoginConfig', + ], + 'FeishuConfig' => [ + '$ref' => '#/components/schemas/IdpFeishuSubConfig', + ], + 'ConnectConfig' => [ + '$ref' => '#/components/schemas/IdpConnectConfig', + ], + 'DingtalkConfig' => [ + '$ref' => '#/components/schemas/IdpDingtalkSubConfig', + ], + 'SyncConfig' => [ + '$ref' => '#/components/schemas/IdpSyncConfig', + ], + 'AttrMapConfig' => [ + '$ref' => '#/components/schemas/IdpAttrMapConfig', + ], + 'LastSyncTimeUnix' => [ + 'title' => '最后一次同步时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'Enabled' => [ + 'title' => '是否启用身份源', + 'type' => 'boolean', + ], + 'WeixinConfig' => [ + '$ref' => '#/components/schemas/IdpWeixin2SubConfig', + ], + 'IdaasConfig' => [ + '$ref' => '#/components/schemas/IdpIdaas2SubConfig', + ], + 'WuyingConfig' => [ + '$ref' => '#/components/schemas/OpenStructIdpWuyingSubConfig', + ], + 'LogoDirectory' => [ + 'type' => 'string', + ], + 'IdpId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'IdpConnectConfig' => [ + 'title' => '身份源连接配置', + 'type' => 'object', + 'properties' => [ + 'UseConnector' => [ + 'title' => '是否使用connector', + 'type' => 'boolean', + ], + 'ConnectorId' => [ + 'title' => 'connector id', + 'type' => 'string', + ], + ], + ], + 'IdpCustomField' => [ + 'title' => '身份源自定义字段', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'type' => 'string', + 'enum' => [ + 'string', + 'integer', + 'boolean', + 'float', + ], + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'Value' => [ + 'title' => '值', + 'type' => 'string', + ], + 'Key' => [ + 'title' => '键', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + ], + ], + ], + 'IdpDingtalkSubConfig' => [ + 'title' => '钉钉身份源配置', + 'type' => 'object', + 'properties' => [ + 'CorpId' => [ + 'title' => 'CorpId', + 'type' => 'string', + ], + 'EventLabel' => [ + 'title' => '回调标签', + 'type' => 'string', + ], + 'Exclusive' => [ + 'title' => '是否是专属钉', + 'type' => 'boolean', + ], + 'AppKey' => [ + 'title' => 'app key', + 'type' => 'string', + ], + 'RedirectUri' => [ + 'title' => '登录回调url', + 'type' => 'string', + ], + 'EventVerifyToken' => [ + 'title' => '回调token', + 'type' => 'string', + ], + 'EventAesKey' => [ + 'title' => '回调AES密钥', + 'type' => 'string', + ], + 'AppSecret' => [ + 'title' => 'app secret', + 'type' => 'string', + ], + ], + ], + 'IdpFeishuSubConfig' => [ + 'title' => '飞书身份源配置', + 'type' => 'object', + 'properties' => [ + 'CorpId' => [ + 'title' => 'CorpId', + 'type' => 'string', + ], + 'EventLabel' => [ + 'title' => 'EventLabel', + 'type' => 'string', + ], + 'AppId' => [ + 'title' => 'AppId', + 'type' => 'string', + ], + 'RedirectUri' => [ + 'title' => 'RedirectUri', + 'type' => 'string', + ], + 'EventVerifyToken' => [ + 'title' => 'EventVerifyToken', + 'type' => 'string', + ], + 'EventAesKey' => [ + 'title' => 'EventAesKey', + 'type' => 'string', + ], + 'AppSecret' => [ + 'title' => 'AppSecret', + 'type' => 'string', + ], + ], + ], + 'IdpIdaas2SubConfig' => [ + 'title' => 'IDaaS身份源配置', + 'type' => 'object', + 'properties' => [ + 'EventLabel' => [ + 'title' => 'EventLabel', + 'type' => 'string', + ], + 'InstanceId' => [ + 'title' => 'InstanceId', + 'type' => 'string', + ], + 'ClientSecret' => [ + 'title' => '新版idaas：ClientSecret'."\n" + .'旧版idaas：api secret', + 'type' => 'string', + ], + 'ClientId' => [ + 'title' => '新版idaas：ClientId'."\n" + .'旧版idaas：api key', + 'type' => 'string', + ], + 'Region' => [ + 'title' => 'Region', + 'type' => 'string', + 'enum' => [ + 'cn-hangzhou', + 'ap-southeast-1', + 'cn-hongkong', + 'eu-central-1', + ], + ], + 'EventAesKey' => [ + 'title' => 'EventAesKey', + 'type' => 'string', + ], + 'ApplicationId' => [ + 'title' => 'ApplicationId', + 'type' => 'string', + ], + 'PublicKeyEndpoint' => [ + 'title' => 'PublicKeyEndpoint', + 'type' => 'string', + ], + 'SamlMetadata' => [ + 'type' => 'string', + ], + ], + ], + 'IdpLdapSubConfig' => [ + 'title' => 'LDAP身份源配置', + 'type' => 'object', + 'properties' => [ + 'ServerType' => [ + 'title' => 'ldap服务器类型', + 'type' => 'string', + 'enum' => [ + 'openldap', + 'windows_ad', + ], + ], + 'GroupBaseDn' => [ + 'title' => '组basedn', + 'type' => 'string', + ], + 'UserDn' => [ + 'title' => '管理员dn', + 'type' => 'string', + ], + 'ServerAddr' => [ + 'title' => '服务器地址', + 'type' => 'string', + ], + 'GroupFilter' => [ + 'title' => '组过滤器', + 'type' => 'string', + ], + 'UserFilter' => [ + 'title' => '用户过滤器', + 'type' => 'string', + ], + 'UserPassword' => [ + 'title' => '管理员密码', + 'type' => 'string', + ], + 'UseSsl' => [ + 'title' => '使用ssl', + 'type' => 'boolean', + ], + 'GroupMembershipAttr' => [ + 'title' => '部门属性', + 'type' => 'string', + ], + 'BaseDn' => [ + 'title' => 'basedn', + 'type' => 'string', + ], + 'LoginNameAttr' => [ + 'title' => '登录名属性', + 'type' => 'string', + ], + 'ServerPort' => [ + 'title' => '服务器端口', + 'type' => 'string', + ], + 'GroupNameAttr' => [ + 'title' => '部门名属性', + 'type' => 'string', + ], + ], + ], + 'IdpLoginConfig' => [ + 'title' => '身份源登录配置', + 'type' => 'object', + 'properties' => [ + 'TotpCorpVerifyUrl' => [ + 'title' => '企业totp校验url', + 'type' => 'string', + ], + 'PcLoginType' => [ + 'title' => '桌面端登录方式', + 'type' => 'string', + 'enum' => [ + 'password', + 'non-password', + ], + ], + 'MobileMfaTypes' => [ + 'title' => '移动端mfa方式，逗号分隔的枚举值'."\n" + .'sms_email: 通过邮箱发送验证码'."\n" + .'sms_phone: 通过手机发送验证码'."\n" + .'totp_sase: 仅允许 SASE 移动端 展示'."\n" + .'totp_third: 仅允许第三方 APP 绑定'."\n" + .'totp_corp: 仅允许企业自有 OTP', + 'type' => 'string', + ], + 'TotpCorpVerifyToken' => [ + 'title' => '企业totp校验token', + 'type' => 'string', + ], + 'PcMfaTypes' => [ + 'title' => '桌面端端mfa方式，逗号分隔的枚举值'."\n" + .'sms_email: 通过邮箱发送验证码'."\n" + .'sms_phone: 通过手机发送验证码'."\n" + .'totp_sase: 仅允许 SASE 移动端 展示'."\n" + .'totp_third: 仅允许第三方 APP 绑定'."\n" + .'totp_corp: 仅允许企业自有 OTP', + 'type' => 'string', + ], + 'MobileLoginType' => [ + 'title' => '移动端登录方式', + 'type' => 'string', + 'enum' => [ + 'password', + 'non-password', + ], + ], + 'TotpCorpVerifyAesKey' => [ + 'title' => '企业totp加密AES密钥', + 'type' => 'string', + ], + ], + ], + 'IdpLoginOrderItem' => [ + 'title' => '登录页认证源', + 'type' => 'object', + 'properties' => [ + 'Desc' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'Type' => [ + 'title' => '类型', + 'type' => 'string', + ], + 'Enabled' => [ + 'title' => '是否启用认证', + 'type' => 'boolean', + ], + 'Class' => [ + 'title' => '种类：身份源、扩展认证源', + 'type' => 'string', + 'enum' => [ + 'idp', + 'ap', + ], + ], + 'ConfigId' => [ + 'title' => '身份源活认证源的id', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + ], + ], + ], + 'IdpSyncConfig' => [ + 'title' => '同步配置', + 'type' => 'object', + 'properties' => [ + 'UserSyncEnabled' => [ + 'type' => 'boolean', + ], + 'ScheduleSyncIntervalSecond' => [ + 'title' => '定时同步时间间隔', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AutoSyncEnabled' => [ + 'title' => '自动同步开关', + 'type' => 'boolean', + ], + 'IdpDepartmentInfos' => [ + 'title' => '选择同步的部门名称，和 IdpDepartmentIds 一一对应', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'IdpWeixin2SubConfig' => [ + 'title' => '企微身份源配置', + 'type' => 'object', + 'properties' => [ + 'AppSchema' => [ + 'title' => '安卓schema', + 'type' => 'string', + ], + 'CorpId' => [ + 'title' => 'corp id', + 'type' => 'string', + ], + 'EventLabel' => [ + 'title' => '事件回调标签', + 'type' => 'string', + ], + 'RedirectUri' => [ + 'title' => '登录回调地址', + 'type' => 'string', + ], + 'EventVerifyToken' => [ + 'title' => 'EventVerifyToken', + 'type' => 'string', + ], + 'AgentId' => [ + 'title' => 'AgentId', + 'type' => 'string', + ], + 'EventAesKey' => [ + 'type' => 'string', + ], + 'AppSecret' => [ + 'title' => '密钥', + 'type' => 'string', + ], + ], + ], + 'OpenStructIdpSyncRecord' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'type' => 'string', + ], + 'IdpResourceId' => [ + 'type' => 'string', + ], + 'SaseRawJson' => [ + 'type' => 'string', + ], + 'RecordType' => [ + 'type' => 'string', + ], + 'SyncRecordId' => [ + 'type' => 'string', + ], + 'SaseResourceId' => [ + 'type' => 'string', + ], + 'SyncTaskId' => [ + 'type' => 'string', + ], + 'TimeUnix' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'IdpRawJson' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + 'OpenStructIdpSyncTask' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => 'pending'."\n" + .'running'."\n" + .'success'."\n" + .'failed', + 'type' => 'string', + ], + 'UserFailed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DepartmentFailed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DepartmentTotal' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'StartTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'EndTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'UserTotal' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SyncTaskId' => [ + 'type' => 'string', + ], + 'UpdateTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FailType' => [ + 'type' => 'string', + ], + 'IdpConfigId' => [ + 'type' => 'string', + 'format' => 'byte', + ], + ], + ], + 'OpenStructIdpWuyingSubConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Aliuids' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'OpenStructSaseDepartment' => [ + 'type' => 'object', + 'properties' => [ + 'DepartmentId' => [ + 'type' => 'string', + ], + 'ParentDepartmentId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'FullDn' => [ + 'type' => 'string', + ], + 'FullDepartmentIdPath' => [ + 'type' => 'string', + ], + 'IdpId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'OpenStructSaseUser' => [ + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'type' => 'string', + ], + 'Username' => [ + 'type' => 'string', + ], + 'Telephone' => [ + 'type' => 'string', + ], + 'Email' => [ + 'type' => 'string', + ], + 'Departments' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/OpenStructSaseDepartment', + ], + ], + 'CustomFields' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/IdpCustomField', + ], + ], + 'CreateTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'UpdateTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SaseUserStatus' => [ + 'type' => 'string', + ], + 'Title' => [ + 'type' => 'string', + ], + 'WorkStatus' => [ + 'type' => 'string', + ], + 'LeaveTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SyncTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'LoginTimeUnix' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'IdpConfigId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'UserTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Aliuid' => [ + 'type' => 'string', + ], + 'SaseUserId' => [ + 'type' => 'string', + ], + 'TagId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'OpenStructSaseUserSimple' => [ + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'type' => 'string', + ], + 'Username' => [ + 'type' => 'string', + ], + 'Telephone' => [ + 'type' => 'string', + ], + 'Email' => [ + 'type' => 'string', + ], + 'IdpConfigId' => [ + 'type' => 'string', + ], + 'Departments' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DepartmentId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'ParentDepartmentId' => [ + 'type' => 'string', + ], + 'FullDepartmentIdPath' => [ + 'type' => 'string', + ], + 'FullDn' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PAL7Config' => [ + 'title' => 'PA7层应用配置', + 'description' => '7层应用配置。', + 'type' => 'object', + 'properties' => [ + 'RequestQueryRewriteConfig' => [ + 'title' => 'query参数改写', + 'description' => 'HTTP请求Query参数改写配置。', + 'type' => 'object', + 'properties' => [ + 'Ops' => [ + 'title' => '改写操作', + 'description' => '改写操作数组。', + 'type' => 'array', + 'items' => [ + 'description' => '改写操作。', + '$ref' => '#/components/schemas/PAL7ConfigRewriteOp', + ], + ], + ], + ], + 'JsHookConfig' => [ + 'title' => 'JS内网请求改写', + 'description' => 'JS内网请求改写配置。', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => 'JS改写模式', + 'description' => 'JS内网请求改写模式。默认为**disabled**。取值：'."\n" + .'- **disabled**：禁用JS引流。'."\n" + .'- **whitelist**：白名单模式，按需引流。', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => 'disabled', + 'whitelist' => 'whitelist', + ], + 'example' => 'disabled', + 'enum' => [ + 'disabled', + 'whitelist', + 'blacklist', + 'global', + 'on_demand', + ], + ], + 'ReplaceRules' => [ + 'title' => '改写规则', + 'description' => 'JS内网请求改写规则数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'JS内网请求改写规则。', + '$ref' => '#/components/schemas/PAL7ConfigReplaceRule', + ], + ], + ], + ], + 'BypassConfig' => [ + 'title' => '匿名访问', + 'description' => '匿名访问配置。', + 'type' => 'object', + 'properties' => [ + 'AppBypassFroms' => [ + 'title' => 'app匿名访问源IP', + 'description' => '可以匿名访问应用的源IP段数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'CIDR格式的IP段。', + 'type' => 'string', + 'example' => '10.x.x.1/24'."\n", + ], + ], + 'Mode' => [ + 'title' => '匿名访问模式', + 'description' => '匿名访问模式。默认为**disabled**。取值：'."\n" + .'- **disabled**：禁用匿名访问。'."\n" + .'- **url**：按URL粒度进行匿名访问设置。'."\n" + .'- **app**：按应用粒度进行匿名访问设置。', + 'type' => 'string', + 'example' => 'disabled', + 'default' => 'disabled', + 'enum' => [ + 'disabled', + 'app', + 'url', + ], + ], + 'UrlBypassRules' => [ + 'title' => 'url匿名访问规则', + 'description' => 'URL匿名访问规则数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'URL匿名访问规则。', + 'type' => 'object', + 'properties' => [ + 'Paths' => [ + 'title' => 'url路径', + 'description' => '允许匿名访问的URL路径。', + 'type' => 'array', + 'items' => [ + 'description' => 'URL路径。', + 'type' => 'string', + 'example' => '/api/xxx', + ], + ], + 'Froms' => [ + 'title' => '源IP CIDR', + 'description' => '可以匿名访问应用路径的源IP段数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'CIDR格式的IP段。', + 'type' => 'string', + 'example' => '10.x.x.1/24'."\n", + ], + ], + ], + ], + ], + ], + ], + 'CertId' => [ + 'title' => '证书ID', + 'description' => '证书ID。使用自定义代理域名时该参数必填。', + 'type' => 'string', + 'example' => 'cert-xxxx', + ], + 'ResponseHeaderRewriteConfig' => [ + 'title' => '响应头重写', + 'description' => 'HTTP响应头重写配置。', + 'type' => 'object', + 'properties' => [ + 'Ops' => [ + 'title' => '改写操作', + 'description' => '改写操作数组。', + 'type' => 'array', + 'items' => [ + 'description' => '改写操作。', + '$ref' => '#/components/schemas/PAL7ConfigRewriteOp', + ], + ], + ], + ], + 'ResponseRewriteConfig' => [ + 'title' => 'HTML内网域名改写', + 'description' => 'HTML内网域名改写配置。', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '改写模式', + 'description' => '改写模式。默认为**auto**。取值：'."\n" + .'- **disabled**：禁用HTML内网域名改写。'."\n" + .'- **auto**：自动模式，会自动识别HTML中的内网域名并进行改写。', + 'type' => 'string', + 'enumValueTitles' => [ + 'auto' => 'auto', + 'disabled' => 'disabled', + ], + 'example' => 'auto', + 'enum' => [ + 'disabled', + 'auto', + 'replace', + ], + ], + 'ReplaceRules' => [ + 'title' => '改写规则', + 'description' => '改写规则数组。', + 'type' => 'array', + 'items' => [ + 'description' => '改写规则。', + '$ref' => '#/components/schemas/PAL7ConfigReplaceRule', + ], + ], + ], + ], + 'RequestHeaderRewriteConfig' => [ + 'title' => '请求头改写', + 'description' => 'HTTP请求头改写规则。', + 'type' => 'object', + 'properties' => [ + 'Ops' => [ + 'title' => '改写操作', + 'description' => '改写操作数组。', + 'type' => 'array', + 'items' => [ + 'description' => '改写操作。', + '$ref' => '#/components/schemas/PAL7ConfigRewriteOp', + ], + ], + ], + ], + 'DnsConfig' => [ + 'title' => 'DNS配置', + 'description' => 'DNS配置。', + 'type' => 'object', + 'properties' => [ + 'DnsServers' => [ + 'title' => 'DNS服务器地址', + 'description' => 'DNS服务器地址数组。网关会优先使用此处配置的DNS服务器来解析内网域名。', + 'type' => 'array', + 'items' => [ + 'description' => 'DNS服务器地址。', + 'type' => 'string', + 'example' => '10.x.x.1', + ], + ], + ], + ], + 'ProxyDomainTypes' => [ + 'title' => '代理域名类型', + 'description' => '代理域名类型。取值：'."\n" + .'- **automatic**：使用映射代理域名。'."\n" + .'- **custom**：使用自定义代理域名。', + 'type' => 'string', + 'format' => 'byte', + 'enumValueTitles' => [ + 'custom' => '自定义代理域名', + 'automatic' => '映射代理域名', + ], + 'example' => 'automatic', + ], + ], + ], + 'PAL7ConfigReplaceRule' => [ + 'title' => '替换规则', + 'description' => '替换规则。', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'title' => '替换源', + 'description' => '替换原内容。', + 'type' => 'string', + 'example' => 'before', + ], + 'To' => [ + 'title' => '替换目标', + 'description' => '替换目标内容。', + 'type' => 'string', + 'example' => 'after', + ], + ], + ], + 'PAL7ConfigRewriteOp' => [ + 'title' => '改写操作', + 'description' => '改写操作。', + 'type' => 'object', + 'properties' => [ + 'Op' => [ + 'title' => '操作类型，必填', + 'description' => '操作类型，必填参数。取值：'."\n" + .'- **add**：添加操作。'."\n" + .'- **set**：设置操作。'."\n" + .'- **delete**：删除操作。'."\n" + .'- **replace**：替换操作。', + 'type' => 'string', + 'enumValueTitles' => [ + 'add' => '添加', + 'set' => '设置', + 'replace' => '替换', + 'delete' => '删除', + ], + 'example' => 'add', + ], + 'OldValue' => [ + 'title' => 'Op=replace时的旧值', + 'description' => '替换操作参数：需要查找用于替换的值。', + 'type' => 'string', + 'example' => 'old_value', + ], + 'Value' => [ + 'title' => '新的值，可以为空', + 'description' => '字符串类型的目标值。', + 'type' => 'string', + 'example' => 'new_value', + ], + 'Key' => [ + 'title' => 'header或query参数名，必填', + 'description' => 'HTTP Header或Query参数名，必填参数。', + 'type' => 'string', + 'example' => 'X-Test-Param', + ], + 'ValueVariable' => [ + 'title' => '将值替换为变量。 sase_app_name: 应用名 sase_app_id: 应用ID sase_policy_name: 零信任策略名 sase_policy_id: 零信任策略ID sase_user_username: 用户名 sase_user_department: 用户部门 sase_user_group_infos: 用户组织架构信息 sase_user_matched_user_groups: 用户组信息 sase_client_addr: 客户端地址 sase_client_ip: 客户端IP sase_client_port: 客户端端口', + 'description' => '字符串类型的目标值。取值：'."\n" + ."\n" + .'- **sase_app_name**：应用名。'."\n" + .'- **sase_app_id**：应用ID。'."\n" + .'- **sase_policy_name**：零信任策略名。'."\n" + .'- **sase_user_username**：用户名。'."\n" + .'- **sase_user_department**：用户部门。'."\n" + .'- **sase_user_group_infos**：用户组织架构信息。'."\n" + .'- **sase_user_matched_user_groups**：用户组信息。'."\n" + .'- **sase_client_addr**：客户端地址。'."\n" + .'- **sase_client_ip**：客户端IP。'."\n" + .'- **sase_client_port**：客户端端口。', + 'type' => 'string', + 'example' => 'sase_app_name', + 'enum' => [ + 'sase_app_name', + 'sase_app_id', + 'sase_policy_name', + 'sase_policy_id', + 'sase_user_username', + 'sase_user_department', + 'sase_user_group_infos', + 'sase_user_matched_user_groups', + 'sase_client_addr', + 'sase_client_ip', + 'sase_client_port', + ], + ], + ], + ], + 'ProcessGroup' => [ + 'title' => '进程组', + 'description' => '进程组', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'type' => 'string', + ], + 'Processes' => [ + 'title' => '进程列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/ProcessItem', + ], + ], + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + ], + 'ProcessGroupId' => [ + 'title' => '进程组ID', + 'type' => 'string', + ], + ], + ], + 'ProcessItem' => [ + 'title' => '进程列表元素', + 'description' => '进程列表元素', + 'type' => 'object', + 'properties' => [ + 'BundleId' => [ + 'title' => '进程包名', + 'type' => 'string', + ], + 'DevType' => [ + 'title' => '设备类型', + 'type' => 'string', + ], + 'Process' => [ + 'title' => '进程名', + 'type' => 'string', + ], + 'Directory' => [ + 'title' => '进程目录', + 'type' => 'string', + ], + ], + ], + 'RecoveryContent' => [ + 'title' => 'recoveryContent', + 'type' => 'object', + 'properties' => [ + 'RecoveryActions' => [ + 'title' => 'recoveryActions', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + ], + 'AuthReportInterval' => [ + 'title' => 'authReportInterval', + '$ref' => '#/components/schemas/AuthReportInterval', + ], + ], + ], + 'RiskSceneConfig' => [ + 'title' => 'riskSceneConfig', + 'type' => 'object', + 'properties' => [ + 'OfficeChannel' => [ + 'title' => '办公渠道', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DetectChannel' => [ + 'title' => '检测渠道', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Rule' => [ + 'title' => 'Rule', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Id', + 'type' => 'string', + ], + 'RuleType' => [ + 'title' => 'ruleType', + 'type' => 'string', + ], + 'RuleSubType' => [ + 'title' => 'ruleSubType', + 'type' => 'string', + ], + 'Name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'Operator' => [ + 'title' => 'operator', + 'type' => 'string', + ], + 'Values' => [ + 'title' => 'values', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Combinator' => [ + 'title' => 'combinator', + 'type' => 'string', + ], + 'Rules' => [ + 'title' => 'rules', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/Rule', + ], + ], + ], + ], + 'UserCertificate' => [ + 'title' => 'tls证书', + 'type' => 'object', + 'properties' => [ + 'PrivateKey' => [ + 'title' => 'PEM私钥', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Description' => [ + 'title' => 'PEM证书', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'CertId' => [ + 'title' => '证书ID', + 'type' => 'string', + 'example' => 'cert-aabbccdd', + ], + 'ExpTimeUnix' => [ + 'title' => '过期时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1734492686', + ], + 'Name' => [ + 'title' => '证书名', + 'type' => 'string', + 'example' => '证书1', + ], + 'Certificate' => [ + 'title' => '证书描述', + 'type' => 'string', + 'example' => '用于测试', + ], + 'GmtModifiedUnix' => [ + 'title' => '更新时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1734523812', + ], + 'GmtCreateUnix' => [ + 'title' => '创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1734523812', + ], + 'DnsNames' => [ + 'title' => '证书生效的域名', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'cloudsecsase.com', + ], + ], + ], + ], + ], + ], + 'apis' => [ + 'DeleteEnterpriseAcceleratePolicy' => [ + 'summary' => '删除企业加速策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263724', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'eap-6edfb9d722ef8429', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '2CABFEBB-0CE7-575E-833A-266F75D46713', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CABFEBB-0CE7-575E-833A-266F75D46713\\"\\n}","type":"json"}]', + 'title' => '删除企业加速策略', + ], + 'DisableEnterpriseAcceleratePolicy' => [ + 'summary' => '禁用企业加速策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263726', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'eap-d50b45aa7dc04aef', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => 'E4C3E4CA-87CC-5EF6-91DD-D400A812EB43', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4C3E4CA-87CC-5EF6-91DD-D400A812EB43\\"\\n}","type":"json"}]', + 'title' => '禁用企业加速策略', + ], + 'ListEnterpriseAcceleratePolicies' => [ + 'summary' => '查询加速策略列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263728', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '企业加速策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试策略', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => 'DB0471D0-C05C-556D-9F40-0325D890036F', + ], + 'Total' => [ + 'description' => '策略总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Policies' => [ + 'description' => '策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略对象。', + 'type' => 'object', + 'properties' => [ + 'EapId' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'example' => 'eap-eec34d4b12fcca61', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'example' => '这是一条测试策略。', + ], + 'UpstreamType' => [ + 'description' => '加速实例。', + 'type' => 'string', + 'example' => 'connector', + ], + 'UpstreamHost' => [ + 'description' => '加速实例的地址（IP或域名）。', + 'type' => 'string', + 'example' => '12.34.56.XX', + ], + 'UpstreamPort' => [ + 'description' => '加速实例的端口（1000~60000之间）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Enabled' => [ + 'description' => '是否启用：'."\n" + .'- **1**: 启用'."\n" + .'- **0**: 未启用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UserAttributeGroup' => [ + 'description' => '加速用户组。', + 'type' => 'string', + 'example' => '测试用户组', + ], + 'Priority' => [ + 'description' => '策略优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '99', + ], + 'AccelerationType' => [ + 'description' => '加速模式：'."\n" + .'- **whiltelist**: 白名单加速'."\n" + .'- **global**: 全局加速'."\n" + .'- **build-in-list:** 系统内置应用加速', + 'type' => 'string', + 'example' => 'whitelist', + ], + 'ShowInClient' => [ + 'description' => '是否在客户端透出：'."\n" + .'- **0**: 不透出'."\n" + .'- **1**: 透出', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OnTls' => [ + 'description' => '是否开启TLS模式：'."\n" + .'- **0**: 不开启'."\n" + .'- **1**: 开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB0471D0-C05C-556D-9F40-0325D890036F\\",\\n \\"Total\\": 5,\\n \\"Policies\\": [\\n {\\n \\"EapId\\": \\"eap-eec34d4b12fcca61\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"这是一条测试策略。\\",\\n \\"UpstreamType\\": \\"connector\\",\\n \\"UpstreamHost\\": \\"12.34.56.XX\\",\\n \\"UpstreamPort\\": 1000,\\n \\"Enabled\\": 0,\\n \\"UserAttributeGroup\\": \\"测试用户组\\",\\n \\"Priority\\": 99,\\n \\"AccelerationType\\": \\"whitelist\\",\\n \\"ShowInClient\\": 1,\\n \\"OnTls\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询企业加速策略列表', + ], + 'ListEnterpriseAccelerateTargets' => [ + 'summary' => '查询企业加速地址列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263737', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'eap-424ba3f47660425c', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '企业加速地址，支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'googleapis.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '529F755E-2E75-52EC-9C2E-6293FB8BF986', + ], + 'Total' => [ + 'description' => '地址总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '103', + ], + 'EapId' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'example' => 'eap-7fed37a757a0de24', + ], + 'Targets' => [ + 'description' => '企业加速地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '企业加速地址。', + 'type' => 'string', + 'example' => 'googleapis.com', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"529F755E-2E75-52EC-9C2E-6293FB8BF986\\",\\n \\"Total\\": 103,\\n \\"EapId\\": \\"eap-7fed37a757a0de24\\",\\n \\"Targets\\": [\\n \\"googleapis.com\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询企业加速地址列表', + ], + 'ListEnterpriseAccelerateLogs' => [ + 'summary' => '查询企业加速审计日志。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264492', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'Department', + 'in' => 'query', + 'schema' => [ + 'description' => '部门。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，Unix时间戳，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1748419094', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，Unix时间戳，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1748422694', + ], + ], + [ + 'name' => 'DstAddr', + 'in' => 'query', + 'schema' => [ + 'description' => '访问地址', + 'type' => 'string', + 'required' => false, + 'example' => 'jfrog.cea.vwah.vwgroup.com', + ], + ], + [ + 'name' => 'SearchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '查询模式，目前只有DstAddr字段支持：'."\n" + .'- **Exact**: 精确查询'."\n" + .'- **Fuzzy**: 模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'Exact', + 'enum' => [ + 'Exact', + 'Fuzzy', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'TotalNumber' => [ + 'description' => '日志总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'RequestId' => [ + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '43F07A6A-294D-56FB-85EB-6AD00C5B60FF', + ], + 'Logs' => [ + 'description' => '日志列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志对象。', + 'type' => 'object', + 'properties' => [ + 'DstAddr' => [ + 'description' => '访问地址。', + 'type' => 'string', + 'example' => 'www.bing.com:443', + ], + 'DeviceType' => [ + 'description' => '设备类型。', + 'type' => 'string', + 'example' => 'windows', + ], + 'UnixTime' => [ + 'description' => '时间。', + 'type' => 'string', + 'example' => '1748422797', + ], + 'Department' => [ + 'description' => '部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '张三', + ], + 'PolicyName' => [ + 'description' => '企业加速策略名。', + 'type' => 'string', + 'example' => '白名单加速', + ], + 'ProxyAddr' => [ + 'description' => '企业加速实例地址。', + 'type' => 'string', + 'example' => '8.222.179.xxx:10015', + ], + 'InBytes' => [ + 'description' => '入流量，单位Byte。', + 'type' => 'string', + 'example' => '12299', + ], + 'OutBytes' => [ + 'description' => '出流量，单位Byte。', + 'type' => 'string', + 'example' => '2603', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalNumber\\": 120,\\n \\"RequestId\\": \\"43F07A6A-294D-56FB-85EB-6AD00C5B60FF\\",\\n \\"Logs\\": [\\n {\\n \\"DstAddr\\": \\"www.bing.com:443\\",\\n \\"DeviceType\\": \\"windows\\",\\n \\"UnixTime\\": \\"1748422797\\",\\n \\"Department\\": \\"测试部\\",\\n \\"Username\\": \\"张三\\",\\n \\"PolicyName\\": \\"白名单加速\\",\\n \\"ProxyAddr\\": \\"8.222.179.xxx:10015\\",\\n \\"InBytes\\": \\"12299\\",\\n \\"OutBytes\\": \\"2603\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询企业加速审计日志', + ], + 'ImportEnterpriseAccelerateTargets' => [ + 'summary' => '批量导入加速地址列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263738', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'eap-6457339b546c4cfb', + ], + ], + [ + 'name' => 'FileUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '导入文件的地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://filename.xlsx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '305508BD-8A31-5E15-86CE-52D57967C45E', + ], + 'Data' => [ + 'description' => '导入任务的ID。', + 'type' => 'string', + 'example' => '1648723859058501', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"305508BD-8A31-5E15-86CE-52D57967C45E\\",\\n \\"Data\\": \\"1648723859058501\\"\\n}","type":"json"}]', + 'title' => '批量导入加速地址列表', + ], + 'CreateEnterpriseAccelerateTarget' => [ + 'summary' => '创建企业加速地址。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263729', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'eap-eec34d4b12fcca61', + ], + ], + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '企业加速地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '企业加速地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'hub.docker.com', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => 'D1AE33DD-0D46-59CD-8340-92BEA2BDD0F1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1AE33DD-0D46-59CD-8340-92BEA2BDD0F1\\"\\n}","type":"json"}]', + 'title' => '创建企业加速地址', + ], + 'EnableEnterpriseAcceleratePolicy' => [ + 'summary' => '启用企业加速策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263725', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'eap-530da9f7110441fb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '09D9F396-29C5-5F0F-9C12-83308062CA2F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09D9F396-29C5-5F0F-9C12-83308062CA2F\\"\\n}","type":"json"}]', + 'title' => '启用企业加速策略', + ], + 'DeleteEnterpriseAccelerateTarget' => [ + 'summary' => '删除企业加速地址。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263730', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'eap-ed1f0e392a28a4e6', + ], + ], + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '企业加速地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '企业加速地址。', + 'type' => 'string', + 'required' => false, + 'example' => '*.chatgpt.com', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '655CE28F-2C0C-5801-A31E-C16BF54BD225', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"655CE28F-2C0C-5801-A31E-C16BF54BD225\\"\\n}","type":"json"}]', + 'title' => '删除企业加速地址', + ], + 'ModifyEnterpriseAcceleratePolicy' => [ + 'summary' => '修改企业加速策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263722', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EapId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eap-ce153a7165c8feea', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => '白名单策略001', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业加速策略描述。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条内网访问策略', + ], + ], + [ + 'name' => 'UpstreamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速实例。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'connector' => 'connector', + 'ga' => 'ga', + 'cen' => 'cen', + ], + 'example' => 'ga', + ], + ], + [ + 'name' => 'UpstreamHost', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速实例的地址（IP或域名）。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '12.34.56.XX', + ], + ], + [ + 'name' => 'UpstreamPort', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速实例的端口（1000~60000之间）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'UserAttributeGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速用户组。', + 'type' => 'string', + 'required' => true, + 'example' => '测试用户组', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '99', + 'minimum' => '0', + 'example' => '999', + 'default' => '99', + ], + ], + [ + 'name' => 'AccelerationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速模式：'."\n" + .'- **whiltelist**: 白名单加速'."\n" + .'- **global**: 全局加速'."\n" + .'- **build-in-list**: 系统内置应用加速', + 'type' => 'string', + 'required' => false, + 'example' => 'whiltelist', + 'default' => 'whitelist', + 'enum' => [ + 'whitelist', + 'global', + 'build-in-list', + ], + ], + ], + [ + 'name' => 'ShowInClient', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否在客户端透出：'."\n" + .'- **0**: 不透出'."\n" + .'- **1**: 透出', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'OnTls', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否开启TLS模式：'."\n" + .'- **0**: 不开启'."\n" + .'- **1**: 开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '-1', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '2CABFEBB-0CE7-575E-833A-266F75D46713', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CABFEBB-0CE7-575E-833A-266F75D46713\\"\\n}","type":"json"}]', + 'title' => '修改企业加速策略', + ], + 'CreateEnterpriseAcceleratePolicy' => [ + 'summary' => '创建企业加速策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263720', + 'abilityTreeNodes' => [ + 'FEATUREcsasQCZUAR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => '全局加速策略', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业管理策略描述，长度为1~512个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '用于全局网络访问的加速策略', + ], + ], + [ + 'name' => 'UpstreamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速实例。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'connector' => 'connector', + 'ga' => 'ga', + 'cen' => 'cen', + ], + 'example' => 'ga', + ], + ], + [ + 'name' => 'UpstreamHost', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速实例的地址（IP或域名）。', + 'type' => 'string', + 'required' => true, + 'example' => '12.34.56.XX', + ], + ], + [ + 'name' => 'UpstreamPort', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速实例的端口（1000~60000之间）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'UserAttributeGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速用户组。', + 'type' => 'string', + 'required' => true, + 'example' => '测试用户组', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '优先级。', + 'type' => 'string', + 'required' => false, + 'example' => '99', + 'maxLength' => 99, + 'minLength' => 0, + 'default' => '99', + ], + ], + [ + 'name' => 'AccelerationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加速模式：'."\n" + .'- **whiltelist**: 白名单加速'."\n" + .'- **global**: 全局加速'."\n" + .'- **build-in-list**: 系统内置应用加速', + 'type' => 'string', + 'required' => false, + 'example' => 'whitelist', + 'default' => 'whitelist', + 'enum' => [ + 'whitelist', + 'global', + 'build-in-list', + ], + ], + ], + [ + 'name' => 'ShowInClient', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否在客户端透出：'."\n" + .'- **0**: 不透出'."\n" + .'- **1**: 透出', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => '2CABFEBB-0CE7-575E-833A-266F75D46713', + ], + 'EapId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CABFEBB-0CE7-575E-833A-266F75D46713\\",\\n \\"EapId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '创建企业加速策略', + ], + 'ListDynamicDisposalProcesses' => [ + 'summary' => '批量查询动态策略处置流程。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257988', + 'abilityTreeNodes' => [ + 'FEATUREcsas2RGHRX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的动态处置流程开始时间。格式为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1743143296', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的动态处置流程结束时间。格式为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1743143296', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'xiaoming', + ], + ], + [ + 'name' => 'DisposalAction', + 'in' => 'query', + 'schema' => [ + 'description' => '处置动作。'."\n" + .'- **ztna_connect**：禁止连接零信任内网。'."\n" + .'- **nac_connect**：禁止连接办公网准入。'."\n" + .'- **none**：无处置动作。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ztna_connect' => 'ztna_connect', + 'nac_connect' => 'nac_connect', + 'none' => 'none', + ], + 'example' => 'none', + ], + ], + [ + 'name' => 'RecoveryType', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复类型。'."\n" + .'- **auto**：自动恢复。'."\n" + .'- **console**：控制台恢复。'."\n" + .'- **auth**：认证报备恢复。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'console' => 'console', + 'auto' => 'auto', + 'auth' => 'auth', + ], + 'example' => 'auto', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '处置状态。取值：'."\n" + .'- **disposal**：处于处置状态。'."\n" + .'- **finished**：已经自动恢复。'."\n" + .'- **recovery**：认证报备恢复或控制台恢复。', + 'type' => 'string', + 'required' => false, + 'example' => 'disposal', + ], + ], + [ + 'name' => 'DisposalProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '处置流程ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dp-xxxxxxxx', + ], + ], + [ + 'name' => 'DevTag', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'E7798391-2554-FE83-E0B7-045DDED629A8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + 'DisposalProcesses' => [ + 'description' => '处置流程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '处置流程。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '处置状态。取值：'."\n" + .'- **disposal**：处于处置状态。'."\n" + .'- **finished**：已经自动恢复。'."\n" + .'- **recovery**：认证报备恢复或控制台恢复。', + 'type' => 'string', + 'enumValueTitles' => [ + 'finished' => 'finished', + 'recovery' => 'recovery', + 'disposal' => 'disposal', + ], + 'example' => 'disposal', + ], + 'DynamicPolicyId' => [ + 'description' => '动态策略ID。', + 'type' => 'string', + 'example' => 'dynamic-policy-xxxxxxxx', + ], + 'DisposalProcessId' => [ + 'description' => '处置流程ID。', + 'type' => 'string', + 'example' => 'dp-xxxxxxxx', + ], + 'DynamicPolicyName' => [ + 'description' => '动态策略名称。', + 'type' => 'string', + 'example' => '动态策略1', + ], + 'Hostname' => [ + 'description' => '终端设备名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（\\_）、分隔号（/）、at（@）和空格。单独输入下划线（\\_）将额外查询所有名称中带4字节utf-8字符的终端设备。', + 'type' => 'string', + 'example' => 'WANGCHENCHENNBB', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'xiaoming', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '场景险部', + ], + 'SaseUserId' => [ + 'description' => 'SASE用户ID。', + 'type' => 'string', + 'example' => 'asdqwedg-xzczvzdaf-asfafs', + ], + 'DevTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => 'FD7554AD-4CDE-6359-6B49-4FE950606C2C', + ], + 'DisposalActions' => [ + 'description' => '处置动作列表。', + 'type' => 'array', + 'items' => [ + 'description' => '处置动作。'."\n" + .'- **ztna_connect**：禁止连接零信任内网。'."\n" + .'- **nac_connect**：禁止连接办公网准入。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ztna_connect' => 'ztna_connect', + 'nac_connect' => 'nac_connect', + ], + 'example' => 'nac-connect', + ], + ], + 'RecoveryType' => [ + 'description' => '恢复类型。'."\n" + .'- **auto**：自动恢复。'."\n" + .'- **console**：控制台恢复。'."\n" + .'- **auth**：认证报备恢复。', + 'type' => 'string', + 'enumValueTitles' => [ + 'console' => 'console', + 'auto' => 'auto', + 'auth' => 'auth', + ], + 'example' => 'auto', + ], + 'RuleContent' => [ + 'description' => '规则内容。', + 'type' => 'any', + 'example' => '{'."\n" + .' "Combinator": "OR",'."\n" + .' "Rules": ['."\n" + .' {'."\n" + .' "Operator": "version_gt",'."\n" + .' "Values": ['."\n" + .' "1"'."\n" + .' ],'."\n" + .' "RuleType": "device_info",'."\n" + .' "Id": "1",'."\n" + .' "RuleSubType": "basic_info",'."\n" + .' "Name": "app_version"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'DisposalTime' => [ + 'description' => '处置时间，格式为秒级时间戳。', + 'type' => 'string', + 'example' => '1743059249', + ], + 'DeviceBasicInfo' => [ + 'description' => '设备基础信息。', + 'type' => 'object', + 'properties' => [ + 'DevTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => 'A84D0AF0-1ACC-02B8-6A07-FC898F71BE09', + ], + 'DevType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'example' => 'windows', + ], + 'OsVersion' => [ + 'description' => '操作系统版本', + 'type' => 'string', + 'example' => '1', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => 'CE:3B:**:**:FD:FB', + ], + 'Cpu' => [ + 'description' => 'CPU型号。', + 'type' => 'string', + 'example' => 'Intel(R) Core(TM) i5-10210U CPU @ 1.60GHz', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'DESKTOP-ERLV3AK', + ], + 'Memory' => [ + 'description' => '终端设备内存容量。单位：GB。', + 'type' => 'string', + 'example' => '2', + ], + 'Disk' => [ + 'description' => '终端设备磁盘型号。', + 'type' => 'string', + 'example' => 'KXG6AZNV512G TOSHIBA', + ], + ], + ], + 'DeviceStatusInfo' => [ + 'description' => '设备状态信息。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'description' => 'SASE用户唯一ID。', + 'type' => 'string', + 'example' => 'su_dfsdfsdgasgsgag', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '测试', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => 'IT运维部', + ], + 'AppVersion' => [ + 'description' => '客户端版本。', + 'type' => 'string', + 'example' => '4.5.1', + ], + 'LoginStatus' => [ + 'description' => '登录状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'ZtnaStatus' => [ + 'description' => 'ZTNA启用状态。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'LaStatus' => [ + 'description' => '上网行为管理启用状态。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'DlpStatus' => [ + 'description' => '办公数据保护状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。'."\n" + .'- **Unauthorized**：未授权。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'NacStatus' => [ + 'description' => '网络准入状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'InternetIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '120.26.XX.XX', + ], + 'PrivateIp' => [ + 'description' => '私网Ip。', + 'type' => 'string', + 'example' => '172.20.XX.XX', + ], + 'Workshop' => [ + 'description' => '识别到的办公区名称。', + 'type' => 'string', + 'example' => '办公地点', + ], + ], + ], + ], + ], + ], + 'TotalNum' => [ + 'description' => '动态处置流程的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\",\\n \\"DisposalProcesses\\": [\\n {\\n \\"Status\\": \\"disposal\\",\\n \\"DynamicPolicyId\\": \\"dynamic-policy-xxxxxxxx\\",\\n \\"DisposalProcessId\\": \\"dp-xxxxxxxx\\",\\n \\"DynamicPolicyName\\": \\"动态策略1\\",\\n \\"Hostname\\": \\"WANGCHENCHENNBB\\",\\n \\"UserName\\": \\"xiaoming\\",\\n \\"Department\\": \\"场景险部\\",\\n \\"SaseUserId\\": \\"asdqwedg-xzczvzdaf-asfafs\\",\\n \\"DevTag\\": \\"FD7554AD-4CDE-6359-6B49-4FE950606C2C\\",\\n \\"DisposalActions\\": [\\n \\"nac-connect\\"\\n ],\\n \\"RecoveryType\\": \\"auto\\",\\n \\"RuleContent\\": \\"{\\\\n \\\\\\"Combinator\\\\\\": \\\\\\"OR\\\\\\",\\\\n \\\\\\"Rules\\\\\\": [\\\\n {\\\\n \\\\\\"Operator\\\\\\": \\\\\\"version_gt\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"1\\\\\\"\\\\n ],\\\\n \\\\\\"RuleType\\\\\\": \\\\\\"device_info\\\\\\",\\\\n \\\\\\"Id\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"RuleSubType\\\\\\": \\\\\\"basic_info\\\\\\",\\\\n \\\\\\"Name\\\\\\": \\\\\\"app_version\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"DisposalTime\\": \\"1743059249\\",\\n \\"DeviceBasicInfo\\": {\\n \\"DevTag\\": \\"A84D0AF0-1ACC-02B8-6A07-FC898F71BE09\\",\\n \\"DevType\\": \\"windows\\",\\n \\"OsVersion\\": \\"1\\",\\n \\"Mac\\": \\"CE:3B:**:**:FD:FB\\",\\n \\"Cpu\\": \\"Intel(R) Core(TM) i5-10210U CPU @ 1.60GHz\\",\\n \\"Hostname\\": \\"DESKTOP-ERLV3AK\\",\\n \\"Memory\\": \\"2\\",\\n \\"Disk\\": \\"KXG6AZNV512G TOSHIBA\\"\\n },\\n \\"DeviceStatusInfo\\": {\\n \\"SaseUserId\\": \\"su_dfsdfsdgasgsgag\\",\\n \\"Username\\": \\"测试\\",\\n \\"Department\\": \\"IT运维部\\",\\n \\"AppVersion\\": \\"4.5.1\\",\\n \\"LoginStatus\\": \\"online\\",\\n \\"ZtnaStatus\\": \\"enabled\\",\\n \\"LaStatus\\": \\"enabled\\",\\n \\"DlpStatus\\": \\"enabled\\",\\n \\"NacStatus\\": \\"enabled\\",\\n \\"InternetIp\\": \\"120.26.XX.XX\\",\\n \\"PrivateIp\\": \\"172.20.XX.XX\\",\\n \\"Workshop\\": \\"办公地点\\"\\n }\\n }\\n ],\\n \\"TotalNum\\": 1\\n}","type":"json"}]', + 'title' => '批量查询动态策略处置流程', + ], + 'UpdateApprovalStatus' => [ + 'summary' => '更新当前阿里云账号下审批实例状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213408', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApprovalId', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例ID。取值来源：'."\n" + .'- [ListApprovals](~~ListApprovals~~)：批量查询审批实例列表。'."\n" + .'- [GetApproval](~~GetApproval~~)：查询审批实例详情。', + 'type' => 'string', + 'required' => true, + 'example' => 'approval-872b5e911b35****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例状态。取值：'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。', + 'type' => 'string', + 'required' => true, + 'example' => 'Approved', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'Approval' => [ + 'description' => '审批实例。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例。', + 'type' => 'object', + 'properties' => [ + 'ApprovalId' => [ + 'description' => '审批实例ID。', + 'type' => 'string', + 'example' => 'approval-165e6738ad9d****', + ], + 'ApprovalProgresses' => [ + 'description' => '审批实例进展节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例进展节点。', + 'type' => 'object', + 'properties' => [ + 'Operators' => [ + 'description' => '审批进展节点操作人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批进展节点操作人。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'description' => '审批进展节点操作人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Username' => [ + 'description' => '审批进展节点操作人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + ], + ], + 'Status' => [ + 'description' => '审批进展节点状态。取值：'."\n" + .'- **Pending**：待审批。'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。'."\n" + .'- **Revoked**：已撤回。', + 'type' => 'string', + 'example' => 'Approved', + ], + 'Executor' => [ + 'description' => '审批进展节点执行人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Action' => [ + 'description' => '审批进展节点执行操作。取值：'."\n" + .'- **Approve**：通过。'."\n" + .'- **Reject**：拒绝。'."\n" + .'- **Revoke**：撤回。'."\n" + .'- **Comment**：评论。', + 'type' => 'string', + 'example' => 'Approve', + ], + 'Comment' => [ + 'description' => '审批进展节点执行评论。', + 'type' => 'string', + 'example' => '审核通过', + ], + 'Timestamp' => [ + 'description' => '审批进展节点执行时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736752000', + ], + ], + ], + ], + 'EndTimestamp' => [ + 'description' => '审批实例有效截止时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1757952000', + ], + 'ApprovalDetail' => [ + 'description' => '审批实例详情。', + 'type' => 'string', + 'example' => '{"initiatorName":"王先生","initiatorDept":"测试部","devType":"windows","deviceType":"usbStorage","deviceId":"FC216E9E3****","approvalEndTimestamp":1736524799,"approvalReason":"这是一个测试"}', + ], + 'Status' => [ + 'description' => '审批实例状态。取值：'."\n" + .'- **Pending**：待审批。'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。'."\n" + .'- **Revoked**：已撤回。'."\n" + .'- **Expired**：已过期。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'ProcessId' => [ + 'description' => '审批实例关联流程ID。', + 'type' => 'string', + 'example' => 'approval-process-fcc351b8a95b****', + ], + 'ProcessName' => [ + 'description' => '审批实例关联流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'PolicyType' => [ + 'description' => '审批实例关联策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'example' => 'DlpSend', + ], + 'SchemaId' => [ + 'description' => '审批实例关联模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SchemaName' => [ + 'description' => '审批实例关联模板名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'SchemaContent' => [ + 'description' => '审批实例关联模板内容。', + 'type' => 'string', + 'example' => '{"form": {"labelCol": 6,"wrapperCol": 12}}', + ], + 'CreatorUserId' => [ + 'description' => '审批实例创建人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'CreatorDevTag' => [ + 'description' => '审批实例创建终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'CreateTime' => [ + 'description' => '审批实例创建时间。', + 'type' => 'string', + 'example' => '2022-11-15 22:11:55', + ], + 'Reason' => [ + 'description' => '审批实例创建原因。', + 'type' => 'string', + 'example' => '这是一个测试', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"Approval\\": [\\n {\\n \\"ApprovalId\\": \\"approval-165e6738ad9d****\\",\\n \\"ApprovalProgresses\\": [\\n {\\n \\"Operators\\": [\\n {\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Username\\": \\"王先生\\"\\n }\\n ],\\n \\"Status\\": \\"Approved\\",\\n \\"Executor\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Action\\": \\"Approve\\",\\n \\"Comment\\": \\"审核通过\\",\\n \\"Timestamp\\": 1736752000\\n }\\n ],\\n \\"EndTimestamp\\": 1757952000,\\n \\"ApprovalDetail\\": \\"{\\\\\\"initiatorName\\\\\\":\\\\\\"王先生\\\\\\",\\\\\\"initiatorDept\\\\\\":\\\\\\"测试部\\\\\\",\\\\\\"devType\\\\\\":\\\\\\"windows\\\\\\",\\\\\\"deviceType\\\\\\":\\\\\\"usbStorage\\\\\\",\\\\\\"deviceId\\\\\\":\\\\\\"FC216E9E3****\\\\\\",\\\\\\"approvalEndTimestamp\\\\\\":1736524799,\\\\\\"approvalReason\\\\\\":\\\\\\"这是一个测试\\\\\\"}\\",\\n \\"Status\\": \\"Pending\\",\\n \\"ProcessId\\": \\"approval-process-fcc351b8a95b****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"PolicyType\\": \\"DlpSend\\",\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"SchemaName\\": \\"测试\\",\\n \\"SchemaContent\\": \\"{\\\\\\"form\\\\\\": {\\\\\\"labelCol\\\\\\": 6,\\\\\\"wrapperCol\\\\\\": 12}}\\",\\n \\"CreatorUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"CreatorDevTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"CreateTime\\": \\"2022-11-15 22:11:55\\",\\n \\"Reason\\": \\"这是一个测试\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '更新审批实例状态', + ], + 'UpdateApprovalProcess' => [ + 'summary' => '更新当前阿里云账号下审批流程。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213358', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessName', + 'in' => 'formData', + 'schema' => [ + 'description' => '审批流程名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '审批流程描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个测试', + ], + ], + [ + 'name' => 'ProcessNodes', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批节点列表。最多可定义5个审批节点。', + 'type' => 'array', + 'items' => [ + 'description' => '审批节点的审批人列表。最多可定义5个审批人。', + 'type' => 'array', + 'items' => [ + 'description' => '审批人ID。取值来源：'."\n" + .'- [ListUsers](~~ListUsers~~)：批量查询用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_d142d5bdeebcdb0c9dfe784d74d84a8f4644cee21bf26c9311c934debbef****', + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'MatchSchemas', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '匹配的审批模板。', + 'type' => 'object', + 'properties' => [ + 'DomainWhitelistSchemaId' => [ + 'description' => '域名白名单审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'DomainBlacklistSchemaId' => [ + 'description' => '域名黑名单审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SoftwareBlockSchemaId' => [ + 'description' => '软件禁用审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'DeviceRegistrationSchemaId' => [ + 'description' => '设备注册审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'AppUninstallSchemaId' => [ + 'description' => '设备卸载审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PeripheralBlockSchemaId' => [ + 'description' => '外设管控审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'DlpSendSchemaId' => [ + 'description' => '文件外发审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'EndpointHardeningSchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'SoftwareHardeningSchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'approval-process-f16bf74b2b29****', + ], + ], + [ + 'name' => 'MatchSchemaConfigs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainWhitelistSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'DomainBlacklistSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'SoftwareBlockSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'DeviceRegistrationSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'AppUninstallSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'DlpSendSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'PeripheralBlockSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'EndpointHardeningSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'SoftwareHardeningSchemaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'ExternalProcessId' => [ + 'type' => 'string', + 'required' => false, + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayField' => [ + 'type' => 'string', + 'required' => false, + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApprovalType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'EventLabel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ExternalConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7E9D7ACD-53D5-56EF-A913-79D148D06299', + ], + 'Process' => [ + 'description' => '审批流程。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '审批流程创建时间。', + 'type' => 'string', + 'example' => '2022-07-11 15:31:39', + ], + 'ProcessId' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-2677fcf063f5****', + ], + 'ProcessName' => [ + 'description' => '审批流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '审批流程描述。', + 'type' => 'string', + 'example' => '这是一个测试', + ], + 'ProcessNodes' => [ + 'description' => '审批节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'description' => '审批人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Username' => [ + 'description' => '审批人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + ], + ], + ], + 'DomainWhitelistPolicies' => [ + 'description' => '域名白名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '域名白名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名白名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DomainBlacklistPolicies' => [ + 'description' => '域名黑名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '域名黑名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名黑名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SoftwareBlockPolicies' => [ + 'description' => '软件禁用关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '软件禁用策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '软件禁用策略ID。', + 'type' => 'string', + 'example' => 'pid-9f37f3a5991f****', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DeviceRegistrationPolicies' => [ + 'description' => '设备注册关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '设备注册策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-63b2f1844b86****', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'AppUninstallPolicies' => [ + 'description' => '终端卸载关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '终端卸载策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端卸载策略ID。', + 'type' => 'string', + 'example' => 'auto-boot-anti-uninstall-5919f8afff47****', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DlpSendPolicies' => [ + 'description' => '文件外发关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '文件外发策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件外发策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PeripheraBlockPolicies' => [ + 'description' => '外设管控关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '外设管控策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '外设管控策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'EndpointHardeningPolicies' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + ], + 'PolicyIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SoftwareHardeningPolicies' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + ], + 'PolicyIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ExternalProcessId' => [ + 'type' => 'string', + ], + 'FieldMap' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'type' => 'string', + ], + 'DisplayField' => [ + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ApprovalType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ExternalConfig' => [ + 'type' => 'string', + ], + 'EventLabel' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E9D7ACD-53D5-56EF-A913-79D148D06299\\",\\n \\"Process\\": {\\n \\"CreateTime\\": \\"2022-07-11 15:31:39\\",\\n \\"ProcessId\\": \\"approval-process-2677fcf063f5****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个测试\\",\\n \\"ProcessNodes\\": [\\n [\\n {\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Username\\": \\"王先生\\"\\n }\\n ]\\n ],\\n \\"DomainWhitelistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"DomainBlacklistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"SoftwareBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"pid-9f37f3a5991f****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"DeviceRegistrationPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"reg-policy-63b2f1844b86****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"AppUninstallPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"auto-boot-anti-uninstall-5919f8afff47****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"DlpSendPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"PeripheraBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"EndpointHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"SoftwareHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"ApprovalType\\": 0,\\n \\"ExternalConfig\\": \\"\\",\\n \\"EventLabel\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '更新审批流程', + ], + 'ListApprovals' => [ + 'summary' => '查询当前阿里云账号下审批实例列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213405', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ApprovalIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批实例ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例ID。取值来源：'."\n" + .'- [ListApprovals](~~ListApprovals~~)：批量查询审批实例列表。'."\n" + .'- [GetApproval](~~GetApproval~~)：查询审批实例详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-872b5e911b35****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批实例状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例状态。取值：'."\n" + .'- **Pending**：待审批。'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。'."\n" + .'- **Revoked**：已撤回。'."\n" + .'- **Expired**：已过期。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Revoked' => '已撤回', + 'Approved' => '已通过', + 'Expired' => '已过期', + 'Rejected' => '已拒绝', + 'Pending' => '待审批', + ], + 'example' => 'Pending', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SchemaId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联审批流程ID', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-process-fcc351b8a95b****', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + ], + [ + 'name' => 'CreatorUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例创建人ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'CreatorDevTag', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例创建终端设备ID。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例操作人ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'OperatorUsername', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例操作人用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '李小姐', + ], + ], + [ + 'name' => 'CreatorUsername', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例创建人用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + ], + [ + 'name' => 'CreatorDepartment', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例创建人部门。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + [ + 'name' => 'CreateStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例创建起始时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1730000000', + ], + ], + [ + 'name' => 'CreateEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例创建结束时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1736750500', + ], + ], + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '关联审批流程名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '关联审批模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '6965F5BA-53B6-5650-A708-51F090F843BB', + ], + 'TotalNum' => [ + 'description' => '审批实例总数。', + 'type' => 'string', + 'example' => '1', + ], + 'Approvals' => [ + 'description' => '审批实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例。', + 'type' => 'object', + 'properties' => [ + 'ApprovalId' => [ + 'description' => '审批实例ID。', + 'type' => 'string', + 'example' => 'approval-872b5e911b35****', + ], + 'ApprovalProgresses' => [ + 'description' => '审批实例进展节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例进展节点。', + 'type' => 'object', + 'properties' => [ + 'Operators' => [ + 'description' => '审批进展节点操作人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批进展节点操作人。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'description' => '审批进展节点操作人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Username' => [ + 'description' => '审批进展节点操作人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + ], + ], + 'Status' => [ + 'description' => '审批进展节点状态。取值：'."\n" + .'- **Pending**：待审批。'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。'."\n" + .'- **Revoked**：已撤回。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Revoked' => '已撤回', + 'Approved' => '已通过', + 'Rejected' => '已拒绝', + 'Pending' => '待审批', + ], + 'example' => 'Approved', + ], + 'Executor' => [ + 'description' => '审批进展节点执行人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Action' => [ + 'description' => '审批进展节点执行操作。取值：'."\n" + .'- **Approve**：通过。'."\n" + .'- **Reject**：拒绝。'."\n" + .'- **Revoke**：撤回。'."\n" + .'- **Comment**：评论。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Reject' => '拒绝', + 'Comment' => '评论', + 'Revoke' => '撤回', + 'Approve' => '通过', + ], + 'example' => 'Approve', + ], + 'Comment' => [ + 'description' => '审批进展节点执行评论。', + 'type' => 'string', + 'example' => '审核通过', + ], + 'Timestamp' => [ + 'description' => '审批进展节点执行时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736752000', + ], + ], + ], + ], + 'EndTimestamp' => [ + 'description' => '审批实例有效截止时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1757952000', + ], + 'ApprovalDetail' => [ + 'description' => '审批实例详情。', + 'type' => 'string', + 'example' => '{"initiatorName":"王先生","initiatorDept":"测试部","devType":"windows","deviceType":"usbStorage","deviceId":"FC216E9E3****","approvalEndTimestamp":1736524799,"approvalReason":"这是一个测试"}', + ], + 'Status' => [ + 'description' => '审批实例状态。取值：'."\n" + .'- **Pending**：待审批。'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。'."\n" + .'- **Revoked**：已撤回。'."\n" + .'- **Expired**：已过期。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Revoked' => '已撤回', + 'Approved' => '已通过', + 'Expired' => '已过期', + 'Rejected' => '已拒绝', + 'Pending' => '待审批', + ], + 'example' => 'Pending', + ], + 'ProcessId' => [ + 'description' => '审批实例关联流程ID。', + 'type' => 'string', + 'example' => 'approval-process-fcc351b8a95b****', + ], + 'ProcessName' => [ + 'description' => '审批实例关联流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'PolicyType' => [ + 'description' => '审批实例关联策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + 'SchemaId' => [ + 'description' => '审批实例关联模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SchemaName' => [ + 'description' => '审批实例关联模板名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'SchemaContent' => [ + 'description' => '审批实例关联模板内容。', + 'type' => 'string', + 'example' => '{"form": {"labelCol": 6,"wrapperCol": 12}}', + ], + 'CreatorUserId' => [ + 'description' => '审批实例创建人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'CreatorDevTag' => [ + 'description' => '审批实例创建终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'CreateTime' => [ + 'description' => '审批实例创建时间。', + 'type' => 'string', + 'example' => '2022-11-15 22:11:55', + ], + 'Reason' => [ + 'description' => '审批实例创建原因。', + 'type' => 'string', + 'example' => '这是一个测试', + ], + 'CreatorUsername' => [ + 'description' => '审批实例创建人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'CreatorDepartment' => [ + 'description' => '审批实例创建人部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'ApprovalType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6965F5BA-53B6-5650-A708-51F090F843BB\\",\\n \\"TotalNum\\": \\"1\\",\\n \\"Approvals\\": [\\n {\\n \\"ApprovalId\\": \\"approval-872b5e911b35****\\",\\n \\"ApprovalProgresses\\": [\\n {\\n \\"Operators\\": [\\n {\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Username\\": \\"王先生\\"\\n }\\n ],\\n \\"Status\\": \\"Approved\\",\\n \\"Executor\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Action\\": \\"Approve\\",\\n \\"Comment\\": \\"审核通过\\",\\n \\"Timestamp\\": 1736752000\\n }\\n ],\\n \\"EndTimestamp\\": 1757952000,\\n \\"ApprovalDetail\\": \\"{\\\\\\"initiatorName\\\\\\":\\\\\\"王先生\\\\\\",\\\\\\"initiatorDept\\\\\\":\\\\\\"测试部\\\\\\",\\\\\\"devType\\\\\\":\\\\\\"windows\\\\\\",\\\\\\"deviceType\\\\\\":\\\\\\"usbStorage\\\\\\",\\\\\\"deviceId\\\\\\":\\\\\\"FC216E9E3****\\\\\\",\\\\\\"approvalEndTimestamp\\\\\\":1736524799,\\\\\\"approvalReason\\\\\\":\\\\\\"这是一个测试\\\\\\"}\\",\\n \\"Status\\": \\"Pending\\",\\n \\"ProcessId\\": \\"approval-process-fcc351b8a95b****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"PolicyType\\": \\"DlpSend\\",\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"SchemaName\\": \\"测试\\",\\n \\"SchemaContent\\": \\"{\\\\\\"form\\\\\\": {\\\\\\"labelCol\\\\\\": 6,\\\\\\"wrapperCol\\\\\\": 12}}\\",\\n \\"CreatorUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"CreatorDevTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"CreateTime\\": \\"2022-11-15 22:11:55\\",\\n \\"Reason\\": \\"这是一个测试\\",\\n \\"CreatorUsername\\": \\"王先生\\",\\n \\"CreatorDepartment\\": \\"测试部\\",\\n \\"ApprovalType\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询审批实例列表', + ], + 'ListApprovalSchemasForApprovalProcesses' => [ + 'summary' => '查询审批流程关联的渲染模板', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213390', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批流程ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板ID。取值：'."\n" + .'- [ListApprovalProcesses](~~ListApprovalProcesses~~)：批量查询审批流程列表。'."\n" + .'- [GetApprovalProcess](~~GetApprovalProcess~~)：查询审批流程详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-process-dc61e92ba5c5****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'Processes' => [ + 'description' => '审批流程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批流程。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-35ee09077ee9****', + ], + 'Schemas' => [ + 'description' => '审批模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '审批模板创建时间。', + 'type' => 'string', + 'example' => '2024-03-15 14:44:07', + ], + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SchemaName' => [ + 'description' => '审批模板名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '审批模板描述。', + 'type' => 'string', + 'example' => '这是一个模板', + ], + 'SchemaContent' => [ + 'description' => '审批模板内容。', + 'type' => 'string', + 'example' => '{"form": {"labelCol": 6,"wrapperCol": 12}}', + ], + 'SchemaVersion' => [ + 'description' => '审批模板版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1715680940', + ], + 'PolicyType' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + 'IsDefault' => [ + 'description' => '是否为官方维护模板。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"Processes\\": [\\n {\\n \\"ProcessId\\": \\"approval-process-35ee09077ee9****\\",\\n \\"Schemas\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15 14:44:07\\",\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"SchemaName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个模板\\",\\n \\"SchemaContent\\": \\"{\\\\\\"form\\\\\\": {\\\\\\"labelCol\\\\\\": 6,\\\\\\"wrapperCol\\\\\\": 12}}\\",\\n \\"SchemaVersion\\": 1715680940,\\n \\"PolicyType\\": \\"DlpSend\\",\\n \\"IsDefault\\": true\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询审批流程关联的模板', + ], + 'ListApprovalSchemas' => [ + 'summary' => '查询当前阿里云账号下审批模板列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213353', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SchemaIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批模板ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'TotalNum' => [ + 'description' => '审批模板总数。', + 'type' => 'string', + 'example' => '1', + ], + 'Schemas' => [ + 'description' => '审批模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '审批模板创建时间。', + 'type' => 'string', + 'example' => '2024-03-15 14:44:07', + ], + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SchemaName' => [ + 'description' => '审批模板名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '审批模板描述。', + 'type' => 'string', + 'example' => '这是一个模板', + ], + 'SchemaContent' => [ + 'description' => '审批模板内容。', + 'type' => 'string', + 'example' => '{"form": {"labelCol": 6,"wrapperCol": 12}}', + ], + 'SchemaVersion' => [ + 'description' => '审批模板版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1715680940', + ], + 'PolicyType' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + 'IsDefault' => [ + 'description' => '是否为官方维护模板。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"TotalNum\\": \\"1\\",\\n \\"Schemas\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15 14:44:07\\",\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"SchemaName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个模板\\",\\n \\"SchemaContent\\": \\"{\\\\\\"form\\\\\\": {\\\\\\"labelCol\\\\\\": 6,\\\\\\"wrapperCol\\\\\\": 12}}\\",\\n \\"SchemaVersion\\": 1715680940,\\n \\"PolicyType\\": \\"DlpSend\\",\\n \\"IsDefault\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询审批模板列表', + ], + 'ListApprovalProcessesForApprovalSchemas' => [ + 'summary' => '查询审批渲染模板关联的流程', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213391', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批模板ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板ID。取值：'."\n" + .'- [ListApprovalSchemas](~~ListApprovalSchemas~~)：批量查询审批模板列表。'."\n" + .'- [GetApprovalSchema](~~GetApprovalSchema~~)：查询审批模板详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + 'Schemas' => [ + 'description' => '审批模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'Processes' => [ + 'description' => '审批流程集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批流程。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '审批流程创建时间。', + 'type' => 'string', + 'example' => '2022-10-25 10:44:09', + ], + 'ProcessId' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-dc61e92ba5c5****', + ], + 'ProcessName' => [ + 'description' => '审批流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '审批流程描述。', + 'type' => 'string', + 'example' => '这是一个审批流程', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\",\\n \\"Schemas\\": [\\n {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"Processes\\": [\\n {\\n \\"CreateTime\\": \\"2022-10-25 10:44:09\\",\\n \\"ProcessId\\": \\"approval-process-dc61e92ba5c5****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个审批流程\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询审批模板关联的流程', + ], + 'ListApprovalProcesses' => [ + 'summary' => '查询当前阿里云账号下审批流程列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213355', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ProcessIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批流程ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板ID。取值：'."\n" + .'- [ListApprovalProcesses](~~ListApprovalProcesses~~)：批量查询审批流程列表。'."\n" + .'- [GetApprovalProcess](~~GetApprovalProcess~~)：查询审批流程详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-process-dc61e92ba5c5****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联业务策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pid-6d6ad77d5b52****', + ], + ], + [ + 'name' => 'SaseUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联审批人ID。取值来源：'."\n" + .'- [ListUsers](~~ListUsers~~)：批量查询用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '关联审批人用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7E39C33B-F565-55C6-ACC2-953FCE7DA7D6', + ], + 'Processes' => [ + 'description' => '审批流程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批流程。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '审批流程创建时间。', + 'type' => 'string', + 'example' => '2024-02-27 14:04:27', + ], + 'ProcessId' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-35ee09077ee9****', + ], + 'ProcessName' => [ + 'description' => '审批流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '审批流程描述。', + 'type' => 'string', + 'example' => '这是一个审批流程', + ], + 'ProcessNodes' => [ + 'description' => '审批节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'description' => '审批人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Username' => [ + 'description' => '审批人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + ], + ], + ], + 'DomainWhitelistPolicies' => [ + 'description' => '域名白名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '域名白名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名白名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + ], + ], + 'DomainBlacklistPolicies' => [ + 'description' => '域名黑名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '域名黑名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名黑名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + ], + ], + 'SoftwareBlockPolicies' => [ + 'description' => '软件禁用关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '软件禁用策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '软件禁用策略ID。', + 'type' => 'string', + 'example' => 'pid-6d6ad77d5b52****', + ], + ], + ], + ], + 'DeviceRegistrationPolicies' => [ + 'description' => '设备注册关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '设备注册策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-63b2f1844b86****', + ], + ], + ], + ], + 'AppUninstallPolicies' => [ + 'description' => '终端卸载关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '终端卸载策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端卸载策略ID。', + 'type' => 'string', + 'example' => 'auto-boot-anti-uninstall-5919f8afff47****', + ], + ], + ], + ], + 'DlpSendPolicies' => [ + 'description' => '文件外发关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '文件外发策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件外发策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + ], + ], + 'PeripheralBlockPolicies' => [ + 'description' => '外设管控关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '外设管控策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '外设管控策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + ], + ], + 'EndpointHardeningPolicies' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + ], + 'PolicyIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SoftwareHardeningPolicies' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + ], + 'PolicyIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ApprovalType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'TotalNum' => [ + 'description' => '审批流程总数。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E39C33B-F565-55C6-ACC2-953FCE7DA7D6\\",\\n \\"Processes\\": [\\n {\\n \\"CreateTime\\": \\"2024-02-27 14:04:27\\",\\n \\"ProcessId\\": \\"approval-process-35ee09077ee9****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个审批流程\\",\\n \\"ProcessNodes\\": [\\n [\\n {\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Username\\": \\"王先生\\"\\n }\\n ]\\n ],\\n \\"DomainWhitelistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ]\\n },\\n \\"DomainBlacklistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ]\\n },\\n \\"SoftwareBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"pid-6d6ad77d5b52****\\"\\n ]\\n },\\n \\"DeviceRegistrationPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"reg-policy-63b2f1844b86****\\"\\n ]\\n },\\n \\"AppUninstallPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"auto-boot-anti-uninstall-5919f8afff47****\\"\\n ]\\n },\\n \\"DlpSendPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ]\\n },\\n \\"PeripheralBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ]\\n },\\n \\"EndpointHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ]\\n },\\n \\"SoftwareHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ]\\n },\\n \\"ApprovalType\\": 0\\n }\\n ],\\n \\"TotalNum\\": \\"1\\"\\n}","type":"json"}]', + 'title' => '批量查询审批流程列表', + ], + 'GetApprovalSchema' => [ + 'summary' => '查询当前阿里云账号下审批模板详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213354', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaId', + 'in' => 'query', + 'schema' => [ + 'description' => '审批模板ID。取值：'."\n" + .'- [ListApprovalSchemas](~~ListApprovalSchemas~~)：批量查询审批模板列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'approval-schema-090134f1ebff****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'EFE7EBB2-449D-5BBB-B381-CA7839BC1649', + ], + 'Schema' => [ + 'description' => '审批模板。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '审批模板创建时间。', + 'type' => 'string', + 'example' => '2022-02-14 11:57:51', + ], + 'SchemaId' => [ + 'description' => '审批模板id。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SchemaName' => [ + 'description' => '审批模板名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '审批模板描述。', + 'type' => 'string', + 'example' => '这是一个模板', + ], + 'SchemaContent' => [ + 'description' => '审批模板内容。', + 'type' => 'string', + 'example' => '{"form": {"labelCol": 6,"wrapperCol": 12}}', + ], + 'SchemaVersion' => [ + 'description' => '审批模板版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1715680940', + ], + 'PolicyType' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + 'IsDefault' => [ + 'description' => '是否为官方维护模板。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFE7EBB2-449D-5BBB-B381-CA7839BC1649\\",\\n \\"Schema\\": {\\n \\"CreateTime\\": \\"2022-02-14 11:57:51\\",\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"SchemaName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个模板\\",\\n \\"SchemaContent\\": \\"{\\\\\\"form\\\\\\": {\\\\\\"labelCol\\\\\\": 6,\\\\\\"wrapperCol\\\\\\": 12}}\\",\\n \\"SchemaVersion\\": 1715680940,\\n \\"PolicyType\\": \\"DlpSend\\",\\n \\"IsDefault\\": true\\n }\\n}","type":"json"}]', + 'title' => '查询审批模板详情', + ], + 'GetApprovalProcess' => [ + 'summary' => '查询当前阿里云账号下审批流程详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213356', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '审批流程ID。取值：'."\n" + .'- [ListApprovalProcesses](~~ListApprovalProcesses~~)：批量查询审批流程列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'approval-process-fcc351b8a95b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'C81E0B4B-AAEB-5FDD-B27E-3F5AF7EBD7EF', + ], + 'Process' => [ + 'title' => '', + 'description' => '审批流程。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '审批流程创建时间。', + 'type' => 'string', + 'example' => '2022-10-25 10:44:09', + ], + 'ProcessId' => [ + 'title' => '流程ID', + 'description' => '审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-35ee09077ee9****', + ], + 'ProcessName' => [ + 'title' => '流程名称', + 'description' => '审批流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'title' => '流程描述', + 'description' => '审批流程描述。', + 'type' => 'string', + 'example' => '这是一个审批流程', + ], + 'ProcessNodes' => [ + 'title' => '流程节点', + 'description' => '审批节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'title' => 'SASE用户ID', + 'description' => '审批人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Username' => [ + 'title' => '用户名称', + 'description' => '审批人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + ], + ], + ], + 'DomainWhitelistPolicies' => [ + 'title' => '域名白名单策略', + 'description' => '域名白名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '域名白名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '域名白名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射表', + 'description' => '字段映射表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DomainBlacklistPolicies' => [ + 'title' => '域名黑名单策略', + 'description' => '域名黑名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '域名黑名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名黑名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SoftwareBlockPolicies' => [ + 'title' => '软件禁用策略', + 'description' => '软件禁用关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '软件禁用策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '软件禁用策略ID。', + 'type' => 'string', + 'example' => 'pid-6d6ad77d5b52****', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DeviceRegistrationPolicies' => [ + 'title' => '设备注册策略', + 'description' => '设备注册关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '设备注册策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-63b2f1844b86****', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'AppUninstallPolicies' => [ + 'title' => '软件卸载策略', + 'description' => '终端卸载关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '终端卸载策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端卸载策略ID。', + 'type' => 'string', + 'example' => 'auto-boot-anti-uninstall-5919f8afff47****', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'title' => '字段映射项', + 'description' => '字段映射项', + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + 'example' => '名称', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + 'example' => '名称', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DlpSendPolicies' => [ + 'title' => '文件外发策略', + 'description' => '文件外发关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '文件外发策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件外发策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PeripheralBlockPolicies' => [ + 'title' => '外设禁用策略', + 'description' => '外设管控关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '外设管控策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '外设管控策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'EndpointHardeningPolicies' => [ + 'title' => '终端防护策略', + 'description' => '终端防护策略', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '策略ID', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SoftwareHardeningPolicies' => [ + 'title' => '软件加固策略', + 'description' => '软件加固策略', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + ], + 'PolicyIds' => [ + 'title' => '策略ID', + 'description' => '策略ID', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ExternalProcessId' => [ + 'title' => '外部流程ID', + 'description' => '外部流程ID', + 'type' => 'string', + ], + 'FieldMap' => [ + 'title' => '字段映射', + 'description' => '字段映射', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SystemField' => [ + 'title' => '系统字段', + 'description' => '系统字段', + 'type' => 'string', + ], + 'DisplayField' => [ + 'title' => '展示字段', + 'description' => '展示字段', + 'type' => 'string', + ], + 'DisplayFieldValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ApprovalType' => [ + 'title' => '审批类型', + 'description' => '审批类型', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ExternalConfig' => [ + 'title' => '外部配置', + 'description' => '外部配置', + 'type' => 'string', + ], + 'EventLabel' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C81E0B4B-AAEB-5FDD-B27E-3F5AF7EBD7EF\\",\\n \\"Process\\": {\\n \\"CreateTime\\": \\"2022-10-25 10:44:09\\",\\n \\"ProcessId\\": \\"approval-process-35ee09077ee9****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个审批流程\\",\\n \\"ProcessNodes\\": [\\n [\\n {\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Username\\": \\"王先生\\"\\n }\\n ]\\n ],\\n \\"DomainWhitelistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"DomainBlacklistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"SoftwareBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"pid-6d6ad77d5b52****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"DeviceRegistrationPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"reg-policy-63b2f1844b86****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"AppUninstallPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"auto-boot-anti-uninstall-5919f8afff47****\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"名称\\",\\n \\"DisplayField\\": \\"名称\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"DlpSendPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"PeripheralBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"EndpointHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"SoftwareHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ],\\n \\"ExternalProcessId\\": \\"\\",\\n \\"FieldMap\\": [\\n {\\n \\"SystemField\\": \\"\\",\\n \\"DisplayField\\": \\"\\",\\n \\"DisplayFieldValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"ApprovalType\\": 0,\\n \\"ExternalConfig\\": \\"\\",\\n \\"EventLabel\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '查询审批流程详情', + ], + 'GetApproval' => [ + 'summary' => '查询当前阿里云账号下审批实例详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213407', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApprovalId', + 'in' => 'query', + 'schema' => [ + 'description' => '审批实例ID。取值来源：'."\n" + .'- [ListApprovals](~~ListApprovals~~)：批量查询审批实例列表。'."\n" + .'- [GetApproval](~~GetApproval~~)：查询审批实例详情。', + 'type' => 'string', + 'required' => true, + 'example' => 'approval-872b5e911b35****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7E9D7ACD-53D5-56EF-A913-79D148D06299', + ], + 'Approval' => [ + 'description' => '审批实例。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例。', + 'type' => 'object', + 'properties' => [ + 'ApprovalId' => [ + 'description' => '审批实例ID。', + 'type' => 'string', + 'example' => 'approval-3564b140642f****', + ], + 'ApprovalProgresses' => [ + 'description' => '审批实例进展节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批实例进展节点。', + 'type' => 'object', + 'properties' => [ + 'Operators' => [ + 'description' => '审批进展节点操作人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '审批进展节点操作人。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'description' => '审批进展节点操作人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Username' => [ + 'description' => '审批进展节点操作人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + ], + ], + 'Status' => [ + 'description' => '审批进展节点状态。取值：'."\n" + .'- **Pending**：待审批。'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。'."\n" + .'- **Revoked**：已撤回。', + 'type' => 'string', + 'example' => 'Approved', + ], + 'Executor' => [ + 'description' => '审批进展节点执行人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Action' => [ + 'description' => '审批进展节点执行操作。取值：'."\n" + .'- **Approve**：通过。'."\n" + .'- **Reject**：拒绝。'."\n" + .'- **Revoke**：撤回。'."\n" + .'- **Comment**：评论。', + 'type' => 'string', + 'example' => 'Approve', + ], + 'Comment' => [ + 'description' => '审批进展节点执行评论。', + 'type' => 'string', + 'example' => '审核通过', + ], + 'Timestamp' => [ + 'description' => '审批进展节点执行时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736752000', + ], + ], + ], + ], + 'EndTimestamp' => [ + 'description' => '审批实例有效截止时刻，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1757952000', + ], + 'ApprovalDetail' => [ + 'description' => '审批实例详情。', + 'type' => 'string', + 'example' => '{"initiatorName":"王先生","initiatorDept":"测试部","devType":"windows","deviceType":"usbStorage","deviceId":"FC216E9E3****","approvalEndTimestamp":1736524799,"approvalReason":"这是一个测试"}', + ], + 'Status' => [ + 'description' => '审批实例状态。取值：'."\n" + .'- **Pending**：待审批。'."\n" + .'- **Approved**：已通过。'."\n" + .'- **Rejected**：已拒绝。'."\n" + .'- **Revoked**：已撤回。'."\n" + .'- **Expired**：已过期。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'ProcessId' => [ + 'description' => '审批实例关联流程ID。', + 'type' => 'string', + 'example' => 'approval-process-fcc351b8a95b****', + ], + 'ProcessName' => [ + 'description' => '审批实例关联流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'PolicyType' => [ + 'description' => '审批实例关联策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'example' => 'DlpSend', + ], + 'SchemaId' => [ + 'description' => '审批实例关联模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SchemaName' => [ + 'description' => '审批实例关联模板名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'SchemaContent' => [ + 'description' => '审批实例关联模板内容。', + 'type' => 'string', + 'example' => '{"form": {"labelCol": 6,"wrapperCol": 12}}', + ], + 'CreatorUserId' => [ + 'description' => '审批实例创建人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'CreatorDevTag' => [ + 'description' => '审批实例创建终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'CreateTime' => [ + 'description' => '审批实例创建时间。', + 'type' => 'string', + 'example' => '2022-11-15 22:11:55', + ], + 'Reason' => [ + 'description' => '审批实例创建原因。', + 'type' => 'string', + 'example' => '这是一个测试', + ], + 'CreatorUsername' => [ + 'description' => '审批实例创建人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'CreatorDepartment' => [ + 'description' => '审批实例创建人部门。', + 'type' => 'string', + 'example' => '测试部', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E9D7ACD-53D5-56EF-A913-79D148D06299\\",\\n \\"Approval\\": [\\n {\\n \\"ApprovalId\\": \\"approval-3564b140642f****\\",\\n \\"ApprovalProgresses\\": [\\n {\\n \\"Operators\\": [\\n {\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Username\\": \\"王先生\\"\\n }\\n ],\\n \\"Status\\": \\"Approved\\",\\n \\"Executor\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Action\\": \\"Approve\\",\\n \\"Comment\\": \\"审核通过\\",\\n \\"Timestamp\\": 1736752000\\n }\\n ],\\n \\"EndTimestamp\\": 1757952000,\\n \\"ApprovalDetail\\": \\"{\\\\\\"initiatorName\\\\\\":\\\\\\"王先生\\\\\\",\\\\\\"initiatorDept\\\\\\":\\\\\\"测试部\\\\\\",\\\\\\"devType\\\\\\":\\\\\\"windows\\\\\\",\\\\\\"deviceType\\\\\\":\\\\\\"usbStorage\\\\\\",\\\\\\"deviceId\\\\\\":\\\\\\"FC216E9E3****\\\\\\",\\\\\\"approvalEndTimestamp\\\\\\":1736524799,\\\\\\"approvalReason\\\\\\":\\\\\\"这是一个测试\\\\\\"}\\",\\n \\"Status\\": \\"Pending\\",\\n \\"ProcessId\\": \\"approval-process-fcc351b8a95b****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"PolicyType\\": \\"DlpSend\\",\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"SchemaName\\": \\"测试\\",\\n \\"SchemaContent\\": \\"{\\\\\\"form\\\\\\": {\\\\\\"labelCol\\\\\\": 6,\\\\\\"wrapperCol\\\\\\": 12}}\\",\\n \\"CreatorUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"CreatorDevTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"CreateTime\\": \\"2022-11-15 22:11:55\\",\\n \\"Reason\\": \\"这是一个测试\\",\\n \\"CreatorUsername\\": \\"王先生\\",\\n \\"CreatorDepartment\\": \\"测试部\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询审批实例详情', + ], + 'DetachPolicy2ApprovalProcess' => [ + 'summary' => '解绑业务策略与审批流程', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213393', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'PeripheralBlock', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'approval-process-2677fcf063f5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\"\\n}","type":"json"}]', + 'title' => '解绑业务策略与审批流程', + ], + 'DeleteApprovalProcesses' => [ + 'summary' => '批量删除当前阿里云账号下审批流程。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213359', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批流程ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '审批模板ID。取值：'."\n" + .'- [ListApprovalProcesses](~~ListApprovalProcesses~~)：批量查询审批流程列表。'."\n" + .'- [GetApprovalProcess](~~GetApprovalProcess~~)：查询审批流程详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-process-dc61e92ba5c5****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'B608C6AE-623D-55C4-9454-601B88AE937E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B608C6AE-623D-55C4-9454-601B88AE937E\\"\\n}","type":"json"}]', + 'title' => '批量删除审批流程', + ], + 'AttachPolicy2ApprovalProcess' => [ + 'summary' => '挂载业务策略至指定审批流程', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213392', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '适配策略类型。取值：'."\n" + .'- **DomainBlacklist**：域名黑名单。'."\n" + .'- **DomainWhitelist**：域名白名单。'."\n" + .'- **SoftwareBlock**：软件禁用。'."\n" + .'- **AppUninstall**：终端卸载。'."\n" + .'- **DlpSend**：文件外发。'."\n" + .'- **PeripheralBlock**：外设管控。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'AppUninstall' => '终端卸载', + 'DlpSend' => '文件外发', + 'DomainWhitelist' => '域名白名单', + 'DomainBlacklist' => '域名黑名单', + 'SoftwareBlock' => '软件禁用', + 'PeripheralBlock' => '外设管控', + ], + 'example' => 'DlpSend', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'approval-process-2677fcf063f5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'C51D9340-4604-5331-AE62-407F3B408F86', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51D9340-4604-5331-AE62-407F3B408F86\\"\\n}","type":"json"}]', + 'title' => '绑定业务策略与审批流程', + ], + 'CreateApprovalProcess' => [ + 'summary' => '创建当前阿里云账号下审批流程。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213357', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessName', + 'in' => 'formData', + 'schema' => [ + 'description' => '流程名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_process', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '审批流程描述。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个审批流程', + ], + ], + [ + 'name' => 'ProcessNodes', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '审批节点列表。最多可定义5个审批节点。', + 'type' => 'array', + 'items' => [ + 'description' => '审批节点的审批人列表。最多可定义5个审批人。', + 'type' => 'array', + 'items' => [ + 'description' => '审批人ID。取值来源：'."\n" + .'- [ListUsers](~~ListUsers~~)：批量查询用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_d142d5bdeebcdb0c9dfe784d74d84a8f4644cee21bf26c9311c934debbef****', + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'MatchSchemas', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '匹配的审批模板。', + 'type' => 'object', + 'properties' => [ + 'DomainWhitelistSchemaId' => [ + 'description' => '域名白名单审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'DomainBlacklistSchemaId' => [ + 'description' => '域名黑名单审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'SoftwareBlockSchemaId' => [ + 'description' => '软件禁用审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'DeviceRegistrationSchemaId' => [ + 'description' => '设备注册审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'AppUninstallSchemaId' => [ + 'description' => '设备卸载审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'DlpSendSchemaId' => [ + 'description' => '文件外发审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PeripheralBlockSchemaId' => [ + 'description' => '外设管控审批模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'approval-schema-090134f1ebff****', + ], + 'EndpointHardeningSchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + 'SoftwareHardeningSchemaId' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '2CABFEBB-0CE7-575E-833A-266F75D46713', + ], + 'Process' => [ + 'description' => '审批流程。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '审批流程创建时间。', + 'type' => 'string', + 'example' => '2022-10-25 10:44:09', + ], + 'ProcessId' => [ + 'description' => '审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-dc61e92ba5c5****', + ], + 'ProcessName' => [ + 'description' => '审批流程名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '审批流程描述。', + 'type' => 'string', + 'example' => '这是一个审批流程', + ], + 'ProcessNodes' => [ + 'description' => '审批节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点审批人。', + 'type' => 'object', + 'properties' => [ + 'SaseUserId' => [ + 'description' => '审批人ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Username' => [ + 'description' => '审批人用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + ], + ], + ], + 'DomainWhitelistPolicies' => [ + 'description' => '域名白名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '域名白名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名白名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + ], + ], + 'DomainBlacklistPolicies' => [ + 'description' => '域名黑名单关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '域名黑名单策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名黑名单策略ID。', + 'type' => 'string', + 'example' => 'ladp-27a4fedf5e73****', + ], + ], + ], + ], + 'SoftwareBlockPolicies' => [ + 'description' => '软件禁用关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '软件禁用策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '软件禁用策略ID。', + 'type' => 'string', + 'example' => 'pid-6d6ad77d5b52****', + ], + ], + ], + ], + 'DeviceRegistrationPolicies' => [ + 'description' => '设备注册关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '设备注册策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-63b2f1844b86****', + ], + ], + ], + ], + 'AppUninstallPolicies' => [ + 'description' => '终端卸载关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '终端卸载策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端卸载策略ID。', + 'type' => 'string', + 'example' => 'auto-boot-anti-uninstall-5919f8afff47****', + ], + ], + ], + ], + 'DlpSendPolicies' => [ + 'description' => '文件外发关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '文件外发策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件外发策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + ], + ], + 'PeripheralBlockPolicies' => [ + 'description' => '外设管控关联策略列表。', + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'description' => '审批模板ID。', + 'type' => 'string', + 'example' => 'approval-schema-090134f1ebff****', + ], + 'PolicyIds' => [ + 'description' => '外设管控策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '外设管控策略ID。', + 'type' => 'string', + 'example' => '17**', + ], + ], + ], + ], + 'EndpointHardeningPolicies' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + ], + 'PolicyIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SoftwareHardeningPolicies' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaId' => [ + 'type' => 'string', + ], + 'PolicyIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CABFEBB-0CE7-575E-833A-266F75D46713\\",\\n \\"Process\\": {\\n \\"CreateTime\\": \\"2022-10-25 10:44:09\\",\\n \\"ProcessId\\": \\"approval-process-dc61e92ba5c5****\\",\\n \\"ProcessName\\": \\"测试\\",\\n \\"Description\\": \\"这是一个审批流程\\",\\n \\"ProcessNodes\\": [\\n [\\n {\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Username\\": \\"王先生\\"\\n }\\n ]\\n ],\\n \\"DomainWhitelistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ]\\n },\\n \\"DomainBlacklistPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"ladp-27a4fedf5e73****\\"\\n ]\\n },\\n \\"SoftwareBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"pid-6d6ad77d5b52****\\"\\n ]\\n },\\n \\"DeviceRegistrationPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"reg-policy-63b2f1844b86****\\"\\n ]\\n },\\n \\"AppUninstallPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"auto-boot-anti-uninstall-5919f8afff47****\\"\\n ]\\n },\\n \\"DlpSendPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ]\\n },\\n \\"PeripheralBlockPolicies\\": {\\n \\"SchemaId\\": \\"approval-schema-090134f1ebff****\\",\\n \\"PolicyIds\\": [\\n \\"17**\\"\\n ]\\n },\\n \\"EndpointHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ]\\n },\\n \\"SoftwareHardeningPolicies\\": {\\n \\"SchemaId\\": \\"\\",\\n \\"PolicyIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建审批流程', + ], + 'ListUninstallApplications' => [ + 'summary' => '批量查询当前阿里云账号下卸载申请列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215483', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '卸载申请ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '卸载申请ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'uninstall-app-6646831ac314****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '卸载申请状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '卸载申请状态。取值：'."\n" + .'- **Pending**：待处理。'."\n" + .'- **Approved**：通过。'."\n" + .'- **Rejected**：拒绝。', + 'type' => 'string', + 'required' => false, + 'example' => 'Pending', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + ], + [ + 'name' => 'Department', + 'in' => 'query', + 'schema' => [ + 'description' => '用户所属部门。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + [ + 'name' => 'Mac', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'required' => false, + 'example' => '00:16:XX:XX:7c:46', + ], + ], + [ + 'name' => 'Hostname', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（\\_）、分隔号（/）、at（@）和空格。单独输入下划线（\\_）将额外查询所有名称中带4字节utf-8字符的终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => 'win10-64bit', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'TotalNum' => [ + 'description' => '卸载申请总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Applications' => [ + 'description' => '卸载申请列表。', + 'type' => 'array', + 'items' => [ + 'description' => '卸载申请。', + 'type' => 'object', + 'properties' => [ + 'DevTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DevType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'example' => 'Windows', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'Reason' => [ + 'description' => '申请原因。', + 'type' => 'string', + 'example' => '这是一个测试', + ], + 'Status' => [ + 'description' => '卸载申请状态。取值：'."\n" + .'- **Pending**：待处理。'."\n" + .'- **Approved**：通过。'."\n" + .'- **Rejected**：拒绝。', + 'type' => 'string', + 'example' => 'Approved', + ], + 'ApplicationId' => [ + 'description' => '卸载申请ID。', + 'type' => 'string', + 'example' => 'uninstall-app-6646831ac314****', + ], + 'IsUninstall' => [ + 'description' => '是否已执行卸载。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => '卸载申请创建时间。', + 'type' => 'string', + 'example' => '2023-07-17 18:46:55', + ], + 'IdpName' => [ + 'description' => '用户身份源名称。', + 'type' => 'string', + 'example' => '测试身份源', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"TotalNum\\": 1,\\n \\"Applications\\": [\\n {\\n \\"DevTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DevType\\": \\"Windows\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"Reason\\": \\"这是一个测试\\",\\n \\"Status\\": \\"Approved\\",\\n \\"ApplicationId\\": \\"uninstall-app-6646831ac314****\\",\\n \\"IsUninstall\\": false,\\n \\"CreateTime\\": \\"2023-07-17 18:46:55\\",\\n \\"IdpName\\": \\"测试身份源\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询卸载申请列表', + ], + 'UpdateBootAndAntiUninstallPolicy' => [ + 'summary' => '更新当前阿里云账号下自启动与防卸载策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218007', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'IsBoot', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否开启自启动功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IsAntiUninstall', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否开启防卸载功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AllowReport', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否允许终端用户提交审批。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'WhitelistUsers', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '策略生效用户组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略生效用户组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-086bcf2d650b****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'BlockContent', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '客户端拦截弹窗展示内容。', + 'type' => 'object', + 'properties' => [ + 'BlockTextZh' => [ + 'description' => '中文内容。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '弹窗标题。', + 'type' => 'string', + 'required' => false, + 'example' => '防卸载警告', + ], + 'Content' => [ + 'description' => '弹窗内容。', + 'type' => 'string', + 'required' => false, + 'example' => '卸载后该设备无法再用于公司办公，同时该设备将失去进入公司内网权限！', + ], + 'MainButtonText' => [ + 'description' => '弹窗主按钮文案。', + 'type' => 'string', + 'required' => false, + 'example' => '去报备', + ], + 'MinorButtonText' => [ + 'description' => '弹窗副按钮文案。', + 'type' => 'string', + 'required' => false, + 'example' => '我知道了', + ], + ], + 'required' => false, + ], + 'BlockTextEn' => [ + 'description' => '英文内容。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '弹窗标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'Anti-Uninstall Warning', + ], + 'Content' => [ + 'description' => '弹窗内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'After uninstalling, the device can no longer be used for company work, and it will lose access to the company\'s intranet!', + ], + 'MainButtonText' => [ + 'description' => '弹窗主按钮文案。', + 'type' => 'string', + 'required' => false, + 'example' => 'Report', + ], + 'MinorButtonText' => [ + 'description' => '弹窗副按钮文案。', + 'type' => 'string', + 'required' => false, + 'example' => 'Ignore', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CB67D866-1E54-5106-89DF-6D70C73E5989', + ], + 'Strategy' => [ + 'description' => '自启动&防卸载策略。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '策略创建时间。', + 'type' => 'string', + 'example' => '2023-04-16 10:50:05', + ], + 'UpdateTime' => [ + 'description' => '策略更新时间。', + 'type' => 'string', + 'example' => '2024-06-14 10:17:14', + ], + 'IsBoot' => [ + 'description' => '是否开启自启动功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsAntiUninstall' => [ + 'description' => '是否开启防卸载功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AllowReport' => [ + 'description' => '是否允许终端用户提交审批。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'WhitelistUsers' => [ + 'description' => '白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + 'UserGroupIds' => [ + 'description' => '策略生效用户组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略生效用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-086bcf2d650b****', + ], + ], + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'example' => 'auto-boot-anti-uninstall-6f6cbf5f6605****', + ], + 'BlockContent' => [ + 'description' => '客户端拦截弹窗展示内容。', + 'type' => 'object', + 'properties' => [ + 'BlockTextZh' => [ + 'description' => '中文内容。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '弹窗标题。', + 'type' => 'string', + 'example' => '防卸载警告', + ], + 'Content' => [ + 'description' => '弹窗内容。', + 'type' => 'string', + 'example' => '卸载后该设备无法再用于公司办公，同时该设备将失去进入公司内网权限！', + ], + 'MainButtonText' => [ + 'description' => '弹窗主按钮文案。', + 'type' => 'string', + 'example' => '去报备', + ], + 'MinorButtonText' => [ + 'description' => '弹窗副按钮文案。', + 'type' => 'string', + 'example' => '我知道了', + ], + ], + ], + 'BlockTextEn' => [ + 'description' => '英文内容。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '弹窗标题。', + 'type' => 'string', + 'example' => 'Anti-Uninstall Warning', + ], + 'Content' => [ + 'description' => '弹窗内容。', + 'type' => 'string', + 'example' => 'After uninstalling, the device can no longer be used for company work, and it will lose access to the company\'s intranet!', + ], + 'MainButtonText' => [ + 'description' => '弹窗主按钮文案。', + 'type' => 'string', + 'example' => 'Report', + ], + 'MinorButtonText' => [ + 'description' => '弹窗副按钮文案。', + 'type' => 'string', + 'example' => 'Ignore', + ], + ], + ], + ], + ], + 'ReportProcessId' => [ + 'description' => '策略关联审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-65c255598826****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB67D866-1E54-5106-89DF-6D70C73E5989\\",\\n \\"Strategy\\": {\\n \\"CreateTime\\": \\"2023-04-16 10:50:05\\",\\n \\"UpdateTime\\": \\"2024-06-14 10:17:14\\",\\n \\"IsBoot\\": true,\\n \\"IsAntiUninstall\\": true,\\n \\"AllowReport\\": true,\\n \\"WhitelistUsers\\": [\\n \\"王先生\\"\\n ],\\n \\"UserGroupIds\\": [\\n \\"usergroup-086bcf2d650b****\\"\\n ],\\n \\"PolicyId\\": \\"auto-boot-anti-uninstall-6f6cbf5f6605****\\",\\n \\"BlockContent\\": {\\n \\"BlockTextZh\\": {\\n \\"Title\\": \\"防卸载警告\\",\\n \\"Content\\": \\"卸载后该设备无法再用于公司办公，同时该设备将失去进入公司内网权限！\\",\\n \\"MainButtonText\\": \\"去报备\\",\\n \\"MinorButtonText\\": \\"我知道了\\"\\n },\\n \\"BlockTextEn\\": {\\n \\"Title\\": \\"Anti-Uninstall Warning\\",\\n \\"Content\\": \\"After uninstalling, the device can no longer be used for company work, and it will lose access to the company\'s intranet!\\",\\n \\"MainButtonText\\": \\"Report\\",\\n \\"MinorButtonText\\": \\"Ignore\\"\\n }\\n },\\n \\"ReportProcessId\\": \\"approval-process-65c255598826****\\"\\n }\\n}","type":"json"}]', + 'title' => '更新自启动&防卸载策略', + ], + 'UpdateUninstallApplicationsStatus' => [ + 'summary' => '批量更新当前阿里云账号下卸载申请状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215484', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '卸载申请ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '卸载申请ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'uninstall-app-6646831ac314****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '卸载申请状态。取值：'."\n" + .'- **Approved**：通过。'."\n" + .'- **Rejected**：拒绝。', + 'type' => 'string', + 'required' => false, + 'example' => 'Approved', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '9B769522-D50C-5978-8981-52BE800D6099', + ], + 'Applications' => [ + 'description' => '卸载申请列表。', + 'type' => 'array', + 'items' => [ + 'description' => '卸载申请。', + 'type' => 'object', + 'properties' => [ + 'DevTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DevType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'example' => 'Windows', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'Reason' => [ + 'description' => '申请原因。', + 'type' => 'string', + 'example' => '这是一个测试', + ], + 'Status' => [ + 'description' => '卸载申请状态。取值：'."\n" + .'- **Pending**：待处理。'."\n" + .'- **Approved**：通过。'."\n" + .'- **Rejected**：拒绝。', + 'type' => 'string', + 'example' => 'Approved', + ], + 'ApplicationId' => [ + 'description' => '卸载申请ID。', + 'type' => 'string', + 'example' => 'uninstall-app-6646831ac314****', + ], + 'IsUninstall' => [ + 'description' => '是否已执行卸载。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IdpName' => [ + 'description' => '用户身份源名称。', + 'type' => 'string', + 'example' => '测试身份源', + ], + 'CreateTime' => [ + 'description' => '卸载申请创建时间。', + 'type' => 'string', + 'example' => '2023-07-17 18:46:55', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B769522-D50C-5978-8981-52BE800D6099\\",\\n \\"Applications\\": [\\n {\\n \\"DevTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DevType\\": \\"Windows\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"Reason\\": \\"这是一个测试\\",\\n \\"Status\\": \\"Approved\\",\\n \\"ApplicationId\\": \\"uninstall-app-6646831ac314****\\",\\n \\"IsUninstall\\": false,\\n \\"IdpName\\": \\"测试身份源\\",\\n \\"CreateTime\\": \\"2023-07-17 18:46:55\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量更新卸载申请状态', + ], + 'GetBootAndAntiUninstallPolicy' => [ + 'summary' => '查询当前阿里云账号下自启动与防卸载策略详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218008', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CB67D866-1E54-5106-89DF-6D70C73E5989', + ], + 'Strategy' => [ + 'description' => '自启动&防卸载策略。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '策略创建时间。', + 'type' => 'string', + 'example' => '2023-04-16 10:50:05', + ], + 'UpdateTime' => [ + 'description' => '策略更新时间。', + 'type' => 'string', + 'example' => '2024-06-14 10:17:14', + ], + 'IsBoot' => [ + 'description' => '是否开启自启动功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsAntiUninstall' => [ + 'description' => '是否开启防卸载功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AllowReport' => [ + 'description' => '是否允许终端用户提交审批。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'WhitelistUsers' => [ + 'description' => '白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + 'UserGroupIds' => [ + 'description' => '策略生效用户组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略生效用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-086bcf2d650b****', + ], + ], + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'example' => 'auto-boot-anti-uninstall-6f6cbf5f6605****', + ], + 'BlockContent' => [ + 'description' => '客户端拦截弹窗展示内容。', + 'type' => 'object', + 'properties' => [ + 'BlockTextZh' => [ + 'description' => '中文内容。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '弹窗标题。', + 'type' => 'string', + 'example' => '防卸载警告', + ], + 'Content' => [ + 'description' => '弹窗内容。', + 'type' => 'string', + 'example' => '卸载后该设备无法再用于公司办公，同时该设备将失去进入公司内网权限！', + ], + 'MainButtonText' => [ + 'description' => '弹窗主按钮文案。', + 'type' => 'string', + 'example' => '去报备', + ], + 'MinorButtonText' => [ + 'description' => '弹窗副按钮文案。', + 'type' => 'string', + 'example' => '我知道了', + ], + ], + ], + 'BlockTextEn' => [ + 'description' => '英文内容。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '弹窗标题。', + 'type' => 'string', + 'example' => 'Anti-Uninstall Warning', + ], + 'Content' => [ + 'description' => '弹窗内容。', + 'type' => 'string', + 'example' => 'After uninstalling, the device can no longer be used for company work, and it will lose access to the company\'s intranet!', + ], + 'MainButtonText' => [ + 'description' => '弹窗主按钮文案。', + 'type' => 'string', + 'example' => 'Report', + ], + 'MinorButtonText' => [ + 'description' => '弹窗副按钮文案。', + 'type' => 'string', + 'example' => 'Ignore', + ], + ], + ], + ], + ], + 'ReportProcessId' => [ + 'description' => '策略关联审批流程ID。', + 'type' => 'string', + 'example' => 'approval-process-300abfb970cc****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB67D866-1E54-5106-89DF-6D70C73E5989\\",\\n \\"Strategy\\": {\\n \\"CreateTime\\": \\"2023-04-16 10:50:05\\",\\n \\"UpdateTime\\": \\"2024-06-14 10:17:14\\",\\n \\"IsBoot\\": true,\\n \\"IsAntiUninstall\\": true,\\n \\"AllowReport\\": true,\\n \\"WhitelistUsers\\": [\\n \\"王先生\\"\\n ],\\n \\"UserGroupIds\\": [\\n \\"usergroup-086bcf2d650b****\\"\\n ],\\n \\"PolicyId\\": \\"auto-boot-anti-uninstall-6f6cbf5f6605****\\",\\n \\"BlockContent\\": {\\n \\"BlockTextZh\\": {\\n \\"Title\\": \\"防卸载警告\\",\\n \\"Content\\": \\"卸载后该设备无法再用于公司办公，同时该设备将失去进入公司内网权限！\\",\\n \\"MainButtonText\\": \\"去报备\\",\\n \\"MinorButtonText\\": \\"我知道了\\"\\n },\\n \\"BlockTextEn\\": {\\n \\"Title\\": \\"Anti-Uninstall Warning\\",\\n \\"Content\\": \\"After uninstalling, the device can no longer be used for company work, and it will lose access to the company\'s intranet!\\",\\n \\"MainButtonText\\": \\"Report\\",\\n \\"MinorButtonText\\": \\"Ignore\\"\\n }\\n },\\n \\"ReportProcessId\\": \\"approval-process-300abfb970cc****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询自启动&防卸载策略详情', + ], + 'ListNacUserCert' => [ + 'summary' => '入网用户列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '209040', + 'abilityTreeNodes' => [ + 'FEATUREcsasFARMOF', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1702260834', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1702770400', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'zhang**', + ], + ], + [ + 'name' => 'Department', + 'in' => 'query', + 'schema' => [ + 'description' => '用户所属部门。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + [ + 'name' => 'DeviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **windows**：Windows系统。'."\n" + .'- **macos**：macOS系统。'."\n" + .'- **linux**：Linux系统。'."\n" + .'- **android**：Android系统。'."\n" + .'- **ios**：iOS系统。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'linux' => 'linux', + 'android' => 'android', + 'windows' => 'windows', + 'ios' => 'ios', + 'macos' => 'macos', + ], + 'example' => 'windows', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '证书状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Disabled' => 'Disabled', + ], + 'example' => 'Enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。取值说明如下：'."\n" + .'- **2xx**：成功。 '."\n" + .'- **3xx**：重定向。 '."\n" + .'- **4xx**：请求错误。 '."\n" + .'- **5xx**：服务器错误。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '2xx' => '2xx', + '3xx' => '3xx', + '4xx' => '4xx', + '5xx' => '5xx', + ], + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DataList' => [ + 'description' => '用户入网证书状态数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户入网证书状态。', + 'type' => 'object', + 'properties' => [ + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'zhang**', + ], + 'Aliuid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '1', + ], + 'ExpiredTime' => [ + 'description' => '到期时间。', + 'type' => 'string', + 'example' => '2029-06-30 09:31:54', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '外包', + ], + 'DeviceType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **windows**：Windows系统。'."\n" + .'- **macos**：macOS系统。'."\n" + .'- **linux**：Linux系统。'."\n" + .'- **android**：Android系统。'."\n" + .'- **ios**：iOS系统。', + 'type' => 'string', + 'enumValueTitles' => [ + 'linux' => 'linux', + 'android' => 'android', + 'windows' => 'windows', + 'ios' => 'ios', + 'macos' => 'macos', + ], + 'example' => 'windows', + ], + 'Status' => [ + 'description' => '入网用户证书状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Disabled' => 'Disabled', + ], + 'example' => 'Disabled', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'DevTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'Hostname' => [ + 'description' => '终端设备名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（\\_）、分隔号（/）、at（@）和空格。单独输入下划线（\\_）将额外查询所有名称中带4字节utf-8字符的终端设备。', + 'type' => 'string', + 'example' => 'MS-XU****', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '08:f8:**:**:**:5e', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"TotalNum\\": 1,\\n \\"DataList\\": [\\n {\\n \\"Username\\": \\"zhang**\\",\\n \\"Aliuid\\": \\"1\\",\\n \\"ExpiredTime\\": \\"2029-06-30 09:31:54\\",\\n \\"Department\\": \\"外包\\",\\n \\"DeviceType\\": \\"windows\\",\\n \\"Status\\": \\"Disabled\\",\\n \\"UserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"DevTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"Hostname\\": \\"MS-XU****\\",\\n \\"Mac\\": \\"08:f8:**:**:**:5e\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询用户入网证书状态', + ], + 'UpdateNacUserCertStatus' => [ + 'summary' => '批量修改当前阿里云账号下用户入网证书状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '208782', + 'abilityTreeNodes' => [ + 'FEATUREcsasFARMOF', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdList', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备用户ID和设备ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备用户ID和设备ID。取值：[ListNacUserCert](~~ListNacUserCert~~)：批量查询用户终端设备入网证书状态。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '终端设备用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'DevTag' => [ + 'description' => '终端设备设备ID。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '终端用户设备证书状态。取值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：禁用。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Disabled' => 'Disabled', + ], + 'example' => 'Enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。取值说明如下：'."\n" + .'- **2xx**：成功。'."\n" + .'- **3xx**：重定向。'."\n" + .'- **4xx**：请求错误。'."\n" + .'- **5xx**：服务器错误。', + 'type' => 'string', + 'enumValueTitles' => [ + '2xx' => '2xx', + '3xx' => '3xx', + '4xx' => '4xx', + '5xx' => '5xx', + ], + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => '批量修改用户入网证书状态', + ], + 'ListIdpConfigs' => [ + 'summary' => '查询当前阿里云账户身份源配置信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215351', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Include', + 'in' => 'query', + 'schema' => [ + 'description' => '指定的身份源配置类型。多个类型以","分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'CSAS,DingTalk,LDAP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'FD724DBC-CD76-5235-BF76-59C51B73296D', + ], + 'Data' => [ + 'description' => '身份源配置。', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DataList' => [ + 'description' => '身份源配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '身份源配置ID。', + 'type' => 'string', + 'example' => '277', + ], + 'Name' => [ + 'description' => '身份源配置名称。', + 'type' => 'string', + 'example' => '示例身份源', + ], + 'Type' => [ + 'description' => '身份源配置类型。', + 'type' => 'string', + 'example' => 'DingTalk', + ], + 'Description' => [ + 'description' => '身份源配置描述。', + 'type' => 'string', + 'example' => '示例描述', + ], + 'Mfa' => [ + 'description' => '二次认证类型。', + 'type' => 'string', + 'example' => 'totp', + ], + 'MobileLoginType' => [ + 'description' => '移动端登录类型。', + 'type' => 'string', + 'example' => 'password', + ], + 'MobileMfaConfigType' => [ + 'description' => '移动端二次认证配置类型。', + 'type' => 'string', + 'example' => 'password', + ], + 'MultiIdpInfo' => [ + 'description' => '多身份源配置ID列表。', + 'type' => 'string', + 'example' => '1482,1355', + ], + 'PcLoginType' => [ + 'description' => 'PC端登录类型。', + 'type' => 'string', + 'example' => 'password', + ], + 'Status' => [ + 'description' => '身份源配置启用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-05-09T02:22:41.430Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD724DBC-CD76-5235-BF76-59C51B73296D\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 1,\\n \\"DataList\\": [\\n {\\n \\"Id\\": \\"277\\",\\n \\"Name\\": \\"示例身份源\\",\\n \\"Type\\": \\"DingTalk\\",\\n \\"Description\\": \\"示例描述\\",\\n \\"Mfa\\": \\"totp\\",\\n \\"MobileLoginType\\": \\"password\\",\\n \\"MobileMfaConfigType\\": \\"password\\",\\n \\"MultiIdpInfo\\": \\"1482,1355\\",\\n \\"PcLoginType\\": \\"password\\",\\n \\"Status\\": \\"Disabled\\",\\n \\"UpdateTime\\": \\"2023-05-09T02:22:41.430Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询身份源配置信息', + ], + 'GetIdpConfig' => [ + 'summary' => '查询当前阿里云账户指定的身份源配置详情信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215357', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'idp-cfg68956d86e********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-******', + ], + 'Data' => [ + 'description' => '身份源配置。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '身份源配置ID。', + 'type' => 'string', + 'example' => 'idp-cfg68956d86e********', + ], + 'Name' => [ + 'description' => '身份源配置名称。', + 'type' => 'string', + 'example' => '示例身份源', + ], + 'Type' => [ + 'description' => '身份源配置类型。', + 'type' => 'string', + 'example' => 'CSAS', + ], + 'IdpMetadata' => [ + 'description' => '身份提供商IdP的元数据。', + 'type' => 'string', + 'example' => '<?xml version="1.0" encoding="utf-8"?>***', + ], + 'AccessKey' => [ + 'description' => 'IDaaS身份源 AccessKey ID。', + 'type' => 'string', + 'example' => '*******', + ], + 'AccessKeySecret' => [ + 'description' => 'IDaaS身份源 AccessKey。', + 'type' => 'string', + 'example' => '*******', + ], + 'Status' => [ + 'description' => '身份源配置启用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'MfaConfigType' => [ + 'description' => '二次认证配置类型。', + 'type' => 'string', + 'example' => 'totp', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-02-26T02:02:42Z', + ], + 'GetGroupUrl' => [ + 'description' => '自建身份源查询组织架构链接地址。', + 'type' => 'string', + 'example' => 'https://172.10.XX.XX:4321/getGroup?name=%s&pass=%s', + ], + 'Description' => [ + 'description' => '身份源配置描述。', + 'type' => 'string', + 'example' => '示例身份源', + ], + 'MultiIdpInfo' => [ + 'description' => '多身份源配置ID列表。', + 'type' => 'string', + 'example' => '1482,1355', + ], + 'PcLoginType' => [ + 'description' => 'PC端登录类型。', + 'type' => 'string', + 'example' => 'password', + ], + 'MobileLoginType' => [ + 'description' => '移动端登录类型。', + 'type' => 'string', + 'example' => 'password', + ], + 'MobileMfaConfigType' => [ + 'description' => '移动端二次认证配置类型。', + 'type' => 'string', + 'example' => 'totp', + ], + 'VerifyToken' => [ + 'description' => '自建二次认证服务请求签名校验Token。', + 'type' => 'string', + 'example' => '7JAr3fYtn****', + ], + 'VerifyAesKey' => [ + 'description' => '自建二次认证服务请求加密密钥。', + 'type' => 'string', + 'example' => 'QVhaU0RDR0JIWV****', + ], + 'VerifyUrl' => [ + 'description' => '自建二次认证服务验证链接地址。', + 'type' => 'string', + 'example' => 'http://172.10.XX.XX:1234/otp_verify', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-******\\",\\n \\"Data\\": {\\n \\"Id\\": \\"idp-cfg68956d86e********\\",\\n \\"Name\\": \\"示例身份源\\",\\n \\"Type\\": \\"CSAS\\",\\n \\"IdpMetadata\\": \\"<?xml version=\\\\\\"1.0\\\\\\" encoding=\\\\\\"utf-8\\\\\\"?>***\\",\\n \\"AccessKey\\": \\"*******\\",\\n \\"AccessKeySecret\\": \\"*******\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"MfaConfigType\\": \\"totp\\",\\n \\"UpdateTime\\": \\"2024-02-26T02:02:42Z\\",\\n \\"GetGroupUrl\\": \\"https://172.10.XX.XX:4321/getGroup?name=%s&pass=%s\\",\\n \\"Description\\": \\"示例身份源\\",\\n \\"MultiIdpInfo\\": \\"1482,1355\\",\\n \\"PcLoginType\\": \\"password\\",\\n \\"MobileLoginType\\": \\"password\\",\\n \\"MobileMfaConfigType\\": \\"totp\\",\\n \\"VerifyToken\\": \\"7JAr3fYtn****\\",\\n \\"VerifyAesKey\\": \\"QVhaU0RDR0JIWV****\\",\\n \\"VerifyUrl\\": \\"http://172.10.XX.XX:1234/otp_verify\\"\\n }\\n}","type":"json"}]', + 'title' => '查询身份源配置详情', + ], + 'GetActiveIdpConfig' => [ + 'summary' => '查询当前阿里云账户已启用的身份源配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215457', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4D169859-A4F2-5EC8-853B-8447787C0D8A', + ], + 'Data' => [ + 'description' => '身份源配置。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '身份源配置ID。', + 'type' => 'string', + 'example' => 'idp-cfg001', + ], + 'Name' => [ + 'description' => '身份源配置名称。', + 'type' => 'string', + 'example' => '测试身份源', + ], + 'Type' => [ + 'description' => '身份源配置类型。', + 'type' => 'string', + 'example' => 'DingTalk', + ], + 'Description' => [ + 'description' => '身份源配置描述。', + 'type' => 'string', + 'example' => '示例身份源', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D169859-A4F2-5EC8-853B-8447787C0D8A\\",\\n \\"Data\\": {\\n \\"Id\\": \\"idp-cfg001\\",\\n \\"Name\\": \\"测试身份源\\",\\n \\"Type\\": \\"DingTalk\\",\\n \\"Description\\": \\"示例身份源\\"\\n }\\n}","type":"json"}]', + 'title' => '查询已启用的身份源配置', + ], + 'ListIdpDepartments' => [ + 'summary' => '查询当前阿里云账户自定义身份源部门信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215359', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'idp-cfg68956d86e********', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'Data' => [ + 'description' => '部门信息。', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DataList' => [ + 'description' => '部门信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'example' => '30520', + ], + 'Name' => [ + 'description' => '部门名称。', + 'type' => 'string', + 'example' => '示例部门', + ], + 'IdpConfigId' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'example' => '1440', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 2,\\n \\"DataList\\": [\\n {\\n \\"Id\\": \\"30520\\",\\n \\"Name\\": \\"示例部门\\",\\n \\"IdpConfigId\\": \\"1440\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询自定义身份源部门', + ], + 'CreateIdpDepartment' => [ + 'summary' => '创建当前阿里云账户自定义身份源部门。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215362', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'idp-cfg68956d86e********', + ], + ], + [ + 'name' => 'DepartmentName', + 'in' => 'query', + 'schema' => [ + 'description' => '部门名称。', + 'type' => 'string', + 'required' => true, + 'example' => '示例部门', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'D6707286-A50E-57B1-B2CF-EFAC59E850D8', + ], + 'Data' => [ + 'description' => '创建的部门ID。', + 'type' => 'string', + 'example' => '726', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6707286-A50E-57B1-B2CF-EFAC59E850D8\\",\\n \\"Data\\": \\"726\\"\\n}","type":"json"}]', + 'title' => '创建自定义身份源部门', + ], + 'ListClientUsers' => [ + 'summary' => '查询当前阿里云账户自定义身份源的用户信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215379', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1071', + ], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10785', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名称。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '电子邮件地址。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'MobileNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码，不需要带国家编码。', + 'type' => 'string', + 'required' => false, + 'example' => '18980976559', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '用户启用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'exclusiveMinimum' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE', + ], + 'Data' => [ + 'description' => '用户信息。', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DataList' => [ + 'description' => '用户信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1970', + ], + 'IdpConfigId' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'example' => '1026', + ], + 'Username' => [ + 'description' => '用户名称。', + 'type' => 'string', + 'example' => '张三', + ], + 'UserId' => [ + 'description' => '用户唯一标识。', + 'type' => 'string', + 'example' => 'su_dead7216****', + ], + 'Description' => [ + 'description' => '用户描述。', + 'type' => 'string', + 'example' => '示例用户', + ], + 'Email' => [ + 'description' => '电子邮件地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MobileNumber' => [ + 'description' => '手机号码，不需要带国家编码。', + 'type' => 'string', + 'example' => '15800820468', + ], + 'DepartmentId' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'example' => '10800', + ], + 'Status' => [ + 'description' => '用户启用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'example' => '105', + ], + 'Name' => [ + 'description' => '部门名称。', + 'type' => 'string', + 'example' => '示例部门', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 2,\\n \\"DataList\\": [\\n {\\n \\"Id\\": \\"1970\\",\\n \\"IdpConfigId\\": \\"1026\\",\\n \\"Username\\": \\"张三\\",\\n \\"UserId\\": \\"su_dead7216****\\",\\n \\"Description\\": \\"示例用户\\",\\n \\"Email\\": \\"[email protected]\\",\\n \\"MobileNumber\\": \\"15800820468\\",\\n \\"DepartmentId\\": \\"10800\\",\\n \\"Status\\": \\"Disabled\\",\\n \\"Department\\": {\\n \\"Id\\": \\"105\\",\\n \\"Name\\": \\"示例部门\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询自定义身份用户信息', + ], + 'UpdateClientUser' => [ + 'summary' => '设置当前阿里云账户自定义身份源指定用户的信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215389', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '20644', + ], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10701', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '电子邮件地址。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'MobileNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码，不需要带国家编码。', + 'type' => 'string', + 'required' => false, + 'example' => '13641966835', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '用户描述。', + 'type' => 'string', + 'required' => false, + 'example' => '示例用户', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\"\\n}","type":"json"}]', + 'title' => '设置自定义身份源指定用户信息', + ], + 'GetClientUser' => [ + 'summary' => '查询当前阿里云账户自定义身份源指定用户的详情信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215387', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'idp-cfg68956d86e********', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名称。', + 'type' => 'string', + 'required' => true, + 'example' => '张三', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'Data' => [ + 'description' => '用户详情信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '83', + ], + 'IdpConfigId' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'example' => 'idp-cfg68956d86e********', + ], + 'Username' => [ + 'description' => '用户名称。', + 'type' => 'string', + 'example' => '张三', + ], + 'UserId' => [ + 'description' => '用户唯一标识。', + 'type' => 'string', + 'example' => 'su_abcd7215****', + ], + 'Description' => [ + 'description' => '用户描述。', + 'type' => 'string', + 'example' => '示例用户', + ], + 'Email' => [ + 'description' => '电子邮件地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MobileNumber' => [ + 'description' => '手机号码，不需要带国家编码。', + 'type' => 'string', + 'example' => '1364196****', + ], + 'DepartmentId' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'example' => '10713', + ], + 'Status' => [ + 'description' => '用户启用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'example' => '107', + ], + 'Name' => [ + 'description' => '部门名称。', + 'type' => 'string', + 'example' => '示例部门', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"Data\\": {\\n \\"Id\\": \\"83\\",\\n \\"IdpConfigId\\": \\"idp-cfg68956d86e********\\",\\n \\"Username\\": \\"张三\\",\\n \\"UserId\\": \\"su_abcd7215****\\",\\n \\"Description\\": \\"示例用户\\",\\n \\"Email\\": \\"[email protected]\\",\\n \\"MobileNumber\\": \\"1364196****\\",\\n \\"DepartmentId\\": \\"10713\\",\\n \\"Status\\": \\"Disabled\\",\\n \\"Department\\": {\\n \\"Id\\": \\"107\\",\\n \\"Name\\": \\"示例部门\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询自定义身份源用户详情', + ], + 'DeleteIdpDepartment' => [ + 'summary' => '删除当前阿里云账户自定义身份源指定的部门。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215371', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'idp-cfg68956d86e********', + ], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10829', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE\\"\\n}","type":"json"}]', + 'title' => '删除自定义身份源指定部门', + ], + 'CreateClientUser' => [ + 'summary' => '创建当前阿里云账户自定义身份源用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215388', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => '727', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名称。', + 'type' => 'string', + 'required' => true, + 'example' => '张三', + ], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10797', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '电子邮件地址。', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'MobileNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码，不需要带国家编码。', + 'type' => 'string', + 'required' => false, + 'example' => '13641966835', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。若为空则自动生成随机密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'kehudiyi', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '用户描述。', + 'type' => 'string', + 'required' => false, + 'example' => '示例用户', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'Data' => [ + 'description' => '创建的用户ID。', + 'type' => 'string', + 'example' => '726', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"Data\\": \\"726\\"\\n}","type":"json"}]', + 'title' => '创建自定义身份源用户', + ], + 'UpdateIdpDepartment' => [ + 'summary' => '删除当前阿里云账户自定义身份源指定的部门。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215363', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => '598', + ], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10653', + ], + ], + [ + 'name' => 'DepartmentName', + 'in' => 'query', + 'schema' => [ + 'description' => '部门名称。', + 'type' => 'string', + 'required' => true, + 'example' => '示例部门', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4D169859-A4F2-5EC8-853B-8447787C0D8A', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D169859-A4F2-5EC8-853B-8447787C0D8A\\"\\n}","type":"json"}]', + 'title' => '修改自定义身份源指定部门', + ], + 'UpdateClientUserStatus' => [ + 'summary' => '设置当前阿里云账户自定义身份源指定用户的启用状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215392', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1495', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '用户启用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'Enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\"\\n}","type":"json"}]', + 'title' => '设置自定义身份源用户启用状态', + ], + 'DeleteClientUser' => [ + 'summary' => '删除当前阿里云账户自定义身份源的指定用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215391', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '27058', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\"\\n}","type":"json"}]', + 'title' => '删除自定义身份源指定用户', + ], + 'UpdateClientUserPassword' => [ + 'summary' => '设置当前阿里云账户自定义身份源指定用户的密码。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215390', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1128', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名称。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。若为空则自动生成随机密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'kehudiyidj', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'EFE7EBB2-449D-5BBB-B381-CA7839BC1649', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFE7EBB2-449D-5BBB-B381-CA7839BC1649\\"\\n}","type":"json"}]', + 'title' => '设置自定义身份源指定用户的密码', + 'requestParamsDescription' => 'Id或Username至少指定其一，优先使用Id。', + ], + 'UpdateUserDevicesStatus' => [ + 'summary' => '批量修改当前阿里云账号下终端设备状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192476', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceTags', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****'."\n", + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceAction', + 'in' => 'formData', + 'schema' => [ + 'description' => '终端设备状态操作。取值：'."\n" + .'- **Locked**：锁定。'."\n" + .'- **Lost**：挂失。'."\n" + .'- **Unbound**：解绑。只有终端设备为离线或长期离线状态时允许解绑。'."\n" + .'- **Unlocked**：解锁。只有终端设备为锁定状态时允许解锁。'."\n" + .'- **Found**：找回。只有终端设备为挂失状态时允许解锁。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Lost' => '挂失', + 'Locked' => '锁定', + 'Unlocked' => '解锁', + 'Unbound' => '解绑', + 'Found' => '找回', + ], + 'example' => 'Unbound', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D', + ], + 'Devices' => [ + 'description' => '终端设备列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备。', + 'type' => 'object', + 'properties' => [ + 'DeviceTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DeviceType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'DeviceModel' => [ + 'description' => '终端设备型号。', + 'type' => 'string', + 'example' => 'MacBookPro17,1', + ], + 'DeviceVersion' => [ + 'description' => '终端设备操作系统版本。', + 'type' => 'string', + 'example' => '3.5.1', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'InnerIP' => [ + 'description' => '终端设备内网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'SrcIP' => [ + 'description' => '终端设备登录IP地址。', + 'type' => 'string', + 'example' => '11.49.XX.XX', + ], + 'Memory' => [ + 'description' => '终端设备内存容量。单位：GB。', + 'type' => 'string', + 'example' => '16', + ], + 'CPU' => [ + 'description' => '终端设备CPU型号。', + 'type' => 'string', + 'example' => 'Apple M1', + ], + 'Disk' => [ + 'description' => '终端设备磁盘型号。', + 'type' => 'string', + 'example' => 'APPLE SSD AP0512Q Media', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + 'AppVersion' => [ + 'description' => '客户端版本。', + 'type' => 'string', + 'example' => '2.2.0', + ], + 'DeviceBelong' => [ + 'description' => '终端设备归属。取值：'."\n" + .'- **Personal**：个人设备。'."\n" + .'- **Company**：公司设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'SharingStatus' => [ + 'description' => '设备是否开启共享。取值：'."\n" + .'- **true**：开启共享。'."\n" + .'- **false**：关闭共享。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '开启共享', + 'false' => '关闭共享', + ], + 'example' => 'true', + ], + 'DeviceStatus' => [ + 'description' => '终端设备状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。'."\n" + .'- **LongTermOffline**：长期离线。'."\n" + .'- **Locked**：锁定。'."\n" + .'- **Lost**：挂失。'."\n" + .'- **Unbound**：解绑。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Lost' => '挂失', + 'Locked' => '锁定', + 'LongTermOffline' => '长期离线', + 'Offline' => '离线', + 'Unbound' => '解绑', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'AppStatus' => [ + 'description' => '客户端状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'PaStatus' => [ + 'description' => '内网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'IaStatus' => [ + 'description' => '互联网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Diabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'DlpStatus' => [ + 'description' => '办公数据保护状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。'."\n" + .'- **Unauthorized**：未授权。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Unauthorized' => '未授权', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'NacStatus' => [ + 'description' => '网络准入状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '终端设备注册时间。', + 'type' => 'string', + 'example' => '2023-07-17 18:46:55', + ], + 'UpdateTime' => [ + 'description' => '终端设备最后在线时间。', + 'type' => 'string', + 'example' => '2023-08-24 19:04:42', + ], + 'NetInterfaceInfo' => [ + 'description' => '终端网卡列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端网卡。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '网卡名称。', + 'type' => 'string', + 'example' => 'eth0', + ], + 'Mac' => [ + 'description' => '网卡MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D\\",\\n \\"Devices\\": [\\n {\\n \\"DeviceTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DeviceType\\": \\"Windows\\",\\n \\"DeviceModel\\": \\"MacBookPro17,1\\",\\n \\"DeviceVersion\\": \\"3.5.1\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"InnerIP\\": \\"192.168.XX.XX\\",\\n \\"SrcIP\\": \\"11.49.XX.XX\\",\\n \\"Memory\\": \\"16\\",\\n \\"CPU\\": \\"Apple M1\\",\\n \\"Disk\\": \\"APPLE SSD AP0512Q Media\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\",\\n \\"AppVersion\\": \\"2.2.0\\",\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"SharingStatus\\": true,\\n \\"DeviceStatus\\": \\"Online\\",\\n \\"AppStatus\\": \\"Online\\",\\n \\"PaStatus\\": \\"Enabled\\",\\n \\"IaStatus\\": \\"Enabled\\",\\n \\"DlpStatus\\": \\"Enabled\\",\\n \\"NacStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2023-07-17 18:46:55\\",\\n \\"UpdateTime\\": \\"2023-08-24 19:04:42\\",\\n \\"NetInterfaceInfo\\": [\\n {\\n \\"Name\\": \\"eth0\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量修改用户终端设备状态', + ], + 'ListExcessiveDeviceRegistrationApplications' => [ + 'summary' => '查询当前阿里云账号下用户终端设备的超额注册申请列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasDGFP8V', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值范围：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + ], + [ + 'name' => 'SaseUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。取值来源：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'Department', + 'in' => 'query', + 'schema' => [ + 'description' => '用户所属部门。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + [ + 'name' => 'Hostname', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（\\_）、分隔号（/）、at（@）和空格。单独输入下划线（\\_）将额外查询所有名称中带4字节utf-8字符的终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => 'win10-64bit', + ], + ], + [ + 'name' => 'Mac', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'required' => false, + 'example' => '00:16:XX:XX:7c:46', + ], + ], + [ + 'name' => 'DeviceTag', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****'."\n", + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '超额注册申请状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '超额注册申请状态。取值：'."\n" + .'- **Pending**：待处理。'."\n" + .'- **Approved**：通过。'."\n" + .'- **Rejected**：拒绝。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Approved' => '通过', + 'Rejected' => '拒绝', + 'Pending' => '待处理', + ], + 'example' => 'Pending', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '超额注册申请ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '超额注册申请ID。取值来源[ListExcessiveDeviceRegistrationApplications](~~ListExcessiveDeviceRegistrationApplications~~)：批量查询设备超额注册申请。', + 'type' => 'string', + 'required' => false, + 'example' => 'reg-application-0f4a127b7e78****', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'TotalNum' => [ + 'description' => '超额注册申请总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Applications' => [ + 'description' => '超额注册申请列表。', + 'type' => 'array', + 'items' => [ + 'description' => '超额注册申请。', + 'type' => 'object', + 'properties' => [ + 'DeviceTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DeviceType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + 'IsUsed' => [ + 'description' => '超额注册申请是否被使用。取值：'."\n" + .'- **true**：被使用。'."\n" + .'- **false**：尚未使用。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '被使用', + 'false' => '尚未使用', + ], + 'example' => 'false', + ], + 'Status' => [ + 'description' => '超额注册申请状态。取值：'."\n" + .'- **Pending**：待处理。'."\n" + .'- **Approved**：通过。'."\n" + .'- **Rejected**：拒绝。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Approved' => '通过', + 'Rejected' => '拒绝', + 'Pending' => '待处理', + ], + 'example' => 'Approved', + ], + 'CreateTime' => [ + 'description' => '超额注册申请创建时间。', + 'type' => 'string', + 'example' => '2023-07-17 18:46:55', + ], + 'Description' => [ + 'description' => '超额注册申请理由。', + 'type' => 'string', + 'example' => '这是一条超额注册申请', + ], + 'ApplicationId' => [ + 'description' => '超额注册申请ID。', + 'type' => 'string', + 'example' => 'reg-application-0f4a127b7e78****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"TotalNum\\": 1,\\n \\"Applications\\": [\\n {\\n \\"DeviceTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DeviceType\\": \\"Windows\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\",\\n \\"IsUsed\\": false,\\n \\"Status\\": \\"Approved\\",\\n \\"CreateTime\\": \\"2023-07-17 18:46:55\\",\\n \\"Description\\": \\"这是一条超额注册申请\\",\\n \\"ApplicationId\\": \\"reg-application-0f4a127b7e78****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询设备超额注册申请', + ], + 'UpdateExcessiveDeviceRegistrationApplicationsStatus' => [ + 'summary' => '批量修改当前阿里云账号下超额注册申请状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasAPE6DH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '超额注册申请状态。取值：'."\n" + .'- **Approved**：通过。只有设备注册申请为待处理状态时允许通过。'."\n" + .'- **Rejected**：拒绝。只有设备注册申请为待处理状态时允许拒绝。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Approved' => '通过', + 'Rejected' => '拒绝', + ], + 'example' => 'Approved', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '超额注册申请ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '超额注册申请ID。取值来源[ListExcessiveDeviceRegistrationApplications](~~ListExcessiveDeviceRegistrationApplications~~)：批量查询设备超额注册申请。', + 'type' => 'string', + 'required' => false, + 'example' => 'reg-application-0f4a127b7e78****'."\n", + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'Applications' => [ + 'description' => '超额注册申请列表。', + 'type' => 'array', + 'items' => [ + 'description' => '超额注册申请。', + 'type' => 'object', + 'properties' => [ + 'DeviceTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DeviceType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + 'IsUsed' => [ + 'description' => '超额注册申请是否被使用。取值：'."\n" + .'- **true**：被使用。'."\n" + .'- **false**：尚未使用。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '被使用', + 'false' => '尚未使用', + ], + 'example' => 'false', + ], + 'Status' => [ + 'description' => '超额注册申请状态。取值：'."\n" + .'- **Pending**：待处理。'."\n" + .'- **Approved**：通过。'."\n" + .'- **Rejected**：拒绝。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Approved' => '通过', + 'Rejected' => '拒绝', + 'Pending' => '待处理', + ], + 'example' => 'Approved', + ], + 'CreateTime' => [ + 'description' => '超额注册申请创建时间。', + 'type' => 'string', + 'example' => '2023-07-17 18:46:55', + ], + 'Description' => [ + 'description' => '超额注册申请理由。', + 'type' => 'string', + 'example' => '这是一条超额注册申请', + ], + 'ApplicationId' => [ + 'description' => '超额注册申请ID。', + 'type' => 'string', + 'example' => 'reg-application-0f4a127b7e78****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"Applications\\": [\\n {\\n \\"DeviceTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DeviceType\\": \\"Windows\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\",\\n \\"IsUsed\\": false,\\n \\"Status\\": \\"Approved\\",\\n \\"CreateTime\\": \\"2023-07-17 18:46:55\\",\\n \\"Description\\": \\"这是一条超额注册申请\\",\\n \\"ApplicationId\\": \\"reg-application-0f4a127b7e78****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量修改设备超额注册申请状态', + ], + 'UpdateUserDevicesSharingStatus' => [ + 'summary' => '批量修改企业用户的终端设备共享状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceTags', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****'."\n", + ], + 'required' => true, + ], + ], + [ + 'name' => 'SharingStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备是否开启共享。取值：'."\n" + .'- **true**：开启共享。'."\n" + .'- **false**：关闭共享。', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => '开启共享', + 'false' => '关闭共享', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4D169859-A4F2-5EC8-853B-8447787C0D8A', + ], + 'Devices' => [ + 'description' => '终端设备列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备。', + 'type' => 'object', + 'properties' => [ + 'DeviceTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DeviceType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'DeviceModel' => [ + 'description' => '终端设备型号。', + 'type' => 'string', + 'example' => 'MacBookPro17,1', + ], + 'DeviceVersion' => [ + 'description' => '终端设备操作系统版本。', + 'type' => 'string', + 'example' => '3.5.1', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'InnerIP' => [ + 'description' => '终端设备内网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'SrcIP' => [ + 'description' => '终端设备登录IP地址。', + 'type' => 'string', + 'example' => '11.49.XX.XX', + ], + 'Memory' => [ + 'description' => '终端设备内存容量。单位：GB。', + 'type' => 'string', + 'example' => '16', + ], + 'CPU' => [ + 'description' => '终端设备CPU型号。', + 'type' => 'string', + 'example' => 'Apple M1', + ], + 'Disk' => [ + 'description' => '终端设备磁盘型号。', + 'type' => 'string', + 'example' => 'APPLE SSD AP0512Q Media', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + 'AppVersion' => [ + 'description' => '客户端版本。', + 'type' => 'string', + 'example' => '2.2.0', + ], + 'DeviceBelong' => [ + 'description' => '终端设备归属。取值：'."\n" + .'- **Personal**：个人设备。'."\n" + .'- **Company**：公司设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'SharingStatus' => [ + 'description' => '设备是否开启共享。取值：'."\n" + .'- **true**：开启共享。'."\n" + .'- **false**：关闭共享。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '开启共享', + 'false' => '关闭共享', + ], + 'example' => 'true', + ], + 'DeviceStatus' => [ + 'description' => '终端设备状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。'."\n" + .'- **LongTermOffline**：长期离线。'."\n" + .'- **Locked**：锁定。'."\n" + .'- **Lost**：挂失。'."\n" + .'- **Unbound**：解绑。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Lost' => '挂失', + 'Locked' => '锁定', + 'LongTermOffline' => '长期离线', + 'Offline' => '离线', + 'Unbound' => '解绑', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'AppStatus' => [ + 'description' => '客户端状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'PaStatus' => [ + 'description' => '内网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'IaStatus' => [ + 'description' => '互联网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'DlpStatus' => [ + 'description' => '办公数据保护状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。'."\n" + .'- **Unauthorized**：未授权。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Unauthorized' => '未授权', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'NacStatus' => [ + 'description' => '网络准入状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '终端设备注册时间。', + 'type' => 'string', + 'example' => '2023-05-16 17:18:46', + ], + 'UpdateTime' => [ + 'description' => '终端设备最后在线时间。', + 'type' => 'string', + 'example' => '2023-08-24 19:04:42', + ], + 'NetInterfaceInfo' => [ + 'description' => '终端网卡列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端网卡。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '网卡名称。', + 'type' => 'string', + 'example' => 'eth0', + ], + 'Mac' => [ + 'description' => '网卡MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D169859-A4F2-5EC8-853B-8447787C0D8A\\",\\n \\"Devices\\": [\\n {\\n \\"DeviceTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DeviceType\\": \\"Windows\\",\\n \\"DeviceModel\\": \\"MacBookPro17,1\\",\\n \\"DeviceVersion\\": \\"3.5.1\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"InnerIP\\": \\"192.168.XX.XX\\",\\n \\"SrcIP\\": \\"11.49.XX.XX\\",\\n \\"Memory\\": \\"16\\",\\n \\"CPU\\": \\"Apple M1\\",\\n \\"Disk\\": \\"APPLE SSD AP0512Q Media\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\",\\n \\"AppVersion\\": \\"2.2.0\\",\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"SharingStatus\\": true,\\n \\"DeviceStatus\\": \\"Online\\",\\n \\"AppStatus\\": \\"Online\\",\\n \\"PaStatus\\": \\"Enabled\\",\\n \\"IaStatus\\": \\"Enabled\\",\\n \\"DlpStatus\\": \\"Enabled\\",\\n \\"NacStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2023-05-16 17:18:46\\",\\n \\"UpdateTime\\": \\"2023-08-24 19:04:42\\",\\n \\"NetInterfaceInfo\\": [\\n {\\n \\"Name\\": \\"eth0\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量修改用户终端设备共享状态', + ], + 'ListUserDevices' => [ + 'summary' => '查询当前阿里云账号下用户终端设备列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192473', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值范围：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + ], + [ + 'name' => 'SaseUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。取值来源：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'Department', + 'in' => 'query', + 'schema' => [ + 'description' => '用户所属部门。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + [ + 'name' => 'Hostname', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（\\_）、分隔号（/）、at（@）和空格。单独输入下划线（\\_）将额外查询所有名称中带4字节utf-8字符的终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => 'win10-64bit', + ], + ], + [ + 'name' => 'DeviceBelong', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备归属。取值：'."\n" + .'- **Personal**：个人设备。'."\n" + .'- **Company**：公司设备。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + ], + [ + 'name' => 'Mac', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'required' => false, + 'example' => '00:16:XX:XX:7c:46', + ], + ], + [ + 'name' => 'SharingStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '设备是否开启共享。取值：'."\n" + .'- **true**：开启共享。'."\n" + .'- **false**：关闭共享。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '开启共享', + 'false' => '关闭共享', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'DeviceStatuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。包括长期离线状态。'."\n" + .'- **LongTermOffline**：长期离线。'."\n" + .'- **Locked**：锁定。'."\n" + .'- **Lost**：挂失。'."\n" + .'- **Unbound**：解绑。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Lost' => '挂失', + 'Locked' => '锁定', + 'LongTermOffline' => '长期离线', + 'Offline' => '离线(包括长期离线)', + 'Unbound' => '解绑', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AppStatuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '客户端状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PaStatuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'required' => false, + ], + ], + [ + 'name' => 'IaStatuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '互联网访问状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '互联网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Disabled', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DlpStatuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '办公数据保护状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '办公数据保护状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。'."\n" + .'- **Unauthorized**：未授权。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Unauthorized' => '未授权', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'required' => false, + ], + ], + [ + 'name' => 'NacStatuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '网络准入状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '网络准入状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Unprovisioned', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AutoLoginStatuses', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeviceTypes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备操作系统类型集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeviceTags', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数。取值：'."\n" + .'- **Username**：按Username升序排列。'."\n" + .'- **AppVersion**：按AppVersion降序排列。'."\n" + .'- **UpdateTime**：按UpdateTime降序排列。'."\n" + .'- **CreateTime**：按CreateTime降序排列。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AppVersion' => '按AppVersion降序排列', + 'Username' => '按Username升序排列', + 'CreateTime' => '按CreateTime降序排列', + 'UpdateTime' => '按UpdateTime降序排列', + ], + 'example' => 'UpdateTime', + ], + ], + [ + 'name' => 'InnerIp', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备内网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'AppVersions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '客户端版本集合。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端版本。', + 'type' => 'string', + 'required' => false, + 'example' => '4.5.0', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Workshop', + 'in' => 'query', + 'schema' => [ + 'description' => '办公区名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试办公区', + ], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'device-group-5191cf830a5e****', + ], + ], + [ + 'name' => 'SnSystem', + 'in' => 'query', + 'schema' => [ + 'description' => '系统sn码。', + 'type' => 'string', + 'required' => false, + 'example' => 'KVN9C9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D', + ], + 'TotalNum' => [ + 'description' => '终端设备总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Devices' => [ + 'description' => '终端设备列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备。', + 'type' => 'object', + 'properties' => [ + 'DeviceTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DeviceType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'DeviceModel' => [ + 'description' => '终端设备型号。', + 'type' => 'string', + 'example' => 'MacBookPro17,1', + ], + 'DeviceVersion' => [ + 'description' => '终端设备操作系统版本。', + 'type' => 'string', + 'example' => '3.5.1', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'InnerIP' => [ + 'description' => '终端设备内网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'SrcIP' => [ + 'description' => '终端设备登录IP地址。', + 'type' => 'string', + 'example' => '11.49.XX.XX', + ], + 'Memory' => [ + 'description' => '终端设备内存容量。单位：GB。', + 'type' => 'string', + 'example' => '16', + ], + 'CPU' => [ + 'description' => '终端设备CPU型号。', + 'type' => 'string', + 'example' => 'Apple M1', + ], + 'Disk' => [ + 'description' => '终端设备磁盘型号。', + 'type' => 'string', + 'example' => 'APPLE SSD AP0512Q Media', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + 'AppVersion' => [ + 'description' => '客户端版本。', + 'type' => 'string', + 'example' => '2.2.0', + ], + 'DeviceBelong' => [ + 'description' => '终端设备归属。取值：'."\n" + .'- **Personal**：个人设备。'."\n" + .'- **Company**：公司设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'SharingStatus' => [ + 'description' => '设备是否开启共享。取值：'."\n" + .'- **true**：开启共享。'."\n" + .'- **false**：关闭共享。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '开启共享', + 'false' => '关闭共享', + ], + 'example' => 'true', + ], + 'DeviceStatus' => [ + 'description' => '终端设备状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。'."\n" + .'- **LongTermOffline**：长期离线。'."\n" + .'- **Locked**：锁定。'."\n" + .'- **Lost**：挂失。'."\n" + .'- **Unbound**：解绑。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Lost' => '挂失', + 'Locked' => '锁定', + 'LongTermOffline' => '长期离线', + 'Offline' => '离线', + 'Unbound' => '解绑', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'AppStatus' => [ + 'description' => '客户端状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'PaStatus' => [ + 'description' => '内网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'IaStatus' => [ + 'description' => '互联网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'DlpStatus' => [ + 'description' => '办公数据保护状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。'."\n" + .'- **Unauthorized**：未授权。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Unauthorized' => '未授权', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'NacStatus' => [ + 'description' => '网络准入状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '终端设备注册时间。', + 'type' => 'string', + 'example' => '2023-07-17 18:46:55', + ], + 'UpdateTime' => [ + 'description' => '终端设备最后在线时间。', + 'type' => 'string', + 'example' => '2023-08-24 19:04:42', + ], + 'EdrStatus' => [ + 'description' => '反入侵状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'NetInterfaceInfo' => [ + 'description' => '终端网卡列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端网卡列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '网卡名称。', + 'type' => 'string', + 'example' => 'eth0', + ], + 'Mac' => [ + 'description' => '网卡MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + ], + ], + ], + 'Workshop' => [ + 'description' => '办公区名称。', + 'type' => 'string', + 'example' => '测试办公区', + ], + 'SnSystem' => [ + 'description' => '系统sn码。', + 'type' => 'string', + 'example' => 'KVN9C9****', + ], + 'SnDiskDrive' => [ + 'description' => '硬盘sn码。', + 'type' => 'string', + 'example' => 'WD-WXR1A99A****', + ], + 'SnBaseBoard' => [ + 'description' => '主板sn码。', + 'type' => 'string', + 'example' => 'PJGGU00WBD****', + ], + 'SnProcessor' => [ + 'description' => '处理器sn码。', + 'type' => 'string', + 'example' => 'BFEBFBFF0008****', + ], + 'SnBios' => [ + 'description' => 'bios系统sn码。', + 'type' => 'string', + 'example' => '5CG003****', + ], + 'AutoLoginStatus' => [ + 'type' => 'string', + ], + 'MatchDeviceGroupIds' => [ + 'description' => '匹配设备组ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '设备组ID。', + 'type' => 'string', + 'example' => 'device-group-5191cf830a5e****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D\\",\\n \\"TotalNum\\": 1,\\n \\"Devices\\": [\\n {\\n \\"DeviceTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DeviceType\\": \\"Windows\\",\\n \\"DeviceModel\\": \\"MacBookPro17,1\\",\\n \\"DeviceVersion\\": \\"3.5.1\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"InnerIP\\": \\"192.168.XX.XX\\",\\n \\"SrcIP\\": \\"11.49.XX.XX\\",\\n \\"Memory\\": \\"16\\",\\n \\"CPU\\": \\"Apple M1\\",\\n \\"Disk\\": \\"APPLE SSD AP0512Q Media\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\",\\n \\"AppVersion\\": \\"2.2.0\\",\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"SharingStatus\\": true,\\n \\"DeviceStatus\\": \\"Online\\",\\n \\"AppStatus\\": \\"Online\\",\\n \\"PaStatus\\": \\"Enabled\\",\\n \\"IaStatus\\": \\"Enabled\\",\\n \\"DlpStatus\\": \\"Enabled\\",\\n \\"NacStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2023-07-17 18:46:55\\",\\n \\"UpdateTime\\": \\"2023-08-24 19:04:42\\",\\n \\"EdrStatus\\": \\"Enabled\\",\\n \\"NetInterfaceInfo\\": [\\n {\\n \\"Name\\": \\"eth0\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\"\\n }\\n ],\\n \\"Workshop\\": \\"测试办公区\\",\\n \\"SnSystem\\": \\"KVN9C9****\\",\\n \\"SnDiskDrive\\": \\"WD-WXR1A99A****\\",\\n \\"SnBaseBoard\\": \\"PJGGU00WBD****\\",\\n \\"SnProcessor\\": \\"BFEBFBFF0008****\\",\\n \\"SnBios\\": \\"5CG003****\\",\\n \\"AutoLoginStatus\\": \\"\\",\\n \\"MatchDeviceGroupIds\\": [\\n \\"device-group-5191cf830a5e****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询用户终端设备', + ], + 'ExportUserDevices' => [ + 'summary' => '导出用户终端设备列表Excel文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197383', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Username', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + ], + [ + 'name' => 'SaseUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'Department', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户所属部门。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + [ + 'name' => 'Hostname', + 'in' => 'formData', + 'schema' => [ + 'description' => '终端设备名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（\\_）、分隔号（/）、at（@）和空格。单独输入下划线（\\_）将额外查询所有名称中带4字节utf-8字符的终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => 'win10-64bit', + ], + ], + [ + 'name' => 'DeviceBelong', + 'in' => 'formData', + 'schema' => [ + 'description' => '终端设备归属。取值：'."\n" + .'- **Personal**：个人设备。'."\n" + .'- **Company**：公司设备。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + ], + [ + 'name' => 'Mac', + 'in' => 'formData', + 'schema' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'required' => false, + 'example' => '00:16:7c:46:**:**', + ], + ], + [ + 'name' => 'SharingStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备是否开启共享。取值：'."\n" + .'- **true**：开启共享。'."\n" + .'- **false**：关闭共享。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '开启共享', + 'false' => '关闭共享', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'DeviceStatuses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。包括长期离线状态。'."\n" + .'- **LongTermOffline**：长期离线。'."\n" + .'- **Locked**：锁定。'."\n" + .'- **Lost**：挂失。'."\n" + .'- **Unbound**：解绑。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Lost' => '挂失', + 'Locked' => '锁定', + 'LongTermOffline' => '长期离线', + 'Offline' => '离线', + 'Unbound' => '解绑', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AppStatuses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '客户端状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PaStatuses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'required' => false, + ], + ], + [ + 'name' => 'IaStatuses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '互联网访问状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '互联网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Disabled', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DlpStatuses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '办公数据保护状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '办公数据保护状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。'."\n" + .'- **Unauthorized**：未授权。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Unauthorized' => '未授权', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'required' => false, + ], + ], + [ + 'name' => 'NacStatuses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '网络准入状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '网络准入状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Unprovisioned', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeviceTypes', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备操作系统类型集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeviceTags', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****'."\n", + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D', + ], + 'SignedUrl' => [ + 'description' => '文件下载URL，有效时间1分钟。', + 'type' => 'string', + 'example' => 'https://sase-export.oss-cn-hangzhou.aliyuncs.com/export%2Fapp-device%2F20240607154831.xlsx?Expires=1717746571&OSSAccessKeyId=********************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D\\",\\n \\"SignedUrl\\": \\"https://sase-export.oss-cn-hangzhou.aliyuncs.com/export%2Fapp-device%2F20240607154831.xlsx?Expires=1717746571&OSSAccessKeyId=********************\\"\\n}","type":"json"}]', + 'title' => '导出用户终端设备列表', + ], + 'GetUserDevice' => [ + 'summary' => '查询当前阿里云账号下用户终端设备详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192474', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DeviceTag', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => true, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'EFE7EBB2-449D-5BBB-B381-CA7839BC1649', + ], + 'Device' => [ + 'description' => '终端设备。', + 'type' => 'object', + 'properties' => [ + 'DeviceTag' => [ + 'description' => '终端设备ID。', + 'type' => 'string', + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'DeviceType' => [ + 'description' => '终端设备操作系统类型。取值：'."\n" + .'- **Windows**：Windows系统。'."\n" + .'- **macOS**：macOS系统。'."\n" + .'- **Linux**：Linux系统。'."\n" + .'- **Android**：Android系统。'."\n" + .'- **iOS**：iOS系统。'."\n" + .'- **Windows_Wuying**：无影云桌面系统。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux系统', + 'Windows_Wuying' => '无影云桌面系统', + 'Windows' => 'Windows系统', + 'iOS' => 'iOS系统', + 'macOS' => 'macOS系统', + 'Android' => 'Android系统', + ], + 'example' => 'Windows', + ], + 'DeviceModel' => [ + 'description' => '终端设备型号。', + 'type' => 'string', + 'example' => 'MacBookPro17,1', + ], + 'DeviceVersion' => [ + 'description' => '终端设备操作系统版本。', + 'type' => 'string', + 'example' => '3.5.1', + ], + 'Hostname' => [ + 'description' => '终端设备名称。', + 'type' => 'string', + 'example' => 'win10-64bit', + ], + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'InnerIP' => [ + 'description' => '终端设备内网IP地址。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'SrcIP' => [ + 'description' => '终端设备登录IP地址。', + 'type' => 'string', + 'example' => '106.14.XX.XX', + ], + 'Memory' => [ + 'description' => '终端设备内存容量。单位：GB。', + 'type' => 'string', + 'example' => '16', + ], + 'CPU' => [ + 'description' => '终端设备CPU型号。', + 'type' => 'string', + 'example' => 'Apple M1', + ], + 'Disk' => [ + 'description' => '终端设备磁盘型号。', + 'type' => 'string', + 'example' => 'APPLE SSD AP0512Q Media', + ], + 'Mac' => [ + 'description' => '终端设备MAC地址。', + 'type' => 'string', + 'example' => '48:9e:XX:XX:02:80', + ], + 'AppVersion' => [ + 'description' => '客户端版本。', + 'type' => 'string', + 'example' => '2.2.0', + ], + 'DeviceBelong' => [ + 'description' => '终端设备归属。取值：'."\n" + .'- **Personal**：个人设备。'."\n" + .'- **Company**：公司设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'SharingStatus' => [ + 'description' => '设备是否开启共享。取值：'."\n" + .'- **true**：开启共享。'."\n" + .'- **false**：关闭共享。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '开启共享', + 'false' => '关闭共享', + ], + 'example' => 'true', + ], + 'DeviceStatus' => [ + 'description' => '终端设备状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。'."\n" + .'- **LongTermOffline**：长期离线。'."\n" + .'- **Locked**：锁定。'."\n" + .'- **Lost**：挂失。'."\n" + .'- **Unbound**：解绑。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Lost' => '挂失', + 'Locked' => '锁定', + 'LongTermOffline' => '长期离线', + 'Offline' => '离线', + 'Unbound' => '解绑', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'AppStatus' => [ + 'description' => '客户端状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'PaStatus' => [ + 'description' => '内网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '在线', + 'Disabled' => '离线', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Enabled', + ], + 'IaStatus' => [ + 'description' => '互联网访问状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Disabled', + ], + 'DlpStatus' => [ + 'description' => '办公数据保护状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。'."\n" + .'- **Unauthorized**：未授权。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Unauthorized' => '未授权', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Unauthorized', + ], + 'NacStatus' => [ + 'description' => '网络准入状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。'."\n" + .'- **Unprovisioned**：未配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + 'Unprovisioned' => '未配置', + ], + 'example' => 'Unprovisioned', + ], + 'CreateTime' => [ + 'description' => '终端设备注册时间。', + 'type' => 'string', + 'example' => '2023-05-16 17:18:46', + ], + 'UpdateTime' => [ + 'description' => '终端设备最后在线时间。', + 'type' => 'string', + 'example' => '2023-08-24 19:04:42', + ], + 'HistoryUsers' => [ + 'description' => '终端设备历史用户集合。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备历史用户。', + 'type' => 'object', + 'properties' => [ + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '张女士', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + ], + ], + 'EdrStatus' => [ + 'description' => '反入侵状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Disabled', + ], + 'AutoLoginStatus' => [ + 'description' => '设备免登状态。取值：'."\n" + ."\n" + .'- 生效中：Enabled。'."\n" + ."\n" + .'- 未生效：Disabled。'."\n" + ."\n" + .'- 未启用：Unprovisioned。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'NetInterfaceInfo' => [ + 'description' => '终端网卡列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端网卡列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '网卡名称。', + 'type' => 'string', + 'example' => 'eth0', + ], + 'Mac' => [ + 'description' => '网卡MAC地址。', + 'type' => 'string', + 'example' => '00:16:XX:XX:7c:46', + ], + ], + ], + ], + 'Workshop' => [ + 'description' => '办公区名称。', + 'type' => 'string', + 'example' => '测试办公区', + ], + 'MatchDeviceGroupIds' => [ + 'description' => '匹配设备组ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '设备组ID。', + 'type' => 'string', + 'example' => 'device-group-5191cf830a5e****', + ], + ], + 'SnSystem' => [ + 'description' => '系统sn码。', + 'type' => 'string', + 'example' => 'KVN9C9****', + ], + 'SnDiskDrive' => [ + 'description' => '硬盘sn码。', + 'type' => 'string', + 'example' => 'WD-WXR1A99A****', + ], + 'SnBaseBoard' => [ + 'description' => '主板sn码。', + 'type' => 'string', + 'example' => 'PJGGU00WBD****', + ], + 'SnProcessor' => [ + 'description' => '处理器sn码。', + 'type' => 'string', + 'example' => 'BFEBFBFF0008****', + ], + 'SnBios' => [ + 'description' => 'bios系统sn码。', + 'type' => 'string', + 'example' => '5CG003****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFE7EBB2-449D-5BBB-B381-CA7839BC1649\\",\\n \\"Device\\": {\\n \\"DeviceTag\\": \\"36efa42d-2c32-c4dc-e3fc-8541e33a****\\",\\n \\"DeviceType\\": \\"Windows\\",\\n \\"DeviceModel\\": \\"MacBookPro17,1\\",\\n \\"DeviceVersion\\": \\"3.5.1\\",\\n \\"Hostname\\": \\"win10-64bit\\",\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"InnerIP\\": \\"172.16.XX.XX\\",\\n \\"SrcIP\\": \\"106.14.XX.XX\\",\\n \\"Memory\\": \\"16\\",\\n \\"CPU\\": \\"Apple M1\\",\\n \\"Disk\\": \\"APPLE SSD AP0512Q Media\\",\\n \\"Mac\\": \\"48:9e:XX:XX:02:80\\",\\n \\"AppVersion\\": \\"2.2.0\\",\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"SharingStatus\\": true,\\n \\"DeviceStatus\\": \\"Online\\",\\n \\"AppStatus\\": \\"Online\\",\\n \\"PaStatus\\": \\"Enabled\\",\\n \\"IaStatus\\": \\"Disabled\\",\\n \\"DlpStatus\\": \\"Unauthorized\\",\\n \\"NacStatus\\": \\"Unprovisioned\\",\\n \\"CreateTime\\": \\"2023-05-16 17:18:46\\",\\n \\"UpdateTime\\": \\"2023-08-24 19:04:42\\",\\n \\"HistoryUsers\\": [\\n {\\n \\"Username\\": \\"张女士\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\"\\n }\\n ],\\n \\"EdrStatus\\": \\"Disabled\\",\\n \\"AutoLoginStatus\\": \\"Enabled\\",\\n \\"NetInterfaceInfo\\": [\\n {\\n \\"Name\\": \\"eth0\\",\\n \\"Mac\\": \\"00:16:XX:XX:7c:46\\"\\n }\\n ],\\n \\"Workshop\\": \\"测试办公区\\",\\n \\"MatchDeviceGroupIds\\": [\\n \\"device-group-5191cf830a5e****\\"\\n ],\\n \\"SnSystem\\": \\"KVN9C9****\\",\\n \\"SnDiskDrive\\": \\"WD-WXR1A99A****\\",\\n \\"SnBaseBoard\\": \\"PJGGU00WBD****\\",\\n \\"SnProcessor\\": \\"BFEBFBFF0008****\\",\\n \\"SnBios\\": \\"5CG003****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询用户终端设备详情', + ], + 'DeleteUserDevices' => [ + 'summary' => '批量删除用户终端设备。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197382', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceTags', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端设备ID集合。最多100条。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => false, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D\\\\n\\"\\n}","type":"json"}]', + 'title' => '批量删除用户终端设备', + 'description' => '单次最多删除100台设备。每台设备的设备状态必须是离线或长期离线状态，若传入的终端设备ID集合中部分设备状态不符，则仅删除状态符合的设备，接口仍返回成功。', + ], + 'ListSoftwareForUserDevice' => [ + 'summary' => '查询当前阿里云账号下用户终端设备安装的软件列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'DeviceTag', + 'in' => 'query', + 'schema' => [ + 'description' => '终端设备ID。取值：'."\n" + .'- [GetUserDevice](~~GetUserDevice~~)：查询用户终端设备详情。'."\n" + .'- [ListUserDevices](~~ListUserDevices~~)：批量查询用户终端设备。', + 'type' => 'string', + 'required' => true, + 'example' => '36efa42d-2c32-c4dc-e3fc-8541e33a****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'TotalNum' => [ + 'description' => '终端设备安装的软件总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Software' => [ + 'description' => '终端设备安装的软件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端设备安装的软件。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => '钉钉', + ], + 'Inc' => [ + 'description' => '软件出品公司。', + 'type' => 'string', + 'example' => 'Alibaba (China) Network Technology Co.,Ltd.', + ], + 'Versions' => [ + 'description' => '软件版本集合。', + 'type' => 'array', + 'items' => [ + 'description' => '软件版本。', + 'type' => 'string', + 'example' => '7.0.40', + ], + ], + 'InstallTime' => [ + 'description' => '软件安装时间。', + 'type' => 'string', + 'example' => '2023-08-18 02:43:02', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"TotalNum\\": 1,\\n \\"Software\\": [\\n {\\n \\"Name\\": \\"钉钉\\",\\n \\"Inc\\": \\"Alibaba (China) Network Technology Co.,Ltd.\\",\\n \\"Versions\\": [\\n \\"7.0.40\\"\\n ],\\n \\"InstallTime\\": \\"2023-08-18 02:43:02\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询用户终端设备安装软件', + ], + 'ListRegistrationPolicies' => [ + 'summary' => '查询当前阿里云账号下设备注册策略列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasAPE6DH', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '设备注册策略名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'registration_policy_name', + ], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + [ + 'name' => 'CompanyLimitType', + 'in' => 'query', + 'schema' => [ + 'description' => '公司设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitAll', + ], + ], + [ + 'name' => 'PersonalLimitType', + 'in' => 'query', + 'schema' => [ + 'description' => '个人设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitDiff', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'MatchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'UserGroupNormal' => '关联部分用户组', + 'UserGroupAll' => '关联全体用户', + ], + 'example' => 'UserGroupAll', + ], + ], + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '设备注册策略ID集合。最多可输入100个设备注册策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略ID。取值来源：'."\n" + .'- [ListRegistrationPolicies](~~ListRegistrationPolicies~~)：批量查询设备注册策略。'."\n" + .'- [GetRegistrationPolicy](~~GetRegistrationPolicy~~)：查询设备注册策略详情。'."\n" + .'- [CreateRegistrationPolicy](~~CreateRegistrationPolicy~~)：创建设备注册策略。'."\n" + .'- [UpdateRegistrationPolicy](~~UpdateRegistrationPolicy~~)：更新设备注册策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'reg-policy-63b2f1844b86****', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7A8FE38A-E29C-5678-B84A-FEDBCB83552F', + ], + 'TotalNum' => [ + 'description' => '设备注册策略总数。', + 'type' => 'string', + 'example' => '1', + ], + 'Policies' => [ + 'description' => '设备注册策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设备注册策略名称。', + 'type' => 'string', + 'example' => 'registration_policy_name', + ], + 'PolicyId' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-dcbfd33cb004****', + ], + 'Description' => [ + 'description' => '设备注册策略描述。', + 'type' => 'string', + 'example' => '这是一条设备注册策略。', + ], + 'Priority' => [ + 'description' => '设备注册策略优先级。数字0表示优先级最高，数字99表示优先级最低。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Whitelist' => [ + 'description' => '设备注册策略白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略白名单用户。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + 'Status' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'MatchMode' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'UserGroupNormal' => '关联部分用户组', + 'UserGroupAll' => '关联全体用户', + ], + 'example' => 'UserGroupNormal', + ], + 'UserGroupIds' => [ + 'description' => '设备注册策略，用户组ID集合。当策略匹配目标类型为**UserGroupNormal**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略，策略匹配目标类型为**UserGroupNormal**时的用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-086bcf2d650b****', + ], + ], + 'CreateTime' => [ + 'description' => '设备注册策略创建时间。', + 'type' => 'string', + 'example' => '2023-05-16 17:18:46', + ], + 'LimitDetail' => [ + 'description' => '设备注册策略限制详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略限制详情。', + 'type' => 'object', + 'properties' => [ + 'DeviceBelong' => [ + 'description' => '设备归属。取值：'."\n" + .'- **Company**：公司设备。'."\n" + .'- **Personal**：个人设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'LimitType' => [ + 'description' => '设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitAll', + ], + 'LimitCount' => [ + 'description' => '设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '设备注册限制总数。当设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PC' => [ + 'description' => '设备注册限制PC端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Mobile' => [ + 'description' => '设备注册限制移动端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A8FE38A-E29C-5678-B84A-FEDBCB83552F\\",\\n \\"TotalNum\\": \\"1\\",\\n \\"Policies\\": [\\n {\\n \\"Name\\": \\"registration_policy_name\\",\\n \\"PolicyId\\": \\"reg-policy-dcbfd33cb004****\\",\\n \\"Description\\": \\"这是一条设备注册策略。\\",\\n \\"Priority\\": 1,\\n \\"Whitelist\\": [\\n \\"王先生\\"\\n ],\\n \\"Status\\": \\"Enabled\\",\\n \\"MatchMode\\": \\"UserGroupNormal\\",\\n \\"UserGroupIds\\": [\\n \\"usergroup-086bcf2d650b****\\"\\n ],\\n \\"CreateTime\\": \\"2023-05-16 17:18:46\\",\\n \\"LimitDetail\\": [\\n {\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"LimitType\\": \\"LimitAll\\",\\n \\"LimitCount\\": {\\n \\"All\\": 3,\\n \\"PC\\": 0,\\n \\"Mobile\\": 0\\n }\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询设备注册策略', + 'responseParamsDescription' => '策略列表按照优先级从高至低、创建时间由晚至早的顺序返回。', + ], + 'ListUserGroupsForRegistrationPolicy' => [ + 'summary' => '查询当前阿里云账号下设备注册策略相关用户组。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasAPE6DH', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '设备注册策略ID集合。最多可输入100个设备注册策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略ID。取值来源：'."\n" + .'- [ListRegistrationPolicies](~~ListRegistrationPolicies~~)：批量查询设备注册策略。'."\n" + .'- [GetRegistrationPolicy](~~GetRegistrationPolicy~~)：查询设备注册策略详情。'."\n" + .'- [CreateRegistrationPolicy](~~CreateRegistrationPolicy~~)：创建设备注册策略。'."\n" + .'- [UpdateRegistrationPolicy](~~UpdateRegistrationPolicy~~)：更新设备注册策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'reg-policy-63b2f1844b86****'."\n", + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'D89009C7-54C6-51B6-BAE7-3F373920C6BF', + ], + 'Policies' => [ + 'description' => '设备注册策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-f25c9e5872e5****', + ], + 'UserGroups' => [ + 'description' => '设备注册策略的用户组集合。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略的用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'Name' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'user_group_name', + ], + 'Description' => [ + 'description' => '用户组描述。', + 'type' => 'string', + 'example' => '这是一条被设备注册策略引用的用户组。', + ], + 'CreateTime' => [ + 'description' => '用户组创建时间。', + 'type' => 'string', + 'example' => '2022-09-27 18:10:25', + ], + 'Attributes' => [ + 'description' => '用户组属性集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D89009C7-54C6-51B6-BAE7-3F373920C6BF\\",\\n \\"Policies\\": [\\n {\\n \\"PolicyId\\": \\"reg-policy-f25c9e5872e5****\\",\\n \\"UserGroups\\": [\\n {\\n \\"UserGroupId\\": \\"usergroup-6f1ef2fc56b6****\\",\\n \\"Name\\": \\"user_group_name\\",\\n \\"Description\\": \\"这是一条被设备注册策略引用的用户组。\\",\\n \\"CreateTime\\": \\"2022-09-27 18:10:25\\",\\n \\"Attributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询设备注册策略的用户组', + ], + 'ListRegistrationPoliciesForUserGroup' => [ + 'summary' => '查询当前阿里云账号下用户组相关的设备注册策略。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasAPE6DH', + ], + ], + 'parameters' => [ + [ + 'name' => 'UserGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '用户组ID集合。最多可输入100个用户组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'UserGroups' => [ + 'description' => '用户组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'Policies' => [ + 'description' => '设备注册策略集合。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设备注册策略名称。', + 'type' => 'string', + 'example' => 'registration_policy_name', + ], + 'PolicyId' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-dcbfd33cb004****', + ], + 'Description' => [ + 'description' => '设备注册策略描述。', + 'type' => 'string', + 'example' => '这是一条设备注册策略。', + ], + 'Priority' => [ + 'description' => '设备注册策略优先级。数字0表示优先级最高，数字99表示优先级最低。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'Whitelist' => [ + 'description' => '设备注册策略白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略白名单用户。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + 'MatchMode' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'UserGroupNormal' => '关联部分用户组', + 'UserGroupAll' => '关联全体用户', + ], + 'example' => 'UserGroupNormal', + ], + 'CreateTime' => [ + 'description' => '设备注册策略创建时间。', + 'type' => 'string', + 'example' => '2023-05-16 17:18:46', + ], + 'LimitDetail' => [ + 'description' => '设备注册策略限制详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略限制详情。', + 'type' => 'object', + 'properties' => [ + 'DeviceBelong' => [ + 'description' => '设备归属。取值：'."\n" + .'- **Company**：公司设备。'."\n" + .'- **Personal**：个人设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'LimitType' => [ + 'description' => '设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitAll', + ], + 'LimitCount' => [ + 'description' => '设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '设备注册限制总数。当设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'string', + 'example' => '3', + ], + 'PC' => [ + 'description' => '设备注册限制PC端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'string', + 'example' => '0', + ], + 'Mobile' => [ + 'description' => '设备注册限制移动端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"UserGroups\\": [\\n {\\n \\"UserGroupId\\": \\"usergroup-6f1ef2fc56b6****\\",\\n \\"Policies\\": [\\n {\\n \\"Name\\": \\"registration_policy_name\\",\\n \\"PolicyId\\": \\"reg-policy-dcbfd33cb004****\\",\\n \\"Description\\": \\"这是一条设备注册策略。\\",\\n \\"Priority\\": 1,\\n \\"Status\\": \\"Enabled\\",\\n \\"Whitelist\\": [\\n \\"王先生\\"\\n ],\\n \\"MatchMode\\": \\"UserGroupNormal\\",\\n \\"CreateTime\\": \\"2023-05-16 17:18:46\\",\\n \\"LimitDetail\\": [\\n {\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"LimitType\\": \\"LimitAll\\",\\n \\"LimitCount\\": {\\n \\"All\\": \\"3\\",\\n \\"PC\\": \\"0\\",\\n \\"Mobile\\": \\"0\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询用户组的设备注册策略', + ], + 'GetRegistrationPolicy' => [ + 'summary' => '查询当前阿里云账号下设备注册策略详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备注册策略ID。取值来源：'."\n" + .'- [ListRegistrationPolicies](~~ListRegistrationPolicies~~)：批量查询设备注册策略。'."\n" + .'- [GetRegistrationPolicy](~~GetRegistrationPolicy~~)：查询设备注册策略详情。'."\n" + .'- [CreateRegistrationPolicy](~~CreateRegistrationPolicy~~)：创建设备注册策略。'."\n" + .'- [UpdateRegistrationPolicy](~~UpdateRegistrationPolicy~~)：更新设备注册策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'reg-policy-dcbfd33cb004****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '47363C2B-1AAA-5954-8847-0E50FCC54117', + ], + 'Name' => [ + 'description' => '设备注册策略名称。', + 'type' => 'string', + 'example' => 'registration_policy_name', + ], + 'PolicyId' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-dcbfd33cb004****', + ], + 'Description' => [ + 'description' => '设备注册策略描述。', + 'type' => 'string', + 'example' => '这是一条设备注册策略。', + ], + 'Priority' => [ + 'description' => '设备注册策略优先级。数字0表示优先级最高，数字99表示优先级最低。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + ], + 'Whitelist' => [ + 'description' => '设备注册策略白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略白名单用户。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + 'Status' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'MatchMode' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'example' => 'UserGroupAll', + ], + 'UserGroupIds' => [ + 'description' => '设备注册策略，用户组ID集合。当策略匹配目标类型为**UserGroupNormal**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略，策略匹配目标类型为**UserGroupNormal**时的用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-086bcf2d650b****', + ], + ], + 'CreateTime' => [ + 'description' => '设备注册策略创建时间。', + 'type' => 'string', + 'example' => '2023-05-16 17:18:46', + ], + 'LimitDetail' => [ + 'description' => '设备注册策略限制详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略限制详情列表。', + 'type' => 'object', + 'properties' => [ + 'DeviceBelong' => [ + 'description' => '设备归属。取值：'."\n" + .'- **Company**：公司设备。'."\n" + .'- **Personal**：个人设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Personal', + ], + 'LimitType' => [ + 'description' => '设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitDiff', + ], + 'LimitCount' => [ + 'description' => '设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '设备注册限制总数。当设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PC' => [ + 'description' => '设备注册限制PC端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Mobile' => [ + 'description' => '设备注册限制移动端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47363C2B-1AAA-5954-8847-0E50FCC54117\\",\\n \\"Name\\": \\"registration_policy_name\\",\\n \\"PolicyId\\": \\"reg-policy-dcbfd33cb004****\\",\\n \\"Description\\": \\"这是一条设备注册策略。\\",\\n \\"Priority\\": 99,\\n \\"Whitelist\\": [\\n \\"王先生\\"\\n ],\\n \\"Status\\": \\"Enabled\\",\\n \\"MatchMode\\": \\"UserGroupAll\\",\\n \\"UserGroupIds\\": [\\n \\"usergroup-086bcf2d650b****\\"\\n ],\\n \\"CreateTime\\": \\"2023-05-16 17:18:46\\",\\n \\"LimitDetail\\": [\\n {\\n \\"DeviceBelong\\": \\"Personal\\",\\n \\"LimitType\\": \\"LimitDiff\\",\\n \\"LimitCount\\": {\\n \\"All\\": 0,\\n \\"PC\\": 2,\\n \\"Mobile\\": 2\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询设备注册策略详情', + ], + 'DeleteRegistrationPolicies' => [ + 'summary' => '批量删除当前阿里云账号下设备注册策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasAPE6DH', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '设备注册策略ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略ID。取值来源：'."\n" + .'- [ListRegistrationPolicies](~~ListRegistrationPolicies~~)：批量查询设备注册策略。'."\n" + .'- [GetRegistrationPolicy](~~GetRegistrationPolicy~~)：查询设备注册策略详情。'."\n" + .'- [CreateRegistrationPolicy](~~CreateRegistrationPolicy~~)：创建设备注册策略。'."\n" + .'- [UpdateRegistrationPolicy](~~UpdateRegistrationPolicy~~)：更新设备注册策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'reg-policy-63b2f1844b86****'."\n", + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'D6707286-A50E-57B1-B2CF-EFAC59E850D8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6707286-A50E-57B1-B2CF-EFAC59E850D8\\"\\n}","type":"json"}]', + 'title' => '批量删除设备注册策略', + ], + 'UpdateRegistrationPolicy' => [ + 'summary' => '修改当前阿里云账号下设备注册策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasAPE6DH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'registration_policy_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条设备注册策略', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'Whitelist', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '设备注册策略白名单用户列表。最多可输入1000个用户名。必传。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略白名单用户。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略优先级。数字0表示优先级最高，数字99表示优先级最低。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CompanyLimitType', + 'in' => 'formData', + 'schema' => [ + 'description' => '公司设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitAll', + ], + ], + [ + 'name' => 'CompanyLimitCount', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '公司设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '公司设备注册限制总数。取值范围为0～100，默认为0。当公司设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PC' => [ + 'description' => '公司设备注册限制PC端登录数量。取值范围为0～100，默认为0。当公司设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Mobile' => [ + 'description' => '公司设备注册限制移动端登录数量。取值范围为0～100，默认为0。当公司设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PersonalLimitType', + 'in' => 'formData', + 'schema' => [ + 'description' => '个人设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitDiff', + ], + ], + [ + 'name' => 'PersonalLimitCount', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '个人设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '个人设备注册限制总数。取值范围为0～100，默认为0。当个人设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'PC' => [ + 'description' => '个人设备注册限制PC端登录数量。取值范围为0～100，默认为0。当个人设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Mobile' => [ + 'description' => '个人设备注册限制移动端登录数量。取值范围为0～100，默认为0。当个人设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MatchMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'UserGroupNormal' => '关联部分用户组', + 'UserGroupAll' => '关联全体用户', + ], + 'example' => 'UserGroupNormal', + ], + ], + [ + 'name' => 'UserGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '设备注册策略的用户组ID集合，当策略匹配目标类型为**UserGroupNormal**时，必填。单个策略的用户组最大支持100个。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略，策略匹配目标类型为**UserGroupNormal**时的用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-086bcf2d650b****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略ID。取值来源：'."\n" + .'- [ListRegistrationPolicies](~~ListRegistrationPolicies~~)：批量查询设备注册策略。'."\n" + .'- [GetRegistrationPolicy](~~GetRegistrationPolicy~~)：查询设备注册策略详情。'."\n" + .'- [CreateRegistrationPolicy](~~CreateRegistrationPolicy~~)：创建设备注册策略。'."\n" + .'- [UpdateRegistrationPolicy](~~UpdateRegistrationPolicy~~)：更新设备注册策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'reg-policy-63b2f1844b86****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '27064ECA-0936-59F3-8A98-EC821E5BD08F', + ], + 'Policy' => [ + 'description' => '设备注册策略。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设备注册策略名称。', + 'type' => 'string', + 'example' => 'registration_policy_name', + ], + 'PolicyId' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => '设备注册策略ID', + ], + 'Priority' => [ + 'description' => '设备注册策略优先级。数字0表示优先级最高，数字99表示优先级最低。', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'description' => '设备注册策略描述。', + 'type' => 'string', + 'example' => '这是一条设备注册策略', + ], + 'Whitelist' => [ + 'description' => '设备注册策略白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略白名单用户。', + 'type' => 'string', + 'example' => '韩梅梅', + ], + ], + 'Status' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'MatchMode' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'UserGroupNormal' => '关联部分用户组', + 'UserGroupAll' => '关联全体用户', + ], + 'example' => 'UserGroupNormal', + ], + 'UserGroupIds' => [ + 'description' => '设备注册策略，用户组ID集合。当策略匹配目标类型为**UserGroupNormal**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略，策略匹配目标类型为**UserGroupNormal**时的用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-086bcf2d650b****', + ], + ], + 'CreateTime' => [ + 'description' => '设备注册策略创建时间。', + 'type' => 'string', + 'example' => '2023-05-16 17:18:46', + ], + 'LimitDetail' => [ + 'description' => '设备注册策略限制详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略限制详情。', + 'type' => 'object', + 'properties' => [ + 'DeviceBelong' => [ + 'description' => '设备归属。取值：'."\n" + .'- **Company**：公司设备。'."\n" + .'- **Personal**：个人设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'LimitType' => [ + 'description' => '设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitAll', + ], + 'LimitCount' => [ + 'description' => '设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '设备注册限制总数。当设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PC' => [ + 'description' => '设备注册限制PC端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Mobile' => [ + 'description' => '设备注册限制移动端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27064ECA-0936-59F3-8A98-EC821E5BD08F\\",\\n \\"Policy\\": {\\n \\"Name\\": \\"registration_policy_name\\",\\n \\"PolicyId\\": \\"设备注册策略ID\\",\\n \\"Priority\\": \\"1\\",\\n \\"Description\\": \\"这是一条设备注册策略\\",\\n \\"Whitelist\\": [\\n \\"韩梅梅\\"\\n ],\\n \\"Status\\": \\"Enabled\\",\\n \\"MatchMode\\": \\"UserGroupNormal\\",\\n \\"UserGroupIds\\": [\\n \\"usergroup-086bcf2d650b****\\"\\n ],\\n \\"CreateTime\\": \\"2023-05-16 17:18:46\\",\\n \\"LimitDetail\\": [\\n {\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"LimitType\\": \\"LimitAll\\",\\n \\"LimitCount\\": {\\n \\"All\\": 1,\\n \\"PC\\": 0,\\n \\"Mobile\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '修改设备注册策略', + ], + 'CreateRegistrationPolicy' => [ + 'summary' => '创建当前阿里云账号下设备注册策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsasAPE6DH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'registration_policy_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条设备注册策略', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'Whitelist', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '设备注册策略白名单用户列表。最多可输入1000个用户名。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略白名单用户。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备注册策略优先级。数字0表示优先级最高，数字99表示优先级最低。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '99', + ], + ], + [ + 'name' => 'CompanyLimitType', + 'in' => 'formData', + 'schema' => [ + 'description' => '公司设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitAll', + ], + ], + [ + 'name' => 'CompanyLimitCount', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '公司设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '公司设备注册限制总数。取值范围为0～100，默认为0。当公司设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PC' => [ + 'description' => '公司设备注册限制PC端登录数量。取值范围为0～100，默认为0。当公司设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Mobile' => [ + 'description' => '公司设备注册限制移动端登录数量。取值范围为0～100，默认为0。当公司设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PersonalLimitType', + 'in' => 'formData', + 'schema' => [ + 'description' => '个人设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitDiff', + ], + ], + [ + 'name' => 'PersonalLimitCount', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '个人设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '个人设备注册限制总数。取值范围为0～100，默认为0。当个人设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'PC' => [ + 'description' => '个人设备注册限制PC端登录数量。取值范围为0～100，默认为0。当个人设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Mobile' => [ + 'description' => '个人设备注册限制移动端登录数量。取值范围为0～100，默认为0。当个人设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MatchMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'UserGroupNormal' => '关联部分用户组', + 'UserGroupAll' => '关联全体用户', + ], + 'example' => 'UserGroupAll', + ], + ], + [ + 'name' => 'UserGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '设备注册策略的用户组ID集合，当策略匹配目标类型为**UserGroupNormal**时必填。单个策略的用户组最大支持100个。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略，策略匹配目标类型为**UserGroupNormal**时的用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-086bcf2d650b****', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE', + ], + 'Policy' => [ + 'description' => '设备注册策略。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设备注册策略名称。', + 'type' => 'string', + 'example' => 'registration_policy_name', + ], + 'PolicyId' => [ + 'description' => '设备注册策略ID。', + 'type' => 'string', + 'example' => 'reg-policy-dcbfd33cb004****', + ], + 'Priority' => [ + 'description' => '设备注册策略优先级。数字0表示优先级最高，数字99表示优先级最低。', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'description' => '设备注册策略描述。', + 'type' => 'string', + 'example' => '这是一条设备注册策略', + ], + 'Whitelist' => [ + 'description' => '设备注册策略白名单用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略白名单用户。', + 'type' => 'string', + 'example' => '王先生', + ], + ], + 'Status' => [ + 'description' => '设备注册策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'MatchMode' => [ + 'description' => '策略匹配目标类型。取值：'."\n" + .'- **UserGroupAll**：关联全体用户。'."\n" + .'- **UserGroupNormal**：关联部分用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'UserGroupNormal' => '关联部分用户组', + 'UserGroupAll' => '关联全体用户', + ], + 'example' => 'UserGroupNormal', + ], + 'UserGroupIds' => [ + 'description' => '设备注册策略，用户组ID集合。当策略匹配目标类型为**UserGroupNormal**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略，策略匹配目标类型为**UserGroupNormal**时的用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-086bcf2d650b****', + ], + ], + 'CreateTime' => [ + 'description' => '设备注册策略创建时间。', + 'type' => 'string', + 'example' => '2023-05-16 17:18:46', + ], + 'LimitDetail' => [ + 'description' => '设备注册策略限制详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备注册策略限制详情。', + 'type' => 'object', + 'properties' => [ + 'DeviceBelong' => [ + 'description' => '设备归属。取值：'."\n" + .'- **Company**：公司设备。'."\n" + .'- **Personal**：个人设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Company' => '公司设备', + 'Personal' => '个人设备', + ], + 'example' => 'Company', + ], + 'LimitType' => [ + 'description' => '设备注册限制类型。取值：'."\n" + .'- **Unlimited**：不限制。'."\n" + .'- **LimitAll**：按照总数限制。'."\n" + .'- **LimitDiff**：按照终端分类限制。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LimitAll' => '按照总数限制', + 'LimitDiff' => '按照终端分类限制', + 'Unlimited' => '不限制', + ], + 'example' => 'LimitDiff', + ], + 'LimitCount' => [ + 'description' => '设备注册限制数量。', + 'type' => 'object', + 'properties' => [ + 'All' => [ + 'description' => '设备注册限制总数。当设备注册限制类型为**LimitAll**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PC' => [ + 'description' => '设备注册限制PC端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Mobile' => [ + 'description' => '设备注册限制移动端登录数量。当设备注册限制类型为**LimitDiff**时，该字段的值有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE\\",\\n \\"Policy\\": {\\n \\"Name\\": \\"registration_policy_name\\",\\n \\"PolicyId\\": \\"reg-policy-dcbfd33cb004****\\",\\n \\"Priority\\": \\"1\\",\\n \\"Description\\": \\"这是一条设备注册策略\\",\\n \\"Whitelist\\": [\\n \\"王先生\\"\\n ],\\n \\"Status\\": \\"Enabled\\",\\n \\"MatchMode\\": \\"UserGroupNormal\\",\\n \\"UserGroupIds\\": [\\n \\"usergroup-086bcf2d650b****\\"\\n ],\\n \\"CreateTime\\": \\"2023-05-16 17:18:46\\",\\n \\"LimitDetail\\": [\\n {\\n \\"DeviceBelong\\": \\"Company\\",\\n \\"LimitType\\": \\"LimitDiff\\",\\n \\"LimitCount\\": {\\n \\"All\\": 0,\\n \\"PC\\": 2,\\n \\"Mobile\\": 3\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '创建设备注册策略', + ], + 'ListUserGroups' => [ + 'summary' => '批量查询当前阿里云账号下所有用户组的信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'UserGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '用户组ID集合。最多可输入100个用户组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_group_name', + ], + ], + [ + 'name' => 'AttributeValue', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组属性的值。长度为1~128个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'username', + ], + ], + [ + 'name' => 'PAPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-policy-54a7838a48bf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4AB972E2-D702-5464-B132-B1911498B8BF', + ], + 'TotalNum' => [ + 'description' => '用户组的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UserGroups' => [ + 'description' => '用户组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'Name' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'user_group_name', + ], + 'Description' => [ + 'description' => '用户组描述。', + 'type' => 'string', + 'example' => '这是一条用户组', + ], + 'Attributes' => [ + 'description' => '用户组属性集合。多个用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '用户组创建时间。', + 'type' => 'string', + 'example' => '2022-10-10 11:39:22', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AB972E2-D702-5464-B132-B1911498B8BF\\",\\n \\"TotalNum\\": 1,\\n \\"UserGroups\\": [\\n {\\n \\"UserGroupId\\": \\"usergroup-6f1ef2fc56b6****\\",\\n \\"Name\\": \\"user_group_name\\",\\n \\"Description\\": \\"这是一条用户组\\",\\n \\"Attributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"CreateTime\\": \\"2022-10-10 11:39:22\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询用户组', + ], + 'ListPolicesForUserGroup' => [ + 'summary' => '批量查询当前阿里云账号下用户组的策略。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'UserGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '用户组ID集合。最多可输入100个用户组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '5F04DFBD-3F48-5F70-AE72-474026670128', + ], + 'UserGroups' => [ + 'description' => '用户组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'Polices' => [ + 'description' => '策略集合。', + 'type' => 'array', + 'items' => [ + 'description' => '策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-ce2bf7236fab****', + ], + 'PolicyType' => [ + 'description' => '策略类型。取值：'."\n" + .'- **PrivateAccess**：内网访问。'."\n" + .'- **URLFilter：URL**防护。'."\n" + .'- **AppAccessControl**：应用管控。'."\n" + .'- **DLP**：数据防泄漏。'."\n" + .'- **NAC**：网络准入。', + 'type' => 'string', + 'enumValueTitles' => [ + 'NAC' => '网络准入', + 'URLFilter' => 'URL防护', + 'DLP' => '数据防泄漏', + 'PrivateAccess' => '内网访问', + 'AppAccessControl' => '应用管控', + ], + 'example' => 'PrivateAccess', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'private_access_policy_name', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5F04DFBD-3F48-5F70-AE72-474026670128\\",\\n \\"UserGroups\\": [\\n {\\n \\"UserGroupId\\": \\"usergroup-6f1ef2fc56b6****\\",\\n \\"Polices\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-ce2bf7236fab****\\",\\n \\"PolicyType\\": \\"PrivateAccess\\",\\n \\"Name\\": \\"private_access_policy_name\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询用户组的策略', + ], + 'GetUserGroup' => [ + 'summary' => '查询当前阿里云账号下的用户组详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => true, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '1310DBC7-7E1F-55D3-B4B4-E4BE912517FB', + ], + 'UserGroup' => [ + 'description' => '用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'Name' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'user_group_name', + ], + 'Description' => [ + 'description' => '用户组描述。', + 'type' => 'string', + 'example' => '这是一条用户组'."\n", + ], + 'Attributes' => [ + 'description' => '用户组属性集合。多个用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '用户组创建时间。', + 'type' => 'string', + 'example' => '2022-10-10 11:39:22', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'UserGroup.NotFound', + 'errorMessage' => 'The userGroup is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1310DBC7-7E1F-55D3-B4B4-E4BE912517FB\\",\\n \\"UserGroup\\": {\\n \\"UserGroupId\\": \\"usergroup-6f1ef2fc56b6****\\",\\n \\"Name\\": \\"user_group_name\\",\\n \\"Description\\": \\"这是一条用户组\\\\n\\",\\n \\"Attributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"CreateTime\\": \\"2022-10-10 11:39:22\\"\\n }\\n}","type":"json"}]', + 'title' => '查询用户组详情', + ], + 'CreateUserGroup' => [ + 'summary' => '创建当前阿里云账号下用户组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163587', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_group_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条用户组', + ], + ], + [ + 'name' => 'Attributes', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '用户组属性集合。最大数量3000个。多个用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'required' => true, + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"UserGroupId\\": \\"usergroup-6f1ef2fc56b6****\\"\\n}","type":"json"}]', + 'title' => '创建用户组', + 'description' => '默认最多可创建500个用户组。', + ], + 'DeleteUserGroup' => [ + 'summary' => '删除当前阿里云账号下用户组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163604', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'UserGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => true, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UserGroup.UsedByPolicy', + 'errorMessage' => 'The userGroup is used by policy.', + ], + ], + 404 => [ + [ + 'errorCode' => 'UserGroup.NotFound', + 'errorMessage' => 'The userGroup is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\"\\n}","type":"json"}]', + 'title' => '删除用户组', + 'description' => '当存在策略引用时，不允许删除。'."\n" + .'参考：'."\n" + .'- [ListPolicesForUserGroup](~~ListPolicesForUserGroup~~)：批量查询用户组的策略。', + ], + 'UpdateUserGroup' => [ + 'summary' => '修改当前阿里云账号下用户组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163597', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'UserGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => true, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条用户组'."\n", + ], + ], + [ + 'name' => 'Attributes', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '用户组属性集合。最大总数3000个。多个用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'required' => true, + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组的修改类型。取值：'."\n" + .'- **Cover**（默认）：使用**Attributes**参数的值覆盖原用户组属性集合。'."\n" + .'- **Append**：在用户组属性集合中分别增加**Attributes**参数中输入的值。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Cover' => '覆盖', + 'Append' => '附加', + ], + 'example' => 'Cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'FD724DBC-CD76-5235-BF76-59C51B73296D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'UserGroup.NotFound', + 'errorMessage' => 'The userGroup is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD724DBC-CD76-5235-BF76-59C51B73296D\\"\\n}","type":"json"}]', + 'title' => '修改用户组', + ], + 'ListUserPrivateAccessPolicies' => [ + 'summary' => '列表查询用户零信任策略。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248706', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SaseUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。取值范围：1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'private_access_policy_name'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request.', + 'type' => 'string', + 'example' => '9D852F87-AFB5-51B8-AACD-F7D0EFB8277D', + ], + 'TotalNum' => [ + 'description' => '被授权访问的策略总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Polices' => [ + 'description' => '被授权访问的策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-1b0d0e8b4bcf****', + ], + 'Name' => [ + 'description' => '内网访问策略名称。', + 'type' => 'string', + 'example' => 'private_access_policy_name', + ], + 'Priority' => [ + 'description' => '内网访问策略优先级。数字1表示优先级最高。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PolicyAction' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + 'UserGroupMode' => [ + 'description' => '内网访问策略的用户组类型。取值：'."\n" + .'- **Normal**：普通用户组。'."\n" + .'- **Custom**：自定义用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义用户组', + 'Normal' => '普通用户组', + ], + 'example' => 'Custom', + ], + 'MatchedUserGroup' => [ + 'description' => '所属用户组。', + 'type' => 'string', + 'example' => 'user_group_name', + ], + 'DeviceAttributeName' => [ + 'description' => '关联的安全基线。', + 'type' => 'string', + 'example' => 'device_attribute_name', + ], + 'CustomUserAttributes' => [ + 'description' => '自定义用户组属性集合。多个自定义用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'TrustedSoftwareIds' => [ + 'description' => '可信软件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可信软件ID。', + 'type' => 'string', + 'example' => 'swb-xxxxxxx', + ], + ], + 'TrustedProcessGroupIds' => [ + 'description' => '可信进程组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可信进程组ID。', + 'type' => 'string', + 'example' => 'pg-xdxxxxxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D852F87-AFB5-51B8-AACD-F7D0EFB8277D\\",\\n \\"TotalNum\\": 20,\\n \\"Polices\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-1b0d0e8b4bcf****\\",\\n \\"Name\\": \\"private_access_policy_name\\",\\n \\"Priority\\": 1,\\n \\"PolicyAction\\": \\"Allow\\",\\n \\"UserGroupMode\\": \\"Custom\\",\\n \\"MatchedUserGroup\\": \\"user_group_name\\",\\n \\"DeviceAttributeName\\": \\"device_attribute_name\\",\\n \\"CustomUserAttributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"TrustedSoftwareIds\\": [\\n \\"swb-xxxxxxx\\"\\n ],\\n \\"TrustedProcessGroupIds\\": [\\n \\"pg-xdxxxxxx\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询用户零信任策略', + ], + 'ListUserApplications' => [ + 'summary' => '查询当前阿里云账号下登录用户的应用权限。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '248619', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SaseUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'private_access_application_name', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'TotalNum' => [ + 'description' => '被授权访问的应用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Applications' => [ + 'description' => '被授权访问的应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'private_access_application_name', + ], + 'ApplicationId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'pa-application-b927baf3e592****', + ], + 'Protocol' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**：TCP'."\n" + .'- **UDP**：UDP'."\n" + .'- **HTTP**: HTTP'."\n" + .'- **HTTPS**: HTTPS', + 'type' => 'string', + 'enumValueTitles' => [ + 'TCP' => 'TCP', + 'UDP' => 'UDP', + 'ALL' => '全部', + 'HTTPS' => 'HTTPS', + 'HTTP' => 'HTTP', + ], + 'example' => 'TCP', + ], + 'Action' => [ + 'description' => '内网应用访问动作：'."\n" + .'- **Block**: 阻断。'."\n" + .'- **Allow**: 允许', + 'type' => 'string', + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Block', + ], + 'Addresses' => [ + 'description' => '内网访问应用地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。长度为1~128个字符，支持IPv4地址、CIDR、域名、泛域名。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + 'PortRanges' => [ + 'description' => '内网访问应用端口范围集合。多个端口范围不可重复或重叠。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。取值：1~65535。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。', + 'type' => 'string', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。', + 'type' => 'string', + 'example' => '81', + ], + ], + ], + ], + 'ConfigMode' => [ + 'title' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。', + 'description' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。', + 'type' => 'string', + ], + 'AddressGroups' => [ + 'title' => '应用地址组。在ConfigMode为Precise时返回；在ConfigMode为空字符串时为空。', + 'description' => '应用地址组。在ConfigMode为Precise时返回；在ConfigMode为空字符串时为空。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/AddressGroup', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"TotalNum\\": 20,\\n \\"Applications\\": [\\n {\\n \\"Name\\": \\"private_access_application_name\\",\\n \\"ApplicationId\\": \\"pa-application-b927baf3e592****\\",\\n \\"Protocol\\": \\"TCP\\",\\n \\"Action\\": \\"Block\\",\\n \\"Addresses\\": [\\n \\"192.168.0.0/16\\"\\n ],\\n \\"PortRanges\\": [\\n {\\n \\"Begin\\": \\"80\\",\\n \\"End\\": \\"81\\"\\n }\\n ],\\n \\"ConfigMode\\": \\"\\",\\n \\"AddressGroups\\": [\\n {\\n \\"Addresses\\": [\\n \\"\\"\\n ],\\n \\"Ports\\": [\\n {\\n \\"Begin\\": 0,\\n \\"End\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询用户内网应用', + ], + 'ListUsers' => [ + 'summary' => '查询当前阿里云账号下登录用户列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'FuzzyUsername', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊匹配用户名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生', + ], + ], + [ + 'name' => 'PreciseUsername', + 'in' => 'query', + 'schema' => [ + 'description' => '精确匹配用户名。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '王先生@alibaba.com', + ], + ], + [ + 'name' => 'SaseUserIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '用户ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID。取值来源：'."\n" + ."\n" + .'ListUsers：批量查询登录用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '用户状态。取值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：禁用。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '启用', + 'Disabled' => '禁用', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'Department', + 'in' => 'query', + 'schema' => [ + 'description' => '用户所属部门。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、半角逗号（,）、半角分号（;）、短划线（-）、下划线（_）、分隔号（/）、at（@）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '测试部', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D', + ], + 'TotalNum' => [ + 'description' => '用户总数。', + 'type' => 'string', + 'example' => '1', + ], + 'Users' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户。', + 'type' => 'object', + 'properties' => [ + 'Username' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '王先生', + ], + 'SaseUserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'Department' => [ + 'description' => '用户所属部门。', + 'type' => 'string', + 'example' => '测试部', + ], + 'Email' => [ + 'description' => '用户邮箱。', + 'type' => 'string', + 'example' => 'a***@example.net', + ], + 'Phone' => [ + 'description' => '用户手机号码。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'Status' => [ + 'description' => '用户状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '启用', + 'Disabled' => '禁用', + ], + 'example' => 'Enabled', + ], + 'IdpName' => [ + 'description' => '用户身份源名称。', + 'type' => 'string', + 'example' => '飞书', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D\\",\\n \\"TotalNum\\": \\"1\\",\\n \\"Users\\": [\\n {\\n \\"Username\\": \\"王先生\\",\\n \\"SaseUserId\\": \\"su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****\\",\\n \\"Department\\": \\"测试部\\",\\n \\"Email\\": \\"a***@example.net\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"IdpName\\": \\"飞书\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询用户', + ], + 'UpdateUsersStatus' => [ + 'summary' => '批量修改当前阿里云账号下登录用户的状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'SaseUserIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '用户ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID。取值来源：'."\n" + ."\n" + .' ListUsers：批量查询登录用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '登录用户状态。取值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：禁用。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Enabled' => '启用', + 'Disabled' => '禁用', + ], + 'example' => 'Enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '47363C2B-1AAA-5954-8847-0E50FCC54117', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47363C2B-1AAA-5954-8847-0E50FCC54117\\"\\n}","type":"json"}]', + 'title' => '批量修改用户状态', + ], + 'ListPrivateAccessApplications' => [ + 'summary' => '批量查询当前阿里云账号下所有内网访问应用的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163590', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'private_access_application_name', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用地址。长度为1~128个字符，支持IPv4地址、CIDR、域名、泛域名。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.0/16', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问应用ID集合。最多可输入100个内网访问应用ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-e12860ef6c48****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-policy-54a7838a48bf****', + ], + ], + [ + 'name' => 'ConnectorId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ConnectorID。取值来源：[ListConnectors](~~ListConnectors~~)批量查询Connector。', + 'type' => 'string', + 'required' => false, + 'example' => 'connector-94db94e06b98****', + ], + ], + [ + 'name' => 'AccessModes', + 'in' => 'query', + 'schema' => [ + 'description' => '访问模式。取值：'."\n" + .'- **app**：应用访问，筛选支持应用访问的应用。'."\n" + .'- **browser**：浏览器访问，筛选支持浏览器访问的应用。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'app' => '应用访问', + 'browser' => '浏览器访问', + ], + 'example' => 'app', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D', + ], + 'TotalNum' => [ + 'description' => '内网访问应用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Applications' => [ + 'description' => '内网访问应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****', + ], + 'Name' => [ + 'description' => '内网访问应用名称。', + 'type' => 'string', + 'example' => 'private_access_application_name', + ], + 'Description' => [ + 'description' => '内网访问应用描述。', + 'type' => 'string', + 'example' => '这是一条内网访问应用', + ], + 'Addresses' => [ + 'description' => '内网访问应用地址集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。长度为1~128个字符，支持IPv4地址、CIDR、域名、泛域名。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + 'PortRanges' => [ + 'description' => '内网访问应用端口范围集合。多个端口范围不可重复或重叠。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。取值：1~65535。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '81', + ], + ], + ], + ], + 'Protocol' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => 'All', + 'TCP' => 'TCP', + 'UDP' => 'UDP', + ], + 'example' => 'All', + ], + 'Status' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '内网访问应用创建时间。', + 'type' => 'string', + 'example' => '2022-12-16 15:03:42', + ], + 'TagIds' => [ + 'description' => '内网访问标签ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + 'PolicyIds' => [ + 'description' => '内网访问策略ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-54a7838a48bf****', + ], + ], + 'ConnectorIds' => [ + 'description' => 'ConnectorID集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'ConnectorID。', + 'type' => 'string', + 'example' => 'connector-94db94e06b98****', + ], + ], + 'BrowserAccessStatus' => [ + 'description' => '浏览器访问模式。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'L7ProxyDomainAutomatic' => [ + 'description' => '浏览器访问模式参数：映射代理域名。', + 'type' => 'string', + 'example' => 'app1-xxx.at.cloudssecsase.com', + ], + 'L7ProxyDomainCustom' => [ + 'description' => '浏览器访问模式参数：自定代理域名。', + 'type' => 'string', + 'example' => 'app1.example.com', + ], + 'AutoGenerated' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ConfigMode' => [ + 'title' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。', + 'description' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。', + 'type' => 'string', + ], + 'AddressGroups' => [ + 'title' => '应用地址组。在ConfigMode为Precise时返回；在ConfigMode为空字符串时为空。', + 'description' => '应用地址组。在ConfigMode为Precise时返回；在ConfigMode为空字符串时为空。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/AddressGroup', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D\\",\\n \\"TotalNum\\": 1,\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"pa-application-e12860ef6c48****\\",\\n \\"Name\\": \\"private_access_application_name\\",\\n \\"Description\\": \\"这是一条内网访问应用\\",\\n \\"Addresses\\": [\\n \\"192.168.0.0/16\\"\\n ],\\n \\"PortRanges\\": [\\n {\\n \\"Begin\\": 80,\\n \\"End\\": 81\\n }\\n ],\\n \\"Protocol\\": \\"All\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2022-12-16 15:03:42\\",\\n \\"TagIds\\": [\\n \\"tag-d3f64e8bdd4a****\\"\\n ],\\n \\"PolicyIds\\": [\\n \\"pa-policy-54a7838a48bf****\\"\\n ],\\n \\"ConnectorIds\\": [\\n \\"connector-94db94e06b98****\\"\\n ],\\n \\"BrowserAccessStatus\\": \\"Enabled\\",\\n \\"L7ProxyDomainAutomatic\\": \\"app1-xxx.at.cloudssecsase.com\\",\\n \\"L7ProxyDomainCustom\\": \\"app1.example.com\\",\\n \\"AutoGenerated\\": 0,\\n \\"ConfigMode\\": \\"\\",\\n \\"AddressGroups\\": [\\n {\\n \\"Addresses\\": [\\n \\"\\"\\n ],\\n \\"Ports\\": [\\n {\\n \\"Begin\\": 0,\\n \\"End\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问应用', + ], + 'ListTagsForPrivateAccessApplication' => [ + 'summary' => '批量查询当前阿里云账号下内网访问应用的标签。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问应用ID集合。最多可输入100个内网访问应用ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-7a4445897856****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7241F45B-E8D3-5BA3-8172-8A58AC2AB0FC', + ], + 'Applications' => [ + 'description' => '内网访问应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-7a4445897856****', + ], + 'Tags' => [ + 'description' => '内网访问标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签。', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-c0cb77857a99****', + ], + 'Name' => [ + 'description' => '内网访问标签名称。', + 'type' => 'string', + 'example' => 'tag_name', + ], + 'Description' => [ + 'description' => '内网访问标签描述。', + 'type' => 'string', + 'example' => '这是一条内网访问标签', + ], + 'TagType' => [ + 'description' => '内网访问标签类型。取值：'."\n" + .'- **Default**：默认。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义', + 'Default' => '默认', + ], + 'example' => 'Default', + ], + 'CreateTime' => [ + 'description' => '内网访问标签创建时间。', + 'type' => 'string', + 'example' => '2022-07-01 16:05:26', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7241F45B-E8D3-5BA3-8172-8A58AC2AB0FC\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"pa-application-7a4445897856****\\",\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"tag-c0cb77857a99****\\",\\n \\"Name\\": \\"tag_name\\",\\n \\"Description\\": \\"这是一条内网访问标签\\",\\n \\"TagType\\": \\"Default\\",\\n \\"CreateTime\\": \\"2022-07-01 16:05:26\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问应用的标签', + ], + 'ListPolicesForPrivateAccessApplication' => [ + 'summary' => '批量查询当前阿里云账号下内网访问应用的策略。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问应用ID集合。最多可输入100个内网访问应用ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-b927baf3e592****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4AB972E2-D702-5464-B132-B1911498B8BF', + ], + 'Applications' => [ + 'description' => '内网访问应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-b927baf3e592****', + ], + 'Policies' => [ + 'description' => '内网访问策略集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-867ef4007c8a****', + ], + 'Name' => [ + 'description' => '内网访问策略名称。', + 'type' => 'string', + 'example' => 'private_access_policy_name'."\n", + ], + 'Description' => [ + 'description' => '内网访问策略描述。', + 'type' => 'string', + 'example' => '这是一条内网访问策略'."\n", + ], + 'PolicyAction' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + 'Priority' => [ + 'description' => '内网访问策略优先级。数字1表示优先级最高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => '内网访问策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'ApplicationType' => [ + 'description' => '内网访问策略的应用类型。取值：'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + 'UserGroupType' => [ + 'description' => '内网访问策略的用户组类型。取值：'."\n" + .'- **Normal**：普通用户组。'."\n" + .'- **Custom**：自定义用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义', + 'Normal' => '普通', + ], + 'example' => 'Normal', + ], + 'CustomUserAttributes' => [ + 'description' => '自定义用户组属性集合。多个自定义用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '内网访问策略创建时间。', + 'type' => 'string', + 'example' => '2022-09-27 18:10:25', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AB972E2-D702-5464-B132-B1911498B8BF\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"pa-application-b927baf3e592****\\",\\n \\"Policies\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-867ef4007c8a****\\",\\n \\"Name\\": \\"private_access_policy_name\\\\n\\",\\n \\"Description\\": \\"这是一条内网访问策略\\\\n\\",\\n \\"PolicyAction\\": \\"Allow\\",\\n \\"Priority\\": 1,\\n \\"Status\\": \\"Enabled\\",\\n \\"ApplicationType\\": \\"Application\\",\\n \\"UserGroupType\\": \\"Normal\\",\\n \\"CustomUserAttributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"CreateTime\\": \\"2022-09-27 18:10:25\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问应用的策略', + ], + 'GetPrivateAccessApplication' => [ + 'summary' => '查询当前阿里云账号下内网访问应用详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163601', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '3ACC5EDC-2B7D-5032-8C58-D7615D66C1D4', + ], + 'Application' => [ + 'description' => '内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****', + ], + 'Name' => [ + 'description' => '内网访问应用名称。', + 'type' => 'string', + 'example' => 'private_access_application_name', + ], + 'Description' => [ + 'description' => '内网访问应用描述。', + 'type' => 'string', + 'example' => '这是一条内网访问应用', + ], + 'Addresses' => [ + 'description' => '内网访问应用地址集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。长度为1~128个字符，支持IPv4地址、CIDR、域名、泛域名。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + 'PortRanges' => [ + 'description' => '内网访问应用端口范围集合。多个端口范围不可重复或重叠。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。取值：1~65535。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '81', + ], + ], + ], + ], + 'Protocol' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**。'."\n" + .'- **UDP**。', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => 'All', + 'TCP' => 'TCP', + 'UDP' => 'UDP', + ], + 'example' => 'All', + ], + 'Status' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '内网访问应用创建时间。', + 'type' => 'string', + 'example' => '2022-08-30 16:50:32', + ], + 'TagIds' => [ + 'description' => '内网访问标签ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + 'PolicyIds' => [ + 'description' => '内网访问策略ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-54a7838a48bf****', + ], + ], + 'ConnectorIds' => [ + 'description' => 'ConnectorID集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'ConnectorID。', + 'type' => 'string', + 'example' => 'connector-94db94e06b98****', + ], + ], + 'BrowserAccessStatus' => [ + 'description' => '浏览器访问模式。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'L7ProxyDomainAutomatic' => [ + 'description' => '浏览器访问模式参数：映射代理域名。', + 'type' => 'string', + 'example' => 'app.example.com', + ], + 'L7ProxyDomainCustom' => [ + 'description' => '浏览器访问模式参数：自定义代理域名。', + 'type' => 'string', + 'example' => 'app.example.com', + ], + 'L7Config' => [ + 'description' => '浏览器访问模式参数：应用配置。', + '$ref' => '#/components/schemas/PAL7Config', + ], + 'AutoGenerated' => [ + 'description' => '是否云应用自动生成。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'ConfigMode' => [ + 'title' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。', + 'description' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。', + 'type' => 'string', + 'example' => 'Precise', + ], + 'AddressGroups' => [ + 'title' => '应用地址组。在ConfigMode为Precise时必传；在ConfigMode为空字符串时不可传。', + 'description' => '应用地址组。在ConfigMode为Precise时必传；在ConfigMode为空字符串时不可传。', + 'type' => 'array', + 'items' => [ + 'description' => '应用地址组。在ConfigMode为Precise时必传；在ConfigMode为空字符串时不可传。', + '$ref' => '#/components/schemas/AddressGroup', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Application.NotFound', + 'errorMessage' => 'The application is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3ACC5EDC-2B7D-5032-8C58-D7615D66C1D4\\",\\n \\"Application\\": {\\n \\"ApplicationId\\": \\"pa-application-e12860ef6c48****\\",\\n \\"Name\\": \\"private_access_application_name\\",\\n \\"Description\\": \\"这是一条内网访问应用\\",\\n \\"Addresses\\": [\\n \\"192.168.0.0/16\\"\\n ],\\n \\"PortRanges\\": [\\n {\\n \\"Begin\\": 80,\\n \\"End\\": 81\\n }\\n ],\\n \\"Protocol\\": \\"All\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2022-08-30 16:50:32\\",\\n \\"TagIds\\": [\\n \\"tag-d3f64e8bdd4a****\\"\\n ],\\n \\"PolicyIds\\": [\\n \\"pa-policy-54a7838a48bf****\\"\\n ],\\n \\"ConnectorIds\\": [\\n \\"connector-94db94e06b98****\\"\\n ],\\n \\"BrowserAccessStatus\\": \\"Enabled\\",\\n \\"L7ProxyDomainAutomatic\\": \\"app.example.com\\",\\n \\"L7ProxyDomainCustom\\": \\"app.example.com\\",\\n \\"L7Config\\": {\\n \\"RequestQueryRewriteConfig\\": {\\n \\"Ops\\": [\\n {\\n \\"Op\\": \\"add,set,delete,replace\\",\\n \\"OldValue\\": \\"\\",\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\",\\n \\"ValueVariable\\": \\"\\"\\n }\\n ]\\n },\\n \\"JsHookConfig\\": {\\n \\"Mode\\": \\"\\",\\n \\"ReplaceRules\\": [\\n {\\n \\"From\\": \\"aaa\\",\\n \\"To\\": \\"bbb\\"\\n }\\n ]\\n },\\n \\"BypassConfig\\": {\\n \\"AppBypassFroms\\": [\\n \\"\\"\\n ],\\n \\"Mode\\": \\"\\",\\n \\"UrlBypassRules\\": [\\n {\\n \\"Paths\\": [\\n \\"\\"\\n ],\\n \\"Froms\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"CertId\\": \\"\\",\\n \\"ClientTypeRestrictConfig\\": {\\n \\"BlacklistClients\\": [\\n \\"\\"\\n ],\\n \\"Mode\\": \\"disabled,whitelist,blacklist\\",\\n \\"WhitelistClients\\": [\\n \\"\\"\\n ]\\n },\\n \\"ResponseHeaderRewriteConfig\\": {\\n \\"Ops\\": [\\n {\\n \\"Op\\": \\"add,set,delete,replace\\",\\n \\"OldValue\\": \\"\\",\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\",\\n \\"ValueVariable\\": \\"\\"\\n }\\n ]\\n },\\n \\"IsNtlm\\": true,\\n \\"ClientIpConfig\\": {\\n \\"ClientIpHeaders\\": [\\n \\"\\"\\n ],\\n \\"TrustedProxies\\": [\\n \\"\\"\\n ]\\n },\\n \\"ClientIpRestrictConfig\\": {\\n \\"BlacklistFroms\\": [\\n \\"\\"\\n ],\\n \\"Mode\\": \\"disabled,whitelist,blacklist\\",\\n \\"WhitelistFroms\\": [\\n \\"\\"\\n ]\\n },\\n \\"ResponseRewriteConfig\\": {\\n \\"Mode\\": \\"\\",\\n \\"ReplaceRules\\": [\\n {\\n \\"From\\": \\"aaa\\",\\n \\"To\\": \\"bbb\\"\\n }\\n ]\\n },\\n \\"RequestHeaderRewriteConfig\\": {\\n \\"Ops\\": [\\n {\\n \\"Op\\": \\"add,set,delete,replace\\",\\n \\"OldValue\\": \\"\\",\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\",\\n \\"ValueVariable\\": \\"\\"\\n }\\n ]\\n },\\n \\"DnsConfig\\": {\\n \\"DnsServers\\": [\\n \\"\\"\\n ]\\n },\\n \\"ProxyDomainTypes\\": \\"逗号分隔的枚举值：automatic,custom\\"\\n },\\n \\"AutoGenerated\\": 0,\\n \\"ConfigMode\\": \\"Precise\\",\\n \\"AddressGroups\\": [\\n {\\n \\"Addresses\\": [\\n \\"\\"\\n ],\\n \\"Ports\\": [\\n {\\n \\"Begin\\": 0,\\n \\"End\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询内网访问应用详情', + ], + 'CreatePrivateAccessApplication' => [ + 'summary' => '创建当前阿里云账号下内网访问应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163596', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'private_access_application_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条内网访问应用', + ], + ], + [ + 'name' => 'Addresses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '应用地址。在ConfigMode为空字符串时必传；在ConfigMode为Precise时不可传。', + 'description' => '内网访问应用地址集合。最多可输入1000个内网访问应用地址。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。长度为1~128个字符，支持IPv4地址、CIDR、域名、泛域名。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.0/16', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PortRanges', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '应用端口。在ConfigMode为空字符串时必传；在ConfigMode为Precise时不可传。', + 'description' => '内网访问应用端口范围集合。最多可输入65535个端口范围。多个端口范围不可重复或重叠。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。取值：1~65535。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。小于等于结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '65535', + 'minimum' => '1', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。大于等于起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '65535', + 'minimum' => '1', + 'example' => '81', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'required' => true, + 'example' => 'All', + 'enum' => [ + 'All', + 'TCP', + 'UDP', + 'HTTP', + 'HTTPS', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + 'enum' => [ + 'Enabled', + 'Disabled', + ], + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问标签ID集合。1个内网访问应用最多可关联6个自定义类型的内网访问标签。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'BrowserAccessStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用状态，开启后可以通过无端方式访问内网应用。默认值为**Disabled**。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disabled', + ], + ], + [ + 'name' => 'L7ProxyDomainAutomaticPrefix', + 'in' => 'formData', + 'schema' => [ + 'description' => '浏览器访问模式参数：映射代理域名前缀。长度为3-20个字符，支持小写英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-sample', + ], + ], + [ + 'name' => 'L7ProxyDomainCustom', + 'in' => 'formData', + 'schema' => [ + 'description' => '浏览器访问模式参数：自定义代理域名。需要是一个合法的域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'app1.example.com', + ], + ], + [ + 'name' => 'L7Config', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '浏览器访问模式参数：应用配置。', + 'required' => false, + '$ref' => '#/components/schemas/PAL7Config', + ], + ], + [ + 'name' => 'ConfigMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。'."\n", + 'description' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。'."\n", + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AddressGroups', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '应用地址组。在ConfigMode为Precise时必传；在ConfigMode为空字符串时不可传。', + 'description' => '应用地址组。在ConfigMode为Precise时必传；在ConfigMode为空字符串时不可传。', + 'type' => 'array', + 'items' => [ + 'required' => false, + '$ref' => '#/components/schemas/AddressGroup', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\",\\n \\"ApplicationId\\": \\"pa-application-e12860ef6c48****\\"\\n}","type":"json"}]', + 'title' => '创建内网访问应用', + 'description' => '默认最多可创建500个内网访问应用。', + ], + 'DeletePrivateAccessApplication' => [ + 'summary' => '删除当前阿里云账号下内网访问应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163584', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Application.NotFound', + 'errorMessage' => 'The application is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\"\\n}","type":"json"}]', + 'title' => '删除内网访问应用', + 'description' => '当存在办公区识别、策略引用时，不允许删除。参考：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。', + ], + 'UpdatePrivateAccessApplication' => [ + 'summary' => '修改当前阿里云账号下内网访问应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163600', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条内网访问应用', + ], + ], + [ + 'name' => 'Addresses', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '应用地址。在ConfigMode为空字符串时可传；在ConfigMode为Precise时不可传。', + 'description' => '内网访问应用地址集合。最多可输入1000个内网访问应用地址。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。长度为1~128个字符，支持IPv4地址、CIDR、域名、泛域名。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.0/16', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PortRanges', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '应用端口。在ConfigMode为空字符串时可传；在ConfigMode为Precise时不可传。', + 'description' => '内网访问应用端口范围集合。最多可输入65535个端口范围。多个端口范围不可重复或重叠。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。取值：1~65535。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。小于等于结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '65535', + 'minimum' => '1', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。大于等于起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '65535', + 'minimum' => '1', + 'example' => '81', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + 'enum' => [ + 'All', + 'TCP', + 'UDP', + 'HTTP', + 'HTTPS', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + 'enum' => [ + 'Enabled', + 'Disabled', + ], + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问标签ID集合。1个内网访问应用最多可关联6个自定义类型的内网访问标签。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问应用的修改类型。取值：'."\n" + .'- **Cover**（默认）：使用**Addresses**、**PortRanges**、**TagIds**参数的值覆盖原地址、端口范围、标签ID集合。'."\n" + .'- **Append**：在原地址、端口范围、标签ID集合中分别增加**Addresses**、**PortRanges**、**TagIds**参数中输入的值。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Cover' => '覆盖', + 'Append' => '附加', + ], + 'example' => 'Cover', + ], + ], + [ + 'name' => 'L7ProxyDomainAutomaticPrefix', + 'in' => 'formData', + 'schema' => [ + 'description' => '浏览器访问模式参数：映射代理域名前缀。长度为3-20个字符，支持小写英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'app1-xxx', + ], + ], + [ + 'name' => 'L7ProxyDomainCustom', + 'in' => 'formData', + 'schema' => [ + 'description' => '浏览器访问模式参数：自定代理域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'app1.example.com', + ], + ], + [ + 'name' => 'L7ProxyDomainPrivate', + 'in' => 'formData', + 'schema' => [ + 'description' => '浏览器访问模式参数：私有代理域名。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'app1.example.com', + ], + ], + [ + 'name' => 'L7Config', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '浏览器访问模式参数：7层应用配置。', + 'required' => false, + '$ref' => '#/components/schemas/PAL7Config', + ], + ], + [ + 'name' => 'ConfigMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。'."\n", + 'description' => '配置模式，枚举值：'."\n" + .'* 空字符串：默认模式。'."\n" + .'* Precise：精细模式。'."\n", + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AddressGroups', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '应用地址组。在ConfigMode为Precise时可传；在ConfigMode为空字符串时不可传。', + 'description' => '应用地址组。在ConfigMode为Precise时可传；在ConfigMode为空字符串时不可传。', + 'type' => 'array', + 'items' => [ + 'required' => false, + '$ref' => '#/components/schemas/AddressGroup', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用名称。', + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'FD724DBC-CD76-5235-BF76-59C51B73296D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Application.NotFound', + 'errorMessage' => 'The application is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD724DBC-CD76-5235-BF76-59C51B73296D\\"\\n}","type":"json"}]', + 'title' => '修改内网访问应用', + ], + 'ListConnectors' => [ + 'summary' => 'Batch query connectors。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Connector名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'connector_name', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Connector连接状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + ], + [ + 'name' => 'SwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Connector实例状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'ConnectorIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'ConnectorID集合。最多可输入100个ConnectorID。', + 'type' => 'array', + 'items' => [ + 'description' => 'ConnectorID。取值来源：[ListConnectors](~~ListConnectors~~)批量查询Connector。', + 'type' => 'string', + 'required' => false, + 'example' => 'connector-94db94e06b98****', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'TotalNum' => [ + 'description' => 'Connector总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Connectors' => [ + 'description' => 'Connector列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Connector。', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => 'ConnectorID。', + 'type' => 'string', + 'example' => 'connector-94db94e06b98****', + ], + 'Name' => [ + 'description' => 'Connector名称。', + 'type' => 'string', + 'example' => 'connector_name', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SwitchStatus' => [ + 'description' => 'Connector实例状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'Status' => [ + 'description' => 'Connector连接状态。取值：'."\n" + .'- **Online**：在线。'."\n" + .'- **Offline**：离线。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Offline' => '离线', + 'Online' => '在线', + ], + 'example' => 'Online', + ], + 'Applications' => [ + 'description' => '关联的内网访问应用集合。', + 'type' => 'array', + 'items' => [ + 'description' => '关联的内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****'."\n", + ], + 'ApplicationName' => [ + 'description' => '内网访问应用名称。', + 'type' => 'string', + 'example' => 'application_name', + ], + ], + ], + ], + 'UpgradeTime' => [ + 'description' => 'Connector升级时间。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '20:00', + ], + 'End' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '23:00', + ], + ], + ], + 'ConnectorClients' => [ + 'description' => '部署的ConnectorClient集合。', + 'type' => 'array', + 'items' => [ + 'description' => '部署的ConnectorClient。', + 'type' => 'object', + 'properties' => [ + 'DevTag' => [ + 'description' => 'ConnectorClient的设备唯一标识。', + 'type' => 'string', + 'example' => 'C50A2386-F851-4F11-920B-DF7148DA0C22', + ], + 'Hostname' => [ + 'description' => 'ConnectorClient主机名。', + 'type' => 'string', + 'example' => 'connector_client', + ], + 'ConnectionStatus' => [ + 'description' => 'ConnectorClient和ConnectorServer的连接状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Connected' => '已连接', + 'Disconnected' => '未连接', + ], + 'example' => 'Disconnected', + ], + 'PublicIp' => [ + 'description' => 'ConnectorClient公网IP。', + 'type' => 'string', + 'example' => '192.0.2.1', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => 'Connector创建时间。', + 'type' => 'string', + 'example' => '2022-09-27 18:10:25', + ], + 'ClusterIP' => [ + 'description' => '集群IP。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'ClusterPort' => [ + 'description' => '集群端口。', + 'type' => 'string', + 'example' => '8000', + ], + 'AccelerateStatus' => [ + 'description' => '是否启用全球加速。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"TotalNum\\": 1,\\n \\"Connectors\\": [\\n {\\n \\"ConnectorId\\": \\"connector-94db94e06b98****\\",\\n \\"Name\\": \\"connector_name\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SwitchStatus\\": \\"Enabled\\",\\n \\"Status\\": \\"Online\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"pa-application-e12860ef6c48****\\\\n\\",\\n \\"ApplicationName\\": \\"application_name\\"\\n }\\n ],\\n \\"UpgradeTime\\": {\\n \\"Start\\": \\"20:00\\",\\n \\"End\\": \\"23:00\\"\\n },\\n \\"ConnectorClients\\": [\\n {\\n \\"DevTag\\": \\"C50A2386-F851-4F11-920B-DF7148DA0C22\\",\\n \\"Hostname\\": \\"connector_client\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"PublicIp\\": \\"192.0.2.1\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2022-09-27 18:10:25\\",\\n \\"ClusterIP\\": \\"1.1.1.1\\",\\n \\"ClusterPort\\": \\"8000\\",\\n \\"AccelerateStatus\\": \\"Enabled\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch Query Connectors', + ], + 'AttachApplication2Connector' => [ + 'summary' => '挂载当前阿里云账号下Connector的内网访问应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164987', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConnectorId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ConnectorID。', + 'type' => 'string', + 'required' => true, + 'example' => 'connector-94db94e06b98****'."\n", + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '内网访问应用ID集合。一个Connector最多可挂载内网访问应用的数量不超过内网访问应用总数。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-application-f4dd77bced90****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7E9D7ACD-53D5-56EF-A913-79D148D06299', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E9D7ACD-53D5-56EF-A913-79D148D06299\\"\\n}","type":"json"}]', + 'title' => '挂载Connector的应用', + ], + 'DetachApplication2Connector' => [ + 'summary' => '卸载当前阿里云账号下Connector的内网访问应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '165052', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConnectorId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ConnectorID。', + 'type' => 'string', + 'required' => true, + 'example' => 'connector-94db94e06b98****', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '内网访问应用ID集合。最多可输入100个内网访问应用ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-application-b927baf3e592****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4D169859-A4F2-5EC8-853B-8447787C0D8A', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'csas::2023-01-20::ModifyForwardStrategy', + ], + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D169859-A4F2-5EC8-853B-8447787C0D8A\\"\\n}","type":"json"}]', + 'title' => '卸载Connector的应用', + ], + 'ListPrivateAccessTags' => [ + 'summary' => '批量查询当前阿里云账号下所有内网访问标签的信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问标签名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag_name', + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问标签ID集合。最多可输入100个内网访问标签ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-policy-54a7838a48bf****', + ], + ], + [ + 'name' => 'SimpleMode', + 'in' => 'query', + 'schema' => [ + 'description' => '简单查询模式。如果值为true，表示不需要查询PolicyId字段。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '54C1D236-CDB9-586C-B44D-AFDCEA195545', + ], + 'TotalNum' => [ + 'description' => '内网访问标签总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tags' => [ + 'description' => '内网访问标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签。', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'Name' => [ + 'description' => '内网访问标签名称。', + 'type' => 'string', + 'example' => 'tag_name', + ], + 'Description' => [ + 'description' => '内网访问标签描述。', + 'type' => 'string', + 'example' => '这是一条内网访问标签', + ], + 'TagType' => [ + 'description' => '内网访问标签类型。取值：'."\n" + .'- **Default**：默认。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义', + 'Default' => '默认', + ], + 'example' => 'Default', + ], + 'CreateTime' => [ + 'description' => '内网访问标签创建时间。', + 'type' => 'string', + 'example' => '2022-10-10 11:39:34', + ], + 'ApplicationIds' => [ + 'description' => '内网访问应用ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + 'PolicyIds' => [ + 'description' => '内网访问策略ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-54a7838a48bf****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54C1D236-CDB9-586C-B44D-AFDCEA195545\\",\\n \\"TotalNum\\": 1,\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"tag-d3f64e8bdd4a****\\",\\n \\"Name\\": \\"tag_name\\",\\n \\"Description\\": \\"这是一条内网访问标签\\",\\n \\"TagType\\": \\"Default\\",\\n \\"CreateTime\\": \\"2022-10-10 11:39:34\\",\\n \\"ApplicationIds\\": [\\n \\"pa-application-e12860ef6c48****\\"\\n ],\\n \\"PolicyIds\\": [\\n \\"pa-policy-54a7838a48bf****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问标签', + ], + 'ListApplicationsForPrivateAccessTag' => [ + 'summary' => '批量查询当前阿里云账号下内网访问标签的应用。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问标签ID集合。最多可输入100个内网访问标签ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-7ffc82853476****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'B608C6AE-623D-55C4-9454-601B88AE937E', + ], + 'Tags' => [ + 'description' => '内网访问标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签。', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-7ffc82853476****', + ], + 'Applications' => [ + 'description' => '内网访问应用集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-7a9243dd02f4****', + ], + 'Name' => [ + 'description' => '内网访问应用名称。', + 'type' => 'string', + 'example' => 'private_access_application_name'."\n", + ], + 'Description' => [ + 'description' => '内网访问应用描述。', + 'type' => 'string', + 'example' => '这是一条内网访问应用'."\n", + ], + 'Addresses' => [ + 'description' => '内网访问应用地址集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。长度为1~128个字符，支持IPv4地址、CIDR、域名、泛域名。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + 'PortRanges' => [ + 'description' => '内网访问应用端口范围集合。多个端口范围不可重复或重叠。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。取值：1~65535。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '81', + ], + ], + ], + ], + 'Protocol' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => 'All', + 'TCP' => 'TCP', + 'UDP' => 'UDP', + ], + 'example' => 'All', + ], + 'Status' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '内网访问应用创建时间。', + 'type' => 'string', + 'example' => '2022-09-27 18:10:25', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B608C6AE-623D-55C4-9454-601B88AE937E\\",\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"tag-7ffc82853476****\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"pa-application-7a9243dd02f4****\\",\\n \\"Name\\": \\"private_access_application_name\\\\n\\",\\n \\"Description\\": \\"这是一条内网访问应用\\\\n\\",\\n \\"Addresses\\": [\\n \\"192.168.0.0/16\\"\\n ],\\n \\"PortRanges\\": [\\n {\\n \\"Begin\\": 80,\\n \\"End\\": 81\\n }\\n ],\\n \\"Protocol\\": \\"All\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2022-09-27 18:10:25\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问标签的应用', + ], + 'ListPolicesForPrivateAccessTag' => [ + 'summary' => '批量查询当前阿里云账号下内网访问标签的策略。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问标签ID集合。最多可输入100个内网访问标签ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-b927baf3e592****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4D169859-A4F2-5EC8-853B-8447787C0D8A', + ], + 'Tags' => [ + 'description' => '内网访问标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签。', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-b927baf3e592****'."\n", + ], + 'Polices' => [ + 'description' => '内网访问策略集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-867ef4007c8a****', + ], + 'Name' => [ + 'description' => '内网访问策略名称。', + 'type' => 'string', + 'example' => 'private_access_policy_name'."\n", + ], + 'Description' => [ + 'description' => '内网访问策略描述。', + 'type' => 'string', + 'example' => '这是一条内网访问策略', + ], + 'PolicyAction' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + 'Priority' => [ + 'description' => '内网访问策略优先级。数字1表示优先级最高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => '内网访问策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'ApplicationType' => [ + 'description' => '内网访问策略的应用类型。取值：'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + 'UserGroupType' => [ + 'description' => '内网访问策略的用户组类型。取值：'."\n" + .'- **Normal**：普通用户组。'."\n" + .'- **Custom**：自定义用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义', + 'Normal' => '普通', + ], + 'example' => 'Normal', + ], + 'CustomUserAttributes' => [ + 'description' => '自定义用户组属性集合。多个自定义用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department'."\n", + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '内网访问策略创建时间。', + 'type' => 'string', + 'example' => '2023-02-21 14:10:16', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D169859-A4F2-5EC8-853B-8447787C0D8A\\",\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"tag-b927baf3e592****\\\\n\\",\\n \\"Polices\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-867ef4007c8a****\\",\\n \\"Name\\": \\"private_access_policy_name\\\\n\\",\\n \\"Description\\": \\"这是一条内网访问策略\\",\\n \\"PolicyAction\\": \\"Allow\\",\\n \\"Priority\\": 1,\\n \\"Status\\": \\"Enabled\\",\\n \\"ApplicationType\\": \\"Application\\",\\n \\"UserGroupType\\": \\"Normal\\",\\n \\"CustomUserAttributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\\\n\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"CreateTime\\": \\"2023-02-21 14:10:16\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问标签的策略', + ], + 'CreatePrivateAccessTag' => [ + 'summary' => '创建当前阿里云账号下内网访问标签。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163592', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问标签名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'tag_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问标签描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条内网访问标签', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'TagId' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'Tag.NameExisted', + 'errorMessage' => 'The tag name is existed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"TagId\\": \\"tag-d3f64e8bdd4a****\\"\\n}","type":"json"}]', + 'title' => '创建内网访问标签', + 'description' => '默认最多可创建500个内网访问标签。', + ], + 'DeletePrivateAccessTag' => [ + 'summary' => '删除当前阿里云账号下内网访问标签。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163589', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => true, + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'FD724DBC-CD76-5235-BF76-59C51B73296D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Tag.NotFound', + 'errorMessage' => 'The tag is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Tag.UsedByApplication', + 'errorMessage' => 'The tag is used by application.', + ], + [ + 'errorCode' => 'Tag.UsedByPolicy', + 'errorMessage' => 'The tag is used by policy.', + ], + [ + 'errorCode' => 'Tag.UsedByWorkshop', + 'errorMessage' => 'The tag is used by workshop.', + ], + [ + 'errorCode' => 'Tag.DefaultCannotDelete', + 'errorMessage' => 'The default tag cannot be deleted.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD724DBC-CD76-5235-BF76-59C51B73296D\\"\\n}","type":"json"}]', + 'title' => '删除内网访问标签', + 'description' => '当存在应用、办公区识别、策略引用时，不允许删除。参考：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。', + ], + 'ListPrivateAccessPolices' => [ + 'summary' => '获取当前阿里云账号下所有内网访问策略的信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163588', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'private_access_policy_name'."\n", + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'PolicyAction', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + ], + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略ID集合。最多可输入100个内网访问策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-policy-63b2f1844b86****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用ID。无法和内网访问标签ID同时过滤。取值来源：'."\n" + .' - [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .' - [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问标签ID。无法和应用ID同时过滤。取值来源：'."\n" + .' - [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .' - [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-c0cb77857a99****', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => '办公', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'required' => false, + 'example' => '云产品', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D', + ], + 'TotalNum' => [ + 'description' => '内网访问策略的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Polices' => [ + 'description' => '内网访问策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-63b2f1844b86****', + ], + 'Name' => [ + 'description' => '内网访问策略名称。', + 'type' => 'string', + 'example' => 'private_access_policy_name', + ], + 'Description' => [ + 'description' => '内网访问策略描述。', + 'type' => 'string', + 'example' => '这是一条内网访问策略', + ], + 'PolicyAction' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + 'Priority' => [ + 'description' => '内网访问策略优先级。数字1表示优先级最高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => '内网访问策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '内网访问策略创建时间。', + 'type' => 'string', + 'example' => '2022-07-10 15:50:23', + ], + 'UserGroupMode' => [ + 'description' => '内网访问策略的用户组类型。取值：'."\n" + .'- **Normal**：普通用户组。'."\n" + .'- **Custom**：自定义用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义用户组', + 'Normal' => '普通用户组', + ], + 'example' => 'Normal', + ], + 'UserGroupIds' => [ + 'description' => '内网访问策略，用户组ID集合。当用户组类型为**Normal**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略，用户组类型为**Normal**的用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + 'CustomUserAttributes' => [ + 'description' => '自定义用户组属性集合。多个自定义用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'ApplicationType' => [ + 'description' => '内网访问策略的应用类型。取值：'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + 'ApplicationIds' => [ + 'description' => '内网访问策略的应用ID集合。当应用类型为**Application**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + 'TagIds' => [ + 'description' => '内网访问策略的标签ID集合。当应用类型为**Tag**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + 'DeviceAttributeId' => [ + 'description' => '安全基线策略的ID。', + 'type' => 'string', + 'example' => 'dag-d3f64e8bdd4a****', + ], + 'DeviceAttributeAction' => [ + 'description' => '不满足安全基线的执行策略。取值：'."\n" + .'- **Block**：拦截。'."\n" + .'- **Observe**：观察。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Observe' => 'Observe', + 'Block' => 'Block', + ], + 'example' => 'Block', + ], + 'TriggerTemplateId' => [ + 'description' => '触发模板ID', + 'type' => 'string', + 'example' => 'dag-d3f64e8bdd4a****', + ], + 'TrustedProcessStatus' => [ + 'description' => '可信进程开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'TrustedProcessGroupIds' => [ + 'description' => '可信进程组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可信进程组ID。', + 'type' => 'string', + 'example' => 'pg-xxxxxxx', + ], + ], + 'TrustedSoftwareIds' => [ + 'description' => '可信软件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可信软件ID。', + 'type' => 'string', + 'example' => 'swb-xxxxxxxx', + ], + ], + 'ValidFrom' => [ + 'description' => '零信任策略的生效起始时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ValidUntil' => [ + 'description' => '零信任策略的生效截止时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1764727544', + ], + 'ValidTimeStatus' => [ + 'description' => '生效时间开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D\\",\\n \\"TotalNum\\": 1,\\n \\"Polices\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-63b2f1844b86****\\",\\n \\"Name\\": \\"private_access_policy_name\\",\\n \\"Description\\": \\"这是一条内网访问策略\\",\\n \\"PolicyAction\\": \\"Allow\\",\\n \\"Priority\\": 1,\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2022-07-10 15:50:23\\",\\n \\"UserGroupMode\\": \\"Normal\\",\\n \\"UserGroupIds\\": [\\n \\"usergroup-6f1ef2fc56b6****\\"\\n ],\\n \\"CustomUserAttributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"ApplicationType\\": \\"Application\\",\\n \\"ApplicationIds\\": [\\n \\"pa-application-e12860ef6c48****\\"\\n ],\\n \\"TagIds\\": [\\n \\"tag-d3f64e8bdd4a****\\"\\n ],\\n \\"DeviceAttributeId\\": \\"dag-d3f64e8bdd4a****\\",\\n \\"DeviceAttributeAction\\": \\"Block\\",\\n \\"TriggerTemplateId\\": \\"dag-d3f64e8bdd4a****\\",\\n \\"TrustedProcessStatus\\": \\"Enabled\\",\\n \\"TrustedProcessGroupIds\\": [\\n \\"pg-xxxxxxx\\"\\n ],\\n \\"TrustedSoftwareIds\\": [\\n \\"swb-xxxxxxxx\\"\\n ],\\n \\"ValidFrom\\": 0,\\n \\"ValidUntil\\": 1764727544,\\n \\"ValidTimeStatus\\": \\"Enabled\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问策略', + ], + 'ListUserGroupsForPrivateAccessPolicy' => [ + 'summary' => '批量查询当前阿里云账号下内网访问策略的用户组。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略ID集合。最多可输入100个内网访问策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-policy-1b0d0e8b4bcf****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'Polices' => [ + 'description' => '内网访问策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-1b0d0e8b4bcf****', + ], + 'UserGroups' => [ + 'description' => '内网访问策略的用户组集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + 'Name' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'user_group_name', + ], + 'Description' => [ + 'description' => '用户组描述。', + 'type' => 'string', + 'example' => '这是一条被内网访问策略引用的用户组', + ], + 'Attributes' => [ + 'description' => '用户组属性集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '用户组的身份源ID。当自定义用户组类型为**department**时，存在该值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '用户组创建时间。', + 'type' => 'string', + 'example' => '2022-09-27 18:10:25'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"Polices\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-1b0d0e8b4bcf****\\",\\n \\"UserGroups\\": [\\n {\\n \\"UserGroupId\\": \\"usergroup-6f1ef2fc56b6****\\",\\n \\"Name\\": \\"user_group_name\\",\\n \\"Description\\": \\"这是一条被内网访问策略引用的用户组\\",\\n \\"Attributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"CreateTime\\": \\"2022-09-27 18:10:25\\\\n\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问策略的用户组', + ], + 'ListApplicationsForPrivateAccessPolicy' => [ + 'summary' => '批量查询当前阿里云账号下内网访问策略的应用。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略ID集合。最多可输入100个内网访问策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-policy-1b0d0e8b4bcf****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4D169859-A4F2-5EC8-853B-8447787C0D8A', + ], + 'Polices' => [ + 'description' => '内网访问策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-1b0d0e8b4bcf****', + ], + 'Applications' => [ + 'description' => '内网访问应用集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-7a9243dd02f4****', + ], + 'Name' => [ + 'description' => '内网访问应用名称。', + 'type' => 'string', + 'example' => 'application_name', + ], + 'Description' => [ + 'description' => '内网访问应用描述。', + 'type' => 'string', + 'example' => '这是一条被内网访问策略引用的内网访问应用', + ], + 'Addresses' => [ + 'description' => '内网访问应用地址集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + 'PortRanges' => [ + 'description' => '内网访问应用端口范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '81', + ], + ], + ], + ], + 'Protocol' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => 'All', + 'TCP' => 'TCP', + 'UDP' => 'UDP', + ], + 'example' => 'TCP', + ], + 'Status' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '内网访问应用创建时间。', + 'type' => 'string', + 'example' => '2022-09-27 18:10:25', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D169859-A4F2-5EC8-853B-8447787C0D8A\\",\\n \\"Polices\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-1b0d0e8b4bcf****\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"pa-application-7a9243dd02f4****\\",\\n \\"Name\\": \\"application_name\\",\\n \\"Description\\": \\"这是一条被内网访问策略引用的内网访问应用\\",\\n \\"Addresses\\": [\\n \\"192.168.0.0/16\\"\\n ],\\n \\"PortRanges\\": [\\n {\\n \\"Begin\\": 80,\\n \\"End\\": 81\\n }\\n ],\\n \\"Protocol\\": \\"TCP\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2022-09-27 18:10:25\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问策略的应用', + ], + 'ListTagsForPrivateAccessPolicy' => [ + 'summary' => '批量查询当前阿里云账号下内网访问策略的标签。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略ID集合。最多可输入100个内网访问策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-policy-1b0d0e8b4bcf****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '9EE61139-A6A8-5E13-80AF-83435C21B26B', + ], + 'Polices' => [ + 'description' => '内网访问策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-1b0d0e8b4bcf****', + ], + 'Tags' => [ + 'description' => '内网访问标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签。', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'Name' => [ + 'description' => '内网访问标签名称。', + 'type' => 'string', + 'example' => 'tag_name', + ], + 'Description' => [ + 'description' => '内网访问标签描述。', + 'type' => 'string', + 'example' => '这是一条被内网访问策略引用的标签', + ], + 'TagType' => [ + 'description' => '内网访问标签类型。取值：'."\n" + .'- **Default**：默认。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义', + 'Default' => '默认', + ], + 'example' => 'Default', + ], + 'CreateTime' => [ + 'description' => '内网访问标签创建时间。', + 'type' => 'string', + 'example' => '2023-02-21 14:10:16', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9EE61139-A6A8-5E13-80AF-83435C21B26B\\",\\n \\"Polices\\": [\\n {\\n \\"PolicyId\\": \\"pa-policy-1b0d0e8b4bcf****\\",\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"tag-d3f64e8bdd4a****\\",\\n \\"Name\\": \\"tag_name\\",\\n \\"Description\\": \\"这是一条被内网访问策略引用的标签\\",\\n \\"TagType\\": \\"Default\\",\\n \\"CreateTime\\": \\"2023-02-21 14:10:16\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询内网访问策略的标签', + ], + 'GetPrivateAccessPolicy' => [ + 'summary' => '获取当前阿里云账号下指定内网访问策略的详情信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163586', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-policy-63b2f1844b86****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7E9D7ACD-53D5-56EF-A913-79D148D06299', + ], + 'Policy' => [ + 'description' => '内网访问策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-63b2f1844b86****', + ], + 'Name' => [ + 'description' => '内网访问策略名称。', + 'type' => 'string', + 'example' => 'private_access_policy_name', + ], + 'Description' => [ + 'description' => '内网访问策略描述。', + 'type' => 'string', + 'example' => '这是一条内网访问策略', + ], + 'PolicyAction' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + 'Priority' => [ + 'description' => '内网访问策略优先级。数字1表示优先级最高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => '内网访问策略状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '内网访问策略创建时间。', + 'type' => 'string', + 'example' => '2021-07-29 11:26:02', + ], + 'UserGroupMode' => [ + 'description' => '内网访问策略的用户组类型。取值：'."\n" + .'- **Normal**：普通用户组。'."\n" + .'- **Custom**：自定义用户组。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义用户组', + 'Normal' => '普通用户组', + ], + 'example' => 'Normal', + ], + 'UserGroupIds' => [ + 'description' => '内网访问策略，用户组ID集合。当用户组类型为Normal时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略，用户组类型为Normal的用户组ID。', + 'type' => 'string', + 'example' => 'usergroup-6f1ef2fc56b6****', + ], + ], + 'CustomUserAttributes' => [ + 'description' => '自定义用户组属性集合。多个自定义用户组属性之间是或的关系，按照合集生效。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义用户组属性。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '自定义用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '自定义用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '自定义用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '自定义用户组的身份源ID。当自定义用户组类型为**department**时，必填。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'ApplicationType' => [ + 'description' => '内网访问策略的应用类型。取值：'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + 'ApplicationIds' => [ + 'description' => '内网访问策略的应用ID集合。当应用类型为Application时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****'."\n", + ], + ], + 'TagIds' => [ + 'description' => '内网访问策略的标签ID集合。当应用类型为Tag时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****'."\n", + ], + ], + 'DeviceAttributeId' => [ + 'description' => '安全基线策略的ID。', + 'type' => 'string', + 'example' => 'dag-d3f64e8bdd4a****', + ], + 'DeviceAttributeAction' => [ + 'description' => '不满足安全基线的执行策略。取值：'."\n" + ."\n" + .'- **Block**：拦截。'."\n" + .'- **Observe**：观察。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Observe' => 'Observe', + 'Block' => 'Block', + ], + 'example' => 'Block', + ], + 'TriggerTemplateId' => [ + 'description' => '触发模板ID', + 'type' => 'string', + 'example' => 'dag-d3f64e8bdd4a****', + ], + 'TrustedProcessStatus' => [ + 'description' => '可信进程开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'TrustedProcessGroupIds' => [ + 'description' => '可信进程组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可信进程组ID。', + 'type' => 'string', + 'example' => 'pg-xxxxxxxx', + ], + ], + 'TrustedSoftwareIds' => [ + 'description' => '可信软件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可信软件ID。', + 'type' => 'string', + 'example' => 'swb-xxxxxxxxx', + ], + ], + 'ValidFrom' => [ + 'description' => '零信任策略的生效起始时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ValidUntil' => [ + 'description' => '零信任策略的生效截止时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1764727544', + ], + 'ValidTimeStatus' => [ + 'description' => '生效时间开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E9D7ACD-53D5-56EF-A913-79D148D06299\\",\\n \\"Policy\\": {\\n \\"PolicyId\\": \\"pa-policy-63b2f1844b86****\\",\\n \\"Name\\": \\"private_access_policy_name\\",\\n \\"Description\\": \\"这是一条内网访问策略\\",\\n \\"PolicyAction\\": \\"Allow\\",\\n \\"Priority\\": 1,\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2021-07-29 11:26:02\\",\\n \\"UserGroupMode\\": \\"Normal\\",\\n \\"UserGroupIds\\": [\\n \\"usergroup-6f1ef2fc56b6****\\"\\n ],\\n \\"CustomUserAttributes\\": [\\n {\\n \\"UserGroupType\\": \\"department\\",\\n \\"Relation\\": \\"Equal\\",\\n \\"Value\\": \\"OU=部门1,OU=SASE钉钉\\",\\n \\"IdpId\\": 12\\n }\\n ],\\n \\"ApplicationType\\": \\"Application\\",\\n \\"ApplicationIds\\": [\\n \\"pa-application-e12860ef6c48****\\\\n\\"\\n ],\\n \\"TagIds\\": [\\n \\"tag-d3f64e8bdd4a****\\\\n\\"\\n ],\\n \\"DeviceAttributeId\\": \\"dag-d3f64e8bdd4a****\\",\\n \\"DeviceAttributeAction\\": \\"Block\\",\\n \\"TriggerTemplateId\\": \\"dag-d3f64e8bdd4a****\\",\\n \\"TrustedProcessStatus\\": \\"Enabled\\",\\n \\"TrustedProcessGroupIds\\": [\\n \\"pg-xxxxxxxx\\"\\n ],\\n \\"TrustedSoftwareIds\\": [\\n \\"swb-xxxxxxxxx\\"\\n ],\\n \\"ValidFrom\\": 0,\\n \\"ValidUntil\\": 1764727544,\\n \\"ValidTimeStatus\\": \\"Enabled\\"\\n }\\n}","type":"json"}]', + 'title' => '查询内网访问策略详情', + ], + 'CreatePrivateAccessPolicy' => [ + 'summary' => '创建当前阿里云账号下内网访问策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163595', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'private_access_policy_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条内网访问策略', + ], + ], + [ + 'name' => 'PolicyAction', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略的应用类型。取值：'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略的应用ID集合。最多可输入100个内网访问应用ID。当**ApplicationType**为**Application时**，必填。和**TagIds**互斥。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-f4dd77bced90****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问标签ID集合。最多可输入100个内网访问标签ID。当**ApplicationType**为**Tag时**，必填。和**ApplicationIds**互斥。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserGroupMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略的用户组类型。取值：'."\n" + .'- **Normal**：普通用户组。'."\n" + .'- **Custom**：自定义用户组。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Custom' => '自定义用户组', + 'Normal' => '普通用户组', + ], + 'example' => 'Normal', + ], + ], + [ + 'name' => 'UserGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略的用户组ID集合，当用户组类型为**Normal**时，必填。和自定义用户组集合互斥。最多可输入2000个用户组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略用户组类型为Normal的用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-927a4c7fee94****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CustomUserAttributes', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略的自定义用户组集合，当用户组类型为**Custom**时，必填。和用户组ID集合互斥。最多可输入10个自定义用户组。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的自定义用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '自定义用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department', + ], + 'Relation' => [ + 'description' => '自定义用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '自定义用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'required' => false, + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '自定义用户组的身份源ID。当自定义用户组类型为**department**时，必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略的状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略优先级。数字1表示优先级最高。取值：1~1000，最大值为内网访问策略总数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DeviceAttributeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '安全基线策略的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dag-d3f64e8bdd4a****', + ], + ], + [ + 'name' => 'DeviceAttributeAction', + 'in' => 'formData', + 'schema' => [ + 'description' => '不满足安全基线的执行策略。取值：'."\n" + ."\n" + .'- **Block**：拦截。'."\n" + .'- **Observe**：观察。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Observe' => 'Observe', + 'Block' => 'Block', + ], + 'example' => 'Block', + ], + ], + [ + 'name' => 'TriggerTemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发模板ID', + 'type' => 'string', + 'required' => false, + 'example' => 'dag-d3f64e8bdd4a****', + ], + ], + [ + 'name' => 'TrustedProcessStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '可信进程开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'TrustedProcessGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '可信进程组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '可信进程组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pg-xxxxxxxxx', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TrustedSoftwareIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '可信软件ID。', + 'type' => 'array', + 'items' => [ + 'description' => '可信软件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'swb-xxxxxxx', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ValidFrom', + 'in' => 'formData', + 'schema' => [ + 'description' => '零信任策略的生效起始时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ValidUntil', + 'in' => 'formData', + 'schema' => [ + 'description' => '零信任策略的生效截止时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1764727544', + ], + ], + [ + 'name' => 'ValidTimeStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '生效时间开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'EFE7EBB2-449D-5BBB-B381-CA7839BC1649', + ], + 'PolicyId' => [ + 'description' => '内网访问策略ID。', + 'type' => 'string', + 'example' => 'pa-policy-867ef4007c8a****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFE7EBB2-449D-5BBB-B381-CA7839BC1649\\",\\n \\"PolicyId\\": \\"pa-policy-867ef4007c8a****\\"\\n}","type":"json"}]', + 'title' => '创建内网访问策略', + 'description' => '默认最多可创建500个内网访问策略。', + ], + 'DeletePrivateAccessPolicy' => [ + 'summary' => '删除当前阿里云账号下内网访问策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163593', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-policy-867ef4007c8a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '4D169859-A4F2-5EC8-853B-8447787C0D8A', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D169859-A4F2-5EC8-853B-8447787C0D8A\\"\\n}","type":"json"}]', + 'title' => '删除内网访问策略', + ], + 'UpdatePrivateAccessPolicy' => [ + 'summary' => '修改当前阿里云账号下内网访问策略。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163583', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略ID。取值来源：'."\n" + .'- [ListPrivateAccessPolices](~~ListPrivateAccessPolices~~)：批量查询内网访问策略。'."\n" + .'- [CreatePrivateAccessPolicy](~~CreatePrivateAccessPolicy~~)：创建内网访问策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-policy-63b2f1844b86****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条内网访问策略', + ], + ], + [ + 'name' => 'PolicyAction', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略动作。取值：'."\n" + .'- **Block**：阻断。'."\n" + .'- **Allow**：允许。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Block' => '阻断', + 'Allow' => '允许', + ], + 'example' => 'Allow', + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略的应用类型。取值：'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略的应用ID集合。一条策略最多支持100个内网访问应用ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-f4dd77bced90****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问标签ID集合。一条策略最多支持100个内网访问标签ID。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-57c8238455b9****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserGroupMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略的用户组类型。取值：'."\n" + .'- **Normal**：普通用户组。'."\n" + .'- **Custom**：自定义用户组。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Custom' => '自定义用户组', + 'Normal' => '普通用户组', + ], + 'example' => 'Normal', + ], + ], + [ + 'name' => 'UserGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略的用户组ID集合，当用户组类型为**Normal**时，必填。和自定义用户组集合互斥。单个策略的用户组最大支持10000个，单次修改的用户组ID数量最多2000个。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略用户组类型为Normal的用户组ID。取值来源：'."\n" + .'- [ListUserGroups](~~ListUserGroups~~)：批量查询用户组。'."\n" + .'- [CreateUserGroup](~~CreateUserGroup~~)：创建用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'usergroup-927a4c7fee94****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CustomUserAttributes', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '内网访问策略的自定义用户组集合，当用户组类型为**Custom**时，必填。和用户组ID集合互斥。自定义用户组总数最多10个。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问策略的自定义用户组。', + 'type' => 'object', + 'properties' => [ + 'UserGroupType' => [ + 'description' => '自定义用户组的类型。取值：'."\n" + .'- **username**：用户名。'."\n" + .'- **department**：部门。'."\n" + .'- **email**：邮箱。'."\n" + .'- **telephone**：手机。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'telephone' => '手机', + 'department' => '部门', + 'email' => '邮箱', + 'username' => '用户名', + ], + 'example' => 'department'."\n", + ], + 'Relation' => [ + 'description' => '自定义用户组的关系。取值：'."\n" + .'- **Equal**：等于。'."\n" + .'- **Unequal**：不等于。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Unequal' => '不等于', + 'Equal' => '等于', + ], + 'example' => 'Equal', + ], + 'Value' => [ + 'description' => '自定义用户组属性的值。'."\n" + .'- 当用户组类型为**username**时，表示用户名的值。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。'."\n" + .'- 当用户组类型为**department**时，表示部门的值。如：OU=部门1,OU=SASE钉钉。'."\n" + .'- 当用户组类型为**email**时，表示邮箱的值。如：[email protected]。'."\n" + .'- 当用户组类型为**telephone**时，表示手机的值。如：13900001234。', + 'type' => 'string', + 'required' => true, + 'example' => 'OU=部门1,OU=SASE钉钉', + ], + 'IdpId' => [ + 'description' => '自定义用户组的身份源ID。当自定义用户组类型为**department**时，必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略的状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略优先级。数字1表示优先级最高。取值：1~1000，最大值为内网访问策略总数减一。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '内网访问策略的修改类型。取值：'."\n" + .'- **Cover**（默认）：使用**ApplicationIds**、**UserGroupIds**、**CustomUserAttributes**参数的值覆盖原应用ID集合、用户组ID集合、自定义用户组集合。'."\n" + .'- **Append**：在原应用ID集合、用户组ID集合、自定义用户组集合中分别增加**ApplicationIds**、**UserGroupIds**、**CustomUserAttributes**参数中输入的值。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Cover' => '覆盖', + 'Append' => '附加', + ], + 'example' => 'Cover', + ], + ], + [ + 'name' => 'DeviceAttributeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '安全基线策略的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dag-d3f64e8bdd4a****', + ], + ], + [ + 'name' => 'DeviceAttributeAction', + 'in' => 'formData', + 'schema' => [ + 'description' => '不满足安全基线的执行策略。取值：'."\n" + ."\n" + .'- **Block**：拦截。'."\n" + .'- **Observe**：观察。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Observe' => 'Observe', + 'Block' => 'Block', + ], + 'example' => 'Block', + ], + ], + [ + 'name' => 'TriggerTemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dag-d3f64e8bdd4a****', + ], + ], + [ + 'name' => 'TrustedSoftwareIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '可信软件ID。', + 'type' => 'array', + 'items' => [ + 'description' => '可信软件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'swb-xxxxxxxx', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TrustedProcessGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '可信进程组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '可信进程组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pg-xxxxxxxx', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TrustedProcessStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '可信进程开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disabled', + ], + ], + [ + 'name' => 'ValidFrom', + 'in' => 'formData', + 'schema' => [ + 'description' => '零信任策略的生效起始时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ValidUntil', + 'in' => 'formData', + 'schema' => [ + 'description' => '零信任策略的生效截止时间，为秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1764727544', + ], + ], + [ + 'name' => 'ValidTimeStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '生效时间开关状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '策略名称。', + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FEF5CFA-14CC-5DE5-BD1F-AFFE0996E71D\\"\\n}","type":"json"}]', + 'title' => '修改内网访问策略', + ], + 'ListDynamicRoutes' => [ + 'summary' => '获取当前阿里云账号下所有动态路由的信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时显示的当前页的页码。取值：1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页数量。取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '动态路由名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'dynamic_route_name', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '动态路由状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'DynamicRouteIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '动态路由ID集合。最多可输入100个动态路由ID。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由ID。取值来源：'."\n" + .'- [ListDynamicRoutes](~~ListDynamicRoutes~~)：批量查询动态路由。'."\n" + .'- [CreateDynamicRoute](~~CreateDynamicRoute~~)：创建动态路由。', + 'type' => 'string', + 'required' => false, + 'example' => 'dr-30108b6c9d31****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RegionIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'SASE的POP集群接入点支持的地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SASE的POP集群接入点支持的地域。取值来源：'."\n" + .' - [ListDynamicRouteRegions](~~ListDynamicRouteRegions~~)：批量查询动态路由已授权地域。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cn-shenzhen' => '深圳', + 'cn-beijing' => '北京', + 'cn-shanghai' => '上海', + 'ap-southeast-1' => '新加坡', + 'us-east-1' => '弗吉尼亚', + 'us-west-1' => '硅谷', + 'cn-hangzhou' => '杭州', + 'cn-chengdu' => '成都', + ], + 'example' => 'ap-southeast-1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '动态路由的内网访问应用ID。无法和内网访问标签ID同时过滤。取值来源：'."\n" + .' - [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .' - [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '动态路由的内网访问标签ID。无法和内网访问应用ID同时过滤。取值来源：'."\n" + .' - [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .' - [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + [ + 'name' => 'NextHop', + 'in' => 'query', + 'schema' => [ + 'description' => '动态路由下一跳实例ID。取值来源：'."\n" + .' - [ListConnectors](~~ListConnectors~~)：批量查询Connector。', + 'type' => 'string', + 'required' => false, + 'example' => 'connector-8ccb13b6f52c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'TotalNum' => [ + 'description' => '动态路由的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DynamicRoutes' => [ + 'description' => '动态路由列表。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由。', + 'type' => 'object', + 'properties' => [ + 'DynamicRouteId' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'example' => 'dr-a0ca843f53cf****', + ], + 'Name' => [ + 'description' => '动态路由的名称。', + 'type' => 'string', + 'example' => 'dynamic_route_name', + ], + 'Description' => [ + 'description' => '动态路由的描述。', + 'type' => 'string', + 'example' => '这是一条动态路由', + ], + 'Status' => [ + 'description' => '动态路由状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'Priority' => [ + 'description' => '动态路由优先级。数字1表示优先级最高。优先级排序和列表查询从上到下保持一致。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionIds' => [ + 'description' => 'SASE的POP集群接入点支持的地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SASE的POP集群接入点支持的地域。', + 'type' => 'string', + 'enumValueTitles' => [ + 'cn-shenzhen' => '深圳', + 'cn-beijing' => '北京', + 'cn-shanghai' => '上海', + 'ap-southeast-1' => '新加坡', + 'us-east-1' => '弗吉尼亚', + 'us-west-1' => '硅谷', + 'cn-hangzhou' => '杭州', + 'cn-chengdu' => '成都', + ], + 'example' => 'ap-southeast-1', + ], + ], + 'ApplicationType' => [ + 'description' => '动态路由的应用类型。取值：'."\n" + .'- **All**：全部应用。'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => '全部应用', + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + 'ApplicationIds' => [ + 'description' => '动态路由的内网访问应用ID集合。当应用类型为**Application**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****', + ], + ], + 'TagIds' => [ + 'description' => '动态路由的内网访问标签ID集合。当应用类型为**Tag**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + ], + 'DynamicRouteType' => [ + 'description' => '动态路由类型。取值：**connector**：自有专线。', + 'type' => 'string', + 'enumValueTitles' => [ + 'connector' => '自有专线', + ], + 'example' => 'connector', + ], + 'NextHop' => [ + 'description' => '动态路由下一跳示例ID。', + 'type' => 'string', + 'example' => 'connector-8ccb13b6f52c****', + ], + 'CreateTime' => [ + 'description' => '动态路由创建时间。', + 'type' => 'string', + 'example' => '2023-03-21 11:50:03', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"TotalNum\\": 1,\\n \\"DynamicRoutes\\": [\\n {\\n \\"DynamicRouteId\\": \\"dr-a0ca843f53cf****\\",\\n \\"Name\\": \\"dynamic_route_name\\",\\n \\"Description\\": \\"这是一条动态路由\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"Priority\\": 1,\\n \\"RegionIds\\": [\\n \\"ap-southeast-1\\"\\n ],\\n \\"ApplicationType\\": \\"Application\\",\\n \\"ApplicationIds\\": [\\n \\"pa-application-e12860ef6c48****\\"\\n ],\\n \\"TagIds\\": [\\n \\"tag-d3f64e8bdd4a****\\"\\n ],\\n \\"DynamicRouteType\\": \\"connector\\",\\n \\"NextHop\\": \\"connector-8ccb13b6f52c****\\",\\n \\"CreateTime\\": \\"2023-03-21 11:50:03\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询动态路由', + ], + 'ListPrivateAccessApplicationsForDynamicRoute' => [ + 'summary' => '批量查询当前阿里云账号下动态路由的应用。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas7ZB8UX', + ], + ], + 'parameters' => [ + [ + 'name' => 'DynamicRouteIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '动态路由ID集合。最多可输入100个动态路由ID。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由ID。取值来源：'."\n" + .'- [ListDynamicRoutes](~~2525438~~)：批量查询动态路由。'."\n" + .'- [CreateDynamicRoute](~~2525443~~)：创建动态路由。', + 'type' => 'string', + 'required' => false, + 'example' => 'dr-ca9fddfac7c6****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + 'DynamicRoutes' => [ + 'description' => '动态路由列表。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由。', + 'type' => 'object', + 'properties' => [ + 'DynamicRouteId' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'example' => 'dr-ca9fddfac7c6****'."\n", + ], + 'Applications' => [ + 'description' => '内网访问应用集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用。', + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'description' => '内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-7a9243dd02f4****', + ], + 'Name' => [ + 'description' => '内网访问应用名称。', + 'type' => 'string', + 'example' => 'application_name', + ], + 'Description' => [ + 'description' => '内网访问应用描述。', + 'type' => 'string', + 'example' => '这是一条被动态路由引用的内网访问应用', + ], + 'Addresses' => [ + 'description' => '内网访问应用地址集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用地址。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + 'PortRanges' => [ + 'description' => '内网访问应用端口范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问应用端口范围。', + 'type' => 'object', + 'properties' => [ + 'Begin' => [ + 'description' => '起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'End' => [ + 'description' => '结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '81', + ], + ], + ], + ], + 'Protocol' => [ + 'description' => '内网访问应用协议。取值：'."\n" + .'- **All**：全部。'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => 'All', + 'TCP' => 'TCP', + 'UDP' => 'UDP', + ], + 'example' => 'All', + ], + 'Status' => [ + 'description' => '内网访问应用状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'CreateTime' => [ + 'description' => '内网访问应用创建时间。', + 'type' => 'string', + 'example' => '2022-04-13 13:33:24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\",\\n \\"DynamicRoutes\\": [\\n {\\n \\"DynamicRouteId\\": \\"dr-ca9fddfac7c6****\\\\n\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"pa-application-7a9243dd02f4****\\",\\n \\"Name\\": \\"application_name\\",\\n \\"Description\\": \\"这是一条被动态路由引用的内网访问应用\\",\\n \\"Addresses\\": [\\n \\"192.168.0.0/16\\"\\n ],\\n \\"PortRanges\\": [\\n {\\n \\"Begin\\": 80,\\n \\"End\\": 81\\n }\\n ],\\n \\"Protocol\\": \\"All\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2022-04-13 13:33:24\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询动态路由的应用', + ], + 'ListPrivateAccessTagsForDynamicRoute' => [ + 'summary' => '批量查询当前阿里云账号下动态路由的标签。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas642DA7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DynamicRouteIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '动态路由ID集合。最多可输入100个动态路由ID。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由ID。取值来源：'."\n" + .'- [ListDynamicRoutes](~~2525438~~)：批量查询动态路由。'."\n" + .'- [CreateDynamicRoute](~~2525443~~)：创建动态路由。', + 'type' => 'string', + 'required' => false, + 'example' => 'dr-ca9fddfac7c6****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'B608C6AE-623D-55C4-9454-601B88AE937E', + ], + 'DynamicRoutes' => [ + 'description' => '动态路由列表。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由。', + 'type' => 'object', + 'properties' => [ + 'DynamicRouteId' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'example' => 'dr-ca9fddfac7c6****', + ], + 'Tags' => [ + 'description' => '内网访问标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '内网访问标签。', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'Name' => [ + 'description' => '内网访问标签名称。', + 'type' => 'string', + 'example' => 'tag_name', + ], + 'Description' => [ + 'description' => '内网访问标签描述。', + 'type' => 'string', + 'example' => '这是一条被动态路由引用的内网访问标签', + ], + 'TagType' => [ + 'description' => '内网访问标签类型。取值：'."\n" + .'- **Default**：默认。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Custom' => '自定义', + 'Default' => '默认', + ], + 'example' => 'Custom', + ], + 'CreateTime' => [ + 'description' => '内网访问标签创建时间。', + 'type' => 'string', + 'example' => '2022-10-23 14:02:56', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B608C6AE-623D-55C4-9454-601B88AE937E\\",\\n \\"DynamicRoutes\\": [\\n {\\n \\"DynamicRouteId\\": \\"dr-ca9fddfac7c6****\\",\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"tag-d3f64e8bdd4a****\\",\\n \\"Name\\": \\"tag_name\\",\\n \\"Description\\": \\"这是一条被动态路由引用的内网访问标签\\",\\n \\"TagType\\": \\"Custom\\",\\n \\"CreateTime\\": \\"2022-10-23 14:02:56\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询动态路由的标签', + ], + 'GetDynamicRoute' => [ + 'summary' => '获取当前阿里云账号下指定动态路由的详情信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'DynamicRouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dr-16ff07c8207d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'DynamicRoute' => [ + 'description' => '动态路由。', + 'type' => 'object', + 'properties' => [ + 'DynamicRouteId' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'example' => 'dr-16ff07c8207d****'."\n", + ], + 'Name' => [ + 'description' => '动态路由名称。', + 'type' => 'string', + 'example' => 'dynamic_route_name', + ], + 'Description' => [ + 'description' => '动态路由的描述。', + 'type' => 'string', + 'example' => '这是一条动态路由'."\n", + ], + 'Status' => [ + 'description' => '动态路由状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Enabled', + ], + 'Priority' => [ + 'description' => '动态路由优先级。数字1表示优先级最高。优先级排序和列表查询从上到下保持一致。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionIds' => [ + 'description' => 'SASE的POP集群接入点支持的地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SASE的POP集群接入点支持的地域。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + ], + 'ApplicationType' => [ + 'description' => '动态路由的应用类型。取值：'."\n" + .'- **All**：全部应用。'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => '全部应用', + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + 'ApplicationIds' => [ + 'description' => '动态路由的内网访问应用ID集合。当应用类型为**Application**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问应用ID。', + 'type' => 'string', + 'example' => 'pa-application-e12860ef6c48****'."\n", + ], + ], + 'TagIds' => [ + 'description' => '动态路由的内网访问标签ID集合。当应用类型为**Tag**时，该字段有值。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问标签ID。', + 'type' => 'string', + 'example' => 'tag-fc0e2395e6f2****', + ], + ], + 'DynamicRouteType' => [ + 'description' => '动态路由类型。取值：**connector**：自有专线。', + 'type' => 'string', + 'enumValueTitles' => [ + 'connector' => '自有专线', + ], + 'example' => 'connector', + ], + 'NextHop' => [ + 'description' => '动态路由下一跳实例ID。', + 'type' => 'string', + 'example' => 'connector-8ccb13b6f52c****', + ], + 'CreateTime' => [ + 'description' => '动态路由创建时间。', + 'type' => 'string', + 'example' => '2023-02-09 10:31:47', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'DynamicRoute.NotFound', + 'errorMessage' => 'The dynamicRoute is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"DynamicRoute\\": {\\n \\"DynamicRouteId\\": \\"dr-16ff07c8207d****\\\\n\\",\\n \\"Name\\": \\"dynamic_route_name\\",\\n \\"Description\\": \\"这是一条动态路由\\\\n\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"Priority\\": 1,\\n \\"RegionIds\\": [\\n \\"ap-southeast-1\\"\\n ],\\n \\"ApplicationType\\": \\"Application\\",\\n \\"ApplicationIds\\": [\\n \\"pa-application-e12860ef6c48****\\\\n\\"\\n ],\\n \\"TagIds\\": [\\n \\"tag-fc0e2395e6f2****\\"\\n ],\\n \\"DynamicRouteType\\": \\"connector\\",\\n \\"NextHop\\": \\"connector-8ccb13b6f52c****\\",\\n \\"CreateTime\\": \\"2023-02-09 10:31:47\\"\\n }\\n}","type":"json"}]', + 'title' => '查询动态路由详情', + ], + 'ListDynamicRouteRegions' => [ + 'summary' => '批量查询当前阿里云账号下查询SASE的POP集群接入点支持地域。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'TotalNum' => [ + 'description' => '已授权SASE全球办公服务的POP集群接入点的地域总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Regions' => [ + 'description' => '已授权SASE全球办公服务的POP集群接入点的地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已授权SASE全球办公服务的POP集群接入点的地域。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ap-southeast-1' => '新加坡', + 'us-east-1' => '弗吉尼亚', + 'us-west-1' => '硅谷', + ], + 'example' => 'ap-southeast-1', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"TotalNum\\": 1,\\n \\"Regions\\": [\\n \\"ap-southeast-1\\"\\n ]\\n}","type":"json"}]', + 'title' => '批量查询动态路由已授权地域', + ], + 'CreateDynamicRoute' => [ + 'summary' => '创建当前阿里云账号下创建动态路由。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173138', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'dynamic_route_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条动态路由', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'Disabled', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由优先级。数字1表示优先级最高。取值：1-99。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '99', + ], + ], + [ + 'name' => 'RegionIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'SASE的POP集群接入点支持的地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SASE的POP集群接入点支持的地域。取值来源：'."\n" + .' - [ListDynamicRouteRegions](~~2525442~~)：批量查询动态路由已授权地域。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'cn-shenzhen' => '深圳', + 'cn-beijing' => '北京', + 'cn-shanghai' => '上海', + 'ap-southeast-1' => '新加坡', + 'us-east-1' => '弗吉尼亚', + 'us-west-1' => '硅谷', + 'cn-hangzhou' => '杭州', + 'cn-chengdu' => '成都', + ], + 'example' => 'ap-southeast-1', + ], + 'required' => true, + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由的应用类型。取值：'."\n" + .'- **All**：全部应用。'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'All' => '全部应用', + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '动态路由的内网访问应用ID集合。最多可输入200个内网访问应用ID。当**ApplicationType**为**Application**时，必填。和**TagIds**二选一。当**ApplicationType**为**All**时，禁止输入。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~611394~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~611541~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-application-7a4445897856****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '动态路由的内网访问标签ID集合。最多可输入40个内网访问标签ID。当**ApplicationType**为**Tag**时，必填。和**ApplicationIds**二选一。当**ApplicationType**为**All**时，禁止输入。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~611549~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~611552~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => true, + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DynamicRouteType', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由类型。取值：**connector**：自有专线。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'connector' => '自有专线', + ], + 'example' => 'connector', + ], + ], + [ + 'name' => 'NextHop', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由下一跳实例ID。取值来源：'."\n" + .' - [ListConnectors](~~611545~~)：批量查询Connector。', + 'type' => 'string', + 'required' => true, + 'example' => 'connector-8ccb13b6f52c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'DynamicRouteId' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'example' => 'dr-ca9fddfac7c6****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"DynamicRouteId\\": \\"dr-ca9fddfac7c6****\\"\\n}","type":"json"}]', + 'title' => '创建动态路由', + 'description' => '默认最多可创建100个动态路由。', + ], + 'UpdateDynamicRoute' => [ + 'summary' => '修改当前阿里云账号下动态路由。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173166', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'DynamicRouteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dr-ca9fddfac7c6****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由名称。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'dynamic_route_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由描述。长度为1~128个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一条动态路由', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由状态。取值：'."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Enabled' => '开启', + 'Disabled' => '关闭', + ], + 'example' => 'Disabled', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由优先级。数字1表示优先级最高。取值：1-99。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '99', + ], + ], + [ + 'name' => 'RegionIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'SASE的POP集群接入点支持的地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SASE的POP集群接入点支持的地域。取值来源：'."\n" + .' - [ListDynamicRouteRegions](~~2525442~~)：批量查询动态路由已授权地域。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cn-shenzhen' => '深圳', + 'cn-beijing' => '北京', + 'cn-shanghai' => '上海', + 'ap-southeast-1' => '新加坡', + 'us-east-1' => '弗吉尼亚', + 'us-west-1' => '硅谷', + 'cn-hangzhou' => '杭州', + 'cn-chengdu' => '成都', + ], + 'example' => 'ap-southeast-1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由的应用类型。取值：'."\n" + .'- **All**：全部应用。'."\n" + .'- **Application**：应用。'."\n" + .'- **Tag**：标签。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => '全部应用', + 'Tag' => '标签', + 'Application' => '应用', + ], + 'example' => 'Application', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '动态路由的应用ID集合。最多可输入200个内网访问应用ID。当**ApplicationType**为**Application**时，必填。和**TagIds**二选一。当**ApplicationType**为**All**时，禁止输入。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问应用ID。取值来源：'."\n" + .'- [ListPrivateAccessApplications](~~ListPrivateAccessApplications~~)：批量查询内网访问应用。'."\n" + .'- [CreatePrivateAccessApplication](~~CreatePrivateAccessApplication~~)：创建内网访问应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-application-f4dd77bced90****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '动态路由的内网访问标签ID集合。最多可输入40个内网访问标签ID。当**ApplicationType**为**Tag**时，必填。和**ApplicationIds**二选一。当**ApplicationType**为**All**时，禁止输入。', + 'type' => 'array', + 'items' => [ + 'description' => '动态路由的内网访问标签ID。取值来源：'."\n" + .'- [ListPrivateAccessTags](~~ListPrivateAccessTags~~)：批量查询内网访问标签。'."\n" + .'- [CreatePrivateAccessTag](~~CreatePrivateAccessTag~~)：创建内网访问标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-d3f64e8bdd4a****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DynamicRouteType', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由类型。取值：**connector**：自由专线。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'connector' => '自有专线', + ], + 'example' => 'connector', + ], + ], + [ + 'name' => 'NextHop', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由下一跳实例ID。取值来源：'."\n" + .' - [ListConnectors](~~ListConnectors~~)：批量查询Connector。', + 'type' => 'string', + 'required' => false, + 'example' => 'connector-8ccb13b6f52c****', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '动态路由的修改类型。取值：'."\n" + .'- **Cover**（默认）：使用**RegionIds**、**ApplicationIds**、**TagIds**、参数的值覆盖原SASE的POP集群接入点支持的地域、内网访问应用ID集合、内网访问标签集合。'."\n" + .'- **Append**：在原SASE的POP集群接入点支持的地域、内网访问应用ID集合、内网访问标签集合中分别增加**RegionIds**、**ApplicationIds**、**TagIds**参数中输入的值。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Cover' => '覆盖', + 'Append' => '附加', + ], + 'example' => 'Cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'DynamicRoute.NotFound', + 'errorMessage' => 'The dynamicRoute is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\"\\n}","type":"json"}]', + 'title' => '修改动态路由', + ], + 'DeleteDynamicRoute' => [ + 'summary' => '删除当前阿里云账号下动态路由。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173167', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'DynamicRouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '动态路由ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dr-ca9fddfac7c6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'DynamicRoute.NotFound', + 'errorMessage' => 'The dynamicRoute is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D\\"\\n}","type":"json"}]', + 'title' => '删除动态路由', + ], + 'LookupWmInfoMapping' => [ + 'summary' => '通过查询已创建的水印信息映射关系，根据数字格式的水印信息查找得到对应的字符串格式的水印信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226773', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'WmType', + 'in' => 'query', + 'schema' => [ + 'title' => '水印类型，枚举值:'."\n" + .'PureDocument: 常规文档水印'."\n" + .'PureWebappInvisible: 常规网页水印'."\n" + .'PureAppInvisible: 常规APP水印'."\n" + .'PureScreenInvisible: 常规屏幕水印'."\n" + .'PureImage: 常规图片水印'."\n" + .'PureAudio: 常规音频水印'."\n" + .'PureVideo: 常规视频水印'."\n" + .'AigcDocument: AIGC文档水印'."\n" + .'AigcWebappInvisible: AIGC网页水印'."\n" + .'AigcAppInvisible: AIGCAPP水印'."\n" + .'AigcScreenInvisible: AIGC屏幕水印'."\n" + .'AigcImage: AIGC图片水印'."\n" + .'AigcAudio: AIGC音频水印'."\n" + .'AigcVideo: AIGC视频水印', + 'description' => '水印类型。取值：'."\n" + .'- **PureWebappInvisible**：网页水印。'."\n" + .'- **PureAppInvisible**：App水印。'."\n" + .'- **PureScreenInvisible**：屏幕水印。'."\n" + .'- **PureDocument**：文档水印。'."\n" + .'- **PureImage**：图片水印。'."\n" + .'- **PureAudio**：音频水印。'."\n" + .'- **PureVideo**：视频水印。'."\n" + .'- **AigcWebappInvisible**：AIGC网页水印。'."\n" + .'- **AigcAppInvisible**：AIGC App水印。'."\n" + .'- **AigcScreenInvisible**：AIGC屏幕水印。'."\n" + .'- **AigcDocument**：AIGC文档水印。'."\n" + .'- **AigcImage**：AIGC图片水印。'."\n" + .'- **AigcAudio**：AIGC音频水印。'."\n" + .'- **AigcVideo**：AIGC视频水印。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'PureImage' => '图片水印', + 'AigcAppInvisible' => 'AIGC App水印', + 'PureWebappInvisible' => '网页水印', + 'AigcAudio' => 'AIGC音频水印', + 'PureDocument' => '文档水印', + 'PureAudio' => '音频水印', + 'AigcScreenInvisible' => 'AIGC屏幕水印', + 'AigcVideo' => 'AIGC视频水印', + 'AigcImage' => 'AIGC图片水印', + 'AigcWebappInvisible' => 'AIGC网页水印', + 'PureAppInvisible' => 'App水印', + 'PureScreenInvisible' => '屏幕水印', + 'PureVideo' => '视频水印', + ], + 'example' => 'PureDocument', + 'enum' => [ + 'PureWebappInvisible', + 'PureAppInvisible', + 'PureScreenInvisible', + 'PureImage', + 'PureAudio', + 'PureVideo', + 'AigcWebappInvisible', + 'AigcAppInvisible', + 'AigcScreenInvisible', + 'AigcImage', + 'AigcAudio', + 'AigcVideo', + 'PureDocument', + ], + ], + ], + [ + 'name' => 'WmInfoSize', + 'in' => 'query', + 'schema' => [ + 'title' => '水印信息的容量位宽，可用值为 32, 40, 64，不传时默认为32。非32时需显式指定。比如嵌入式使用的是 40 位的sdk，那么提取时也需要将该值设为 40。', + 'description' => '水印信息的容量位宽，默认为32。该参数应该和实际嵌入或者生成透明图时的容量位宽保持一致。取值范围：32~64。该参数的值应当和创建映射关系时保持一致。否则会导致查询不到映射关系。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '64', + 'minimum' => '32', + 'example' => '32', + ], + ], + [ + 'name' => 'WmInfoUint', + 'in' => 'query', + 'schema' => [ + 'description' => '数字格式的水印信息。取值来源：'."\n" + .'- [CreateWmInfoMapping](~~CreateWmInfoMapping~~)：创建水印信息映射关系接口的**WmInfoUint**返回值。', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7E9D7ACD-53D5-56EF-A913-79D148D06299', + ], + 'Data' => [ + 'description' => '映射关系查询结果。', + 'type' => 'object', + 'properties' => [ + 'WmInfoBytesB64' => [ + 'description' => '根据映射关系查询得到的字符串格式的水印信息。取值来源：'."\n" + .'- [CreateWmInfoMapping](~~CreateWmInfoMapping~~)：创建水印信息映射关系接口的**WmInfoBytesB64**参数。', + 'type' => 'string', + 'example' => 'aGVsbG8gc2F*****'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E9D7ACD-53D5-56EF-A913-79D148D06299\\",\\n \\"Data\\": {\\n \\"WmInfoBytesB64\\": \\"aGVsbG8gc2F*****\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '查询水印信息映射关系', + ], + 'CreateWmInfoMapping' => [ + 'summary' => '创建一条字符串格式的水印信息到数字格式的水印信息的映射关系。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226693', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'WmType', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印类型，枚举值:'."\n" + .'PureDocument: 常规文档水印'."\n" + .'PureWebappInvisible: 常规网页水印'."\n" + .'PureAppInvisible: 常规APP水印'."\n" + .'PureScreenInvisible: 常规屏幕水印'."\n" + .'PureImage: 常规图片水印'."\n" + .'PureAudio: 常规音频水印'."\n" + .'PureVideo: 常规视频水印'."\n" + .'AigcDocument: AIGC文档水印'."\n" + .'AigcWebappInvisible: AIGC网页水印'."\n" + .'AigcAppInvisible: AIGCAPP水印'."\n" + .'AigcScreenInvisible: AIGC屏幕水印'."\n" + .'AigcImage: AIGC图片水印'."\n" + .'AigcAudio: AIGC音频水印'."\n" + .'AigcVideo: AIGC视频水印', + 'description' => '水印类型。取值：'."\n" + .'- **PureWebappInvisible**：网页水印。'."\n" + .'- **PureAppInvisible**：App水印。'."\n" + .'- **PureScreenInvisible**：屏幕水印。'."\n" + .'- **PureDocument**：文档水印。'."\n" + .'- **PureImage**：图片水印。'."\n" + .'- **PureAudio**：音频水印。'."\n" + .'- **PureVideo**：视频水印。'."\n" + .'- **AigcWebappInvisible**：AIGC网页水印。'."\n" + .'- **AigcAppInvisible**：AIGC App水印。'."\n" + .'- **AigcScreenInvisible**：AIGC屏幕水印。'."\n" + .'- **AigcDocument**：AIGC文档水印。'."\n" + .'- **AigcImage**：AIGC图片水印。'."\n" + .'- **AigcAudio**：AIGC音频水印。'."\n" + .'- **AigcVideo**：AIGC视频水印。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'PureImage' => '图片水印', + 'AigcAppInvisible' => 'AIGC App水印', + 'PureWebappInvisible' => '网页水印', + 'AigcAudio' => 'AIGC音频水印', + 'PureDocument' => '文档水印', + 'PureAudio' => '音频水印', + 'AigcScreenInvisible' => 'AIGC屏幕水印', + 'AigcVideo' => 'AIGC视频水印', + 'AigcImage' => 'AIGC图片水印', + 'AigcWebappInvisible' => 'AIGC网页水印', + 'PureAppInvisible' => 'App水印', + 'PureScreenInvisible' => '屏幕水印', + 'PureVideo' => '视频水印', + ], + 'example' => 'PureDocument', + 'enum' => [ + 'PureWebappInvisible', + 'PureAppInvisible', + 'PureScreenInvisible', + 'PureImage', + 'PureAudio', + 'PureVideo', + 'AigcWebappInvisible', + 'AigcAppInvisible', + 'AigcScreenInvisible', + 'AigcImage', + 'AigcAudio', + 'AigcVideo', + 'PureDocument', + ], + ], + ], + [ + 'name' => 'WmInfoSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印信息的容量位宽，可用值为 32, 40, 64，不传时默认为32。非32时需显式指定。比如嵌入式使用的是 40 位的sdk，那么提取时也需要将该值设为 40。', + 'description' => '水印信息的容量位宽，默认为32。该参数应该和实际嵌入或者生成透明图时的容量位宽保持一致。取值范围：32~64。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '64', + 'minimum' => '32', + 'example' => '32', + ], + ], + [ + 'name' => 'WmInfoBytesB64', + 'in' => 'formData', + 'schema' => [ + 'title' => 'base64 编码后的字符串格式水印信息 。若设置该值，则 wmInfoUint 不能设置。', + 'description' => 'Base64编码后的字符串格式水印信息 。长度1～300个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'aGVsbG8gc2F*****'."\n", + 'maxLength' => 400, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7E9D7ACD-53D5-56EF-A913-79D148D06299', + ], + 'Data' => [ + 'description' => '映射结果。', + 'type' => 'object', + 'properties' => [ + 'WmInfoUint' => [ + 'description' => '映射得到的数字格式的水印信息。后续可以使用该值查找到对应映射的字符串格式的水印信息。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123***', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E9D7ACD-53D5-56EF-A913-79D148D06299\\",\\n \\"Data\\": {\\n \\"WmInfoUint\\": 0\\n }\\n}","type":"json"}]', + 'title' => '创建水印信息映射关系', + ], + 'CreateWmBaseImage' => [ + 'summary' => '获取网页水印、屏幕水印和App水印的暗水印透明底图。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226309', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'WmType', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印类型'."\n" + .'PureWebappInvisible: 常规网页水印'."\n" + .'PureAppInvisible: 常规APP水印'."\n" + .'PureScreenInvisible: 常规屏幕水印'."\n" + .'AigcWebappInvisible: AIGC网页水印'."\n" + .'AigcAppInvisible: AIGCAPP水印'."\n" + .'AigcScreenInvisible: AIGC屏幕水印', + 'description' => '水印类型。取值：'."\n" + .'- **PureWebappInvisible**：网页水印。'."\n" + .'- **PureAppInvisible**：App水印。'."\n" + .'- **PureScreenInvisible**：屏幕水印。'."\n" + .'- **AigcWebappInvisible**：AIGC网页水印。'."\n" + .'- **AigcAppInvisible**：AIGC App水印。'."\n" + .'- **AigcScreenInvisible**：AIGC屏幕水印。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'AigcAppInvisible' => 'AIGC App水印', + 'PureWebappInvisible' => '网页水印', + 'AigcWebappInvisible' => 'AIGC网页水印', + 'PureAppInvisible' => 'App水印', + 'PureScreenInvisible' => '屏幕水印', + 'AigcScreenInvisible' => 'AIGC屏幕水印', + ], + 'example' => 'PureWebappInvisible', + 'enum' => [ + 'PureWebappInvisible', + 'PureAppInvisible', + 'PureScreenInvisible', + 'AigcWebappInvisible', + 'AigcAppInvisible', + 'AigcScreenInvisible', + ], + ], + ], + [ + 'name' => 'WmInfoSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印信息的容量位宽，可用值为 32, 40, 64，不传时默认为32。非32时需显式指定。比如嵌入式使用的是 40 位的sdk，那么提取时也需要将该值设为 40。', + 'description' => '水印信息的容量位宽，默认为32。该参数嵌入和提取时需要保持一致。比如嵌入时使用的是 40 位的SDK，那么提取时也需要将该值设为 40。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + 32 => '32', + 40 => '40', + 64 => '64', + ], + 'example' => '32', + ], + ], + [ + 'name' => 'WmInfoUint', + 'in' => 'formData', + 'schema' => [ + 'description' => '10进制数字格式水印信息。若设置该值，则 WmInfoBytesB64 不能设置。'."\n" + ."\n" + .'取值范围取决于 WmInfoSize 参数：'."\n" + ."\n" + .'- 当 WmInfoSize 为**32**时，取值范围为 1~4294967295。'."\n" + ."\n" + .'- 当 WmInfoSize 为**40**时，取值范围为 1~1099511627775。'."\n" + ."\n" + .'- 当 WmInfoSize 为**64**时，取值范围为 1~18446744073709551615。', + 'type' => 'string', + 'required' => false, + 'example' => '12*****', + ], + ], + [ + 'name' => 'WmInfoBytesB64', + 'in' => 'formData', + 'schema' => [ + 'title' => 'base64 编码后的字符串格式水印信息 。若设置该值，则 wmInfoUint 参数不能设置。', + 'description' => 'Base64编码后的字符串格式水印信息 。长度1～300个字符。若设置该值，则 WmInfoUint 参数不能设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'aGVsbG8gc2F*****', + 'maxLength' => 400, + ], + ], + [ + 'name' => 'Scale', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印图片的缩放比例。', + 'description' => '水印图片的缩放比例。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '3', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Width', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印图片的宽度，单位为像素。取值范围为 [100, 5000]', + 'description' => '水印图片的宽度，单位为像素。取值：100~5000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '100', + 'example' => '1920', + ], + ], + [ + 'name' => 'Height', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印图片的高度，单位为像素。取值范围为 [100, 5000]', + 'description' => '水印图片的高度，单位为像素。取值：100~5000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '100', + 'example' => '1080', + ], + ], + [ + 'name' => 'Opacity', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印图片的透明度。取值范围为 [1, 255]', + 'description' => '水印图片的透明度。取值：1~255。取值越大，透明度越低。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '255', + 'minimum' => '1', + 'example' => '255', + ], + ], + [ + 'name' => 'ImageControl', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '图片水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'TextVisibleControl' => [ + 'description' => '图片文本水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'VisibleText' => [ + 'description' => '文本水印文案。格式为utf8字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '水印文本', + ], + 'Mode' => [ + 'description' => '文本水印显示模式。取值：'."\n" + .'- **pos**：固定位置模式。'."\n" + .'- **repeat**：平铺模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'pos' => 'pos', + 'repeat' => 'repeat', + ], + 'example' => 'pos', + ], + 'Opacity' => [ + 'description' => '文本水印透明度。取值：1~255。取值越大，越不透明。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + ], + 'FontSize' => [ + 'description' => '文本水印文字字号。取值越大，字体越大。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'FontColor' => [ + 'description' => '文本水印文字颜色。格式为 0xFFFFFF或#FFFFFF RGB颜色格式。如 0x000000或#000000 表示黑色。', + 'type' => 'string', + 'required' => false, + 'example' => '#FF0000', + ], + 'Angle' => [ + 'description' => '文本水印文字顺针旋转角度。取值范围0~360。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'PosX' => [ + 'description' => 'Mode为pos时生效。控制文本水印水平位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'PosY' => [ + 'description' => 'Mode为pos时生效。控制文本水印垂直位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'SpaceX' => [ + 'description' => 'Mode为repeat时生效。控制文本水印平铺水平间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'SpaceY' => [ + 'description' => 'Mode为repeat时生效。控制文本水印平铺垂直间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'PosAx' => [ + 'description' => '文本水印水平方向锚点。'."\n" + .'取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'PosAy' => [ + 'description' => '文本水印垂直方向锚点。'."\n" + .'取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Visible' => [ + 'description' => '可见性：'."\n" + ."\n" + .'true ： 显示'."\n" + ."\n" + .'false： 不显示', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Margin' => [ + 'description' => 'Mode为top-left、top-right、bottom-left、bottom-right时生效。边距。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => 'Mode为top-left、top-right时生效。上边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Right' => [ + 'description' => 'Mode为top-right、bottom-right时生效。右边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Bottom' => [ + 'description' => 'Mode为bottom-left、bottom-right时生效。下边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Left' => [ + 'description' => 'Mode为top-left、bottom-left时生效。左边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'LogoVisibleControl' => [ + 'description' => 'Logo水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'Enhance' => [ + 'description' => '是否开启增强明水印。开启后logo会被转换为水印logo，添加到图片上。', + 'type' => 'boolean', + 'required' => false, + ], + 'LogoBase64' => [ + 'description' => 'Base64格式logo水印。Logo文件为PNG图片转成Base64格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAFLRJREFUeF7tnXmYZFV5h9+vehwHE5FFQBZFDGDCoiiKYYIJqBBF4DEakARJGCQwfYtRRicsQiQkgWBEQGb6VjOyJKgxRpIYASWiPmZhcdgkGXABVDBq3FgSGGdguk/uObV0dXdV3Vunq073mfud55k/puus73d/92zfOVfQoASUQFcComyUgBLoTkAFok+HEuhBQAWij4cSUIHoM6AE/AhoD+LHTVOVhIAKpCSG1mb6EVCB+HHTVCUhoAIpiaG1mX4EVCB+3DRVSQioQEpiaG2mHwEViB83TVUSAiqQkhham+lHQAXix01TlYSACqQkhtZm+hFQgfhx01QlIaACKYmhtZl+BFQgftw0VUkIqEBKYmhtph8BFYgfN01VEgIqkJIYWpvpR0AF4sdNU5WEgAqkJIbWZvoRUIH4cdNUJSGgAimJobWZfgRUIH7cNFVJCKhASmJobaYfARWIHzdNVRICKpCSGFqb6UdABeLHTVOVhIAKpCSG1mb6EVCB+HHTVCUhoAIpiaG1mX4EVCB+3DRVSQioQEpiaG2mHwEViB83TVUSAiqQkhham+lHQAXix01TlYSACqQkhtZm+hFQgfhx01QlIaACKYmhtZl+BFQgftw0VUkIqEBKYmhtph8BFYgfN01VEgIqkJIYWpvpR0AF4sdNU5WEgAqkJIbWZvoRUIH4cdNUJSGgAimJobWZfgRUIH7cNFVJCKhASmJobaYfARWIHzdNVRICKpCSGFqb6UdABeLHTVOVhIAKpCSG1mb6EVCB+HHTVCUhoAIpiaG1mX4EVCB+3DRVSQioQEpiaG2mHwEViB83TVUSAiqQkhham+lHQAXix01TlYSACqQkhtZm+hFQgfhx01QlIaACKYmhtZl+BFQgftw0VUkIqEBKYmhtph8BFYgfN01VEgIqkJIYWpvpR0AF4sdNU5WEgAqkJIbWZvoRUIH4cdNUJSGgAimJobWZfgRUIH7cNFVJCKhASmJobaYfARWIHzdNVRICKpCSGFqb6UdABeLHTVOVhMC8C8QkvAj4PeCtGF6KsCuwZED8j5GUG/LyMlUOx/DFvHh9/P494BGEmxA+KWv4YR9pNeoCIjBvAjEJe2Yc/hQ4HhgZAhMDbC0pT+XlbU5iCc/jaaCSF9fjd1uPf2CC8+VKHvBIr0nmkcC8CMSMsizrKT42JGE0cd4rKa8uytYk3AG8rmh8j3iTwHJJXbs1REIguEBMwp8BfxKAz2WS8r6i5ZgqF2M4q2h873iGi6TGud7pNWFQAkEF0ug5rgnUwkLzj2Zdsh7kzVkP8oVAdTtFUq7upyxT5XgMy7umqbCKSY7qJ08bV1I3zHXBJFwKxXvd3LI2c6SsZcPMeCbhFuA5uek7RTA8KjX+wCutR6JgAjGnsQ8j3O9RR78kI7xAVvO/RRObhF8G/q9o/AHE20dSvlE0H1PljzH8Vdf4m9ieJSzF5C9KtPIQjpYxbmwJpMqXMbyhaJ1y421ka7lmOlOT8FpgXW7aXhEWs61czhNzyqNg4nACSfgccHTBes012mcl5Xf6zcQkfAb43X7Tecb/Z0l5W9G0bQL5PtDshW2PcSDwDUnZx5zBzjzDaTl5nt/4/QIWc6Vczo86COTerCex9uoU7LD1+eBYzV50MOyIMOoSdhLIKAcic3wOhGtljEeKsptLvCACMcvZjwr/NZeK9khrDfw14HaEO1jMnXIZv/Atq7Gi9RqEgzH8Orh/u/jm1zPdJPvLOOuL5N0mkNsk5TdsGpNwK7AU+JiknFoonwS7qgaTHCbjfLU9jZnqQa6WlFM65WcSfuB4GI6TmhPJtDDN1h0EUqSOCylOGIFUOQ/Dnw+o4bdhXBd9GxXWhXiTmIQXU+GgbK9kKZO8Dqk/oHMOhvOl5hYtcsNMgTSEXH8RGE6SGn9jTmVnFvPyTpnJmroYjAokl3V7hDACmXrT9VU54HsY7qDC7baXkDHXUyyI0BhLW7E0e5qX9V0xcQIvtLRsEs4EPmR7SklZakZ5PcK/uTIn2Fuu5EEzyqkIV3asxyQ7yTg/6SmQhK8AhwGuBzGjHIuw74z83g9uvnY9zJpTXsIkL22NFvqcB/bNL0CCUAKx4+bdCrbH7kL/BSN8Tlbz04Jp5j2aqbI9xo2t7RJ2UbE8Jakbz+eGWT3IKGchXAz8VFJ2bPQOf5QNf9aCWzm6E2ErDAe5zEfY0fLspwcxCd8C9s6tXDNChTezmR+0BKJDrGLoWkbJj/51nsvSucwh8osYfoy+Nh0bb/a8WnUQyA2IW9ZtLUhk84O6QIQHZIx9zWnsxQjf9hEIG1nJko4rYr/l8hMewMx6gV3DJPeoQPKsOeP3wgIxnCA1/rbP7BdcdJO4lbBZE9iOFa3wMlnDd/MaMUsgCY8B2wKrsl7oI9N6kAEIxHuSfjr7M8l/uvZoD5Jn1vrvhQVS4RWyZmirXcUqO4BYZpSXI3yzUFaT7CHj2GFlz2ASVgEfxnArFU7IJubNNJ+UlHc5zlVOwThXlvslZb+Gv9uDLuPN7CBr+VnOHORLwBubc5BOFTIJ/52tmlmH0mOzMuw8ZFowo7wN4Z9cJ5MybQhvqqzJep1qXlsL/S6slDEuLxR3DpFCzUHqS4t5YUsRSPvQJr/Nfj1IlQswfLD+BuJXpca3BjjE8t0H2TrzYl4GbGNXGZvL0U0Epsr9GPbJQ1Lw9772kQrmOSuaCsSXXI9008b+efl7DrGcLhJ+AuyA4cNS48wBCiSv1vm/Gw6VGv/aHtGczqGt/9slc8OFjf+/hQob8zNti7GZDTI+xx35AgUuLIH0sXFWoG3zFmXa0CavFh5DLKlxiBPI1JBlvaTsP+chVpWPZK4qdme+W7DPy282frS9zExXnmcyT4T1CFfLWG+3opbTquE+qXFAHqb5+n1hCUSHWF2fgy476acDq60PmaRsPdcepMhD2JrDGA6Wmjsi4BVMwm3AwcAVkvJer0wCJFpYAtEepLtA2ibpbT3IiRius4nshHiuPUiR522AAqnPS7u4rMysi0mwCwiLmGSljGN7ryBBBTIEzMGGWKNciPAB4IfZQaxdZwlkOW+gwpcbD+J2UuPxXqtY7nmtOxO6ZeMOoX2IZd317YrW7GC4uVfvYqrO+8D2IHZ1bRdZO+Uw2c0cJnGisEOxsyTt4dU8YHsuLIHoEKt7DzLl7j7lrFjlEQwvabmGNDcKmzvpOL8se+b/cUnZzgmghy9W43frCVDIP6zHs3iNpLy7x8N+NvCX1pVIUvYo8kybhDEgyZxHb5aUtxRJM4g4C0sgAxpimeUcSqWru3Z3boZVUnOuGnMKw+5B3LEB4ePuoot62CvbC3morQeZWf8zJOWjZgVbM8GT7scO3rxOIFWO67EUa5dv6/OFzjvpzXK/K6lb7u0YTOIOptkDap+QlBOLwDaj/L69ACPbGC3snlMk37w4W7JA7NCjv2C4PhKBrEKcA6cN50jqfLLsw/1qDMe0NfpJhC82V5RMwtvdBRI2bGZ3Wcuj/QAyy50jYnPXv+NGYZH8TMLjjb2SauZHlhZKs5xdqTSGdAN6kRYpd4sUSJGGDzNOgB7ECuQfgZWS8umibWnbBXcewUXTNeMNQiAm4ddaB62EA2WMe4rWwyT8D7AThtMG8SIrUu7CEojOQbrarNMybxEDN1w/7BVLdmhU96judtipyr4Yju2Rr/X9ek/j984nCqcS272Z2a4oU/MkW4+LEJ4t0g4XR1jWmHN9WlJ3XdTQw8ISiOGVUms4ug296cMrwFTZG+NcxfOD4VeySwi+kxdx5nmQvPitt/7U5Lb5pxWSsqZTepM4V/25TtCbWX9b0tmHt0zCVdB9Al+oXYarpOY8l4ceFpZAtAfp1YPUbzUR1ssYdoOwUHALFuIeJrvDfXc2tOp6g6RJ3A0nU+4ghUroGemomRf3mVGsC6OvP9YmhH9nKy6TS9xFf0MPC0sgW0oP0o837wh7ymoeHrqltQAvAioQL2y9E/Xl7q4CGYIFBpelCmRwLFs5qUCGAHWeslxoAnmN1Lh7nlgMrFjTfqouL9eC7u552ZiTeb47Imt4v2VoEm5EGG+/GC4vD/19NoGFJpBRqTEeu6GyjTC7pFrstNugBDLKtgiPZScOD8+cGb+kAhnMUxRKIPbcQP7tHcKjTPBaez3NYJoXPhdzOru4iwvshlaR0LhtpEjUXnHMu9mO5/LzpkDmmp+mrxMIJRB7RaXdQS0SrAPe+Ri+EJNQ3LU/kxyDuH2EolcczTq33VMEo7wVcb2Tve3Rnkm/lY2cae+/NWewDc/w+LQexFBjhIeZZJwKy2XN1Dl5M8rN1smRCr9w9/luYCv56/qpPpNwNoZTpMaepu7iYX2gLgB359ZemdOgfYGd2G3J2KxgByZcXHv968+A/6DChbKGu1z+VS7CuOtJrW+Xbcd5kroymufqz8hcZu5BWn5an8heOLXGRRj2lstvMsLxspr7ijxQc4kTRiCjXI/wDo+K2i8z3Y3hLoR1bGKdXO1u85j34C6Os1eT2ovj6t8VKXoXVnvdH8oeDPvA5Ya2y7XPYYSrWcRTbOKzCPfKGGd3EMgTCKtkjKtMwqPUN9fcJqBJ3OVwX2GSPRhhv54CqX/o6MHG8O09CE9iWJGdOT+i260lGZubsoNc22fCeJPdB8kWLT6FcEh2o/2LTeL2cC52d3rZ20/EiegkDG7+2XK4NNxHhSsyh8Y9MZwDbt/j2uwuYvvFsPMaTotH5oKbY4RQArEfzBnMZw/sMMy+Xez1oxXu4lnWydqGh+ocYXRLPrSrR4XVMtZy3ehZe/NeduJZRmd8rsBu7B1gL8HuKZD6t09+W1Je1RDIGPU9p0NMlaMKCuRcGeMil765CDHCATPf4q27eQ1HSq3+OQnHDz7uXpL2wRcuab+RxM2X4Onstvt3tgTSNjczifM0sK4rzhHTjPKHiDuJ+IIhmbyVbRiB1G8dtIdrBvXtwZlcLEA77r+z+a/Ip9c6we1webXtIXYeiiEqHNa8M7dI/qbK7kxiLziwb/0X2je0Hb4UEIj1sVpP46EziTugZA8eXddRIFU+wCQnuyHWVA/Sciw0K9iNCb5Ph2O3rWt/NrH9zN7erGQrNrGBGd64pn5L5AmS8oqGQOzD/7wmkyzPrwM3NT881PhWyqdmXitUhGG/cYIIpDG2tONO21UOPxgetsbttyCT8Pf2vqd+03nGtw/264umzeYMdjhn5w0XuUu71/BVk7gLqZ/IE0jjrWsfsuvcUBVuYSM7urlL5x7kUus2P00g8KqsHJsHOQJ5lzurspltZvbsZjk7UuHHTaG2CeB9CCe7u7zqd3tdIqmbn7jgBCLcKKkbWtl5inW72cIEUj+sYz+gU3gCW/Th6Rhvkt1k3F3VXyjMwwd0DpLU9XiFgqnfg7Vz+2cOGoJeXEggCfbSaTsPtALZRVKOcw9bwhHZ5Qn/gvBCGePnjb/djmEHT4HYI7t3tfcuzk1euJZNHMMSfoRhWfunE0x9jrrItaOsAmm8eV7JhDuL3Oo+Cz0dPpEMJ2YGtqsfhULQT7B53ApoqoxiOJMKy5jgMcRNdu0Ni/dieCdLeHrGKlZrku7Y15ef7QvDXghuPyZqz5NM/V24FOEGJjjcfQDH8FhRgZiEc7M55ktkrP7xHlPla9lowToW1j+kA1cwyYZsEn60Sdz+kB0mnswzrGeRE6q9T/gIGeOWUgukAc9+k9wax16hP8zQ9SMwnQoN+BFPd8mbT8Oz8+T261BWGHb+cQvilmPt2W672mdXlm6ctpNuqEnNrSi5YBLnybu/pNPnVI1exJ7AtBdTr8dwKRXeJGOc0LbMa7+r+FDjRWeXcT/DBIn9tPUsgdjvlCxyy7L2GlNrZ9tTviM7p25v+bcCsr2hvUq1/qIUphYA6kvZdjGi9b3Fhou8PeTlvuto6pdRfFDSgXoedzRJsDlIe+mNlY7PZ+vwdnVjOKHPeUhfN7L71dhOjE/q5W7ul23xVCZxw6vPt6+EFU892Jhuwr6RgxC+0xTOYEsYTG7zIhD3FljFL2VfsbDLlPZNMpxQcB4y9PmH3bCb4JxhL0d3g2jqJwX3A/6O5/Ai+Sg/Hg7wLS/XeRNIq9u3PkT17+zZyd3uje8BbjUQ1PVPnE27H7ZTvgOef9gNrfon4uy3Ezdx63xvbprEXdTwdgyXS42VA2FbkkzmXSAl4azNjJSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ+D/AdF26yPzUbcJAAAAAElFTkSuQmCC', + ], + 'Mode' => [ + 'description' => 'Logo水印显示模式。取值：'."\n" + .'- **pos**：固定位置模式。'."\n" + .'- **repeat**：平铺模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'pos' => 'pos', + 'repeat' => 'repeat', + ], + 'example' => 'pos', + ], + 'Opacity' => [ + 'description' => 'Logo水印透明度。取值：1~255。取值越大，透明度越低。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + ], + 'Angle' => [ + 'description' => 'Logo水印文字顺针旋转角度。取值范围1~360', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'PosX' => [ + 'description' => 'Mode为pos时生效。控制明水印水平位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'PosY' => [ + 'description' => 'Mode为pos时生效。控制明水印垂直位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'SpaceX' => [ + 'description' => 'Mode为repeat时生效。控制明水印平铺水平间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'SpaceY' => [ + 'description' => 'Mode为repeat时生效。控制明水印平铺垂直间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'PosAx' => [ + 'description' => 'Logo水印水平方向锚点。 取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'PosAy' => [ + 'description' => 'Logo水印垂直方向锚点。 取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角为位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Visible' => [ + 'description' => '可见性：'."\n" + ."\n" + .'**true** ： 显示'."\n" + ."\n" + .'**false**： 不显示', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Margin' => [ + 'description' => 'Mode为top-left、top-right、bottom-left、bottom-right时生效。边距。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => 'Mode为top-left、top-right时生效。上边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Right' => [ + 'description' => 'Mode为top-right、bottom-right时生效。右边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Bottom' => [ + 'description' => 'Mode为bottom-left、bottom-right时生效。下边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Left' => [ + 'description' => 'Mode为top-left、bottom-left时生效。左边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'comment', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => '备注', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '58D6B23E-E5DA-5418-8F61-51A3B5A30049', + ], + 'Data' => [ + 'description' => '透明图信息。', + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'description' => '透明图ID，相同的ID表示图片内容完全一致。', + 'type' => 'string', + 'example' => 'fafb432cdede9b20640e12105845386e-496883833-8242409229217337*****', + ], + 'ImageUrl' => [ + 'description' => '可用于下载图片的临时URL。', + 'type' => 'string', + 'example' => 'https://example.com/test-*****.png', + ], + 'ImageUrlExp' => [ + 'description' => '图片临时URL的有效截止时间，格式为Unix时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17185*****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D6B23E-E5DA-5418-8F61-51A3B5A30049\\",\\n \\"Data\\": {\\n \\"ImageId\\": \\"fafb432cdede9b20640e12105845386e-496883833-8242409229217337*****\\",\\n \\"ImageUrl\\": \\"https://example.com/test-*****.png\\",\\n \\"ImageUrlExp\\": 0\\n }\\n}","type":"json"}]', + 'title' => '创建暗水印透明底图', + ], + 'GetWmExtractTask' => [ + 'summary' => '根据创建提取任务时获取的任务ID，查询水印提取任务结果。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216135', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '创建提取任务返回的 task id', + 'description' => '提取任务ID。取值来源：'."\n" + .'- [CreateWmExtractTask](~~CreateWmExtractTask~~)：创建水印提取任务。', + 'type' => 'string', + 'required' => true, + 'example' => 'wmt-9648c22d2eb2cb57bb855dcae7898464********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '102350E7-1A20-58F5-9D63-ABEA820AE6E1', + ], + 'Data' => [ + 'description' => '任务结果。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间', + 'type' => 'string', + 'example' => '2024-01-01 11:22:33', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'wmt-9648c22d2eb2cb57bb855dcae7898464********', + ], + 'Status' => [ + 'title' => '任务状态'."\n" + .'Running: 运行中'."\n" + .'Success: 任务执行成功'."\n" + .'Failed: 任务执行失败', + 'description' => '任务状态。取值：'."\n" + .'- **Running**：运行中。'."\n" + .'- **Success**：成功。'."\n" + .'- **Failed**：失败。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Failed' => '失败', + 'Running' => '运行中', + 'Success' => '成功', + ], + 'example' => 'Success', + 'enum' => [ + 'Running', + 'Success', + 'Failed', + ], + ], + 'Filename' => [ + 'title' => '创建提取任务时传入的文件名', + 'description' => '创建提取任务时传入的文件名。', + 'type' => 'string', + 'example' => 'test-****.pdf', + ], + 'WmType' => [ + 'title' => '创建提取任务时传入的水印类型', + 'description' => '创建提取任务时传入的水印类型。', + 'type' => 'string', + 'example' => 'PureDocument', + ], + 'WmInfoSize' => [ + 'title' => '创建提取任务时传入的参数', + 'description' => '创建提取任务时传入的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'WmInfoUint' => [ + 'title' => '提取得到的结果', + 'description' => '提取得到的10进制数字格式的水印信息。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123**', + ], + 'WmInfoBytesB64' => [ + 'title' => '提取得到的结果', + 'description' => '提取得到的base64编码字符串格式的水印信息。', + 'type' => 'string', + 'example' => 'aGVsbG8gc2Fz****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102350E7-1A20-58F5-9D63-ABEA820AE6E1\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"2024-01-01 11:22:33\\",\\n \\"TaskId\\": \\"wmt-9648c22d2eb2cb57bb855dcae7898464********\\",\\n \\"Status\\": \\"Success\\",\\n \\"Filename\\": \\"test-****.pdf\\",\\n \\"WmType\\": \\"PureDocument\\",\\n \\"WmInfoSize\\": 32,\\n \\"WmInfoUint\\": 0,\\n \\"WmInfoBytesB64\\": \\"aGVsbG8gc2Fz****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询水印提取任务详情', + ], + 'GetWmEmbedTask' => [ + 'summary' => '使用创建水印嵌入任务得到的任务ID，查询嵌入任务结果。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216126', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '创建嵌入任务时得到的任务ID', + 'description' => '创建嵌入任务时得到的任务ID。取值来源：'."\n" + .'- [CreateWmEmbedTask](~~CreateWmEmbedTask~~)：创建水印嵌入任务。', + 'type' => 'string', + 'required' => true, + 'example' => 'job:5GfrJYsoaffmCE7Z5bZtjU********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'D6707286-A50E-57B1-B2CF-EFAC59E850D8', + ], + 'Data' => [ + 'description' => '水印嵌入任务结果。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '嵌入任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'job:5GfrJYsoaffmCE7Z5bZtjUxxxxxxxxxx', + ], + 'TaskStatus' => [ + 'title' => '任务状态'."\n" + .'Running: 运行中'."\n" + .'Success: 任务执行成功'."\n" + .'Failed: 任务执行失败'."\n", + 'description' => '任务状态。取值：'."\n" + .'- **Running**：运行中。'."\n" + .'- **Success**：成功。'."\n" + .'- **Failed**：失败。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Failed' => '失败', + 'Running' => '运行中', + 'Success' => '成功', + ], + 'example' => 'Success', + 'enum' => [ + 'Running', + 'Success', + 'Failed', + ], + ], + 'FileUrl' => [ + 'title' => '输入文件的下载 url', + 'description' => '嵌入水印信息得到的文件的临时URL。', + 'type' => 'string', + 'example' => 'https://example.com/embed-****.pdf', + ], + 'FileUrlExp' => [ + 'title' => 'fileUrl 的过期时间，格式为 unix 时间戳，单位为秒', + 'description' => 'FileUrl的过期时间，格式为Unix时间戳，精度为秒。', + 'type' => 'string', + 'example' => '171859****', + ], + 'Filename' => [ + 'title' => '输出文件的文件名', + 'description' => '嵌入水印信息得到的文件的文件名。', + 'type' => 'string', + 'example' => 'embed-****.pdf'."\n", + ], + 'OutFileHashMd5' => [ + 'title' => '输出文件的md5哈希，用于校验', + 'description' => '嵌入水印信息得到的文件的md5哈希，用于排查问题。', + 'type' => 'string', + 'example' => 'd41d8cd98f00b204e9800998ecf8****', + ], + 'OutFileSize' => [ + 'title' => '输入文件的大小（单位为字节），用于校验', + 'description' => '嵌入水印信息得到的文件的大小，单位为字节。用于排查问题。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123**', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6707286-A50E-57B1-B2CF-EFAC59E850D8\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"job:5GfrJYsoaffmCE7Z5bZtjUxxxxxxxxxx\\",\\n \\"TaskStatus\\": \\"Success\\",\\n \\"FileUrl\\": \\"https://example.com/embed-****.pdf\\",\\n \\"FileUrlExp\\": \\"171859****\\",\\n \\"Filename\\": \\"embed-****.pdf\\\\n\\",\\n \\"OutFileHashMd5\\": \\"d41d8cd98f00b204e9800998ecf8****\\",\\n \\"OutFileSize\\": 0\\n }\\n}","type":"json"}]', + 'title' => '查询水印嵌入任务详情', + ], + 'CreateWmExtractTask' => [ + 'summary' => '创建数字水印提取任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216136', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'WmType', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印类型，枚举值:'."\n" + .'PureDocument: 常规文档水印'."\n" + .'PureWebappInvisible: 常规网页水印'."\n" + .'PureAppInvisible: 常规APP水印'."\n" + .'PureScreenInvisible: 常规屏幕水印'."\n" + .'PureImage: 常规图片水印'."\n" + .'PureAudio: 常规音频水印'."\n" + .'PureVideo: 常规视频水印'."\n" + .'AigcDocument: AIGC文档水印'."\n" + .'AigcWebappInvisible: AIGC网页水印'."\n" + .'AigcAppInvisible: AIGCAPP水印'."\n" + .'AigcScreenInvisible: AIGC屏幕水印'."\n" + .'AigcImage: AIGC图片水印'."\n" + .'AigcAudio: AIGC音频水印'."\n" + .'AigcVideo: AIGC视频水印', + 'description' => '水印类型。取值：'."\n" + .'- **PureWebappInvisible**：网页水印。'."\n" + .'- **PureAppInvisible**：App水印。'."\n" + .'- **PureScreenInvisible**：屏幕水印。'."\n" + .'- **PureDocument**：文档水印。'."\n" + .'- **PureImage**：图片水印。'."\n" + .'- **PureAudio**：音频水印。'."\n" + .'- **PureVideo**：视频水印。'."\n" + .'- **AigcWebappInvisible**：AIGC网页水印。'."\n" + .'- **AigcAppInvisible**：AIGC App水印。'."\n" + .'- **AigcScreenInvisible**：AIGC屏幕水印。'."\n" + .'- **AigcDocument**：AIGC文档水印。'."\n" + .'- **AigcImage**：AIGC图片水印。'."\n" + .'- **AigcAudio**：AIGC音频水印。'."\n" + .'- **AigcVideo**：AIGC视频水印。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'PureImage' => '图片水印', + 'AigcAppInvisible' => 'AIGC App水印', + 'PureWebappInvisible' => '网页水印', + 'AigcAudio' => 'AIGC音频水印', + 'PureDocument' => '文档水印', + 'PureAudio' => '音频水印', + 'AigcScreenInvisible' => 'AIGC屏幕水印', + 'AigcVideo' => 'AIGC视频水印', + 'AigcImage' => 'AIGC图片水印', + 'AigcWebappInvisible' => 'AIGC网页水印', + 'PureAppInvisible' => 'App水印', + 'PureScreenInvisible' => '屏幕水印', + 'PureVideo' => '视频水印', + ], + 'example' => 'PureDocument', + 'enum' => [ + 'PureWebappInvisible', + 'PureAppInvisible', + 'PureScreenInvisible', + 'PureImage', + 'PureAudio', + 'PureVideo', + 'AigcWebappInvisible', + 'AigcAppInvisible', + 'AigcScreenInvisible', + 'AigcImage', + 'AigcAudio', + 'AigcVideo', + 'PureDocument', + 'VisibleEnhance', + ], + ], + ], + [ + 'name' => 'IsClientEmbed', + 'in' => 'query', + 'schema' => [ + 'description' => '音频水印参数：是否为客户端SDK嵌入，默认为false。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FileUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => '可用于下载文件的 URL'."\n" + .'控制台调用时传递文件的 oss 路径', + 'description' => '用于下载待提取文件的URL，需要可以公网访问。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://example.com/test-****.pdf', + ], + ], + [ + 'name' => 'Filename', + 'in' => 'formData', + 'schema' => [ + 'title' => '文件名，后端需要根据文件名的后缀判断校验文件类型', + 'description' => '待提取文件的文件名，后端需要根据文件名的后缀判断校验文件类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-****.pdf', + ], + ], + [ + 'name' => 'WmInfoSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印信息的容量位宽，可用值为 32, 40, 64，不传时默认为32。非32时需显式指定。比如嵌入式使用的是 40 位的sdk，那么提取时也需要将该值设为 40。', + 'description' => '水印信息的容量位宽，默认为32。该参数嵌入和提取时需要保持一致。比如嵌入时使用的是 40 位的SDK，那么提取时也需要将该值设为 40。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '64', + 'minimum' => '32', + 'example' => '32', + ], + ], + [ + 'name' => 'VideoSpeed', + 'in' => 'formData', + 'schema' => [ + 'title' => '长视频水印参数：含义为视频倍速，浮点数字符串。默认1，代表添加水印时的采用倍速，或者添加水印之后，视频时间轴拉伸的倍速', + 'description' => '长视频水印参数：含义为视频倍速，浮点数字符串。默认1，代表添加水印时的采用倍速，或者添加水印之后，视频时间轴拉伸的倍速。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VideoIsLong', + 'in' => 'formData', + 'schema' => [ + 'title' => '视频水印参数：在嵌入视频水印时，通过该值控制使用使用长视频的SDK。默认为 false，此时会使用短视频的 SDK', + 'description' => '视频水印参数：是否使用长视频水印SDK，默认为false。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'DocumentIsCapture', + 'in' => 'formData', + 'schema' => [ + 'title' => '文档水印参数：当提取文档截图中的背景暗水印信息时将该参数设为true。默认为 false', + 'description' => '文档水印参数：指定待提取文件是否为添加了背景水文档的截图。服务会根据待提取文件是否为图像文件来判断是否走文档背景水印提取逻辑，因此默认无需设置该参数 。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'CsvControl', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'CSV水印控制参数。需要和嵌入时的参数保持一致，否则会提取失败。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => 'CSV水印嵌入方法。需要和嵌入时的参数保持一致，否则会提取失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'lossless_row_shift_embed', + 'enum' => [ + 'lossless_row_shift_embed', + 'lossy_number_embed', + 'lossy_time_stamp_embed', + 'lossy_zero_width_embed', + ], + ], + 'EmbedColumn' => [ + 'description' => '有损嵌入控制参数：指定修改列。需要和嵌入时的参数保持一致，否则会提取失败。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'EmbedPrecision' => [ + 'description' => '有损嵌入控制参数：指定修改精度。需要和嵌入时的参数保持一致，否则会提取失败。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'EmbedTimePosition' => [ + 'title' => '嵌入位置，枚举值。需要和嵌入时的参数保持一致'."\n", + 'description' => '时间戳水印参数：控制时间戳水印嵌入位置。需要和嵌入时对应参数保持一致，否则会提取失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Min', + 'enum' => [ + 'Min', + 'Sec', + 'MilSec', + ], + ], + 'EmbedBitsNumberInEachTime' => [ + 'title' => '时间戳信息位宽，需要和嵌入时保持一致。', + 'description' => '时间戳水印参数：指定单个时间戳容纳多少信息。需要和嵌入时对应参数保持一致，否则会提取失败。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '4', + 'minimum' => '1', + 'example' => '1', + ], + 'TimeFormat' => [ + 'title' => '时间戳的格式，需要和嵌入时保持一致。', + 'description' => '时间戳水印参数：指定时间戳格式。需要和嵌入时对应参数保持一致，否则会提取失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year-Mon-Day Hour:Min:Sec.MilSec', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ImageExtractParamsOpenApi', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '图片提取参数', + 'type' => 'object', + 'properties' => [ + 'SrcLogoBase64' => [ + 'description' => '增强明水印Logo,base64格式原文件。用于提取增强明水印。', + 'type' => 'string', + 'required' => false, + 'example' => 'iVBORw0KGgoAAAANSUhEUgAAAGQAAAAWCAYAAAA2CDmeAAAACXBIWXMAAAsTAAALEwEAmpwYAAAE7mlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgOS4wLWMwMDAgNzkuMTcxYzI3ZiwgMjAyMi8wOC8xNi0xODowMjo0MyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iIHhtbG5zOnBob3Rvc2hvcD0iaHR0cDovL25zLmFkb2JlLmNvbS9waG90b3Nob3AvMS4wLyIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0RXZ0PSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VFdmVudCMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIDI0LjAgKFdpbmRvd3MpIiB4bXA6Q3JlYXRlRGF0ZT0iMjAyNS0wNS0yN1QyMjo1MToyMyswODowMCIgeG1wOk1vZGlmeURhdGU9IjIwMjUtMDUtMjdUMjM6NDQ6MzcrMDg6MDAiIHhtcDpNZXRhZGF0YURhdGU9IjIwMjUtMDUtMjdUMjM6NDQ6MzcrMDg6MDAiIGRjOmZvcm1hdD0iaW1hZ2UvcG5nIiBwaG90b3Nob3A6Q29sb3JNb2RlPSIzIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOmRiYTA3MjM3LWJmNWUtNTc0ZS04ZDhlLTAyNDlmNDFlNWE2ZCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpkYmEwNzIzNy1iZjVlLTU3NGUtOGQ4ZS0wMjQ5ZjQxZTVhNmQiIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpkYmEwNzIzNy1iZjVlLTU3NGUtOGQ4ZS0wMjQ5ZjQxZTVhNmQiPiA8eG1wTU06SGlzdG9yeT4gPHJkZjpTZXE+IDxyZGY6bGkgc3RFdnQ6YWN0aW9uPSJjcmVhdGVkIiBzdEV2dDppbnN0YW5jZUlEPSJ4bXAuaWlkOmRiYTA3MjM3LWJmNWUtNTc0ZS04ZDhlLTAyNDlmNDFlNWE2ZCIgc3RFdnQ6d2hlbj0iMjAyNS0wNS0yN1QyMjo1MToyMyswODowMCIgc3RFdnQ6c29mdHdhcmVBZ2VudD0iQWRvYmUgUGhvdG9zaG9wIDI0LjAgKFdpbmRvd3MpIi8+IDwvcmRmOlNlcT4gPC94bXBNTTpIaXN0b3J5PiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pj/PwpEAAAZYSURBVGje3Zp7iFVFHMfPlkaW9qAM0nQlzQxiS1YrQ0vyEdVmRmaCiu9777nnruuu2oMK2wQrkUpJxAyFJDAoIiqt7AVmDylbFMuSnpaKFLXqrliup+/M+c49c+eec+859xHVHx/3zsxv5szMd56/0XITluXaIA0c61b8fRMcBcfBEY120AVbF3Y3uY2wzxCH+X1GSru0dZL59HKOyzjH2oK/DdJefD9B0nnlDafdGA1Rz2vAGaAODANDCzACDNTK7AHqydCYXAsuN9p7JrgUDAC1MRkEestyXBf/zGWHONYHiHSLMt96Dlg5NAXQaK2NVJ5jbcP3u7nzWJdkniCfhOTdzg44Guk73kBTZdZFzBPGDkOQMWWW95IvSEoW+F7RTN6If81tgf0isFCjxUDENctyt0Ss0PuyHqlsfYIE+RN0gGMMf8QR9gfDJw3+kjPa/8bmEEG6AvKGpXVVXxDHmlnEWDT8YdhdJjOpTkuSFGdYEF5lB8v83oguNFNmyJmRv/ztoM18hufJwZGxPpSz05bLVs8AhG2aeYWQF4QIMplxKs8gLW2UkTaK8buMOp4FrgRXgCExEXXp6wuSDlyqvgTN6Jy+2TVddVR+h8fhErAA7A0Q5K2QPUkJMpfhFbRfJ20Lf28284q96+wQQSYYeS7W0uqNtHrG7y6h7cWhIIeNjmnLCuBom6wuSDkf9cvaZYjyE8o+LUBsJcg0hj9nPRMsZzx4BTxD1oG1tJ0YQZA3wFLmXQ42aGkvgmVMW8awiN9ZTUGOGHuFk+2UIEHKxZ9hCw1BDvP0E7Zk3c6wGjh1rNP9IcugSBsbQZBKbOpVFWR6GUtSHEHmxhTkBgjQj7+/09KVIG3g+RIEeQc8BdaD1WCTlvYqWMm0VQy7nKX/kCBpCJKukhi5xBPEtq7DAeJmiCJsX9fS72P+pcwfV5B/3R4SRxBxzGwCc7hhFqIl4AJVuiDisilOWL59G9OdMgW5m3EqfaCWNtJIGxlwyjoffMpZ20a+4CzaqcUVQlyWW0sRZGLMtTZRRUG+N462pQoi7jed7BTFKaad0NI6GTb3kN5MCzrKu5zRUVj/XxNkKsOPZU9llRGk3E1duE1mABvL6iy6dXZLIVLWt2AKfk8vsposknecEgTpTb/SWMO3FMSE7IWnMoLMY7iB4Z/LEKQnj8vjjTqL5WoJ8/zGuBGGTQP9a/nHec+/d5GcUZ4gGXlxdv6Pm3plBSnEncxzIFZ7hBgLpCDP0s0kBD0v0r0s0rFXGaWqcAS2qyLIyxxMUQQZxsteK3hEw9GOvUcZ94Bh8wR4kO4Ss119uCe5dBcFea9zL9gL6RtsCZ8hiawIKcN3ZVfwHuL5piopSJyLYarMPUQ4OC+UZc0Bs/h0kLEe5WbeKZcu5QrKb9MI2DyNtKQ71erlTkLcPb4gvxong+05M0P9TZblwwpynXxsNPIA3zfCBJnEsHJf/GAsfcfoROziKBVp40IEGU1P9AZe+hRPgneZ5xRny2rDRnx/DfrBczguAY+DhxBOoS9tucqsCvVweH1Ylz2BTcWmPhlxU3xvb5AXdpvsABsjVs2QRKg3Nw7dwR0hnt/tIXmUINdrFzPvcug1tgacC87hZl2j+d2aaNtewh4ihO0TaqeeCZaBlaAVMz5JIZNWf/m+Yxfc0FdI8ZrR7nsRXqwEsXFcC5+anXxHWIyPDMgKkYqIN0p64e8s+vzbQ7+VwkUy+D1ECTKaF03xW3iG+0v3e9gszKAzbWs/7ffE8MVFE0SVNxNMA7OtfbxzbIro+xuitf82f1NP8BHIKfhWoX6/LTcgpejigMcqfZNKWy9EXJP3oR7d5Yth/sgy9xDV4d7JJreRPfh00AGbE9mHtQxGbxPz2dbpvEGLB6xfDH7k6UjV6xDYH2An0jZq3x2s5RFlfA0OBuRTHJKDxB+gW31BvFEvGvJZxCfcjTnPt418sm3hK2EzfzdJd3UUMQ6io2qzG2Cm6KZeSBBx8vndKH+5tPNtu2mdWg6bQwQphV3QoMYTJJmz2dyFxm6VIzZtfQO+0tgjR4stLz3Ds//JoZEdlPtyeBXP4m7Af3LoIHvlDVW8pzsFXfzD+arXN0+QfPHE6L+RS8B4pNdqFzZlU0M3zC0RLrdhiKeAq42BMC7golmMsTw19pP9B0H+Bvsku1jBpCmEAAAAAElFTkSuQmCC', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'D6707286-A50E-57B1-B2CF-EFAC59E850D8', + ], + 'Data' => [ + 'description' => '水印提取任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => 'task id, 用于查询任务结果', + 'description' => '任务ID，用于查询任务结果。', + 'type' => 'string', + 'example' => 'wmt-9648c22d2eb2cb57bb855dcae7898464********', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6707286-A50E-57B1-B2CF-EFAC59E850D8\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"wmt-9648c22d2eb2cb57bb855dcae7898464********\\"\\n }\\n}","type":"json"}]', + 'title' => '创建水印提取任务', + ], + 'CreateWmEmbedTask' => [ + 'summary' => '创建数字水印嵌入任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216120', + 'abilityTreeNodes' => [ + 'FEATUREcsas3KYQ7V', + ], + ], + 'parameters' => [ + [ + 'name' => 'WmType', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印类型'."\n" + .'PureDocument: 常规文档水印'."\n" + .'PureImage: 常规图片水印'."\n" + .'PureAudio: 常规音频水印'."\n" + .'PureVideo: 常规视频水印'."\n" + .'AigcDocument: AIGC文档水印'."\n" + .'AigcImage: AIGC图片水印'."\n" + .'AigcAudio: AIGC音频水印'."\n" + .'AigcVideo: AIGC视频水印', + 'description' => '水印类型。取值：'."\n" + .'- **PureDocument**：文档水印。'."\n" + .'- **PureImage**：图片水印。'."\n" + .'- **PureAudio**：音频水印。'."\n" + .'- **PureVideo**：视频水印。'."\n" + .'- **AigcDocument**：AIGC文档水印。'."\n" + .'- **AigcImage**：AIGC图片水印。'."\n" + .'- **AigcAudio**：AIGC音频水印。'."\n" + .'- **AigcVideo**：AIGC视频水印。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PureImage' => '图片水印', + 'AigcImage' => 'AIGC图片水印', + 'AigcAudio' => 'AIGC音频水印', + 'PureDocument' => '文档水印', + 'PureAudio' => '音频水印', + 'PureVideo' => '视频水印', + 'AigcDocument' => 'AIGC文档水印', + 'AigcVideo' => 'AIGC视频水印', + ], + 'example' => 'PureDocument', + 'enum' => [ + 'PureDocument', + 'PureImage', + 'PureAudio', + 'PureVideo', + 'AigcDocument', + 'AigcImage', + 'AigcAudio', + 'AigcVideo', + ], + ], + ], + [ + 'name' => 'Filename', + 'in' => 'formData', + 'schema' => [ + 'title' => '文件名，后端需要根据文件名的后缀判断校验文件类型', + 'description' => '待嵌入文件的文件名，后端需要根据文件名的后缀判断校验文件类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'abc****.pdf', + ], + ], + [ + 'name' => 'FileUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => '可用于下载文件的 URL'."\n" + .'控制台调用时传递文件的 oss 路径', + 'description' => '可用于下载待嵌入文件的URL，需要可以公网访问。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://example.com/abc****.pdf', + ], + ], + [ + 'name' => 'WmInfoSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '水印信息的容量位宽，可用值为 32, 40, 64，不传时默认为32。非32时需显式指定。比如嵌入式使用的是 40 位的sdk，那么提取时也需要将该值设为 40。', + 'description' => '水印信息的容量位宽，默认为32。该参数嵌入和提取时需要保持一致。比如嵌入时使用的是 40 位的SDK，那么提取时也需要将该值设为 40。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '64', + 'minimum' => '32', + 'enumValueTitles' => [ + 32 => '32', + 40 => '40', + 64 => '64', + ], + 'example' => '32', + ], + ], + [ + 'name' => 'WmInfoUint', + 'in' => 'formData', + 'schema' => [ + 'description' => '10进制数字格式水印信息。若设置该值，则 WmInfoBytesB64 不能设置。'."\n" + ."\n" + .'取值范围取决于 WmInfoSize 参数：'."\n" + ."\n" + .'- 当 WmInfoSize 为32时，取值范围为 1~4294967295。'."\n" + ."\n" + .'- 当 WmInfoSize 为40时，取值范围为 1~1099511627775。'."\n" + ."\n" + .'- 当 WmInfoSize 为64时，取值范围为 1~18446744073709551615。', + 'type' => 'string', + 'required' => false, + 'example' => '123***', + ], + ], + [ + 'name' => 'WmInfoBytesB64', + 'in' => 'formData', + 'schema' => [ + 'title' => 'base64 编码后的字符串格式水印信息 。若设置该值，则 wmInfoUint 不能设置。', + 'description' => 'Base64 编码后的字符串格式水印信息 。若设置该值，则 WmInfoUint 不能设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'aGVsbG8gc2F*****', + 'maxLength' => 400, + ], + ], + [ + 'name' => 'VideoIsLong', + 'in' => 'formData', + 'schema' => [ + 'title' => '视频水印参数：默认为 false，此时会使用短视频的 SDK，设为true时会使用使用长视频的SDK', + 'description' => '视频水印参数：是否使用长视频水印SDK，默认为false。取值：'."\n" + ."\n" + .'- **true**: 是'."\n" + .'- **false**: 否', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'VideoBitrate', + 'in' => 'formData', + 'schema' => [ + 'title' => '短视频水印参数，含义为视频的比特率(bitrate)，短视频时必须设置该参数。', + 'description' => '短视频水印参数：含义为视频的比特率，默认会自动获取视频的比特率，可以通过该参数强制指定提取时使用的比特率。通常无需设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '3000k', + ], + ], + [ + 'name' => 'ImageEmbedLevel', + 'in' => 'formData', + 'schema' => [ + 'title' => '图像水印参数：取值范围为 [0, 4]，默认值为 2。更大的值意味着更高的鲁棒性，但是视觉质量会下降。', + 'description' => '图像水印参数：更大的值意味着更高的鲁棒性，但是视觉质量会下降。默认值2。取值：0~4。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ImageEmbedJpegQuality', + 'in' => 'formData', + 'schema' => [ + 'title' => '图像水印参数：期望的输出图像jpeg压缩质量因子，取值范围 [1, 100]，默认值 95', + 'description' => '图像水印参数：期望的输出图像jpeg压缩质量因子，默认值 95。取值：1~100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '95', + ], + ], + [ + 'name' => 'InvisibleEnable', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '是否启用嵌入暗水印。默认为true。'."\n" + .'取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'DocumentControl', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '文档水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'InvisibleAntiTextCopy' => [ + 'description' => '是否启用零宽字符暗水印。零宽字符暗水印可以抵抗文档增、删、改、另存（格式不变）、部分文本复制粘贴、CopytoTxt攻击。不能抵抗格式转换toPDF攻击。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'InvisibleAntiAllCopy' => [ + 'description' => '是否启用组件暗水印。组件暗水印可以抵抗文档增、删、改、另存（格式不变）、docx全选复制拷贝到新docx文档，不能抵抗格式转换攻击。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'BackgroundControl' => [ + 'description' => '背景水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'BgAddVisible' => [ + 'description' => '是否启用背景明水印。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'BgVisibleControl' => [ + 'description' => '背景明水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'VisibleText' => [ + 'description' => '背景明水印文案。格式为utf8字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello ****', + 'maxLength' => 1000, + ], + 'Mode' => [ + 'title' => '', + 'description' => '背景明水印模式。取值：'."\n" + ."\n" + .'- **pos**：在背景的特定位置嵌入一处明水印文案。'."\n" + .'- **repeat**：在文档背景中平铺嵌入多处明水印文案。', + 'type' => 'string', + 'required' => false, + 'example' => 'pos', + 'enum' => [ + 'repeat', + 'pos', + ], + ], + 'FontSize' => [ + 'description' => '明水印文字字号。取值越大，字体越大。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '200', + 'example' => '30', + ], + 'FontColor' => [ + 'description' => '明水印文字颜色。格式为 0xFFFFFF RGB颜色格式。如 0x000000 表示黑色。', + 'type' => 'string', + 'required' => false, + 'example' => '0x000000', + 'pattern' => '^0[xX][0-9a-fA-F]{6}$', + ], + 'Angle' => [ + 'description' => '明水印文字逆时针旋转角度。取值范围1~360。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '360', + 'minimum' => '0', + 'example' => '30', + ], + 'PosX' => [ + 'description' => 'Mode为pos时生效。控制明水印水平位置的参数，以左下角为原点。数值在0～1之间时，为比例控制。数值大于1时，为精确的像素位置控制。', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + 'pattern' => '^[\\d.]+$', + ], + 'PosY' => [ + 'description' => 'Mode为pos时生效。控制明水印垂直位置的参数，以左下角为原点。数值在0～1之间时，为比例控制，数值大于1时，为精确的像素位置控制。', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + 'pattern' => '^[\\d.]+$', + ], + 'HorizontalNumber' => [ + 'description' => 'Mode为repeat时生效。表示明水印在水平方向上重复出现的次数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '200', + 'example' => '3', + ], + 'VerticalNumber' => [ + 'description' => 'Mode为repeat时生效。表示明水印在垂直方向上重复出现的次数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '200', + 'example' => '3', + ], + 'Opacity' => [ + 'description' => '明水印透明度参数。取值范围1~255。取值越大，越不透明。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '255', + 'minimum' => '1', + 'example' => '100', + ], + ], + 'required' => false, + ], + 'BgAddInvisible' => [ + 'description' => '是否添加背景暗水印。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'BgInvisibleControl' => [ + 'description' => '背景暗水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'Opacity' => [ + 'description' => '背景暗水印透明度参数。取值范围1~13。取值越大，越不透明。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '255', + 'minimum' => '1', + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CsvControl', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Csv嵌入水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => '水印嵌入方式。'."\n" + .'取值：'."\n" + ."\n" + .'- **lossless_row_shift_embed**：数据无损方法'."\n" + .'- **lossy_number_embed**：数据有损方法'."\n" + .'- **lossy_time_stamp_embed**：时间戳方法'."\n" + .'- **lossy_zero_width_embed**：零宽字符方法', + 'type' => 'string', + 'required' => false, + 'example' => 'lossy_zero_width_embed', + 'enum' => [ + 'lossless_row_shift_embed', + 'lossy_number_embed', + 'lossy_time_stamp_embed', + 'lossy_zero_width_embed', + ], + ], + 'EmbedColumn' => [ + 'description' => '指定嵌入列，建议为string内容列，计数从1开始。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'EmbedPrecision' => [ + 'description' => '修改精度，表示修改的幅度，为10的n次方，比如0表示修改精度为10^0，即个位部分，-1表示小数点后一位，1表示十位部分，若float数据无此精度的部分，则不修改。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + 'EmbedTimePosition' => [ + 'title' => '时间戳水印参数。水印嵌入位置。可以为Min（分）、Sec（秒）、MilSec（毫秒），三者选一个填入，选择哪个，则算法修改哪个位置的数据。', + 'description' => '时间戳水印参数。水印嵌入位置。可以为Min（分）、Sec（秒）、MilSec（毫秒），三者选一个填入，选择哪个，则算法修改哪个位置的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'Sec', + 'enum' => [ + 'Min', + 'Sec', + 'MilSec', + ], + ], + 'TimeFormat' => [ + 'title' => '时间戳水印参数。解析csv文件中时间戳的格式字符串。若csv文件中的时间戳类似“2023-10-15 13:20:59:342”，则对应的格式字符串为“Year-Mon-Day Hour:Min:Sec.MilSec”，则这里要填“Year-Mon-Day Hour:Min:Sec.MilSec”，水印嵌入后依然按照此格式输出，一旦填错则该方法无法使用。格式字符串中的年、月、日、时、分、秒、毫秒必须按照上述写法填写，连接符为英文非字符的单连接符，一般可以是“:”“/”“-”“ ”（空格），额外支持“T”“Z”为连接符。其他形式的时间格式目前不支持解析。 ', + 'description' => '时间戳水印参数。解析csv文件中时间戳的格式字符串。若csv文件中的时间戳类似“2023-10-15 13:20:59:342”，则对应的格式字符串为“Year-Mon-Day Hour:Min:Sec.MilSec”，则这里要填“Year-Mon-Day Hour:Min:Sec.MilSec”，水印嵌入后依然按照此格式输出，一旦填错则该方法无法使用。格式字符串中的年、月、日、时、分、秒、毫秒必须按照上述写法填写，连接符为英文非字符的单连接符，一般可以是“:”“/”“-”“ ”（空格），额外支持“T”“Z”为连接符。其他形式的时间格式目前不支持解析。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'Hour:Min:Sec', + ], + 'EmbedBitsNumberInEachTime' => [ + 'title' => '时间戳水印信息位宽。指定单个时间戳容纳多少信息，这个数越大，提取信息需要的行数理论上越少，但是修改的时间幅度变大，幅度范围是2的n次方，n为此参数值。', + 'description' => '时间戳水印信息位宽。指定单个时间戳容纳多少信息，这个数越大，提取信息需要的行数理论上越少，但是修改的时间幅度变大，幅度范围是2的n次方，n为此参数值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '4', + 'minimum' => '1', + 'example' => '2', + ], + 'EmbedDensity' => [ + 'title' => '零宽字符水印参数。嵌入密度，取值在0～1之间的浮点数，0为仅嵌入第一行内容，1为所有行均嵌入。', + 'description' => '零宽字符水印参数。嵌入密度，取值在0～1之间的浮点数，0为仅嵌入第一行内容，1为所有行均嵌入。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ImageControl', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '图片水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'TextVisibleControl' => [ + 'description' => '图片文本水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'VisibleText' => [ + 'description' => '文本水印文案。格式为utf8字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '水印文本', + ], + 'Mode' => [ + 'description' => '文本水印显示模式。取值：'."\n" + .'- **pos**：固定位置模式。'."\n" + .'- **repeat**：平铺模式。'."\n" + .'- **top-left**：左上模式。'."\n" + .'- **top-right**：右上模式。'."\n" + .'- **bottom-left**：左下模式。'."\n" + .'- **bottom-right**：右下模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'top-right' => 'top-right', + 'pos' => 'pos', + 'bottom-right' => 'bottom-right', + 'bottom-left' => 'bottom-left', + 'repeat' => 'repeat', + 'top-left' => 'top-left', + ], + 'example' => 'pos', + ], + 'Opacity' => [ + 'description' => '文本水印透明度。取值：1~255。取值越大，越不透明。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + ], + 'FontSize' => [ + 'description' => '文本水印文字字号。取值越大，字体越大。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'FontColor' => [ + 'description' => '文本水印文字颜色。格式为 0xFFFFFF或#FFFFFF RGB颜色格式。如 0x000000或#000000 表示黑色。', + 'type' => 'string', + 'required' => false, + 'example' => '#FF0000', + ], + 'Angle' => [ + 'description' => '文本水印文字顺针旋转角度。取值范围0~360。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'PosX' => [ + 'description' => 'Mode为pos时生效。控制文本水印水平位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'PosY' => [ + 'description' => 'Mode为pos时生效。控制文本水印垂直位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'SpaceX' => [ + 'description' => 'Mode为repeat时生效。控制文本水印平铺水平间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'SpaceY' => [ + 'description' => 'Mode为repeat时生效。控制文本水印平铺垂直间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'PosAx' => [ + 'description' => '文本水印水平方向锚点。'."\n" + .'取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'PosAy' => [ + 'description' => '文本水印垂直方向锚点。'."\n" + .'取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Visible' => [ + 'description' => '可见性：'."\n" + ."\n" + .'true ： 显示'."\n" + ."\n" + .'false： 不显示', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Margin' => [ + 'description' => 'Mode为top-left、top-right、bottom-left、bottom-right时生效。边距。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => 'Mode为top-left、top-right时生效。上边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Right' => [ + 'description' => 'Mode为top-right、bottom-right时生效。右边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Bottom' => [ + 'description' => 'Mode为bottom-left、bottom-right时生效。下边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Left' => [ + 'description' => 'Mode为top-left、bottom-left时生效。左边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'LogoVisibleControl' => [ + 'description' => 'Logo水印控制参数。', + 'type' => 'object', + 'properties' => [ + 'Enhance' => [ + 'description' => '是否开启增强明水印。开启后会对logo进行处理，处理后可以对嵌入logo嵌入信息进行提取。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'LogoBase64' => [ + 'description' => 'Base64格式logo水印。Logo文件为PNG图片转成Base64格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAFLRJREFUeF7tnXmYZFV5h9+vehwHE5FFQBZFDGDCoiiKYYIJqBBF4DEakARJGCQwfYtRRicsQiQkgWBEQGb6VjOyJKgxRpIYASWiPmZhcdgkGXABVDBq3FgSGGdguk/uObV0dXdV3Vunq073mfud55k/puus73d/92zfOVfQoASUQFcComyUgBLoTkAFok+HEuhBQAWij4cSUIHoM6AE/AhoD+LHTVOVhIAKpCSG1mb6EVCB+HHTVCUhoAIpiaG1mX4EVCB+3DRVSQioQEpiaG2mHwEViB83TVUSAiqQkhham+lHQAXix01TlYSACqQkhtZm+hFQgfhx01QlIaACKYmhtZl+BFQgftw0VUkIqEBKYmhtph8BFYgfN01VEgIqkJIYWpvpR0AF4sdNU5WEgAqkJIbWZvoRUIH4cdNUJSGgAimJobWZfgRUIH7cNFVJCKhASmJobaYfARWIHzdNVRICKpCSGFqb6UdABeLHTVOVhIAKpCSG1mb6EVCB+HHTVCUhoAIpiaG1mX4EVCB+3DRVSQioQEpiaG2mHwEViB83TVUSAiqQkhham+lHQAXix01TlYSACqQkhtZm+hFQgfhx01QlIaACKYmhtZl+BFQgftw0VUkIqEBKYmhtph8BFYgfN01VEgIqkJIYWpvpR0AF4sdNU5WEgAqkJIbWZvoRUIH4cdNUJSGgAimJobWZfgRUIH7cNFVJCKhASmJobaYfARWIHzdNVRICKpCSGFqb6UdABeLHTVOVhIAKpCSG1mb6EVCB+HHTVCUhoAIpiaG1mX4EVCB+3DRVSQioQEpiaG2mHwEViB83TVUSAiqQkhham+lHQAXix01TlYSACqQkhtZm+hFQgfhx01QlIaACKYmhtZl+BFQgftw0VUkIqEBKYmhtph8BFYgfN01VEgIqkJIYWpvpR0AF4sdNU5WEgAqkJIbWZvoRUIH4cdNUJSGgAimJobWZfgRUIH7cNFVJCKhASmJobaYfARWIHzdNVRICKpCSGFqb6UdABeLHTVOVhMC8C8QkvAj4PeCtGF6KsCuwZED8j5GUG/LyMlUOx/DFvHh9/P494BGEmxA+KWv4YR9pNeoCIjBvAjEJe2Yc/hQ4HhgZAhMDbC0pT+XlbU5iCc/jaaCSF9fjd1uPf2CC8+VKHvBIr0nmkcC8CMSMsizrKT42JGE0cd4rKa8uytYk3AG8rmh8j3iTwHJJXbs1REIguEBMwp8BfxKAz2WS8r6i5ZgqF2M4q2h873iGi6TGud7pNWFQAkEF0ug5rgnUwkLzj2Zdsh7kzVkP8oVAdTtFUq7upyxT5XgMy7umqbCKSY7qJ08bV1I3zHXBJFwKxXvd3LI2c6SsZcPMeCbhFuA5uek7RTA8KjX+wCutR6JgAjGnsQ8j3O9RR78kI7xAVvO/RRObhF8G/q9o/AHE20dSvlE0H1PljzH8Vdf4m9ieJSzF5C9KtPIQjpYxbmwJpMqXMbyhaJ1y421ka7lmOlOT8FpgXW7aXhEWs61czhNzyqNg4nACSfgccHTBes012mcl5Xf6zcQkfAb43X7Tecb/Z0l5W9G0bQL5PtDshW2PcSDwDUnZx5zBzjzDaTl5nt/4/QIWc6Vczo86COTerCex9uoU7LD1+eBYzV50MOyIMOoSdhLIKAcic3wOhGtljEeKsptLvCACMcvZjwr/NZeK9khrDfw14HaEO1jMnXIZv/Atq7Gi9RqEgzH8Orh/u/jm1zPdJPvLOOuL5N0mkNsk5TdsGpNwK7AU+JiknFoonwS7qgaTHCbjfLU9jZnqQa6WlFM65WcSfuB4GI6TmhPJtDDN1h0EUqSOCylOGIFUOQ/Dnw+o4bdhXBd9GxXWhXiTmIQXU+GgbK9kKZO8Dqk/oHMOhvOl5hYtcsNMgTSEXH8RGE6SGn9jTmVnFvPyTpnJmroYjAokl3V7hDACmXrT9VU54HsY7qDC7baXkDHXUyyI0BhLW7E0e5qX9V0xcQIvtLRsEs4EPmR7SklZakZ5PcK/uTIn2Fuu5EEzyqkIV3asxyQ7yTg/6SmQhK8AhwGuBzGjHIuw74z83g9uvnY9zJpTXsIkL22NFvqcB/bNL0CCUAKx4+bdCrbH7kL/BSN8Tlbz04Jp5j2aqbI9xo2t7RJ2UbE8Jakbz+eGWT3IKGchXAz8VFJ2bPQOf5QNf9aCWzm6E2ErDAe5zEfY0fLspwcxCd8C9s6tXDNChTezmR+0BKJDrGLoWkbJj/51nsvSucwh8osYfoy+Nh0bb/a8WnUQyA2IW9ZtLUhk84O6QIQHZIx9zWnsxQjf9hEIG1nJko4rYr/l8hMewMx6gV3DJPeoQPKsOeP3wgIxnCA1/rbP7BdcdJO4lbBZE9iOFa3wMlnDd/MaMUsgCY8B2wKrsl7oI9N6kAEIxHuSfjr7M8l/uvZoD5Jn1vrvhQVS4RWyZmirXcUqO4BYZpSXI3yzUFaT7CHj2GFlz2ASVgEfxnArFU7IJubNNJ+UlHc5zlVOwThXlvslZb+Gv9uDLuPN7CBr+VnOHORLwBubc5BOFTIJ/52tmlmH0mOzMuw8ZFowo7wN4Z9cJ5MybQhvqqzJep1qXlsL/S6slDEuLxR3DpFCzUHqS4t5YUsRSPvQJr/Nfj1IlQswfLD+BuJXpca3BjjE8t0H2TrzYl4GbGNXGZvL0U0Epsr9GPbJQ1Lw9772kQrmOSuaCsSXXI9008b+efl7DrGcLhJ+AuyA4cNS48wBCiSv1vm/Gw6VGv/aHtGczqGt/9slc8OFjf+/hQob8zNti7GZDTI+xx35AgUuLIH0sXFWoG3zFmXa0CavFh5DLKlxiBPI1JBlvaTsP+chVpWPZK4qdme+W7DPy282frS9zExXnmcyT4T1CFfLWG+3opbTquE+qXFAHqb5+n1hCUSHWF2fgy476acDq60PmaRsPdcepMhD2JrDGA6Wmjsi4BVMwm3AwcAVkvJer0wCJFpYAtEepLtA2ibpbT3IiRius4nshHiuPUiR522AAqnPS7u4rMysi0mwCwiLmGSljGN7ryBBBTIEzMGGWKNciPAB4IfZQaxdZwlkOW+gwpcbD+J2UuPxXqtY7nmtOxO6ZeMOoX2IZd317YrW7GC4uVfvYqrO+8D2IHZ1bRdZO+Uw2c0cJnGisEOxsyTt4dU8YHsuLIHoEKt7DzLl7j7lrFjlEQwvabmGNDcKmzvpOL8se+b/cUnZzgmghy9W43frCVDIP6zHs3iNpLy7x8N+NvCX1pVIUvYo8kybhDEgyZxHb5aUtxRJM4g4C0sgAxpimeUcSqWru3Z3boZVUnOuGnMKw+5B3LEB4ePuoot62CvbC3morQeZWf8zJOWjZgVbM8GT7scO3rxOIFWO67EUa5dv6/OFzjvpzXK/K6lb7u0YTOIOptkDap+QlBOLwDaj/L69ACPbGC3snlMk37w4W7JA7NCjv2C4PhKBrEKcA6cN50jqfLLsw/1qDMe0NfpJhC82V5RMwtvdBRI2bGZ3Wcuj/QAyy50jYnPXv+NGYZH8TMLjjb2SauZHlhZKs5xdqTSGdAN6kRYpd4sUSJGGDzNOgB7ECuQfgZWS8umibWnbBXcewUXTNeMNQiAm4ddaB62EA2WMe4rWwyT8D7AThtMG8SIrUu7CEojOQbrarNMybxEDN1w/7BVLdmhU96judtipyr4Yju2Rr/X9ek/j984nCqcS272Z2a4oU/MkW4+LEJ4t0g4XR1jWmHN9WlJ3XdTQw8ISiOGVUms4ug296cMrwFTZG+NcxfOD4VeySwi+kxdx5nmQvPitt/7U5Lb5pxWSsqZTepM4V/25TtCbWX9b0tmHt0zCVdB9Al+oXYarpOY8l4ceFpZAtAfp1YPUbzUR1ssYdoOwUHALFuIeJrvDfXc2tOp6g6RJ3A0nU+4ghUroGemomRf3mVGsC6OvP9YmhH9nKy6TS9xFf0MPC0sgW0oP0o837wh7ymoeHrqltQAvAioQL2y9E/Xl7q4CGYIFBpelCmRwLFs5qUCGAHWeslxoAnmN1Lh7nlgMrFjTfqouL9eC7u552ZiTeb47Imt4v2VoEm5EGG+/GC4vD/19NoGFJpBRqTEeu6GyjTC7pFrstNugBDLKtgiPZScOD8+cGb+kAhnMUxRKIPbcQP7tHcKjTPBaez3NYJoXPhdzOru4iwvshlaR0LhtpEjUXnHMu9mO5/LzpkDmmp+mrxMIJRB7RaXdQS0SrAPe+Ri+EJNQ3LU/kxyDuH2EolcczTq33VMEo7wVcb2Tve3Rnkm/lY2cae+/NWewDc/w+LQexFBjhIeZZJwKy2XN1Dl5M8rN1smRCr9w9/luYCv56/qpPpNwNoZTpMaepu7iYX2gLgB359ZemdOgfYGd2G3J2KxgByZcXHv968+A/6DChbKGu1z+VS7CuOtJrW+Xbcd5kroymufqz8hcZu5BWn5an8heOLXGRRj2lstvMsLxspr7ijxQc4kTRiCjXI/wDo+K2i8z3Y3hLoR1bGKdXO1u85j34C6Os1eT2ovj6t8VKXoXVnvdH8oeDPvA5Ya2y7XPYYSrWcRTbOKzCPfKGGd3EMgTCKtkjKtMwqPUN9fcJqBJ3OVwX2GSPRhhv54CqX/o6MHG8O09CE9iWJGdOT+i260lGZubsoNc22fCeJPdB8kWLT6FcEh2o/2LTeL2cC52d3rZ20/EiegkDG7+2XK4NNxHhSsyh8Y9MZwDbt/j2uwuYvvFsPMaTotH5oKbY4RQArEfzBnMZw/sMMy+Xez1oxXu4lnWydqGh+ocYXRLPrSrR4XVMtZy3ehZe/NeduJZRmd8rsBu7B1gL8HuKZD6t09+W1Je1RDIGPU9p0NMlaMKCuRcGeMil765CDHCATPf4q27eQ1HSq3+OQnHDz7uXpL2wRcuab+RxM2X4Onstvt3tgTSNjczifM0sK4rzhHTjPKHiDuJ+IIhmbyVbRiB1G8dtIdrBvXtwZlcLEA77r+z+a/Ip9c6we1webXtIXYeiiEqHNa8M7dI/qbK7kxiLziwb/0X2je0Hb4UEIj1sVpP46EziTugZA8eXddRIFU+wCQnuyHWVA/Sciw0K9iNCb5Ph2O3rWt/NrH9zN7erGQrNrGBGd64pn5L5AmS8oqGQOzD/7wmkyzPrwM3NT881PhWyqdmXitUhGG/cYIIpDG2tONO21UOPxgetsbttyCT8Pf2vqd+03nGtw/264umzeYMdjhn5w0XuUu71/BVk7gLqZ/IE0jjrWsfsuvcUBVuYSM7urlL5x7kUus2P00g8KqsHJsHOQJ5lzurspltZvbsZjk7UuHHTaG2CeB9CCe7u7zqd3tdIqmbn7jgBCLcKKkbWtl5inW72cIEUj+sYz+gU3gCW/Th6Rhvkt1k3F3VXyjMwwd0DpLU9XiFgqnfg7Vz+2cOGoJeXEggCfbSaTsPtALZRVKOcw9bwhHZ5Qn/gvBCGePnjb/djmEHT4HYI7t3tfcuzk1euJZNHMMSfoRhWfunE0x9jrrItaOsAmm8eV7JhDuL3Oo+Cz0dPpEMJ2YGtqsfhULQT7B53ApoqoxiOJMKy5jgMcRNdu0Ni/dieCdLeHrGKlZrku7Y15ef7QvDXghuPyZqz5NM/V24FOEGJjjcfQDH8FhRgZiEc7M55ktkrP7xHlPla9lowToW1j+kA1cwyYZsEn60Sdz+kB0mnswzrGeRE6q9T/gIGeOWUgukAc9+k9wax16hP8zQ9SMwnQoN+BFPd8mbT8Oz8+T261BWGHb+cQvilmPt2W672mdXlm6ctpNuqEnNrSi5YBLnybu/pNPnVI1exJ7AtBdTr8dwKRXeJGOc0LbMa7+r+FDjRWeXcT/DBIn9tPUsgdjvlCxyy7L2GlNrZ9tTviM7p25v+bcCsr2hvUq1/qIUphYA6kvZdjGi9b3Fhou8PeTlvuto6pdRfFDSgXoedzRJsDlIe+mNlY7PZ+vwdnVjOKHPeUhfN7L71dhOjE/q5W7ul23xVCZxw6vPt6+EFU892Jhuwr6RgxC+0xTOYEsYTG7zIhD3FljFL2VfsbDLlPZNMpxQcB4y9PmH3bCb4JxhL0d3g2jqJwX3A/6O5/Ai+Sg/Hg7wLS/XeRNIq9u3PkT17+zZyd3uje8BbjUQ1PVPnE27H7ZTvgOef9gNrfon4uy3Ezdx63xvbprEXdTwdgyXS42VA2FbkkzmXSAl4azNjJSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ0AFEoazlhIpARVIpIbTaochoAIJw1lLiZSACiRSw2m1wxBQgYThrKVESkAFEqnhtNphCKhAwnDWUiIloAKJ1HBa7TAEVCBhOGspkRJQgURqOK12GAIqkDCctZRICahAIjWcVjsMARVIGM5aSqQEVCCRGk6rHYaACiQMZy0lUgIqkEgNp9UOQ+D/AdF26yPzUbcJAAAAAElFTkSuQmCC', + ], + 'Mode' => [ + 'description' => 'Logo水印显示模式。取值：'."\n" + .'- **pos**：固定位置模式。'."\n" + .'- **repeat**：平铺模式。'."\n" + .'- **top-left**：左上模式。'."\n" + .'- **top-right**：右上模式。'."\n" + .'- **bottom-left**：左下模式。'."\n" + .'- **bottom-right**：右下模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'top-right' => 'top-right', + 'pos' => 'pos', + 'bottom-right' => 'bottom-right', + 'bottom-left' => 'bottom-left', + 'repeat' => 'repeat', + 'top-left' => 'top-left', + ], + 'example' => 'pos', + ], + 'Opacity' => [ + 'description' => 'Logo水印透明度。取值：1~255。取值越大，透明度越低。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + ], + 'Angle' => [ + 'description' => 'Logo水印文字顺针旋转角度。取值范围1~360', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'PosX' => [ + 'description' => 'Mode为pos时生效。控制明水印水平位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'PosY' => [ + 'description' => 'Mode为pos时生效。控制明水印垂直位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'SpaceX' => [ + 'description' => 'Mode为repeat时生效。控制明水印平铺水平间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'SpaceY' => [ + 'description' => 'Mode为repeat时生效。控制明水印平铺垂直间距的参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'PosAx' => [ + 'description' => 'Logo水印水平方向锚点。 取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'PosAy' => [ + 'description' => 'Logo水印垂直方向锚点。 取值范围0~1。(PosAx,PosAy)取值为（0,0）时，以文本左上角为锚点绘制；取值为0.5，以文本中心点位置绘制；取值为（1,1）时，以文本右下角为位置绘制。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Visible' => [ + 'description' => '可见性：'."\n" + ."\n" + .'**true** ： 显示'."\n" + ."\n" + .'**false**： 不显示', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Margin' => [ + 'description' => 'Mode为top-left、top-right、bottom-left、bottom-right时生效。边距。', + 'type' => 'object', + 'properties' => [ + 'Top' => [ + 'description' => 'Mode为top-left、top-right时生效。上边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Right' => [ + 'description' => 'Mode为top-right、bottom-right时生效。右边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Bottom' => [ + 'description' => 'Mode为bottom-left、bottom-right时生效。下边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'Left' => [ + 'description' => 'Mode为top-left、bottom-left时生效。左边距。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'MetadataControl' => [ + 'description' => '元信息控制参数。WmType为PureImage或AigcImage时生效。', + 'type' => 'object', + 'properties' => [ + 'XmpKvBase64' => [ + 'description' => '元信息Base64格式。需要将格式为AIGC:{"Label":"1","ContentProducer":"AXXXX","ProduceID":"BXXXX,"ReservedCode1":"CXXX","ContentPropagator":"DXXX","PropagateID":"EXXX","ReservedCode2":"FXXXX"}。的字符串编码为Base64格式字符串。 注意:1. "AIGC:"前缀需要加上，否则无法进行添加，另外需要注意与音视频的格式不同。2.Base64为标准格式需要，需要有补位。', + 'type' => 'string', + 'required' => false, + 'example' => 'QUlHQzp7IkxhYmVsIjoiMSIsIkNvbnRlbnRQcm9kdWNlciI6IkFYWFhYIiwiUHJvZHVjZUlEIjoiQlhYWFgsIlJlc2VydmVkQ29kZTEiOiJDWFhYIiwiQ29udGVudFByb3BhZ2F0b3IiOiJEWFhYIiwiUHJvcGFnYXRlSUQiOiJFWFhYIiwiUmVzZXJ2ZWRDb2RlMiI6IkZYWFhYIn0=', + ], + 'Enable' => [ + 'description' => '是否启用。'."\n" + ."\n" + .'true ： 显示'."\n" + ."\n" + .'false： 不显示', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'VideoControl', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '视频控制参数。', + 'type' => 'object', + 'properties' => [ + 'TextVisibleControl' => [ + 'description' => '视频文本水印控制参数', + 'type' => 'object', + 'properties' => [ + 'VisibleText' => [ + 'description' => '文本水印文案。格式为utf8字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '水印测试', + ], + 'Mode' => [ + 'description' => '文本水印显示模式。取值：'."\n" + .'- **pos**：固定位置，左上角为原点。'."\n" + .'- **bottom-right**：左下模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'bottom-right', + 'enum' => [ + 'pos', + 'bottom-right', + ], + ], + 'Opacity' => [ + 'description' => '文本水印透明度。取值：1~255。取值越大，越不透明。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + ], + 'FontSize' => [ + 'description' => '字体大小，取值范围：**0**~**72**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'FontColor' => [ + 'description' => '文本水印文字颜色。格式为 0xFFFFFF或#FFFFFF RGB颜色格式。', + 'type' => 'string', + 'required' => false, + 'example' => '#FF0000', + ], + 'PosX' => [ + 'description' => 'Mode为pos时生效。控制明水印水平位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'PosY' => [ + 'description' => 'Mode为pos时生效。控制明水印垂直位置的参数，以左上角为原点的像素位置控制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Visible' => [ + 'description' => '可见性：'."\n" + ."\n" + .'true ： 显示'."\n" + ."\n" + .'false： 不显示', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + 'Margin' => [ + 'description' => 'Mode为top-left、top-right、bottom-left、bottom-right时生效。边距。', + 'type' => 'object', + 'properties' => [ + 'Bottom' => [ + 'description' => 'Mode为bottom-left、bottom-right时生效。下边距。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Right' => [ + 'description' => 'Mode为top-right、bottom-right时生效。右边距。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'MetadataControl' => [ + 'description' => '元信息控制参数。', + 'type' => 'object', + 'properties' => [ + 'XmpKvBase64' => [ + 'description' => '元信息Base64格式。需要将格式为AIGC={"Label":"1","ContentProducer":"AXXXX","ProduceID":"BXXXX,"ReservedCode1":"CXXX","ContentPropagator":"DXXX","PropagateID":"EXXX","ReservedCode2":"FXXXX"}。的字符串编码为Base64格式字符串。 注意:1. "AIGC="前缀需要加上，否则无法进行添加，另外需要注意与图片元信息前缀不同。2.Base64为标准格式需要，需要有补位。', + 'type' => 'string', + 'required' => false, + 'example' => 'QUlHQz17IkxhYmVsIjoiMSIsIkNvbnRlbnRQcm9kdWNlciI6IkFYWFhYIiwiUHJvZHVjZUlEIjoiQlhYWFgsIlJlc2VydmVkQ29kZTEiOiJDWFhYIiwiQ29udGVudFByb3BhZ2F0b3IiOiJEWFhYIiwiUHJvcGFnYXRlSUQiOiJFWFhYIiwiUmVzZXJ2ZWRDb2RlMiI6IkZYWFhYIn0=', + ], + 'Enable' => [ + 'description' => '是否开启。'."\n" + .'- **false**：未开启。'."\n" + ."\n" + .'- **true**：已开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AudioControl', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '音频控制参数。', + 'type' => 'object', + 'properties' => [ + 'MetadataControl' => [ + 'description' => '音频元信息控制参数。', + 'type' => 'object', + 'properties' => [ + 'XmpKvBase64' => [ + 'description' => '元信息Base64格式。需要将格式为AIGC={"Label":"1","ContentProducer":"AXXXX","ProduceID":"BXXXX,"ReservedCode1":"CXXX","ContentPropagator":"DXXX","PropagateID":"EXXX","ReservedCode2":"FXXXX"}。的字符串编码为Base64格式字符串。 注意:1. "AIGC="前缀需要加上，否则无法进行添加，另外需要注意与图片元信息前缀不同。2.Base64为标准格式需要，需要有补位。', + 'type' => 'string', + 'required' => false, + 'example' => 'QUlHQz17IkxhYmVsIjoiMSIsIkNvbnRlbnRQcm9kdWNlciI6IkFYWFhYIiwiUHJvZHVjZUlEIjoiQlhYWFgsIlJlc2VydmVkQ29kZTEiOiJDWFhYIiwiQ29udGVudFByb3BhZ2F0b3IiOiJEWFhYIiwiUHJvcGFnYXRlSUQiOiJFWFhYIiwiUmVzZXJ2ZWRDb2RlMiI6IkZYWFhYIn0=', + ], + 'Enable' => [ + 'description' => '是否开启。'."\n" + .'- **false**：未开启。'."\n" + ."\n" + .'- **true**：已开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE4FB974-11BC-5453-9BE1-1606A73EACA6', + ], + 'Data' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '嵌入任务ID', + 'description' => '任务ID，用于后续查询任务执行结果。', + 'type' => 'string', + 'example' => 'job:5GfrJYsoaffmCE7Z5bZtjUefzxfd****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE4FB974-11BC-5453-9BE1-1606A73EACA6\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"job:5GfrJYsoaffmCE7Z5bZtjUefzxfd****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建水印嵌入任务', + 'description' => '默认最多可创建500个用户组。', + ], + 'RevokeUserSession' => [ + 'summary' => '吊销用户登录会话。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '224559', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdpId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户所属身份源配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'idp-cfg9vcrqylo39c39uxnw', + ], + ], + [ + 'name' => 'ExternalIds', + 'in' => 'query', + 'schema' => [ + 'description' => '外部身份源用户唯一ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12345678', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'D6707286-A50E-57B1-B2CF-EFAC59E850D8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6707286-A50E-57B1-B2CF-EFAC59E850D8\\"\\n}","type":"json"}]', + 'title' => '吊销用户登录会话', + ], + 'ListPopTrafficStatistics' => [ + 'summary' => '查询SASE的POP节点带宽。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '数据的起始时间。以秒为单位的UNIX时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '1681035708', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。以秒为单位的UNIX时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '1681293719', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'EFE7EBB2-449D-5BBB-B381-CA7839BC1649', + ], + 'TrafficData' => [ + 'description' => 'POP点带宽数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流入/流出带宽数据列表。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '统计指标名称。分为流入、流出两种。', + 'type' => 'string', + 'enumValueTitles' => [ + 'InternetTx' => 'InternetTx', + 'InternetRx' => 'InternetRx', + ], + 'example' => 'InternetTx', + ], + 'Datapoints' => [ + 'description' => 'POP点带宽数据点列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'POP点带宽数据点。', + 'type' => 'object', + 'properties' => [ + 'DateTime' => [ + 'description' => '该数据点对应时间。', + 'type' => 'string', + 'example' => '2023-12-06 15:29:00', + ], + 'Average' => [ + 'description' => '以分钟为单位的平均带宽值。单位为Byte/s。', + 'type' => 'number', + 'format' => 'double', + 'example' => '15325', + ], + ], + ], + ], + ], + ], + ], + ], + 'enumValueTitles' => [], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFE7EBB2-449D-5BBB-B381-CA7839BC1649\\",\\n \\"TrafficData\\": [\\n {\\n \\"MetricName\\": \\"InternetTx\\",\\n \\"Datapoints\\": [\\n {\\n \\"DateTime\\": \\"2023-12-06 15:29:00\\",\\n \\"Average\\": 15325\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询POP点带宽统计', + ], + 'DeleteOtpConfig' => [ + 'summary' => '删除员工OTP配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsas62O8LY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Username', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54A4055A-343D-583E-9EAC-D12231148A68', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54A4055A-343D-583E-9EAC-D12231148A68\\"\\n}","type":"json"}]', + 'title' => '删除员工OTP配置。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'public', + 'endpoint' => 'csas.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'csas.aliyuncs.com', + ], + ], +]; |