华为云用户手册

创建Deployment挂载已有数据卷 新建一个Deployment的YAML文件，例如deployment-test.yaml。 配置示例： apiVersion: apps/v1 kind: Deployment metadata: name: test-turbo-subpath-example namespace: default generation: 1 labels: appgroup: '' spec: replicas: 1 selector: matchLabels: app: test-turbo-subpath-example template: metadata: labels: app: test-turbo-subpath-example spec: containers: - image: nginx:latest name: container-0 volumeMounts: - mountPath: /tmp name: pvc-sfs-turbo-example restartPolicy: Always imagePullSecrets: - name: default-secret volumes: - name: pvc-sfs-turbo-example persistentVolumeClaim: claimName: sfs-turbo-test 其中： name：创建的工作负载名称。 image：工作负载的镜像。 mountPath：容器内挂载路径，示例中挂载到“/tmp”路径。 claimName：已有的PVC名称。 创建Deployment负载。 kubectl create -f deployment-test.yaml

StatefulSet动态创建subpath模式的数据卷 新建一个StatefulSet的YAML文件，例如statefulset-test.yaml。 配置示例： apiVersion: apps/v1 kind: StatefulSet metadata: name: test-turbo-subpath namespace: default generation: 1 labels: appgroup: '' spec: replicas: 2 selector: matchLabels: app: test-turbo-subpath template: metadata: labels: app: test-turbo-subpath annotations: metrics.alpha.kubernetes.io/custom-endpoints: '[{"api":"","path":"","port":"","names":""}]' pod.alpha.kubernetes.io/initialized: 'true' spec: containers: - name: container-0 image: 'nginx:latest' resources: {} volumeMounts: - name: sfs-turbo-160024548582479676 mountPath: /tmp terminationMessagePath: /dev/termination-log terminationMessagePolicy: File imagePullPolicy: IfNotPresent restartPolicy: Always terminationGracePeriodSeconds: 30 dnsPolicy: ClusterFirst securityContext: {} imagePullSecrets: - name: default-secret affinity: {} schedulerName: default-scheduler volumeClaimTemplates: - metadata: name: sfs-turbo-160024548582479676 namespace: default annotations: {} spec: accessModes: - ReadWriteOnce resources: requests: storage: 10Gi storageClassName: sfsturbo-subpath-sc serviceName: wwww podManagementPolicy: OrderedReady updateStrategy: type: RollingUpdate revisionHistoryLimit: 10 其中： name：创建的工作负载名称。 image：工作负载的镜像。 mountPath：容器内挂载路径，示例中挂载到“/tmp”路径。 “spec.template.spec.containers.volumeMounts.name ”和 “spec.volumeClaimTemplates.metadata.name”有映射关系，必须保持一致。 storageClassName: 填写自建的SC名称。 创建StatefulSet负载。 kubectl create -f statefulset-test.yaml

指标清单 Kubelet视图使用的指标清单如下： 表2 Kubelet指标说明 指标 类型 说明 storage_operation_errors_total Counter 存储操作期间发生的错误次数 storage_operation_duration_seconds_count Counter 存储操作的操作次数 storage_operation_duration_seconds_bucket Histogram 存储操作的持续时间 kubelet_pod_start_duration_seconds_count Counter 进行过pod start的数量 kubelet_pod_start_duration_seconds_bucket Histogram pod start的耗时分布情况 kubelet_runtime_operations_duration_seconds_bucket Histogram 不同操作的累计操作耗时分布情况 kubelet_runtime_operations_errors_total Counter 不同操作的累计操作失败的数量 kubelet_node_config_error Gauge 如果节点遇到与配置相关的错误，则此指标为true（1），否则为false（0） volume_manager_total_volumes Gauge Volume Manager中的卷数 kubelet_running_containers Gauge 当前运行的Containers数 kubelet_running_pods Gauge 当前运行的pod数 kubelet_node_name Gauge 节点名称，值始终为1 kubelet_runtime_operations_total Counter 运行过程中不同的操作类型的累计操作次数 kubelet_cgroup_manager_duration_seconds_count Counter 销毁和更新的数量 kubelet_cgroup_manager_duration_seconds_bucket Histogram 销毁和更新操作的耗时分布情况 kubelet_pleg_relist_duration_seconds_count Counter PLEG relist pod不同耗时的数量 kubelet_pleg_relist_interval_seconds_bucket Histogram PLEG relist 间隔的分布情况 kubelet_pleg_relist_duration_seconds_bucket Histogram PLEG relist pod耗时的分布情况 rest_client_requests_total Counter 请求apiserver的总次数（按照返回码code和请求类型method统计） rest_client_request_duration_seconds_bucket Histogram 请求apiserver的总次数（按照返回码code和请求类型method统计）的分布情况 process_resident_memory_bytes Gauge 进程驻留内存大小（以字节为单位） process_cpu_seconds_total Counter 进程用户和系统 CPU 总时间（以秒为单位） go_goroutines Gauge 协程数量

文件存储挂载参数 CCE在挂载文件存储时默认设置了如表1所示的参数。 表1 文件存储挂载参数 参数 参数值 描述 keep-original-ownership 无需填写 表示是否保留文件挂载点的ownership。 默认为不添加该参数，此时挂载文件存储时将会默认把挂载点的ownership修改为root:root。 如添加该参数，挂载文件存储时将保持文件系统原有的ownership。 vers 3 文件系统版本，目前只支持NFSv3。取值：3 nolock 无需填写 选择是否使用NLM协议在服务器上锁文件。当选择nolock选项时，锁对于同一主机的应用有效，对不同主机不受锁的影响。 timeo 600 NFS客户端重传请求前的等待时间(单位为0.1秒)。建议值：600。 hard/soft 无需填写 挂载方式类型。 取值为hard，即使用硬连接方式，若NFS请求超时，则客户端一直重新请求直至成功。 取值为soft，即软挂载方式挂载系统，若NFS请求超时，则客户端向调用程序返回错误。 默认为hard。 sharecache/nosharecache 无需填写 设置客户端并发挂载同一文件系统时数据缓存和属性缓存的共享方式。设置为sharecache时，多个挂载共享共享同一缓存。设为nosharecache时，每个挂载各有一个缓存。默认为sharecache。 说明： 设置nosharecache禁用共享缓存会对性能产生一定影响。每次挂载都会重新获取挂载信息，会增加与NFS服务器的通信开销和NFS客户端的内存消耗，同时同客户端设置nosharecache存在cache不一致的风险。因此，应该根据具体情况进行权衡，以确定是否需要使用nosharecache选项。 除了以上参数外，您还可以设置其他的文件存储挂载参数，具体请参见挂载NFS文件系统到云服务器（Linux）。

按需计费区域单价 表2 按需计费区域单价 区域 集群管理费用 Pod 华南-广州友好 公测期间免收集群管理费用 CPU：0.000049元/秒/Core 内存：0.00000613元/秒/GiB 西南-贵阳一 公测期间免收集群管理费用 CPU：0.000044元/秒/Core 内存：0.00000552元/秒/GiB 华南-广州 公测期间免收集群管理费用 CPU：0.000049元/秒/Core 内存：0.00000613元/秒/GiB 华东-上海一 公测期间免收集群管理费用 CPU：0.000049元/秒/Core 内存：0.00000613元/秒/GiB

规格说明 Autopilot会自动规整不支持的规格，向上规整为最接近的vCPU与内存配置，以确保Pod始终拥有运行所需的资源。 表3 Autopilot支持的vCPU与内存组合 vCPU 内存（GiB） 0.25 vCPU 0.5GiB、1GiB、2GiB 0.5 vCPU 1GiB、2GiB、3GiB、4GiB 1 vCPU 2GiB、3GiB、4GiB、5GiB、6GiB、7GiB、8GiB 2 vCPU 4GiB、5GiB、... 、15GiB、16GiB（以 1GiB 为增量） 4 vCPU 8GiB、9GiB、... 、31GiB、32GiB（以 1GiB 为增量） 8 vCPU 8GiB、12GiB、... 、60GiB、64GiB（以 4GiB 为增量） 16 vCPU 16GiB、24GiB、... 、120GiB、128GiB（以 8GiB 为增量） 32 vCPU 32GiB、64GiB、128GiB、256GiB 48 vCPU 96GiB、192GiB、384GiB 64 vCPU 128GiB、256GiB、512GiB

指标清单 Prometheus Agent视图使用的指标清单如下： 表2 Prometheus Agent指标说明 指标名称 类型 说明 container_cpu_usage_seconds_total Gauge 容器CPU使用量 container_memory_working_set_bytes Gauge 容器工作内存使用量 vmagent_remotewrite_bytes_sent_total Counter Prometheus Agent远程写入字节数发送总计 vmagent_remotewrite_duration_seconds_sum Summary Prometheus Agent远程写入耗时 vmagent_remotewrite_pending_data_bytes Gauge Prometheus Agent远程写入挂起数据字节数 vmagent_remotewrite_packets_dropped_total Counter Prometheus Agent远程写入数据包丢弃总数 vmagent_remotewrite_requests_total Counter Prometheus Agent远程写入请求总数 vmagent_remotewrite_retries_count_total Counter Prometheus Agent远程写入重试次数总数 vm_promscrape_active_scrapers Gauge 采集的分片数量 vm_promscrape_scrapes_total Counter 采集次数 vm_promscrape_scrape_duration_seconds_sum Summary vmagent采集指标的耗时 vm_promscrape_conn_read_errors_total Counter 采集读取错误次数 vm_promscrape_conn_write_errors_total Counter 采集写入错误次数 vm_promscrape_max_scrape_size_exceeded_errors_total Counter 采集大小超过限制的次数 vm_persistentqueue_bytes_read_total Counter 发送队列读取的总字节数 vm_persistentqueue_bytes_written_total Counter 发送队列写入的总字节数 vm_persistentqueue_bytes_pending Gauge 发送队列Pending的字节数 vm_persistentqueue_blocks_read_total Counter 发送队列读block的次数 vm_persistentqueue_blocks_written_total Counter 发送队列写block的次数 vm_persistentqueue_blocks_dropped_total Counter 发送队列block丢弃的次数

指标说明 Prometheus Agent视图暴露的指标如下： 表1 Prometheus Agent视图说明 视图指标 单位 描述 CPU使用率 百分比 Prometheus Agent Pod CPU平均使用率 内存使用率 百分比 Prometheus Agent Pod 内存平均使用率 远程写Bps 字节/秒 每秒远程写入的字节数 远程写平均耗时 秒 远程写入平均耗时 远程写Pending字节数 字节 远程写入挂起的数据字节数 远程写Packet每秒丢弃次数 次 远程写入每秒丢弃的数据包数 远程写每秒错误请求次数 次 远程写每秒错误请求次数 远程写错误请求百分比 百分比 远程写错误请求百分比 远程写每秒重试次数 次 远程写每秒重试次数 采集Scrapers数量 个 采集Scrapers数量 每秒采集次数 次 每秒采集次数 采集平均耗时 秒 采集平均耗时 每秒采集读取错误次数 次 每秒采集读取错误次数 每秒采集写入错误次数 次 每秒采集写入错误次数 每秒采集大小超限次数 次 每秒采集大小超限次数 发送队列读取Bps 字节/秒 发送队列每秒读的字节数 发送队列写Bps 字节/秒 发送队列每秒写的字节数 发送队列Pending大小 字节 发送队列挂起的数据字节数 每秒Block读取次数 次 发送队列每秒读block的次数 每秒Block写入次数 次 发送队列每秒写block的次数 每秒Block丢弃次数 次 发送队列每秒block丢弃的次数

高级Rewrite配置 对于一些复杂高级的Rewrite需求，可以通过如下注解来实现，其本质也是修改Nginx的配置文件（nginx.conf），可以实现上面提到的“nginx.ingress.kubernetes.io/rewrite-target”注解的功能，但是自定义程度更高，适合更加复杂的Rewrite需求。 nginx.ingress.kubernetes.io/server-snippet：在nginx.conf的“server”字段中添加自定义配置。 nginx.ingress.kubernetes.io/configuration-snippet：在nginx.conf的“location”字段中添加自定义配置。 snippet配置在NGINX Ingress控制器版本为2.4.6版本及以上时（对应社区版本为v1.9.3）不再默认启用，详情请参见Changelog。如果您仍需要使用snippet配置，可以通过allow-snippet-annotations启用。 通过以上两个注解可以在nginx.conf中的“server”或“location”字段中插入Rewrite指令，完成URL的重写，示例如下： annotations: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/configuration-snippet: | rewrite ^/stylesheets/(.*)$ /something/stylesheets/$1 redirect; # 添加 /something 前缀 rewrite ^/images/(.*)$ /something/images/$1 redirect; # 添加 /something 前缀 如上两条规则在访问URL中添加了“/something”路径，即： 当用户访问rewrite.bar.com/stylesheets/new.css时，重写为rewrite.bar.com/something/stylesheets/new.css 当用户访问rewrite.bar.com/images/new.jpg时，重写为rewrite.bar.com/something/images/new.jpg

极速文件存储介绍 CCE支持将极速文件存储（SFS Turbo）创建的存储卷挂载到容器的某一路径下，以满足数据持久化的需求。极速文件存储具有按需申请，快速供给，弹性扩展，方便灵活等特点，适用于海量小文件业务，例如DevOps、容器微服务、企业办公等应用场景。 SFS Turbo为用户提供一个完全托管的共享文件存储，能够弹性伸缩至320TB规模，具备高可用性和持久性，为海量的小文件、低延迟高IOPS型应用提供有力支持。 符合标准文件协议：用户可以将文件系统挂载给服务器，像使用本地文件目录一样。 数据共享：多台服务器可挂载相同的文件系统，数据可以共享操作和访问。 私有网络：数据访问必须在数据中心内部网络中。 安全隔离：直接使用云上现有IaaS服务构建独享的云文件存储，为租户提供数据隔离保护和IOPS性能保障。 应用场景：适用于多读多写（ReadWriteMany）场景下的各种工作负载（Deployment/StatefulSet）和普通任务（Job）使用，主要面向高性能网站、日志存储、DevOps、企业办公等场景。

集群服务器配置（kube-apiserver） 容器故障迁移默认容忍周期 容器故障迁移默认容忍周期配置默认对集群中所有的容器生效，您也可以为指定Pod进行差异化容忍配置，此时将以Pod配置的容忍时长为准，详情请参见默认容忍策略说明。 请合理设置容忍时间配置，否则可能出现以下问题： 配置过小：在网络抖动等短时故障场景下，容器可能会频繁迁移而影响业务。 配置过大：在节点故障时，容器可能长时间无法迁移，导致业务受损。 表1 容器故障迁移默认容忍周期配置参数说明 名称 参数 说明 取值 容器迁移对节点不可用状态的容忍时间 default-not-ready-toleration-seconds 表示节点处于NotReady状态下的容忍时间。当节点出现异常，变为不可用状态时，容器将在该容忍时间后自动驱逐，默认为300s。 默认：300s 容器迁移对节点无法访问状态的容忍时间 default-unreachable-toleration-seconds 表示节点处于unreachable状态下的容忍时间。当环境出现异常，例如节点无法访问（如节点网络异常）时，容器将在该容忍时间后自动驱逐，默认为300s。 默认：300s 准入控制器插件配置 Kubernetes支持开启一些准入控制插件，可以在集群对Kubernetes API对象（如Pods、Services、Deployments等）进行修改操作前，进行相应的约束与控制。 v1.23.14-r0、v1.25.9-r0、v1.27.6-r0、v1.28.4-r0及以上版本的集群支持该参数。 表2 准入控制器插件配置参数说明 名称 参数 说明 取值 节点限制插件 enable-admission-plugin-node-restriction 节点限制插件限制了节点的 kubelet 只能操作当前节点的对象，增强了在高安全要求或多租户场景下的隔离性。详细信息请参考官方文档。 开启/关闭 Pod节点选择器插件 enable-admission-plugin-pod-node-selector Pod节点选择器插件允许集群管理员通过命名空间注释设置默认节点选择器，帮助约束 Pod 可以运行的节点，并简化配置。 开启/关闭 Pod容忍度限制插件 enable-admission-plugin-pod-toleration-restriction Pod容忍度限制插件允许通过命名空间设置 Pod 的容忍度的默认值和限制，为集群管理者提供了对 Pod 调度的精细控制，以保护关键资源。 开启/关闭

集群控制器配置（kube-controller-manager） 控制器公共配置 控制器性能配置：用于设置控制器访问kube-api-server的性能参数配置。 请合理设置控制器性能配置，否则可能出现以下问题： 配置过小：可能会触发客户端限流，对控制器性能产生影响。 配置过大：可能会导致kube-apiserver过载。 表3 控制器性能配置参数说明 名称 参数 说明 取值 控制器访问kube-apiserver的QPS kube-api-qps 与kube-apiserver通信的QPS，即每秒查询率。 集群规格为1000节点以下时，默认值为100 集群规格为1000节点及以上时，默认值为200 控制器访问kube-apiserver的突发流量上限 kube-api-burst 与kube-apiserver通信的突发流量上限。 集群规格为1000节点以下时，默认值为100 集群规格为1000节点及以上时，默认值为200 资源对象处理并发配置：允许同时同步的资源对象的数量。配置数量越大，管理响应越快，但 CPU（和网络）负载也越高。 请合理设置资源对象处理并发配置，否则可能出现以下问题： 配置过小：可能导致管理器处理响应慢。 配置过大：会对集群管控面造成压力，产生过载风险。 表4 资源对象处理并发配置参数说明 名称 参数 说明 取值 Deployment concurrent-deployment-syncs 可以并发同步的Deployment对象个数。数值越大意味着对Deployment的响应越及时，同时也意味着更大的CPU（和网络带宽）压力。 默认：5 Endpoint concurrent-endpoint-syncs 可以并发同步的Endpoints对象个数。数值越大意味着更新Endpoints越快，同时也意味着更大的CPU（和网络）压力。 默认：5 GC回收 concurrent-gc-syncs 可以并发同步的垃圾收集（Garbage Collector）工作线程个数。 默认：20 Job concurrent-job-syncs 可以并发同步的Job对象个数。较大的数值意味着对Job的响应越及时，不过也意味着更多的CPU（和网络）占用。 默认：5 CronJob concurrent-cron-job-syncs 可以并发同步的CronJob对象个数。较大的数值意味着对CronJob的响应越及时，不过也意味着更多的CPU（和网络）占用。 默认：5 Namespace concurrent-namespace-syncs 可以并发同步的Namespace对象个数。较大的数值意味着对Namespace的响应越及时，不过也意味着更多的CPU（和网络）占用。 默认：10 Replicaset concurrent-replicaset-syncs 可以并发同步的ReplicaSet个数。数值越大，副本管理的响应速度越快，同时也意味着更多的CPU（和网络）占用。 默认：5 ResourceQuota concurrent-resource-quota-syncs 可以并发同步的ResourceQuota对象个数。数值越大，配额管理的响应速度越快，不过对CPU（和网络）的占用也越高。 默认：5 Service concurrent-service-syncs 可以并发同步的Service对象个数。数值越大，服务管理的响应速度越快，不过对CPU（和网络）的占用也越高。 默认：10 ServiceAccountToken concurrent-serviceaccount-token-syncs 可以并发同步的服务账号令牌对象个数。数值越大，令牌生成的速度越快，不过对CPU（和网络）的占用也越高。 默认：5 TTLAfterFinished concurrent-ttl-after-finished-syncs 可以并发同步的ttl-after-finished-controller线程个数。 默认：5 RC concurrent_rc_syncs 可以并发同步的副本控制器对象个数。数值越大，副本管理操作越快，不过对CPU（和网络）的占用也越高。 说明： 该参数仅在v1.19及以下版本集群中使用。 默认：5 RC concurrent-rc-syncs 可以并发同步的副本控制器对象个数。数值越大，副本管理操作越快，不过对CPU（和网络）的占用也越高。 说明： 该参数仅在v1.21至v1.23版本集群中使用。v1.25版本后，该参数弃用（正式弃用版本为v1.25.3-r0）。 默认：5 HPA并发处理数 concurrent-horizontal-pod-autoscaler-syncs 允许并发执行的HPA弹性伸缩数量。 数值越大，HPA弹性伸缩响应越快，不过对CPU（和网络）的占用也越高。 该参数仅v1.27及以上版本集群支持。 默认：5 取值范围为1-50 节点生命周期控制器（node-lifecycle-controller）配置 v1.23.14-r0、v1.25.9-r0、v1.27.6-r0、v1.28.4-r0及以上版本的集群支持该参数。 表5 负载弹性伸缩控制器配置参数说明 名称 参数 说明 取值 可用区亚健康阈值 unhealthy-zone-threshold 当可用区故障节点规模达到指定比例时被认定为不健康，针对不健康的区域，故障节点业务的迁移频率会降级，避免规模故障场景下大规模迁移操作产生更坏的影响。 说明： 比例配置过大可能导致区域在规模故障场景下仍尝试执行大规模迁移动作，导致集群过载等风险。 默认：0.55 节点迁移速率 node-eviction-rate 当某区域健康时，在节点故障的情况下每秒删除Pod的节点数。该值默认设置为0.1，代表每10秒钟内至多从一个节点驱逐Pod。 说明： 结合集群规模合理设置，建议按比例折算后每批迁移Pod数量不超过300。 迁移速率设置过大可能引入集群过载风险，同时每批迁移重调度的Pod过多，大量Pod无法及时调度，影响整体故障恢复时间。 默认：0.1 次级节点迁移速率 secondary-node-eviction-rate 当某区域不健康时，在节点故障的情况下每秒删除Pod的节点数。该值默认设置为0.01，代表每100秒钟内至多从一个节点驱逐Pod。 说明： 配合node-eviction-rate设置，一般建议设置为node-eviction-rate的十分之一。 区域亚健康场景迁移速率设置过大无实际意义，且可能引入集群过载风险。 默认：0.01 大规模集群大小阈值 large-cluster-size-threshold 集群内节点数量大于此参数时，集群被判断为大规模集群。 说明： 在拥有大量节点的集群中，适当增加此阈值可以帮助提高控制器的性能和响应速度。对于规模较小的集群，保持默认值即可。在调整此参数时，建议先在测试环境中验证其对性能的影响，然后再在生产环境中应用。 被视为大型集群时，kube-controller-manager 会进行特定配置调整。这些配置用来优化大规模集群性能。因此阈值如果过低，规模小的集群用上的大集群的配置，反而降低性能。 默认：50 负载弹性伸缩控制器（horizontal-pod-autoscaler-controller）配置 请合理设置负载弹性伸缩控制器配置，否则可能出现以下问题： 配置过小：可能导致控制器处理响应慢。 配置过大：会对集群管控面造成压力，产生过载风险。 表6 负载弹性伸缩控制器配置参数说明 名称 参数 说明 取值 Pod水平伸缩同步的周期 horizontal-pod-autoscaler-sync-period 水平Pod扩缩器对Pod进行弹性伸缩的周期。配置越小弹性伸缩器反应越及时，同时CPU负载也越高。 默认：15s Pod回收控制器（pod-garbage-collector-controller）配置 表7 Pod回收控制器配置参数说明 名称 参数 说明 取值 终止状态Pod触发回收的数量阈值 terminated-pod-gc-threshold 在Pod GC开始删除终止状态（terminated）的Pod之前，系统允许存在终止状态的Pod数量。 说明： 请合理设置该参数，配置过大时，集群中可能存在大量终止状态的Pod，影响相关List查询请求性能，产生集群过载风险。 默认：1000 取值范围为10-12500 资源配额控制器（resource-quota-controller）配置 在高并发场景下（如批量创建Pod），配额管理机制可能导致部分请求因冲突而失败，除非必要不建议启用该功能。如启用，请确保请求客户端具备重试机制。 表8 资源配额控制器配置参数说明 名称 参数 说明 取值 启用资源配额管理 enable-resource-quota 通过配额管理功能，用户可以对命名空间或相关维度下的各类负载（Deployment、Pod等）数量以及资源（CPU、Memory）上限进行控制。命名空间通过ResourceQuota对象进行配额限制。 关闭（false）：不自动创建ResourceQuota对象。 开启（true）：自动创建ResourceQuota对象。ResourceQuota的默认取值请参见设置资源配额及限制。 默认：关闭（false）

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512

AK/SK认证 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参考API签名指南。 AK/SK签名认证方式对于支持消息体的大小有限制，为了让您拥有更好的体验，推荐您使用WebARSDK。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 task_id String 任务ID。 task_name String 任务名称。 task_type String 任务类型。 REAL3D-UNCTRL（无控建模） REAL3D-CTRL（有控建模） modeling_type String 建模类型。 Mesh：纹理模型实景三维建模。 Nerf：显式辐射场实景三维建模。 task_description String 任务描述。 workspace_id String 任务所属工作共享空间ID。 modeling_params ModelingParams object 任务建模参数列表。 coordinate_sys String 建模坐标系。 has_marker Boolean 是否添加了刺点。 folder_code String 任务绑定的倾斜影像的影像code。 create_time String 任务创建时间。格式为UTC时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 update_time String 任务更新时间。格式为UTC时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 tenant_domain_id String 华为云IAM租户账号ID。 creator String 任务创建人。 latest_operator String 任务最近操作人。 task_status String 任务当前状态。 INIT（初始化） PENDING（等待中） STARTING（启动中） START_FAILED（启动失败） RUNNING（运行中） SUCCESS（运行成功） FAILED（运行失败） STOPPING（停止中） STOP_SUCCESS（已停止） ARCHIVED（已归档） BUNDLE_SUCCESS（空三建模成功） complete_stage Integer 建模已完成作业步骤数。 total_stage Integer 建模总作业步骤数。 task_progress String 任务进度。该字段为字符串表示的保留两位小数的浮点型数值，取值范围：0.00~1.00。 exec_start_time String 任务执行开始时间。格式为UTC时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 exec_stop_time String 任务执行结束时间。格式为UTC时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 fail_message String 失败消息。当任务执行失败时，该字段显示任务的失败原因，用于辅助定位问题。 AT_progress String 空三建模进度，取值范围：0.00~1.00。展示有控建模任务空三建模阶段的执行进度。因为空三建模仅在有控建模任务中执行，无控建模任务中该字段取值始终为null。 表6 ModelingParams 参数 参数类型 描述 accuracy String 空三精度。取值包括：Highest、High、Medium、Low、Lowest。 缺省值：High key_point_limit Integer 空三关键点数量。取值范围：1000~1000000。 缺省值：40000 tie_point_limit Integer 空三连接点数量。取值范围：100~100000。 缺省值：4000 mesh_accuracy Integer Mesh重建质量。枚举值： 0：高 1：中 2：低 缺省值：0 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512

响应示例 状态码： 200 请求成功。 { "task_id" : "914305233ef7428e8073a95d8042xxxx", "task_name" : "测试任务1685087027834", "task_type" : "REAL3D-UNCTRL", "modeling_type" : "Nerf", "workspace_id" : "c734a30b6c5f42cfaf49e01eb6903xxx", "modeling_params" : { "accuracy" : "High", "key_point_limit" : "40000", "tie_point_limit" : "4000", "mesh_accuracy" : "0" }, "coordinate_sys" : "WGS84-UTM", "has_marker" : false, "folder_code" : "m73MeiI7ztsJpRTaYE3X-YqeZDWfgxxxx", "create_time" : "2023-05-26T07:43:47Z", "update_time" : "2023-05-26T07:43:47Z", "tenant_domain_id" : "xxxx", "creator" : "xxxx", "latest_operator" : "xxxx", "task_status" : "INIT", "complete_stage" : null, "total_stage" : null, "exec_start_time" : null, "task_progress" : null, "exec_stop_time" : null, "fail_message" : null, "AT_progress" : null }

请求示例 该请求示例用于创建一个REAL3D-UNCTRL（无控建模）任务。 POST https://{Endpoint}/v1/real3d/c734a30b6c5f42cfaf49e01eb6903xxx/tasks { "task_name" : "测试任务", "task_description" : "测试任务", "task_type" : "REAL3D-UNCTRL", "modeling_type" : "Nerf", "folder_code" : "m73MeiI7ztsJpRTaYE3X-YqeZDWfgxxxx", "coordinate_sys" : "WGS84-UTM" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息，用于租户鉴权，该字段由租户请求IAM的Token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 task_name 是 String 任务名称。支持中文、英文、数字以及“_”字符，长度限制1~50个字符。 task_description 否 String 任务描述。支持中文、英文、数字以及“_”字符，长度限制255个字符以内。 task_type 否 String 任务类型。 REAL3D-CTRL：实景三维有控建模 REAL3D-UNCTRL：实景三维无控建模 modeling_type 否 String 建模类型。 Mesh：纹理模型实景三维建模。 Nerf：显式辐射场实景三维建模。 modeling_params 否 ModelingParams object 实景三维建模参数。 当请求体中modeling_params为null或者未配置时，其属性均使用缺省值。 当请求体中modeling_params不为null时，则其属性均为必填项，不能省略。 folder_code 否 String 需要进行三维重建的倾斜影像的影像code。 coordinate_sys 否 String 建模坐标系。坐标系当前仅支持WGS84-UTM。输入为null或者不填时，均使用缺省值WGS84-UTM。 表4 ModelingParams 参数 是否必选 参数类型 描述 accuracy 是 String 空三精度。取值包括：Highest、High、Medium、Low、Lowest。 缺省值：High key_point_limit 是 Integer 空三关键点数量。取值范围：1000~1000000。 缺省值：40000 tie_point_limit 是 Integer 空三连接点数量。取值范围：100~100000。 缺省值：4000 mesh_accuracy 是 Integer Mesh重建质量。枚举值： 0：高 1：中 2：低 缺省值：0

响应示例 状态码： 200 请求成功。 { "page" : { "offset" : 0, "limit" : 10, "total" : 1 }, "data" : [ { "task_id" : "4673779ec6d34a0cad106a2aaa5xxxxx", "workspace_id" : "ce5694adfd4f4f11a13a67e2e7exxxxx", "data_id" : "[\"3f7eb40cf46d45fd96a927361c57787\"]", "task_name" : "任45YU655675ds", "domain_id" : "c163c3c55c3c4526b2ed7a0213bxxxxx", "creator" : "创建人", "create_time" : "2022-12-19T12:41:41Z", "task_status" : "INIT", "task_type" : "ORSIP", "task_description" : "任务描述", "exec_start_time" : null, "exec_stop_time" : null, "origin_data_alias" : null, "production_level" : "tile", "task_progress" : "0.0", "shape_id" : "541f58792fb84cd0bc3d8d6d8cd93337", "is_deleted" : 0, "image_url" : "https://koomap-optical-image-data.obs.cn-north-5.myhuaweicloud.com:443/c163c3c55c3c4526b2ed7a0213bc9871/%E6%95%B0%E6%8D%AE%E5%8A%A0%E5%B7%A5/%E5%85%89%E5%AD%A6%E5%BD%B1%E5%83%8F/%E6%88%90%E6%9E%9C%E5%BD%B1%E5%83%8F/%E4%BB%BB45YU655675ds_L5_tile_1671453701674/%E4%BB%BB45YU655675ds_L5_tile_per.png?AccessKeyId=********&Expires=1672217213&Signature=yzB8ao4%2Bzo5BXen6HPXOJ6FOdyI%3D", "frozen_tag" : null, "is_clip" : "0", "is_tile" : "0" } ], "taskNumVo" : [ { "totalNum" : 10, "failedNum" : 1, "archivedNum" : 1, "successNum" : 1, "runningNum" : 1 } ] }

URI GET /v1/kmp-control/tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_name 否 String 任务名称，支持模糊查询。 最小长度：1 最大长度：50 workspace_id 是 String 任务所属工作共享空间ID。 最小长度：32 最大长度：32 task_status 否 Array 任务状态。包括INIT（初始化）、RUNNING（运行中）、SUCCESS（执行成功）、ARCHIVED（已归档）、FAILED（执行失败）、STOPPING（停止中）、STOP_SUCCESS（已停止）、STOP_FAILD（停止失败）、START_RUNNING（等待中）。 create_time_start 否 String 创建开始时间。格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 create_time_end 否 String 创建结束时间。格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 offset 是 Integer 偏移量，从第几条记录开始查询。 最小值：0 最大值：2147483647 缺省值：0 limit 是 Integer 分页大小。 最小值：1 最大值：100 缺省值：10

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 page Page object 分页信息。 data Array of TaskVo objects 任务列表。 taskNumVo TaskNumVo object 各状态任务数量。 表4 Page 参数 参数类型 描述 offset Integer 偏移量，表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 表5 TaskVo 参数 参数类型 描述 task_id String 任务唯一标识ID。 最小长度：32 最大长度：36 workspace_id String 工作共享空间ID。 data_id String 数据ID。 task_name String 任务名称。 最小长度：2 最大长度：64 creator String 创建者ID。 最小长度：2 最大长度：512 create_time String 创建时间。 task_status String 任务状态。包括INIT（初始化）、RUNNING（运行中）、SUCCESS（执行成功）、ARCHIVED（已归档）、FAILED（执行失败）、STOPPING（停止中）、STOP_SUCCESS（已停止）、STOP_FAILED（停止失败）、START_RUNNING（等待中）。 task_type String 任务类型。 当前仅支持ORSIP（卫星影像生产）。 task_description String 任务描述。 exec_start_time String 开始操作时间。 缺省值：null exec_stop_time String 停止操作时间。 缺省值：null origin_data_alias String 原始数据别名。 production_level String 任务输出结果影像级别，当前支持以下级别： L2、L3、L4、L5。 task_progress String 任务执行进度。 shape_id String 矢量数据文件ID，“isClip”为“1”时必填。 is_deleted Integer 是否删除。 0：未删除 1：已删除 image_url String 影像链接。 domain_id String 华为云IAM租户账号ID。 fail_message String 任务失败原因。 frozen_tag String 任务冻结状态。当前仅支持frozen（冻结中）。 isClip String 是否为矢量切割。 0：否 1：是 isTile String 是否为金字塔切割。 0：否 1：是 表6 TaskNumVo 参数 参数类型 描述 totalNum Integer 任务总数量。 failedNum Integer 失败任务数量。 archivedNum Integer 存档任务数量。 successNum Integer 成功任务数量。 runningNum Integer 运行中任务数量。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512

响应示例 状态码： 200 请求成功。 { "spurInfos" : [ { "imageCode" : "1674019035390013440", "id" : "1676151290921086976", "taskId" : "db554dbd410f4c53a2118c6e34a31eb0", "pointWidth" : "7864.08984", "pointHeight" : "5433.04541", "longitude" : "113.87890565212626", "latitude" : "22.876653471049696", "height" : "37.884999999999998", "accuracy" : "0.05" }, { "imageCode" : "1674019035390013440", "id" : "1674395911112953856", "taskId" : "db554dbd410f4c53a2118c6e34a31eb0", "pointWidth" : "9274.5957", "pointHeight" : "2941.47803", "longitude" : "113.8800482786927", "latitude" : "22.8771672263087", "height" : "37.976999999999997", "accuracy" : "0.05" }, { "imageCode" : "1674019035390013440", "id" : "1674394962671767552", "taskId" : "db554dbd410f4c53a2118c6e34a31eb0", "pointWidth" : "7864.08984", "pointHeight" : "5433.04541", "longitude" : "113.87890565212626", "latitude" : "22.876653471049696", "height" : "37.884999999999998", "accuracy" : "0.05" } ], "page" : { "offset" : -1, "limit" : 10, "total" : 3 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 spurInfos Array of SpurInfoDetail objects 刺点信息列表。 page Page object 分页信息。 表4 SpurInfoDetail 参数 参数类型 描述 imageCode String 图像ID。 id String 刺点ID。 taskId String 刺点所属任务ID。 pointWidth String 刺点在图片中的横向像素值。 pointHeight String 刺点在图片中的纵向像素值。 longitude String 像控点经度。 latitude String 像控点纬度。 height String 像控点高度。 accuracy String 像控点精度。 表5 Page 参数 参数类型 描述 offset Integer 偏移量，表示从第几条数据开始查询。 limit Integer 每页包含的查询记录数量。 total Integer 符合查询条件的记录总数。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token信息，用于租户鉴权，该字段由租户请求IAM的Token接口获得。 表2 请求Body参数 参数 是否必选 参数类型 描述 imageCode 是 String 图片ID。 taskId 是 String 刺点所属的任务ID。 offset 否 Integer 偏移量。 最小值：0 最大值：2147483647 缺省值：0 limit 否 Integer 分页大小。 最小值：1 最大值：100 缺省值：10

请求示例 新建处理任务，目前只支持卫星影像处理任务（ORSIP）。 POST https://{Endpoint}/v1/kmp-control/tasks { "task_name": "这是任务描述", "task_type": "ORSIP", "data_ids": [ "ed9313d537dd4cf7a6a7758f9xxxxd84", "8dc0d6187b8e4f429c2d20d34xxxxx5a" ], "production_level": "L2", "task_description": "这是任务描述", "workspace_id": "dfa3527b45a24de6a2d0ddbcb8xxxxxx", "shape_id": null, "data_alias": { "JL1_20160112_203_0018_L2": "JL1_20160112_203_0018_L2" }, "coordination": "WGS84", "data_description": { "JL1_20160112_203_0018_L2": null }, "csv_ids": [3cd09e0xbf7949a59c9ec14012a4xxxx], "is_clip": "0", "is_tile": "0" }

响应示例 状态码： 200 请求成功。 { "task_id" : "4d40e927514a40898d23a20155xxxxxx", "workspace_id" : "dfa3527b45a24de6a2d0ddbcb8xxxxxx", "data_id" : "[\"ed9313d537dd4cf7a6a7758f942xxxxx\",\"8dc0d6187b8e4f429c2d20d340xxxxxa\"]", "task_name" : "测试", "domain_id" : "234602bf93714dcba145eaa45xxxxxxx", "creator" : "xxxxx", "create_time" : "2023-02-17T09:27:07Z", "task_status" : "INIT", "task_type" : "ORSIP", "task_description" : "测试", "exec_start_time" : null, "exec_stop_time" : null, "origin_data_alias" : null, "production_level" : "L2", "task_progress" : "0.0", "shape_id" : null, "is_deleted" : 0, "image_url" : null, "frozen_tag" : null, "is_clip" : "0", "is_tile" : "0" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 task_id String 任务唯一标识ID。 最小长度：32 最大长度：36 workspace_id String 工作共享空间ID。 data_id String 数据ID。 task_name String 任务名称。 最小长度：2 最大长度：64 creator String 创建者ID。 最小长度：2 最大长度：512 create_time String 创建时间。 task_status String 任务状态。包括INIT（初始化）、RUNNING（运行中）、SUCCESS（执行成功）、ARCHIVED（已归档）、FAILED（执行失败）、STOPPING（停止中）、STOP_SUCCESS（已停止）、STOP_FAILED（停止失败）、START_RUNNING（等待中）。 task_type String 任务类型。 当前仅支持ORSIP（卫星影像生产）。 task_description String 任务描述。 exec_start_time String 开始操作时间。 缺省值：null exec_stop_time String 停止操作时间。 缺省值：null origin_data_alias String 原始数据别名。 production_level String 任务输出结果影像级别，当前支持以下级别： L2、L3、L4、L5。 task_progress String 任务执行进度。 shape_id String 矢量数据文件ID，“isClip”为“1”时必填。 is_deleted Integer 是否删除。 0：未删除 1：已删除 image_url String 影像链接。 domain_id String 华为云IAM租户账号ID。 fail_message String 任务失败原因。 frozen_tag String 任务冻结状态。当前仅支持frozen（冻结中）。 isClip String 是否为矢量切割。 0：否 1：是 isTile String 是否为金字塔切割。 0：否 1：是 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512

请求示例 该请求查询单个像控点已经刺点的数量。 POST https://{Endpoint}/v1/real3d/spur/count { "taskId" : "41f72c882cc747a88f90151b1af18292", "longitude" : 9.24242349, "latitude" : 12.718883191, "height" : 3.247742033, "accuracy" : 0.05 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 像控点在图片上已刺点的数量。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：2 最大长度：512