华为云用户手册

问题背景与现象 当数据量较大时会频繁地发生rebalance导致出现重复消费的情况，关键日志如下： 2018-05-12 10:58:42,561 | INFO | [kafka-request-handler-3] | [GroupCoordinator 2]: Preparing to restabilize group DemoConsumer with old generation 118 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 10:58:43,245 | INFO | [kafka-request-handler-5] | [GroupCoordinator 2]: Stabilized group DemoConsumer generation 119 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 10:58:43,560 | INFO | [kafka-request-handler-7] | [GroupCoordinator 2]: Assignment received from leader for group DemoConsumer for generation 119 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 10:59:13,562 | INFO | [executor-Heartbeat] | [GroupCoordinator 2]: Preparing to restabilize group DemoConsumer with old generation 119 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 10:59:13,790 | INFO | [kafka-request-handler-3] | [GroupCoordinator 2]: Stabilized group DemoConsumer generation 120 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 10:59:13,791 | INFO | [kafka-request-handler-0] | [GroupCoordinator 2]: Assignment received from leader for group DemoConsumer for generation 120 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 10:59:43,802 | INFO | [kafka-request-handler-2] | Rolled new log segment for '__consumer_offsets-17' in 2 ms. | kafka.log.Log (Logging.scala:68)2018-05-12 10:59:52,456 | INFO | [group-metadata-manager-0] | [Group Metadata Manager on Broker 2]: Removed 0 expired offsets in 0 milliseconds. | kafka.coordinator.GroupMetadataManager (Logging.scala:68)2018-05-12 11:00:49,772 | INFO | [kafka-scheduler-6] | Deleting segment 0 from log __consumer_offsets-17. | kafka.log.Log (Logging.scala:68)2018-05-12 11:00:49,773 | INFO | [kafka-scheduler-6] | Deleting index /srv/BigData/kafka/data4/kafka-logs/__consumer_offsets-17/00000000000000000000.index.deleted | kafka.log.OffsetIndex (Logging.scala:68)2018-05-12 11:00:49,773 | INFO | [kafka-scheduler-2] | Deleting segment 2147948547 from log __consumer_offsets-17. | kafka.log.Log (Logging.scala:68)2018-05-12 11:00:49,773 | INFO | [kafka-scheduler-4] | Deleting segment 4282404355 from log __consumer_offsets-17. | kafka.log.Log (Logging.scala:68)2018-05-12 11:00:49,775 | INFO | [kafka-scheduler-2] | Deleting index /srv/BigData/kafka/data4/kafka-logs/__consumer_offsets-17/00000000002147948547.index.deleted | kafka.log.OffsetIndex (Logging.scala:68)2018-05-12 11:00:49,775 | INFO | [kafka-scheduler-4] | Deleting index /srv/BigData/kafka/data4/kafka-logs/__consumer_offsets-17/00000000004282404355.index.deleted | kafka.log.OffsetIndex (Logging.scala:68)2018-05-12 11:00:50,533 | INFO | [kafka-scheduler-6] | Deleting segment 4283544095 from log __consumer_offsets-17. | kafka.log.Log (Logging.scala:68)2018-05-12 11:00:50,569 | INFO | [kafka-scheduler-6] | Deleting index /srv/BigData/kafka/data4/kafka-logs/__consumer_offsets-17/00000000004283544095.index.deleted | kafka.log.OffsetIndex (Logging.scala:68)2018-05-12 11:02:21,178 | INFO | [kafka-request-handler-2] | [GroupCoordinator 2]: Preparing to restabilize group DemoConsumer with old generation 120 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 11:02:22,839 | INFO | [kafka-request-handler-4] | [GroupCoordinator 2]: Stabilized group DemoConsumer generation 121 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 11:02:23,169 | INFO | [kafka-request-handler-1] | [GroupCoordinator 2]: Assignment received from leader for group DemoConsumer for generation 121 | kafka.coordinator.GroupCoordinator (Logging.scala:68)2018-05-12 11:02:49,913 | INFO | [kafka-request-handler-6] | Rolled new log segment for '__consumer_offsets-17' in 2 ms. | kafka.log.Log (Logging.scala:68) 其中Preparing to restabilize group DemoConsumer with old generation表示正在发生rebalance。

参考信息 nimbus.task.launch.secs和supervisor.worker.start.timeout.secs这两个参数分别代表nimbus端和supervisor端对于拓扑启动的超时容忍时间，一般nimbus.task.launch.secs的值要大于等于supervisor.worker.start.timeout.secs的值（建议相等或略大，如果超出太多会影响任务重分配的效率）。 nimbus.task.launch.secs：nimbus在超过该参数配置的时间内没有收到拓扑的task发的心跳时，会将该拓扑重新分配（分配给别的supervisor），同时会刷新zk中的任务信息，supervisor读到zk中的任务信息并且与自己当前所启动的拓扑进行比较，如果存在拓扑已经不属于自己，那么则会删除该拓扑的元数据，也就是/srv/Bigdata/streaming_data/stormdir/supervisor/stormdist/{worker-id}目录。 supervisor.worker.start.timeout.secs：supervisor启动worker后，在该参数配置的时间内没有收到worker的心跳时，supervisor会主动停掉worker，等待worker的重新调度，一般在业务启动时间较长时适当增加该参数的值，保证worker能启动成功。 如果supervisor.worker.start.timeout.secs配置的值比nimbus.task.launch.secs的值大，那么则会出现supervisor的容忍时间没到，仍然继续让worker启动，而nimbus却认定该业务启动超时，将该业务分配给了其他主机，这时supervisor的后台线程发现任务不一致，删除了拓扑的元数据，导致接下来worker在启动过程中要读取stormconf.ser时，发现该文件已经不存在了，就会抛出FileNotFoundException。 nimbus.task.timeout.secs和supervisor.worker.timeout.secs这两个参数则分别代表nimbus端和supervisor端对于拓扑运行过程中心跳上报的超时容忍时间，一般nimbus.task.timeout.secs的值要大于等于supervisor.worker.timeout.secs的值（建议相等或略大），原理同上。

原因分析 原因：由于参数设置不当，数据量大时数据处理时间过长，导致频繁发生balance，此时offset无法正常提交，导致重复消费数据。 原理：每次poll的数据处理完后才提交offset，如果poll数据后的处理时长超出了session.timeout.ms的设置时长，此时发生rebalance导致本次消费失败，已经消费数据的offset无法正常提交，所以下次重新消费时还是在旧的offset消费数据，从而导致消费数据重复。

原因分析 由于执行命令的用户与当前查看pid信息的进程提交用户不一致导致。 Storm引入区分用户执行任务特性，在启动worker进程时将给进程的uid和gid改为提交用户和ficommon，目的是为了logviewer可以访问到worker进程的日志同时日志文件只开放权限到640。这样会导致切换到提交用户后对Worker进程执行jstack和jmap等命令执行失败，原因是提交用户的默认gid并不是ficommon，需要通过ldap命令修改提交用户的gid为9998（ficommon）才可执行。

可能原因 Worker进程启动失败，触发Nimbus重新分配任务，在其他Supervisor上启动Worker。由于Worker启动失败后会继续重启，导致Worker节点在一直变化，且Worker日志内容为空。Worker进程启动失败的可能原因有两个： 提交的Jar包中包含“storm.yaml”文件。 Storm规定，每个“classpath”中只能包含一个“storm.yaml”文件，如果多于一个那么就会产生异常。使用Storm客户端提交拓扑，由于客户端“classpath”配置和Eclipse远程提交方式“classpath”不一样，客户端会自动加载用户的Jar包到“classpath”，从而使“classpath”中存在两个“storm.yaml”文件。 Worker进程初始化时间较长，超过Storm集群设置Worker启动超时时间，导致Worker被Kill从而一直进行重分配。

解决办法 建议用户在Manager页面调整以下服务参数： request.timeout.ms=100000 session.timeout.ms=90000 max.poll.records=50 heartbeat.interval.ms=3000 其中： request.timeout.ms要比session.timeout.ms大10s。 session.timeout.ms的大小设置要在服务端参数group.min.session.timeout.ms和group.max.session.timeout.ms之间。 以上参数可以根据实际情况进行适当的调整，特别是max.poll.records，这个参数是为了控制每次poll数据的records量，保证每次的处理时长尽量保持稳定。目的是为了保证poll数据以后的处理时间不要超过session.timeout.ms的时间。

原因分析 HDFS的客户端和服务端数据传输走的rpc协议，该协议有多种加密方式，由hadoop.rpc.protection参数控制。 如果客户端和服务端的hadoop.rpc.protection参数的配置值不一样，即会报No common protection layer between client and server错误。 hadoop.rpc.protection参数表示数据可通过以下任一方式在节点间进行传输。 privacy：指数据在鉴权及加密后再传输。这种方式会降低性能。 authentication：指数据在鉴权后直接传输，不加密。这种方式能保证性能但存在安全风险。 integrity：指数据直接传输，即不加密也不鉴权。 为保证数据安全，请谨慎使用这种方式。

解决办法 针对 MRS 2.x及之前版本，操作如下： 方法1： 关闭Flink SSL通信加密，修改客户端配置文件“conf/flink-conf.yaml”。 security.ssl.internal.enabled: false 方法2： 开启Flink SSL通信加密，security.ssl.internal.enabled保持默认。 正确配置SSL： 配置keystore或truststore文件路径为相对路径时，Flink Client执行命令的目录需要可以直接访问该相对路径。 security.ssl.internal.keystore: ssl/flink.keystoresecurity.ssl.internal.truststore: ssl/flink.truststore 在Flink的CLI yarn-session.sh命令中增加“-t”选项来传输keystore和truststore文件到各个执行节点。 yarn-session.sh -t ssl/ 2 配置keystore或truststore文件路径为绝对路径时，需要在Flink Client以及各个节点的该绝对路径上放置keystore或truststore文件。 security.ssl.internal.keystore: /opt/client/Flink/flink/conf/flink.keystoresecurity.ssl.internal.truststore: /opt/client/Flink/flink/conf/flink.truststore 针对MRS3.x及之后版本，操作如下： 方法1： 关闭Flink SSL通信加密，修改客户端配置文件“conf/flink-conf.yaml”。 security.ssl.enabled: false 方法2： 开启Flink SSL通信加密，security.ssl.enabled 保持默认。 正确配置SSL： 配置keystore或truststore文件路径为相对路径时，Flink Client执行命令的目录需要可以直接访问该相对路径。 security.ssl.keystore: ssl/flink.keystoresecurity.ssl.truststore: ssl/flink.truststore 在Flink的CLI yarn-session.sh命令中增加“-t”选项来传输keystore和truststore文件到各个执行节点。 yarn-session.sh -t ssl/ 2 配置keystore或truststore文件路径为绝对路径时，需要在Flink Client以及各个节点的该绝对路径上放置keystore或truststore文件。 security.ssl.keystore: /opt/client/Flink/flink/conf/flink.keystoresecurity.ssl.truststore: /opt/client/Flink/flink/conf/flink.truststore

问题1：报没权限（Access denied）执行balance 问题详细：执行start-balancer.sh，“hadoop-root-balancer-主机名.out”日志显示“Access denied for user test1. Superuser privilege is required” cat /opt/client/HDFS/hadoop/logs/hadoop-root-balancer-host2.outTime Stamp Iteration# Bytes Already Moved Bytes Left To Move Bytes Being MovedINFO: Watching file:/opt/client/HDFS/hadoop/etc/hadoop/log4j.properties for changes with interval : 60000org.apache.hadoop.ipc.RemoteException(org.apache.hadoop.security.AccessControlException): Access denied for user test1. Superuser privilege is requiredat org.apache.hadoop.hdfs.server.namenode.FSPermissionChecker.checkSuperuserPrivilege(FSPermissionChecker.java:122)at org.apache.hadoop.hdfs.server.namenode.FSNamesystem.checkSuperuserPrivilege(FSNamesystem.java:5916) 问题根因： 执行balance需要使用管理员账户 解决方法 安全版本 使用hdfs或者其他属于supergroup组的用户认证后，执行balance 普通版本 执行HDFS的balance命令前，需要在客户端执行su - hdfs命令。

问题背景与现象 shell客户端或者其他客户端操作HDFS失败，报“No common protection layer between client and server”。 在集群外的机器，执行任意hadoop命令，如hadoop fs -ls /均失败，最底层的报错为"No common protection layer between client and server"。 2017-05-13 19:14:19,060 | ERROR | [pool-1-thread-1] | Server startup failure | org.apache.sqoop.core.SqoopServer.initializeServer(SqoopServer.java:69)org.apache.sqoop.common.SqoopException: MAPRED_EXEC_0028:Failed to operate HDFS - Failed to get the file /user/loader/etl_dirty_data_dir status at org.apache.sqoop.job.mr.HDFSClient.fileExist(HDFSClient.java:85)... at java.lang.Thread.run(Thread.java:745)Caused by: java.io.IOException: Failed on local exception: java.io.IOException: Couldn't setup connection for loader/hadoop@HADOOP.COM to loader37/10.162.0.37:25000; Host Details : local host is: "loader37/10.162.0.37"; destination host is: "loader37":25000; at org.apache.hadoop.net.NetUtils.wrapException(NetUtils.java:776)... ... 10 moreCaused by: java.io.IOException: Couldn't setup connection for loader/hadoop@HADOOP.COM to loader37/10.162.0.37:25000 at org.apache.hadoop.ipc.Client$Connection$1.run(Client.java:674 ... 28 moreCaused by: javax.security.sasl.SaslException: No common protection layer between client and server at com.sun.security.sasl.gsskerb.GssKrb5Client.doFinalHandshake(GssKrb5Client.java:251)... at org.apache.hadoop.ipc.Client$Connection.setupIOstreams(Client.java:720)

问题2：执行balance失败，/system/balancer.id文件异常 问题详细： 在HDFS客户端启动一个Balance进程，该进程被异常停止后，再次执行Balance操作，操作会失败。 org.apache.hadoop.ipc.RemoteException(org.apache.hadoop.protocol.RecoveryInProgressException): Failed to APPEND_FILE /system/balancer.id for DFSClient because lease recovery is in progress. Try again later. 问题根因： 通常，HDFS执行Balance操作结束后，会自动释放“/system/balancer.id”文件，可再次正常执行Balance。 但在上述场景中，由于第一次的Balance操作是被异常停止的，所以第二次进行Balance操作时，“/system/balancer.id”文件仍然存在，则会触发append /system/balancer.id操作，进而导致Balance操作失败。 解决方法 方法1：等待硬租期超过1小时后，原有客户端释放租约，再执行第二次Balance操作。 方法2：删除HDFS中的“/system/balancer.id”文件，再执行下次Balance操作。

问题背景与现象 创建Fllink集群，执行yarn-session.sh命令卡住一段时间后报错： 2018-09-20 22:51:16,842 | WARN | [main] | Unable to get ClusterClient status from Application Client | org.apache.flink.yarn.YarnClusterClient (YarnClusterClient.java:253) org.apache.flink.util.FlinkException: Could not connect to the leading JobManager. Please check that the JobManager is running.at org.apache.flink.client.program.ClusterClient.getJobManagerGateway(ClusterClient.java:861)at org.apache.flink.yarn.YarnClusterClient.getClusterStatus(YarnClusterClient.java:248)at org.apache.flink.yarn.YarnClusterClient.waitForClusterToBeReady(YarnClusterClient.java:516)at org.apache.flink.yarn.cli.FlinkYarnSessionCli.run(FlinkYarnSessionCli.java:717)at org.apache.flink.yarn.cli.FlinkYarnSessionCli$1.call(FlinkYarnSessionCli.java:514)at org.apache.flink.yarn.cli.FlinkYarnSessionCli$1.call(FlinkYarnSessionCli.java:511)at java.security.AccessController.doPrivileged(Native Method)at javax.security.auth.Subject.doAs(Subject.java:422)at org.apache.hadoop.security.UserGroupInformation.doAs(UserGroupInformation.java:1729)at org.apache.flink.runtime.security.HadoopSecurityContext.runSecured(HadoopSecurityContext.java:41)at org.apache.flink.yarn.cli.FlinkYarnSessionCli.main(FlinkYarnSessionCli.java:511)Caused by: org.apache.flink.runtime.leaderretrieval.LeaderRetrievalException: Could not retrieve the leader gateway.at org.apache.flink.runtime.util.LeaderRetrievalUtils.retrieveLeaderGateway(LeaderRetrievalUtils.java:79)at org.apache.flink.client.program.ClusterClient.getJobManagerGateway(ClusterClient.java:856)... 10 common frames omittedCaused by: java.util.concurrent.TimeoutException: Futures timed out after [10000 milliseconds]

问题背景与现象 客户端安装成功，执行客户端命令例如yarn-session.sh时报错，提示如下： [root@host01 bin]# yarn-session.sh2018-10-25 19:27:01,397 | ERROR | [main] | Error while trying to split key and value in configuration file /opt/flinkclient/Flink/flink/conf/flink-conf.yaml:81: "security.kerberos.login.principal:pippo " | org.apache.flink.configuration.GlobalConfiguration (GlobalConfiguration.java:160)Exception in thread "main" org.apache.flink.configuration.IllegalConfigurationException: Error while parsing YAML configuration file :81: "security.kerberos.login.principal:pippo " at org.apache.flink.configuration.GlobalConfiguration.loadYAMLResource(GlobalConfiguration.java:161) at org.apache.flink.configuration.GlobalConfiguration.loadConfiguration(GlobalConfiguration.java:112) at org.apache.flink.configuration.GlobalConfiguration.loadConfiguration(GlobalConfiguration.java:79) at org.apache.flink.yarn.cli.FlinkYarnSessionCli.main(FlinkYarnSessionCli.java:482)

问题背景与现象 使用Flink过程中，具有两个相同权限用户testuser和bdpuser。 使用用户testuser创建Flink集群正常，但是切换至bdpuser用户创建Fllink集群时，执行yarn-session.sh命令报错： 2019-01-02 14:28:09,098 | ERROR | [main] | Ensure path threw exception | org.apache.flink.shaded.curator.org.apache.curator.framework.imps.CuratorFrameworkImpl (CuratorFrameworkImpl.java:566) org.apache.flink.shaded.zookeeper.org.apache.zookeeper.KeeperException$NoAuthException: KeeperErrorCode = NoAuth for /flink/application_1545397824912_0022

原因分析 在Driver端打印异常如下，打印连接两个ResourceManager主备节点的26004端口均被拒绝： 15/08/19 18:36:16 INFO RetryInvocationHandler: Exception while invoking getClusterMetrics of class ApplicationClientProtocolPBClientImpl over 33 after 1 fail over attempts. Trying to fail over after sleeping for 17448ms. java.net.ConnectException: Call From ip0 to ip1:26004 failed on connection exception: java.net.ConnectException: Connection refused.INFO RetryInvocationHandler: Exception while invoking getClusterMetrics of class ApplicationClientProtocolPBClientImpl over 32 after 2 fail over attempts. Trying to fail over after sleeping for 16233ms. java.net.ConnectException: Call From ip0 to ip2:26004 failed on connection exception: java.net.ConnectException: Connection refused; 在MRS Manager页面查看ResourceManager此时是否功能正常，如果Yarn服务状态故障或某个Yarn服务的实例出现未知之类的异常说明此时集群的ResourceManager可能异常。 排查使用的客户端是否是集群最新的客户端。 排查集群是否做过实例ResourceManager迁移相关操作（先卸载某个ResourceManager实例，然后在其他节点添加）。 在MRS Manager页面查看审计日志，是否有相关操作的记录。 使用ping命令，查看IP是否可连通。

处理步骤 登录Manager，停止HDFS服务。 在停止HDFS时，建议不要停止相关服务。 停止成功后，登录到被修改了RPC端口的Master节点。 如果两个Master节点都被修改了RPC端口，则只需登录其中一个修改即可。 执行su - omm命令切换到omm用户。 如果是安全集群，需要执行kinit hdfs命令进行认证。 执行如下命令，将环境变量脚本加载到环境中。 cd ${BIGDATA_HOME}/MRS_X.X.X/1_8_Zkfc/etc source ${BIGDATA_HOME}/MRS_X.X.X/install/ FusionInsight -Hadoop-3.1.1/hadoop/sbin/exportENV_VARS.sh 命令中的“MRS_X.X.X”和“1_8”根据实际版本而定。 加载完成后，执行如下命令，格式化Zkfc。 cd ${HADOOP_HOME}/bin ./hdfs zkfc -formatZK 格式化成功后，在Manager页面“重启”HDFS服务。 如果更改了NameNode的RPC端口，则之前安装的所有客户端都需要刷新配置文件。

解决办法 ZooKeeper连接失败导致。 Kafka客户端连接ZooKeeper服务超时。检查客户端到ZooKeeper的网络连通性。 网络连接失败，通过Manager界面查看Zookeeper服务信息。 图1 Zookeeper服务信息 配置错误，修改客户端命令中ZooKeeper地址。 Kafka服务端配置禁止删除。 通过Manager界面修改delete.topic.enable为true。保存配置并重启服务。 图2 修改delete.topic.enable 客户端查询命令，无Topic:test。 kafka-topics.sh --list --zookeeper 192.168.0.122:24002/kafka 进入RunningAsController节点日志目录，在controller.log发现Deletion of topic test successfully。 2016-03-10 10:39:40,665 | INFO | [delete-topics-thread-3] | [Partition state machine on Controller 3]: Invoking state change to OfflinePartition for partitions [test,2],[test,15],[test,6],[test,16],[test,12],[test,7],[test,10],[test,13],[test,9],[test,19],[test,3],[test,5],[test,1],[test,0],[test,17],[test,8],[test,4],[test,11],[test,14],[test,18] | kafka.controller.PartitionStateMachine (Logging.scala:68)2016-03-10 10:39:40,668 | INFO | [delete-topics-thread-3] | [Partition state machine on Controller 3]: Invoking state change to NonExistentPartition for partitions [test,2],[test,15],[test,6],[test,16],[test,12],[test,7],[test,10],[test,13],[test,9],[test,19],[test,3],[test,5],[test,1],[test,0],[test,17],[test,8],[test,4],[test,11],[test,14],[test,18] | kafka.controller.PartitionStateMachine (Logging.scala:68)2016-03-10 10:39:40,977 | INFO | [delete-topics-thread-3] | [delete-topics-thread-3], Deletion of topic test successfully completed | kafka.controller.TopicDeletionManager$DeleteTopicsThread (Logging.scala:68) Kafka部分节点处于停止或者故障状态。 启动停止的Broker实例。 客户端查询命令，无Topic:test。 kafka-topics.sh --list --zookeeper 192.168.0.122:24002/kafka 进入RunningAsController节点日志目录，在controller.log发现Deletion of topic test successfully。 2016-03-10 11:17:56,463 | INFO | [delete-topics-thread-3] | [Partition state machine on Controller 3]: Invoking state change to NonExistentPartition for partitions [test,4],[test,1],[test,8],[test,2],[test,5],[test,9],[test,7],[test,6],[test,0],[test,3] | kafka.controller.PartitionStateMachine (Logging.scala:68)2016-03-10 11:17:56,726 | INFO | [delete-topics-thread-3] | [delete-topics-thread-3], Deletion of topic test successfully completed | kafka.controller.TopicDeletionManager$DeleteTopicsThread (Logging.scala:68) Kafka配置自动创建，且Producer未停止。 停止相关应用，通过Manager界面修改“auto.create.topics.enable”为“false”，保存配置并重启服务。 图3 修改auto.create.topics.enable 再次执行delete操作。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 Authorization：签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考AK/SK认证。 X-Sdk-Date：请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考AK/SK认证。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID：子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID：账号ID，可选。AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。 对于管理员创建 IAM 用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码，并在Content-type中声明字符编码方式，例如：Content-Type: application/json; charset=utf-8。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/jsonX-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

场景描述 购买包年/包月云应用服务器可以使用创建云服务器接口，相对于创建按需的云应用服务器，只需要在请求body中指定create_server_extend_param.charging_mode参数值为“prePaid”，即包年包月，指定订购的周期等。create_server_extend_param的详细参数解释请参见云应用API中创建云服务器的表7说明。 示例： 如下所示，在cn-north-4区域购买一台包年/包月云应用服务器，时长为一个月，且下单后自动支付，自动续订。 { "type": "createApps", "server_group_id": "266aa7aa-862b-4c46-9064-dfd057049d67", "availability_zone":"cn-north-4a", "subscription_num": 1, "product_id": "workspace.appstream.general.xlarge.2", "root_volume": { "type": "SAS", "size": 80 }, "subnet_id": "6719e894-515f-4a19-86a8-e056a839ecee", "vpc_id": "3d00f422-1968-4349-b2d0-9d72d75cc502", "update_access_agent": false, "create_server_extend_param": { "charging_mode": "prePaid", "period_type": 2, "period_num": 1, "is_auto_renew": true, "is_auto_pay": true }}包年/包月云应用服务器创建后会返回一个order_id，即订单ID。{ "order_id": " CS 2311171xxxxxxxx"} 上面请求体中create_server_extend_param.is_auto_pay取值为true，表示自动支付，如果不填该字段或取值为false，则需要手动去支付，手动支付可以填写优惠券和折扣券等信息。 手动支付需要调用【支付包年/包月产品订单】支付，示例如下。 POST https://bss.myhuaweicloud.com/v2/orders/customer-orders/pay{ "order_id": "CS2311172xxxxxxxx"}

概述 欢迎使用 云桌面 （Workspace）。云桌面（Workspace）是一种基于云计算的桌面服务。与传统PC和VDI不同，企业无需投入大量的资金和花费数天的部署时间，即可快速构建桌面办公环境。云桌面支持多种登录方式，可让您灵活存取文件及使用应用，实现移动办公。 您可以使用本文档提供的API对云桌面进行相关操作，如创建、查询、删除等。支持的全部操作请参见API概览。 在调用云桌面服务的API之前，请确保已经充分了解云桌面服务的相关概念，详细信息请参见《云桌面产品介绍》。 父主题： 使用前必读

请求URI 请求URI由如下部分组成： {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“管理员创建IAM用户”接口的resource-path为“/v3.0/OS-USER/users”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint（比如“华北-北京四”区域的Endpoint：“iam.cn-north-4.myhuaweicloud.com”，并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求示例 PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-groups/656582710889807872/apps/656599335839993860{ "version" : "19.0.0.1", "description" : "修改应用。", "sandbox_enable" : false, "name" : "7-Zip File Manager", "work_path" : "C:\\Program Files\\7-Zip", "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "command_param" : ""}

响应示例 状态码： 200 成功响应。 { "id" : "656599335839993860", "name" : "7-Zip File Manager", "version" : "19.0.0.1", "command_param" : "", "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "work_path" : "C:\\Program Files\\7-Zip", "icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "icon_index" : 0, "description" : "", "app_group_id" : "656582710889807872", "state" : "NORMAL", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011", "publish_at" : "2024-01-15T08:39:56.265Z", "source_type" : 2, "publisher" : "Igor Pavlov", "sandbox_enable" : false}

云应用错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 WKS.00211102 The number of application exceeds the limit, limit:''{1}'' 应用数量超出限制。 请联系管理员 400 WKS.00211108 Unsupported bucket, expected:''{0}'' actual:''{1}'' 存储桶不支持。 请先修改请求参数,再重新请求 400 WKS.00211201 The application install job''{0}'' does not exist 应用安装任务不存在。 检查任务ID是否填写错误, 修改并重新请求。 400 WKS.00211206 The installation task was canceled, please try again later 安装任务已取消，请稍后重试 安装任务已取消，请稍后重试 400 WKS.00211301 OBS operation param illegal:{0} OBS参数错误。 请联系管理员 400 WKS.00211802 The number of application rule exceeds the limit, limit:''{0}'' 应用规则超过数量限制 请确认是否超过限制并重新请求 400 WKS.00211807 The parameter is invalid : ''{0}''. 参数有误 重新输入参数 400 WKS.00211810 The execution of script or command is canceled, please try again later. 脚本执行被取消 稍后重试或者联系管理员。 400 WKS.00211811 AppCenterAgent need to be updated. AppCenterAgent需要更新 更新AppCenterAgent。 400 WKS.00212101 SFS operation param illegal:{0}. SFS参数错误。 请联系管理员。 401 WKS.00211302 OBS operation failed, user authorization error:{0} OBS操作失败，用户授权错误。 请先进行桶授权,之后重试。 401 WKS.00212102 SFS operation failed, user authorization error:{0}. SFS操作失败，用户授权错误。 请先进行桶授权，之后重试。 403 WKS.00211803 Script number reaches max num, can not create script, max script num: ''{0}'' 租户脚本数量达到最大值，无法创建脚本 删除脚本后重新创建 403 WKS.00211804 Script name exists, create script failed. 存在同名脚本，创建脚本失败 修改脚本名字 403 WKS.00211904 Associated storage folder claim exists, not allowed to delete the storage ''{0}''. 存在关联的存储目录声明,不允许删除存储。 请先删除关联的存储目录声明，并尝试重新请求。 403 WKS.00211905 Associated storage attachment exists, not allowed to delete the storage folder claim ''{0}'.' 存在关联存储对象,不允许删除存储目录声明 请先删除关联的存储对象，并尝试重新请求。 403 WKS.00211906 Unsupported operation, user storage claim ''{0}''. 用户存储目录声明不支持对应操作。 稍后重试或者联系管理员。 403 WKS.00211907 Direct assignment of associated attachment for user storage claims is not supported. 不支持为用户存储声明直接分配关联对象。 请选择其他的存储声明，并尝试重新请求。 404 WKS.00211101 The application''{0}'' does not exist 应用不存在。 检查应用ID是否填写错误, 修改并重新请求。 404 WKS.00211204 Application install job aborted, no instances available 无关联实例,应用安装任务被中止 请先添加实例,再重新尝试 404 WKS.00211303 OBS operation failed, bucket''{0}'' does not exist OBS操作失败，桶不存在。 请先创建创建桶,之后重试。 404 WKS.00211304 OBS operation failed, object''{0}'' does not exist OBS操作失败，对象不存在。 请先添加桶对象,之后重试。 404 WKS.00211601 Install application fail, the instance''{0}'' does not exist 应用安装失败,实例不存在 检查实例ID是否填写错误, 修改并重新请求 404 WKS.00211701 Category''{0}'' does not exist 分类不存在。 检查分类ID是否填写错误, 修改并重新请求。 404 WKS.00211801 The application rule does not exist 应用规则不存在 请确认是否存在应用规则并重新请求 404 WKS.00211805 The script is not exist, scriptId : ''{0}''. 脚本不存在 重新选择脚本 404 WKS.00211806 The resource is not exist, resourceId : ''{0}''. 资源不存在 重新选择资源 404 WKS.00211902 Storage ''{0}'' not found 关联存储未找到。 请检查请求参数，并尝试重新请求。 404 WKS.00211903 Storage folder claim ''{0}'' not found 存储目录声明未找到。 请检查请求参数，并尝试重新请求。 404 WKS.00212001 Storage policy statement ''{0}'' not found. 存储策略不存在。 请检查请求参数，并尝试重新请求。 404 WKS.00212103 SFS operation failed, bucket''{0}'' does not exist. SFS操作失败，桶不存在。 请先创建创建桶，之后重试。 404 WKS.00212104 SFS operation failed, object''{0}'' does not exist. SFS操作失败，目录不存在。 请先添加桶对象,之后重试。 409 WKS.00211103 Operation not supported, application''{0}'' is being installed 操作不支持，应用正在安装。 请等待安装结束后,再重新请求。 409 WKS.00211104 Operation not supported, the authorization mode of the application''{0}'' is: ALL_USER 操作不支持，应用授权模式为:全量用户。 请联系管理员修改授权模式,再重新请求。 409 WKS.00211105 Application ''{0}'' does not support quiet installation 应用不支持静默安装 检查应用ID是否填写错误, 修改并重新请求 409 WKS.00211106 Invalid application download link 应用下载链接无效 重新上传应用或者设置有效的下载链接,再重新请求 409 WKS.00211107 Application ''{0}'' is not authorized 应用未获得授权 请联系管理员授权应用,再重新请求 409 WKS.00211202 Retry not supported, only FAIL status jobs are supported, ''{0}'' actual status:''{1}'' 仅支持失败状态任务重试。 检查任务状态是否合法 409 WKS.00211305 OBS operation failed:{0} OBS操作失败。 稍后重试或者联系管理员 409 WKS.00211602 Instance''{0}'' status is abnormal, only running instances are supported 实例状态异常,仅支持运行中的实例 请先检查实例状态,稍后重试 409 WKS.00211603 Inconsistent operating system, application expects ''{0}'', instance is ''{1}'' 安装应用失败,应用支持的操作系统和实例实际的操作系统不一致。 请先检查应用支持的操作系统和目标实例的操作系统类型是否一致 409 WKS.00211901 Storage ''{0}'' is already in use 存储正在使用中。 请选择其他的存储并尝试重新请求。 409 WKS.00211908 Storage folder claim ''{0}'' is already in use. 存储目录声明已存在。 请检查请求参数，并尝试重新请求。 409 WKS.00211909 The number of [{0}] storage folders for ''{1}'' exceeds the limit, limit {2}. 存储目录声明数量超出限制。 请联系管理员。 409 WKS.00212105 SFS operation failed:{0}. SFS操作失败。 稍后重试或者联系管理员。 429 WKS.00211205 Too many installation tasks, please try again later 安装任务太多,请稍后重试 请检查实例状态,重新安装 500 WKS.00211203 Waiting for the application installation result to respond timeout 等待应用安装结果响应超时 请检查实例状态,重新安装 500 WKS.00211306 OBS service error:{0} OBS服务异常。 稍后重试或者联系管理员 500 WKS.00211401 The application installation failed:{0} 应用安装失败 稍后重试或者联系管理员。 500 WKS.00211402 Instance connection timeout, please try again later or contact the administrator 实例连接超时，请稍后重试或联系管理员 稍后重试或者联系管理员 500 WKS.00211403 Instance access fail, try again later or contact the administrator 实例访问失败，稍后重试或联系管理员 稍后重试或者联系管理员 500 WKS.00211808 Failed to execute script or command. 执行脚本或命令行失败 稍后重试或者联系管理员。 500 WKS.00211809 Failed to query the result of the script or command. 查询脚本或命令行失败 稍后重试或者联系管理员。 500 WKS.00212106 SFS service error:{0}. SFS服务异常。 稍后重试或者联系管理员。 400 WKS.00131104 The number of application groups exceeds the limit, limit {0}. 应用组数量超过限制。 请联系管理员增加配额。 400 WKS.00131105 In shared desktop mode, a server group can be associated with only one application group, The number of application groups bound to a server group is {0}. 在共享桌面模式下，服务器组只能关联一个应用组。 请先解绑该服务器组下面的原先的应用组。 400 WKS.00131502 The total number of apps stored in the application warehouse exceeds the limit, limit {0}. 应用仓库中已存储的应用数量超过上限。 请联系管理员增加配额。 403 WKS.00131202 The published application is forbidden. 应用被禁止使用。 请联系管理员修改应用状态。 403 WKS.00131203 The number of application in the groups exceeds the limit, limit {0}. 应用组下应用数量超过限制。 请联系管理员增加配额。 403 WKS.00131303 The authorization record does not exist. 授权不存在。 请先添加授权。 403 WKS.00131304 The number of authorized users in the application group exceeds the limit, limit {0}. 应用组下的授权用户数超出限制。 请联系管理员增加配额。 403 WKS.00131504 The application warehouse obs bucket permission does not exist. 应用仓库obs无权限。 请根据提示创建obs桶权限。 404 WKS.00131100 Application group does not exist. 应用组不存在。 检查应用组ID是否填写错误, 修改并重新请求。 404 WKS.00131102 The application group needs to be bound to the application server group first. 应用组没有绑定应用服务器组。 请先绑定应用服务器组后, 重新请求。 404 WKS.00131200 Published application record does not exist. 已发布应用记录不存在 请检查应用ID是否填写错误,修改并重新请求。 404 WKS.00131503 The application warehouse obs bucket does not exist. 应用仓库obs桶不存在。 请根据提示创建obs桶。 404 WKS.00131505 The application warehouse obs object does not exist. 应用仓库obs对象不存在。 请根据提示创建obs对象。 409 WKS.00131101 The application under the application group is not unpublished. 应用组下应用未取消发布。 请先将应用组下应用取消发布，再重新请求。 409 WKS.00131103 Application group name ''{0}'' already exists. 应用组名称已经存在 请修改应用组名称后, 重新请求。 409 WKS.00131201 An published application with the same name ''{0}'' exists in the application group. 应用组中存在同名的已发布应用。 请修改应用名称，并重新请求。 409 WKS.00131300 The authorization mode of ''{0}'' is: application group authorization, which does not support adding an authorization account when publishing an application. 不支持发布应用时添加授权账户。 请先移除请求中授权账户后，重新请求，发布成功后再按照应用组为账户授权。 409 WKS.00131301 The authorization mode of ''{0}'' is: application authorization, not supported: application group authorization. 不支持应用组授权。 请先在应用组下发布应用，再对应用授权。 409 WKS.00131302 The authorization mode of ''{0}'' is: application group authorization, not supported: application authorization. 不支持应用授权。 请选择应用所在应用组进行授权。 409 WKS.00131501 An application with the same name ''{0}'' exists in the application warehouse. 在应用仓库中已有该名称的应用。 请修改应用名称，并重新请求。 403 WKS.00081102 This is a basic policy group,can't be deleted. 基础策略组不能被删除。 请检查修改无效解析参数,并尝试重新请求。 403 WKS.00081105 The number of policy groups exceeds the limit, limit {0}. 策略组数量超出限制。 请联系管理员增加配额。 404 WKS.00081103 The policy template is not found, the group id is ''{0}''. 策略组模板未找到。 请检查修改无效解析参数，并尝试重新请求。 404 WKS.00081104 The policy group is not found, the group id is ''{0}''. 策略组未找到。 请检查修改无效解析参数，并尝试重新请求。 409 WKS.00081101 The policy group name is conflict. 策略组名称重复。 请先修改策略组名称,并尝试重新请求。 400 WKS.00121107 The number of server group exceeds the limit, limit {0} 服务器组数量超过限制。 请联系管理员增加配额。 400 WKS.00121301 The image requested by the client was not supported:{0} 镜像非法,操作不支持。 请选择其他镜像，并尝试重新请求。 400 WKS.00121404 Failed to modify the application type. The server group cannot be associated with any application group. 修改应用类型失败，服务器组下面不能有应用组关联。 请检查该服务器组关联，解绑后重新提交。 400 WKS.00121602 The number of maxSession exceeds the sum of the number of paid sessions and the number of default sessions. 调度会话数超过付费会话数和默认会话数之和。 请检查并修改会话参数后重试。 400 WKS.00121603 Only pay-per-use computers in the server group are allowed to modify the number of paid sessions. 服务器组中只允许按需购买的计算机修改付费会话数。 检查修改的服务器是否都是按需的。 400 WKS.00121604 The number of payment sessions cannot be the same as the original value. 付费会话数与原先的值不能相同。 请检查并修改会话参数后重试。 400 WKS.00121605 TServers in the BUILD/DELETING/BUILD_FAIL state cannot exist in the server group. 服务器组中不能存在BUILD/DELETING/BUILD_FAIL状态的服务器。 请检查该服务器组下面的服务器状态。 400 WKS.00121606 The number of server sessions in the server group is greater than the number of available sessions and cannot be changed. 服务器组中服务器会话数大于可用会话数，不允许更改。 请检查并修改会话参数后重试。 400 WKS.00121608 The number of sessions exceeds the maximum,max extra session size is ''{0}''. 增购会话数超过最大值限制。 请检查并修改会话参数后重试。 401 WKS.00121601 Missing {0} agency rights permission. 用户缺少委托相关的权限。 为当前用户添加管理员权限，并尝试重新请求。 403 WKS.00121102 Current user has no auth to user market image. 当前用户没有权限使用市场镜像。 请检查请求的市场镜像是否符合要求，再重试请求。 404 WKS.00121100 The cloud application server group requested by the client was not found, and ''{0}'' is a non-existing cloud application server group. 客户端请求的云应用服务器组未找到。 请检查请求的云应用服务器组是否存在。 404 WKS.00121104 There are no instances under server group ''{0}''. 服务器组下不存在实例。 请先在服务器组添加实例,并尝试重新请求。 404 WKS.00121200 The cloud application server requested by the client was not found, and ''{0}'' is a non-existing cloud application server. 客户端请求的云应用服务器不存在。 请检查请求的云应用服务器是否存在。 404 WKS.00121206 There are no volumes under the cloud application server {0} requested by the client. 客户端请求的云服务器下没有磁盘。 请联系服务商寻求协助。 404 WKS.00121209 The server original image info does not exist. 服务器的原始镜像信息不存在。 请联系服务商寻求协助。 404 WKS.00121210 The disk information for the server was not found. 未找到服务器关联的磁盘信息。 请联系服务商寻求协助。 404 WKS.00121212 Organization unit(OU) ''{0}'' does not exist. 未查询到对应的OU。 请检查OU名称填写正确,并尝试重新请求。 404 WKS.00121302 Port information not found. 未找到端口信息。 请检查修改无效参数，并尝试重新请求。 404 WKS.00121303 The client requested image ''{0}'' not found. 客户端请求的镜像未找到。 请检查并修改镜像ID，尝试重新请求。 404 WKS.00121304 The subnet ''{0}'' requested by the client was not found. 未找到客户端请求的子网信息。 请检查修改无效参数，并尝试重新请求。 404 WKS.00121401 Failed to query sid of vm instance. 未查询到虚拟机的sid。 请检查修改无效参数，并尝试重新请求。 404 WKS.00121402 The Policy information of server group ''{0}'' not found. 服务器组的策略信息信息未找到。 请检查修改无效参数，并尝试重新请求。 404 WKS.00121403 The subnet ''{0}'' associated with the server group was not found. 服务器组关联的子网未找到。 请检查修改无效参数，并尝试重新请求。 404 WKS.00121501 The dss cluster ''{0}'' is not find. 云专属分布式存储池id未找到。 请检查并修改存储池ID后并发起重试。 404 WKS.00121502 The availability zone of the dedicated storage pool does not match the input. 存储池可用区不匹配。 请检查并修改可用区参数后重试。 404 WKS.00121503 The storage type and disk type of the dedicated distributed storage pool are inconsistent. 云专属分布式存储池磁盘不匹配。 请检查并修改存储池类型参数后重试。 404 WKS.00121607 The corresponding session resource cannot be matched,session type is ''{0}''. 匹配不到对应的会话资源。 请检查并修改会话参数后重试。 409 WKS.00121101 The app-server group requested by the client is in conflict, ''{0}'' is an app-server group in conflict. 客户端请求的云应用服务器组镜像存在冲突。 请检查请求的云应用服务器组镜像以及实例是否存在多个版本，或镜像以及实例存在不同的操作系统版本。 409 WKS.00121103 There are undeleted instances under server group ''{0}''. 服务器组下存在未删除的实例。 请先删除服务器组下下实例,并尝试重新请求。 409 WKS.00121105 The server group requires the OS type of the mirror is: ''{0}'', but the OS type of the request mirror is ''{1}''. 服务器组要求镜像的操作系统类型与请求镜像的操作系统类型不匹配。 请使用具有相应操作系统类型的镜像，并尝试重新请求。 409 WKS.00121106 There are undissolved app group under server group ''{0}''. 服务器组下存在未解绑的应用组。 请先解绑服务器组下的云应用组，并尝试重新请求。 409 WKS.00121201 The cloud application server {0} operation requested by the client is not supported. 客户端请求的云应用服务器操作不支持。 请检查请求的云服务状态。 409 WKS.00121208 Server ''{0}'' must be shut down before cold migration. 服务器冷迁移之前服务器需要处于关机状态 请先关机,并尝试重新请求。 409 WKS.00121211 The identifier ''{0}'' requested by the client is failed to update ip virtualization. 更新虚拟IP配置失败。 请联系服务商寻求协助。 500 WKS.00121203 The cloud application server {0} requested by the client is failed to attach with users. 客户端请求的云应用服务器绑定用户失败。 请联系服务商寻求协助。 500 WKS.00121204 The cloud application server {0} requested by the client is failed to detach with users. 客户端请求的云应用服务器解绑用户失败。 请联系服务商寻求协助。 500 WKS.00121205 The cloud application server {0} requested by the client is failed to attach with apps. 客户端请求的云应用服务器添加软件失败。 请联系服务商寻求协助。 500 WKS.00121207 Rebuild server occur error. 重建镜像发生系统异常。 请联系服务商寻求协助。 400 WKS.00051101 The request message is invalid, failed to read http request. 请求消息不合法，读取http请求失败。 请检查修改请求消息，并尝试重新请求。 400 WKS.00051102 The parameter passed in the request is invalid, {0}. 请求传入的参数不合法。 请检查修改无效参数，并尝试重新请求。 400 WKS.00051103 The json parse failed, error message is ''{0}''. Json 解析失败。 请检查修改无效解析参数，并尝试重新请求。 400 WKS.00052102 Insufficient quota. 资源配额不足。 资源配额不足，请申请扩容。 400 WKS.00052106 The version of privacy statement to sign is not newest. 签署的隐私声明不是最新版本，请刷新后重新签署。 签署的隐私声明不是最新版本，请刷新后重新签署。 400 WKS.00052107 The order ''{0}'' not find. 订单ID未找到。 请联系管理员。 400 WKS.00052108 Failed to create order. 创建订单失败。 请联系管理员。 400 WKS.00052109 DeH packages can be provisioned only on DeHs. 专属主机套餐只允许发放在专属主机上。 请更换套餐类型或者添加专属主机信息。 401 WKS.00051202 The project_id in the request body is inconsistent with the project_id in the token 请求体中的project_id和token中的project_id不一致 请检查并修改无效参数,之后尝试重新请求 403 WKS.00051201 Invalid token scope, token scope is not domain. token 的scope非法，需要使用domain token。 使用 domain token，并尝试重新请求。 404 WKS.00051301 Availability zone {0} not exists. 该可用区不存在。 该可用区不存在。 404 WKS.00051401 Tenant information not found. 租户信息未找到。 请检查是否已成功开通租户，并尝试重新请求。 404 WKS.00051402 Domain information is not configured. 域信息未配置。 请先配置域信息，配置成功后尝试重新请求。 404 WKS.00051403 Account''{0}'' does not exist 账户不存在 检查账户是否填写错误, 修改并重新请求 404 WKS.00051404 User group''{0}'' does not exist 用户组不存在 检查账户是否填写错误, 修改并重新请求 404 WKS.00051501 The job ''{0}'' requested by the client was not found. 客户端请求的任务未找到。 请检查任务是否正确,并尝试重新请求。 404 WKS.00052103 The product ''{0}'' not find. 产品套餐不存在。 产品套餐不存在，请更换其他产品。 404 WKS.00052104 This product has been sold out or abandon in the availabilityZone {0}. 该产品套餐已经售罄或者废弃, 请更换一个套餐。 该产品套餐已经售罄或者废弃, 请更换一个套餐。 404 WKS.00052105 Failed to query the quota. 配额信息不存在。 配额信息不存在, 请联系管理员。 409 WKS.00051502 Operation not supported,the cloud application resources exist. 存在云应用资源,不允许销户。 请确保租户不存在云应用资源。 409 WKS.00052101 The order already exists. 该订单已存在。 订单已存在，请重新下单。 429 WKS.00051503 Server is busy, please try again later 服务器繁忙，请稍后重试或联系管理员 稍后重试或者联系管理员 500 WKS.00050901 The service encountered an internal error while processing the request. 服务器内部错误，无法处理请求。 请联系服务商寻求协助。 503 WKS.00050902 The service is now unavailable to process the request. 服务现在不可用，无法处理请求。 请联系服务商寻求协助。 父主题： 附录

响应示例 状态码： 200 成功响应。 { "id" : "1", "name" : "Chrome", "version" : "99.0.4844.51", "command_param" : "", "execute_path" : "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe", "work_path" : "C:\\Users\\zhangSan\\AppData\\Local\\Google\\Chrome", "icon_path" : "C:\\Users\\zhangSan\\AppData\\Local\\Google\\Chrome.png", "icon_index" : 1, "description" : "Google浏览器。", "app_group_id" : "1", "state" : "NORMAL", "tenant_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx", "publish_at" : "2022-03-07T10:40:43.858Z", "source_type" : 2, "publisher" : "Google Chrome", "icon_url" : "https://workspace*****.obs.cn-north-**.myhuaweicloud.com/1.png", "publishable" : false, "sandbox_enable" : false}

响应示例 状态码： 200 操作成功。 { "count" : 1, "items" : [ { "id" : "656599335839993860", "name" : "7-Zip File Manager", "version" : "19.0.0.0", "command_param" : "", "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "work_path" : "", "icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "icon_index" : 0, "description" : "", "app_group_id" : "656582710889807872", "state" : "NORMAL", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011", "publish_at" : "2024-01-15T08:39:56.265Z", "source_type" : 2, "publisher" : "Igor Pavlov", "sandbox_enable" : false } ]}

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "575772278315290631", "name" : "应用name2531691942", "version" : "V1.9202534394", "command_param" : "yQhK1urkWx0XR8ILGdSeFvqJYyMHURzP", "execute_path" : "C:\\Program Files (x86)\\Google应用\\appH7wqKcwpfk\\app0256aVegjU\\chrome.exe", "work_path" : "C:\\Users\\zhangssan\\AppData应用\\Local\\Google\\app5P521tF0RMkLrihaO0DR", "icon_path" : "C:\\Users\\zhangSan\\AppData\\Local应用\\Google\\appAXwSgdKA1FyDkbejBs2f.jpg", "icon_index" : 1499, "description" : "应用description256261241750805。", "app_group_id" : "575772274859184144", "state" : "NORMAL", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "publish_at" : "2023-06-06T14:13:58.914Z", "source_type" : 2, "publisher" : "tPPgWwxy5T130lX", "icon_url" : "", "sandbox_enable" : false } ]}

响应示例 状态码： 200 成功响应。 { "count" : 2, "items" : [ { "id" : "682367396442275840", "app_id" : "682367396387749888", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_name" : "WeChat", "app_category" : "PRODUCTIVITY_AND_COLLABORATION", "os_type" : "Windows", "version_id" : "111", "version_name" : "000", "appfile_store_path" : "file/WeChatSetup_3.9.0.28.exe", "app_file_size" : "169179", "app_description" : "", "appicon_store_path" : "", "create_time" : "2024-03-26T06:16:57.321Z", "modify_time" : "2024-03-26T06:16:57.321Z", "verify_status" : "VERIFYING", "app_icon" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAF4AAABdCAIAAACjJEaXAAAA*******BVHhe7Vt7jFzXWb/Peb929mXv2rt27PhtJ47rmKQhRG0d2tKkJAqgQEEFJFClAir8V6FWQhVB9E+Q4A/+KSBoVQRqqVQFopImEhQanKR2ahs7dtZee70Pr3d2Z+dxn/zO+e6cPffemd1ZZ7zeKPubq7O/77u/e+ec73zncWdmVd/3lS20w0poQFzXdRzH87yteKmAiAKCYhgG8S0AWvCXhyZgW+BYCQ3GUcC2wLESmq35JYKV0Gwhgq3QdMRWaDpiZfFeXl7OZrPEewhHcWt+o+43bd/2VXSFaipGSk1m1JSh6IFoU6LHobEV57ZXueXPTbozc/4CeNWvu77r+Vj/XCSpirdUVE3VTFXLq7l+tTis9Y9og9u0/rJW0DZTFvcmNA3fuu5OX/CuXnInZv1Kw2vaKrbVju07vmgs9gbg9G6IkIc4abqqI4lw5NRUv9a3Xx87ZDywXR1IILfuN95vaKp+7Yxz4Q3npwhNXbEcxELBc0ZrEqNwECKhkWIEv+qj0BGphGqMacOPGkce0Q/mtDQX3R/cfWiW/frr1luvWW/cVhYdz+7hfhEBNFRzQOt7KnHipHG4pOWCExuLuwkNZtb/tS98t/naTXfORZpg8mC97qv8BUGchJxriYmAmsggffsnk489bO5LKhs9xNYdmhvu3D80Xj5rXfL4kAgas1ZrQ861xDJBmdTMU4mjzyafwITN7I3COkLjKd7Lzf/+dv3VutcIXBuIYb3865lPHjP2IJUC1z1GV6FBJ8+5lW/WX/mR9Y6jOm27V7zifpC4M2KuQsQrrSU/k/zo6dTJvJphg/geY+3QYKtyyZn8++WX33UmMdeKmuJUi7JaBhRhZAOGU6mRguMFHtAO4oCsnGQGDUNsfB5LHvmV9Me26eV7vQlaIzRN3zpjX/rH5VduuLdZ9mwOHDDHfy1zer+xU1fvYXRWCw3i8j/WhX+q/XDCmfFVtjq3OpF3ZIfuDYxwRqxLHDlJBuMtFzR7jZHPZZ9+OLGX3/ueoGNoXMX7cePCt+qvXrWnsBixakGNFwfV9d6RuJ+w4vf9vYnR38l95qA5Rqd6jvahgeuSPfl31X9/237X9Vm+oE4oW53IXsxs1wYish6E8a7FRCJKAjMl2ZHErt8rPL/DGKCzvUX7sXrbrbzSePOsNWGxrxcUl23+VX4QCZmu73OisCdIxlUQWSDzlpiZcbGLfqBbtVGKaqzof9Kc+NbyD/EEF9S7p2iTNZbv/Ef97W9U/23OWVRVlQ0mAAQAJ49kOg17cXJh6cYiiJE2CztKxZ1FzdBDypaYlUCYOE3nzpX56lQFzxt6Qi+MlUrjZc3g3SaUBDJRApzktNTvFj79dPoj/HQv0SY0mHT/qvK9M9ZlnArSVwwKYbdS2m7a8xdm71yates2ywFdNVJGec/gwNFhzdSFUr4WvEXZKWfZufnGRHVqyWu4zKfiDmZpb3no2Iiu60JJL3Ef6YbK4eT4l0svDuklOHuI6IDCLuad5sRbzatoqKP4yGEkMy/pCHs8rzqzdPv/Zuxlm0KME3bNnjs/vTS95Hqwoteye2KOb5kYFLM/vbU4WXGbTnAH37eXLSRR5fqCSxWQ9HHiKMpVe+a1xjmasHqIaGjm3eoP6m83PAspQAf7KjPMhcex3NpU1anxuLDtID8w41juwuV5j6VRoMQhOJu+WqZdd5auL/gW5hv+9ig5cZft6vUK+xo1rG9LFp36f9bOz7gVfoueIRQaBP49e/onjfeomVRParXMhcd1vGatyboLowR3QkkEe6KlhoNOjV3LiGTics/x2CVUkRbBPa2G5TpsdYy8aZwgPtft2beaV/gtegaqUQBHcX/UuFjzLCwUqBVKfqCJER54UC1F5zNiDKrB9ojtrhWElT6bjoJLImBfOqsrytjlITLjLWEeqPvN4OJeIBSapmf/V/0i7xBMz8Ehm8SFRzG0VF9Ow249yAR+gChKZriIm8evZQQp0TLNbMrMJtjehV8VpAGu1PVEX8ZjX8lH37QtsT33qjMzaeNppmcIheaaM3fTnmdDmO1RgkM2iQsPUiYxnEkMpOUBhdqahWRmd8nXIYxeK0hgql7h4JCWbj0qouREL5iZXSVZGbk8Tm5at6/Zs/wuvUEoNO9Y1xq+Q3sqH7VmbytvsQQXHsUopkvHRlJDOYRJ1TXFUMEHHt+lZRJhpcxDN0mPFMsndhr5hGog/zTcJ1nO9J/caRTSYWXk8iiZdpZuuvM9XKeQkMG9sK/5s9p3vl89Q+a6gHjalbpbc/SsaRZTLEbrhO961tyy23T1tJnsz/BvZdaNF4tPfKH0qYyWDOz3h1Ab3rWmXaQLpk/Mf2wD4gcmJ+JUIJCUvqHpA5nkzqJeTns0AcuCsJgIK8X9URqqOZxPjheNoYynqXFlWO/pqpZTU2U9N6yXRrXyDqN/VO/XPX3ZxcaRDbGgSe8Doax5ZvbP570qONIy/hyIkh4FqZTN+CWyAETwbsRtlZqi8lhkB9V8Sc/2q/myls2r6ayaTCrYd2tQFrXceHIAWWPiKQODU9OwzKFk96Rni/UgFJonp7+KPSmZmwdpNTGml/fqw7uNoTF9YJtWGtaLcAanOwPPGRQaAJzM4FwXCIXm0ak/Zq5W7xFks/XYwl7yKSIRU+hBQs61xILk1dQhc/Sk+cABc3RM7y9pWVPVsDdGCwHsktFm1B8gwq5t/QSPBGTy4DAYHCAQrIlQaE7d+gpuR+b9hakah4ztTyePHUvsHNH6KEfQTpSocFtCDYmQiJICZJpmNwEKheYTMy/NO1XqNHQmnKx7W30IBKdanoAKJRwd+l/wbsRFNfPZ9COnk4cxfNJaQtQw0s4IIRmRVZQoaWSlUikECGYnhELz4uxfXmhOkXm/sNPo+2L29PHEeEFNUxzvBRAaZA2igwyiqMURSqpdyWEPscJmnZeCoAwO4sLTIlFlnEi8kxiex1MPfr344keT+/p09vxBDUBJtScTBGWckEwmqyhBMHXU6/VmsymSIwKmFjiYHMWWgA5X8XAIkw5AlDLxsO8QXPILEuLtxKjes6mHvpx7drcxaCrsEQP1YW4Oqh5AXDhlwk7HPLIpiCgRHYSmVqu1nWHRWUwEYEC9qU5+/vpfuxs+E2PgPJM++of5T2FJClwbCCRRIpHIZDKUTQKhrDmQ3D5g5FmvsucSdC97/CMzONDDohQETzCkEZdEBDJvJ/5Y+sCXCiwukbQHBAH4yejoEERoBOlSCSB3Go3oF/lMLZDT0h9J7UEWeYrK9+bY8rM1g4jgwiOdau+XBJ3EygFj+Pdzpws8X1jSh9Oe0JbH9XGPbAoiTEB4EB3LCn0zEQqNqeofzx1iS6uLLkZs+IdFvKQDVJQrhH1GyU2URCKCzuKEZ/5B/ultaoGfhpMhQuRydULoRklENl3XxaSDMohFJDS6oj2UHj+S3umxj5aQ9lg7aJ0KDuLCEyGd/G2dKJHJv5F77LA5wh55Oqc9THTp1NTU1atXZ2dnbdsWfqbuMExA0OaFhQVcNTExgWZD1klJfgQIaxZKUoam4Ww2W/Osv51//U+nv2sjbZBswT6Mf/rL1Csv2YwoA9oSsCtjYo199zjyteJzDxgD7HNCntioaJzMzMycPXt2enoaXYrd2rZt206ePJnP5+N6ApmI5rlz5y5fvoxhAg9m2aNHj+7duxd3EJr4HRBN3BmzMkxWJxkZLfFk7sDx9DjLNVzBPiViJR0RjzDb+mUiOEoiCcV4JvXQNq2AYDJHDJTn6LCLFy8iZRyHfRuD6ExOTiJSyB2uWgEbGFRlzq9cuUJxoXYhHc6cOYMo01mSATIHoER+EYmGBtidGHyh79SgWeT7MaYiEvBWuUJo/yYpo4J24v3m8PHkeFZnHzuhi6jTIgRYWlpaXFxEXcFpCODsjRs3EJq2egL0iCYNPYAECC4uJE8E8q0QLApom9DgseWp3MHTucNJ1URIWVTZksuIzOOkrZNI3H8qsXs7TxkAbiBCqKReFacA8IhT1hM6CdreTZREACzk4G1CA4wYpV8tP/5oeo+OKQKXtQ7cmOUFvwf1f6cjSBOuZyQsLqrpA8Z2scGjOomayWaOg/pTYGhoCM8+Qk+QTUwoAwMDNK0IIOmGh4dBZKXgRKhEBDFy24dGV7Vj6bHf7P/ZfclRmKydNGWwi1ulmD7IonmkRSLKwNkSj+nlYb2ABRE3hzfSchlYGXbv3l0ul2kdgbK/v//QoUPyQzN/tyhw1Y4dOxBBMjGz7t+/n0ITR6QOCA0bjOK+tEIRJyx7zX9ZOPP16e9fs+YCEf7gDlTKJhAhsoAgiX8hc+RL+Y+PG2VUiCpAhOpHRPhRyzt37mDZRp6jhkgHilQnPRGgWq1i3q1UKnAioIODg3jUjisjBCV4MplcuVE8NEDVa3xn4c2Xpv/1evMOW4axIdFaJcCJWI/ZhzBoOoqwgJEW52L187lTX8g92a+zn5GL2sSJADy0JGGMAKvrZT/6H7MvONJHjmYE8VvhXdoPKIGclnq+dOIr254bTw20PoUKSkGw/0Hr436ZCA4x5i/cln7+S/VAGScoBUGJtqEnaYAwUWe97MG4Q6ZgNImAUhknKGXSca6RgQXrs6XjfzH6uQPJEVzHlhg0EnOGIGwe4SZNK3FBWIx3N330CUtY9CpslHGCsyQgAieZXeqFP06EQJC4Ev61QwMkVeOJ/IP/vOeLT+X28RrydYo1jRPeXr4G8SAIv0RWOLsc6cNugwL9A5s6KkL4OwddSuAnu9ULf5wIgSBtlV2FBsBqghX9qyPP5fU02sSax1sYlNRg2SObMufftFm+gzK49aYEotNtaACoh0z21TRayIZHkC2cRMwYkbnjeVW3yf6LDHnUddoD/GS3euGPEyEQJK7EnL2O0AAX67cqXp21UWNHQPAYjUdqmPSQLfwSWeEQKP6sv1z1LZ65LKtXJ3LZDemJkq1oMLrHq9ULtoeHFwwMNBAx5oQHR2f/Bsem1hW/TARnmeNfd+bvuOwprrdADQP2vsG+qKI2dwPHd39QOY+kY3VAhmCP4mMO0vv03PHMrudLj/x84ciR9OioWe4zMmklYWAb01KSmBE2ISvv2rdvOYsIFXUUQIR3WECECTAFB3HhlAk73cFDpSDCBIRHEJQYTOxzCUSITrTd8sm43Jz5mfNfW3Sb6H62TfGVrGYezY49Vzr+Qt+JnYkyNLfsyrn6jfONqSuN2SmnMm8vL3tWU3Esz2G/B8Xb+kpC1ZN64rfSp04n96c25f8zIy59fX3rCM3fzL3+R9e+WVccjAm08cH00KcLR3+57+SxzA7MzYGoBcf36p5V85p33HrFqdV8u+FZSDhD1bNaoqRncp6ZqPmqg/EVdBdqEiEy4mc76btXCsgClIVCAaHoNjSu4v32e9/49u0f2747kiicLh55pvTwz+X2FfW7/Kda1/eWlpYa9Toe5FdviVyuIovo71qJlCmVSms/KAgggOjtATP3QvnESzt+6U9GfvHZ4kN3HRcAD/fpVErXOg4o1DJgLS574ojrO6GtkggClMlkEBfGxbnVswZTJmaQCWv+weTQrsSA0Yv/0cJb403xfEx1QBnpw7boUgbElWteggeuYrFIe5puQ0Ngawp/UOwV8BRXqVSanb943kggWcrlsviIZ32d3/OfLqA2uVwOmwjqTLYH7fDlCZxkyoTOttXHlYIIgSDkz+fz8idkzHt/gV5CdECQOLRJJ4JSJoSIPy7rRFAKwt1RghGD0URVIqxvQN0joA6NRgMjC+MrcG0gkC9oOLqH0kfg/mcNgKym+Y9tzzukPcnE2TghmUy6UaLEkhSPCxC17xdQy3Q6jQ0FmZTLKAnkBIgLp0zY6ZhHNgWRTQQFU0w8LsCmGFAyMPLn5+fjP+noObACYNeL/mgbF2CzZI0AKooVFIMLVRdpTwAHSBMnQiPI6spkMolRTM626HjiPgLVRZL39/dT1dEMOMUQ6BXotqtg0w0oGaibZVm1Wg2lw38OQE462yV4iqgYp4HdArIGuYkysGPY1KEhoIaIC/1qCgQLPNqJ1oKgJAERApmUbhiVtIvDJbhcXAJAgFkfyxOZcXwAQiNAMSJQgACqPxoMLiYOEEREACYuQXCRgLZt0+4JTgzbtss24YMUmghQcwqNaAKAdlLKBHYYiAuig+UPBCaWJ9pM0dkIPsChuTsgmhhZaCySCBHEaphItP8nmQ9daAgYXwgQyCrr92ZcvDcAGEQYTavs94APaWgATElAYLTDhzc0a2IrNB2xFZqO2ApNR2yFpiNWQrP6dP0hxMqWjz6dpZ9MbsAnSZscqVTq/wFA/8Sn/CbPxwAAAABJRU5ErkJggg==" }, { "id" : "662803789908017152", "app_id" : "662803789585055744", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_name" : "notepad", "app_category" : "GAME", "os_type" : "Windows", "version_id" : "v", "version_name" : "v", "appfile_store_path" : "file/npp_7.4.2_Installer.exe", "app_file_size" : "2979", "app_app_description" : "notepad。", "appicon_store_path" : "", "create_time" : "2024-02-01T06:38:10.049Z", "modify_time" : "2024-02-01T06:38:10.049Z", "verify_status" : "VERIFYING", "app_icon" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACYAAAAgCAYAAAB+******rSURBVFhHpZdpbJRVFIYHYtToHxOioOxYFls" } ]}

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-warehouse/apps{ "app_name" : "Postman", "app_category" : "PRODUCTIVITY_AND_COLLABORATION", "os_type" : "Windows", "version_name" : "Canary", "version_id" : "7.9.0.0", "appfile_store_path" : "file/Postman.exe", "app_app_description" : "A postman setup exe.。", "app_icon" : "data:image/png;base64,iVBORw0KGWBUwmyIgfBRgjsA88DJ9OxpLdgbbFDuB+Pt***********w59LFEQHa+0QrAJNBfiSUVORK5CYII=", "app_file_size" : 401}