huawei-cloud-api-definitions-Workspace 0.1.20260425

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\",\"application/json;charset=UTF-8\"]","definitions":{"AdDomain":{"description":"域信息。","properties":{"active_dns_ip":{"description":"主DNS IP地址。域类型为LOCAL_AD时需要配置。","maxLength":255,"minLength":1,"pattern":"^((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])$","type":"string"},"active_domain_ip":{"description":"主域控制器IP地址。域类型为LOCAL_AD时需要配置。","maxLength":255,"minLength":1,"pattern":"^((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])$","type":"string"},"active_domain_name":{"description":"主域控制器名称。域类型为LOCAL_AD时需要配置。","maxLength":55,"minLength":1,"type":"string"},"cba_enabled":{"description":"是否开启智能卡认证。","type":"boolean"},"certificate_id":{"description":"智能卡证书id。","maxLength":255,"minLength":0,"type":"string"},"delete_computer_object":{"default":0,"description":"是否在删除桌面的同时删除AD上对应的计算机对象,0代表不删除,1代表删除。","format":"int32","maximum":1,"minimum":0,"type":"integer"},"domain_admin_account":{"description":"域管理员账号。域类型为LOCAL_AD时需要配置。\n必须为AD服务器上已经存在的域管理员账号。","maxLength":55,"minLength":1,"type":"string"},"domain_controllers":{"description":"域控制器信息列表。有值时,active_domain_name、active_domain_ip、standby_domain_name、standby_domain_ip无效。","items":{"$ref":"#/definitions/DomainController"},"maxItems":1000,"minItems":0,"type":"array","x-maxLength":1000,"x-minLength":0},"domain_name":{"description":"域名称。域类型为LOCAL_AD时需要配置。\n域名必须为AD服务器上已经存在的域名,且长度不超过55。","maxLength":55,"minLength":1,"type":"string"},"domain_password":{"description":"域管理员账号密码。域类型为LOCAL_AD时需要配置。","maxLength":255,"minLength":1,"type":"string","x-isSensitive":true},"domain_type":{"description":"域类型。\n- LITE_AS:本地认证。\n- LOCAL_AD:本地AD。\n说明:域类型为“LOCAL_AD”时,请确保所选VPC网络与AD所属网络可连通。","enum":["LITE_AS","LOCAL_AD"],"maxLength":55,"minLength":1,"type":"string"},"id":{"description":"域id。","type":"string"},"standby_dns_ip":{"description":"备DNS IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。","maxLength":255,"minLength":0,"pattern":"^((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])$","type":"string"},"standby_domain_ip":{"description":"备域控制器IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。","maxLength":255,"minLength":0,"pattern":"^((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])$","type":"string"},"standby_domain_name":{"description":"备域控制器名称。域类型为LOCAL_AD时且配置备节点时需要配置。","maxLength":55,"minLength":0,"type":"string"},"tls_config":{"$ref":"#/definitions/TlsConfig"},"use_ldaps":{"default":false,"description":"是否开启LDAPS。","type":"boolean","x-hcs-ignore":true}},"required":["domain_type"]},"BaseResponse":{"description":"API响应基类。","properties":{"encoded_authorization_message":{"description":"加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。","readOnly":true,"type":"string"},"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_detail":{"description":"错误详情。","maxLength":1000,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"BaseThirdDomainController":{"properties":{"app_cert":{"description":"客户端证书公钥。","maxLength":4096,"minLength":0,"type":"string","x-isSensitive":true},"app_cert_key":{"description":"客户端证书私钥。","maxLength":4096,"minLength":0,"type":"string","x-isSensitive":true},"internal_service_address":{"description":"域管内部服务地址。","example":"https://127.0.0.1:4435","maxLength":255,"minLength":1,"type":"string"},"main_dc_address":{"description":"域管平台地址。","example":"https://127.0.0.1:4433","maxLength":255,"minLength":1,"type":"string"},"open_interface_address":{"description":"域管开放接口地址。","example":"https://127.0.0.1:4434","maxLength":255,"minLength":1,"type":"string"},"open_interface_domain_name":{"description":"域管开放接口域名。","example":"udcp-openapi.uniontech.com","maxLength":255,"minLength":1,"type":"string"},"openapi_ca_cert":{"description":"服务端CA。","maxLength":4096,"minLength":0,"type":"string","x-isSensitive":true},"user_password":{"description":"域管理员密码。","example":"password","maxLength":255,"minLength":0,"type":"string","x-isSensitive":true},"username":{"description":"域管理员。","example":"admin","maxLength":255,"minLength":1,"type":"string","x-anonymous":true}}},"CreateDomainNewReq":{"description":"配置域控的配置信息请求。","properties":{"ad_domain_info":{"$ref":"#/definitions/AdDomain","description":"统信域控名称。"},"auth_type":{"$ref":"#/definitions/DomainType","description":"对接协议类型。"},"uos_domain_info":{"$ref":"#/definitions/CreateUosDomainInfo","description":"统信域控名称。"}}},"CreateUosDomainInfo":{"allOf":[{"$ref":"#/definitions/BaseThirdDomainController"},{"properties":{"domain_name":{"description":"统信域控名称。","example":"UOS","maxLength":255,"minLength":1,"type":"string"},"type":{"$ref":"#/definitions/DomainType","description":"对接协议类型。"}},"type":"object"}],"required":["app_cert","app_cert_key","domain_name","internal_service_address","main_dc_address","open_interface_address","openapi_ca_cert","type","user_password","username"]},"DomainController":{"description":"域控制器信息。","properties":{"dc_ip":{"description":"域控制器IP地址。","maxLength":255,"minLength":1,"pattern":"^((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])$","type":"string"},"dc_name":{"description":"域控制器名称。","maxLength":255,"minLength":1,"type":"string"}},"required":["dc_ip","dc_name"]},"DomainType":{"description":"域类型\nKERBEROS:对接AD\nOPEN_API:使用OPEN_API的方式对接统信域控","enum":["KERBEROS","OPEN_API"],"type":"string"},"TlsConfig":{"description":"TLS信息。","properties":{"cert_end_time":{"description":"证书生效截止时间,时间参考样例 2022-01-25T09:24:27。","maxLength":255,"minLength":0,"type":"string"},"cert_pem":{"description":"pem内容, 有则更新,无则上传。查询不返回。","maxLength":8192,"minLength":0,"type":"string"},"cert_start_time":{"description":"证书生效开始时间,时间参考样例 2022-01-25T09:24:27。","maxLength":255,"minLength":0,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"a908c5a46c244f0ba004f984e84bbb42","info_version":"v2","method":"post","name":"CreateDomainNew","parameters":{"project_id":{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-annotations":["@Size(max = 255, min = 1)"],"x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"}},"paths":{"/v3/{project_id}/domains":{"post":{"description":"配置域控。","operationId":"CreateDomainNew","parameters":[{"$ref":"#/parameters/project_id"},{"description":"配置域控请求。","in":"body","name":"CreateDomainNewRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateDomainNewReq"}}],"responses":{"204":{"description":"正常,无响应体。"},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResponse"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}}},"schemes":["https"],"summary":"配置域控","tags":["WorkspaceV3"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@IamAuthMeta(authLevel = IamAuthLevel.PROJECT, abacAction = \"workspace:tenants:addDomain\", authContextInitializerName = \"workspaceCommonAuthContextInitializer\", needApigwJwtAuthCheck = false, needRbacCheck = false)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"createDomainNew\")"],"x-request-examples-1":{"auth_type":"OPEN_API","uos_domain_info":{"app_cert":"string","app_cert_key":"string","domain_name":"UOS","internal_service_address":"https://127.0.0.1:4435","main_dc_address":"https://127.0.0.1:4433","open_interface_address":"https://127.0.0.1:4434","open_interface_domain_name":"udcp-openapi.uniontech.com","openapi_ca_cert":"string","type":"OPEN_API","user_password":"password","username":"admin"}},"x-request-examples-text-1":{"auth_type":"OPEN_API","uos_domain_info":{"app_cert":"string","app_cert_key":"string","domain_name":"UOS","internal_service_address":"https://127.0.0.1:4435","main_dc_address":"https://127.0.0.1:4433","open_interface_address":"https://127.0.0.1:4434","open_interface_domain_name":"udcp-openapi.uniontech.com","openapi_ca_cert":"string","type":"OPEN_API","user_password":"password","username":"admin"}},"x-request-examples-url-1":"POST /v3/fb2e5ec048384c8f9469d22db0037908/domains","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-used-authn5":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-opt":{"inner-auth-type":"iam_auth_n5"},"x-apigateway-auth-type":"IAM"}},"summary":"配置域控","tags":"云办公服务","uri":null,"version":"2.0"}