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

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择domain，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "domain": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 身份认证信息 最小长度：1 最大长度：16384 表2 请求Body参数 参数 是否必选 参数类型 描述 metadata 是 CreateRuleObjectMeta object 基本信息，为集合类的元素类型，包含一组由不同名称定义的属性。 spec 是 RuleSpec object spec是集合类的元素类型，您对需要管理的对象进行详细描述的主体部分都在spec中给出。U CS 通过spec的描述来创建或更新对象。 表3 CreateRuleObjectMeta 参数 是否必选 参数类型 描述 name 是 String 权限策略名称 最小长度：1 最大长度：63 表4 RuleSpec 参数 是否必选 参数类型 描述 iamuserids 否 Array of strings 权限策略关联的 IAM 用户信息 type 否 String 权限策略类型，只允许四种类型：readonly/develop/admin/custom contents 否 Array of Content objects 权限策略内容 description 否 String 权限策略描述信息 最小长度：0 最大长度：255 表5 Content 参数 是否必选 参数类型 描述 verbs 否 Array of strings 动作列表 resources 否 Array of strings 资源列表

响应示例 状态码： 200 集群的信息，例如状态信息、集群与karmada控制面的同步模式等 { "kind" : "Cluster", "apiVersion" : "v1", "metadata" : { "name" : "test-cluster", "uid" : "b0d1ecb5-7947-11ee-9467-0255ac1001bf", "creationTimestamp" : "2023-11-02T06:36:14Z", "labels" : { "FeatureGates" : "elbv3,SupportClientCertificateRevocation,xGPU" }, "annotations" : { "vpcId" : "11c9fe72-5a90-4295-bcfe-774726fb9066" } }, "spec" : { "syncMode" : "", "clusterGroupID" : "bffbb35b-7949-11ee-886c-0255ac100037", "manageType" : "grouped", "provider" : "huaweicloud", "type" : "cce", "category" : "self", "region" : "cn-north-4", "country" : "CN", "city" : "150900", "projectID" : "b6315dd3d0ff4be5b31a963256794989", "projectName" : "cn-north-4", "IsDownloadedCert" : false, "operatorNamespace" : "2cd7ebd02e4743eba4e6342c09e49344" }, "status" : { "kubernetesVersion" : "v1.25", "conditions" : [ { "type" : "Ready", "status" : "True", "lastTransitionTime" : "2023-11-27T11:05:09+08:00", "reason" : "ClusterAvailable" }, { "type" : "Cluster", "status" : "Available", "lastTransitionTime" : "2023-11-27T11:05:09+08:00", "reason" : "ClusterAvailable" }, { "type" : "Federation", "status" : "Federalized", "lastTransitionTime" : "2023-11-14T14:31:58.744215+08:00" } ], "endpoints" : [ { "url" : "https://192.168.1.251:5443", "type" : "Internal" } ], "phase" : "Available", "arrearFreeze" : "false", "policeFreeze" : "false" } }

URI GET /v1/permissions/rules 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页获取列表时，页的大小，默认为-1 offset 否 Integer 分页获取列表时，起始偏移量，默认为0 order_by 否 String 分页获取列表时，排序参数，支持 create_at 和 update_at order 否 String 分页获取列表时，排序方向，支持 desc 和 asc

响应示例 状态码： 200 权限策略列表 { "items" : [ { "metadata" : { "name" : "admin", "uid" : "3dcdef78-65bb-11ee-bdf2-0255ac100033", "creationTimestamp" : "2023-10-08 09:15:36.526016 +0000 UTC", "updateTimestamp" : "2023-10-08 09:15:36.526016 +0000 UTC" }, "spec" : { "iamUserIDs" : [ "873395a21c8d4d8ba9e37d6d32debc41" ], "type" : "admin", "contents" : [ { "verbs" : [ "*" ], "resources" : [ "*" ] } ] } } ], "total" : 1 }

响应示例 状态码： 200 容器舰队对象 { "kind" : "ClusterGroup", "apiVersion" : "v1", "metadata" : { "name" : "cluster-test", "uid" : "bffbb35b-7949-11ee-886c-0255ac100037", "creationTimestamp" : "2023-11-02 06:33:35.558128 +0000 UTC", "updateTimestamp" : "2023-11-14 06:20:20.446476 +0000 UTC" }, "spec" : { "federationId" : "e2f27cc6-82b5-11ee-84e3-0255ac100032", "federationVersion" : "v1.7.0-t1109", "dnsSuffix" : [ "www.oidc.com" ] }, "status" : { "conditions" : [ { "type" : "Federation", "status" : "Unavailable", "reason" : "FederationUnavailable", "message" : "component volcano-scheduler is unhealthy", "lastTransitionTime" : "0001-01-01T00:00:00Z" } ] } }

请求示例 更新权限策略 PUT https://ucs.myhuaweicloud.com/v1/permissions/{ruleid} { "spec" : { "iamUserIDs" : [ "978ff70ec1494a5680f6218faa3567d9", "5acdb44b47ba4bd79783ad40e5346783" ], "type" : "custom", "description" : "this is description" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 身份认证信息 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 spec 否 RuleSpec object spec是集合类的元素类型，您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 表4 RuleSpec 参数 是否必选 参数类型 描述 iamuserids 否 Array of strings 权限策略关联的IAM用户信息 type 否 String 权限策略类型，只允许四种类型：readonly/develop/admin/custom contents 否 Array of Content objects 权限策略内容 description 否 String 权限策略描述信息 最小长度：0 最大长度：255 表5 Content 参数 是否必选 参数类型 描述 verbs 否 Array of strings 动作列表 resources 否 Array of strings 资源列表

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 kind String API类型。 apiVersion String API版本，固定值“v1”，该值不可修改。 spec JobSpec object spec是集合类的元素类型，您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 status JobStatus object 运行状态信息。集合类的元素类型，用于记录对象在系统中的当前状态信息。 表4 JobSpec 参数 参数类型 描述 type String Job类型 federationuid String 联邦uid resourceid String 资源id resourcename String 资源名字 extendparam String 扩展参数 subjobs Array of Job objects 子Job 表5 Job 参数 参数类型 描述 kind String API类型。 apiVersion String API版本，固定值“v1”，该值不可修改。 spec JobSpec object spec是集合类的元素类型，您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 status JobStatus object 运行状态信息。集合类的元素类型，用于记录对象在系统中的当前状态信息。 表6 JobStatus 参数 参数类型 描述 phase String Job phase reason String Job reason completiontime String Job完成时间 starttime String Job开始时间

响应示例 状态码： 200 返回开启联邦对应的Job { "kind" : "Job", "apiVersion" : "v3", "metadata" : { "uid" : "70b5a14f-2fa4-11ee-bf07-0255ac1000b9", "creationTimestamp" : "2023-07-31 13:16:20.715779 +0000 UTC", "updateTimestamp" : "2023-07-31 13:17:24.497868 +0000 UTC", "annotations" : { "currentTimestamp" : "2023-07-31 13:17:24.933313136 +0000 UTC" } }, "spec" : { "type" : "CreateFederationContainer", "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4", "resourceID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4", "resourceName" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4", "subJobs" : [ { "kind" : "Job", "apiVersion" : "v3", "metadata" : { "uid" : "70b66b9a-2fa4-11ee-bf07-0255ac1000b9", "creationTimestamp" : "2023-07-31 13:16:20.740512 +0000 UTC", "updateTimestamp" : "2023-07-31 13:16:22.100528 +0000 UTC", "annotations" : { "currentTimestamp" : "2023-07-31 13:17:24.934274579 +0000 UTC" } }, "spec" : { "type" : "InstallFederationChart", "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4" }, "status" : { "phase" : "Success", "completionTime" : "2023-07-31 13:16:22.100528 +0000 UTC", "startTime" : "2023-07-31 13:16:22.100528 +0000 UTC" } }, { "kind" : "Job", "apiVersion" : "v3", "metadata" : { "uid" : "70b66b68-2fa4-11ee-bf07-0255ac1000b9", "creationTimestamp" : "2023-07-31 13:16:20.736232 +0000 UTC", "updateTimestamp" : "2023-07-31 13:17:24.490359 +0000 UTC", "annotations" : { "currentTimestamp" : "2023-07-31 13:17:24.934277116 +0000 UTC" } }, "spec" : { "type" : "CreateNetworkResource", "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4", "extendParam" : { "JobExtendParamKeyElbID" : "69694819-67dc-44ac-ab6e-9b18087c5c4c" } }, "status" : { "phase" : "Success", "completionTime" : "2023-07-31 13:17:24.490359 +0000 UTC", "startTime" : "2023-07-31 13:16:20.744891 +0000 UTC" } }, { "kind" : "Job", "apiVersion" : "v3", "metadata" : { "uid" : "70b66afa-2fa4-11ee-bf07-0255ac1000b9", "creationTimestamp" : "2023-07-31 13:16:20.731295 +0000 UTC", "updateTimestamp" : "2023-07-31 13:16:22.100452 +0000 UTC", "annotations" : { "currentTimestamp" : "2023-07-31 13:17:24.934288685 +0000 UTC" } }, "spec" : { "type" : "CreateCert", "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4" }, "status" : { "phase" : "Success", "completionTime" : "2023-07-31 13:16:22.100452 +0000 UTC", "startTime" : "2023-07-31 13:16:22.100452 +0000 UTC" } }, { "kind" : "Job", "apiVersion" : "v3", "metadata" : { "uid" : "70b66ad0-2fa4-11ee-bf07-0255ac1000b9", "creationTimestamp" : "2023-07-31 13:16:20.726434 +0000 UTC", "updateTimestamp" : "2023-07-31 13:16:22.093902 +0000 UTC", "annotations" : { "currentTimestamp" : "2023-07-31 13:17:24.934291673 +0000 UTC" } }, "spec" : { "type" : "CreateNode", "federationUID" : "70acf480-2fa4-11ee-ad1d-0255ac1001c4" }, "status" : { "phase" : "Success", "completionTime" : "2023-07-31 13:16:22.093902 +0000 UTC", "startTime" : "2023-07-31 13:16:20.745187 +0000 UTC" } } ] }, "status" : { "phase" : "Success", "completionTime" : "2023-07-31 13:17:24.497868 +0000 UTC", "startTime" : "2023-07-31 13:16:20.721007 +0000 UTC" } }

请求示例 更新集群区域 PUT https://ucs.myhuaweicloud.com/v1/clusters/{clusterid} { "kind" : "Cluster", "apiVersion" : "v1", "metadata" : { "annotations" : { "kubeconfig" : "{\"kind\":\"Config\",\"apiVersion\":\"v1\",\"preferences\":{},\"clusters\":[{\"name\":\"internalCluster\",\"cluster\":{\"server\":\"https://100.94.13.93:5443\",\"insecure-skip-tls-verify\":true}}],\"users\":[{\"name\":\"user\",\"user\":{\"client-certificate-data\":\"\",\"client-key-data\":\"\"}}],\"contexts\":[{\"name\":\"internal\",\"context\":{\"cluster\":\"internalCluster\",\"user\":\"user\"}}],\"current-context\":\"internal\"}" } }, "spec" : { "country" : "AL", "city" : "AL" } }

URI GET /v1/clustergroups 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页获取列表时，页的大小，默认为-1 offset 否 Integer 分页获取列表时，起始偏移量，默认为0 order_by 否 String 分页获取列表时，排序参数，支持 create_at 和 update_at order 否 String 分页获取列表时，排序方向，支持 desc 和 asc

响应示例 状态码： 200 返回容器舰队列表信息 { "items" : [ { "kind" : "ClusterGroup", "apiVersion" : "v1", "metadata" : { "name" : "cluster-test", "uid" : "bffbb35b-7949-11ee-886c-0255ac100037", "creationTimestamp" : "2023-11-02 06:33:35.558128 +0000 UTC", "updateTimestamp" : "2023-11-14 06:20:20.446476 +0000 UTC" }, "spec" : { "federationId" : "e2f27cc6-82b5-11ee-84e3-0255ac100032", "federationVersion" : "v1.7.0-t1109", "dnsSuffix" : [ "www.oidc.com" ] }, "status" : { "conditions" : [ { "type" : "Federation", "status" : "Unavailable", "reason" : "FederationUnavailable", "message" : "component volcano-scheduler is unhealthy", "lastTransitionTime" : "0001-01-01T00:00:00Z" } ] } }, { "kind" : "ClusterGroup", "apiVersion" : "v1", "metadata" : { "name" : "cluster-dev", "uid" : "4557ad49-22bf-11ee-b0c9-0255ac10004b", "creationTimestamp" : "2023-07-15 03:25:39.253589 +0000 UTC", "updateTimestamp" : "2023-10-19 11:52:14.509405 +0000 UTC" }, "spec" : { }, "status" : { } }, { "kind" : "ClusterGroup", "apiVersion" : "v1", "metadata" : { "name" : "test0131", "uid" : "108f5981-a105-11ed-a23e-0255ac100032", "creationTimestamp" : "2023-01-31 01:17:44.309185 +0000 UTC", "updateTimestamp" : "2023-06-29 01:02:28.78095 +0000 UTC" }, "spec" : { }, "status" : { } } ], "total" : 3 }

集群类别与类型说明 集群类别（category） 集群类型（type） provider供应商 华为云集群（self） CCE Standard集群（cce） huaweicloud CCE Turbo 集群（turbo） huaweicloud 本地集群（onpremise） 本地集群（baremetal） huaweicloud 多云集群（multicloud） 多云集群（aws） huaweicloud 附着集群（attachedcluster） 阿里云集群（ack） aliyun 微软云集群（aks） azure 亚马逊云集群（eks） aws 谷歌云集群（gke） googlecloud 腾讯云集群（tke） tencentcloud OpenShift集群（openshift） openshift 自建集群（privatek8s） privatek8s 父主题： 附录