文档

API概览

更新时间:
本产品(服务网格/2020-01-11)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

产品信息

API标题API概述
DescribeMetadata获取服务网格ASM的基本信息调用DescribeMetadata获取服务网格ASM的基本信息。

网格实例

API标题API概述
CreateServiceMesh创建一个服务网格实例调用CreateServiceMesh创建一个服务网格实例。
DeleteServiceMesh删除一个服务网格实例调用DeleteServiceMesh删除一个服务网格实例。
ModifyServiceMeshName修改服务网格实例名称调用ModifyServiceMeshName修改服务网格实例名称。
UpdateMeshFeature更新服务网格的功能配置调用UpdateMeshFeature更新服务网格的功能配置。
RevokeKubeconfig重新生成Kubeconfig调用RevokeKubeconfig吊销ASM实例的Kubeconfig,并重新生成新的Kubeconfig。
DescribeServiceMeshes获取服务网格列表调用DescribeServiceMeshes获取服务网格列表。
DescribeServiceMeshDetail获取服务网格详情调用DescribeServiceMeshDetail获取服务网格详情。
DescribeServiceMeshKubeconfig获取KubeConfig配置调用DescribeServiceMeshKubeconfig获取连接服务网格的KubeConfig配置。
DescribeServiceMeshAdditionalStatus查询ASM实例的附加检查信息调用DescribeServiceMeshAdditionalStatus查询ASM实例的附加检查信息。
DescribeVersions获取可用的ASM版本调用DescribeVersions获取创建网格时可用的ASM版本。

网格管理

API标题API概述
ReActivateAudit重建新的网格审计日志调用ReActivateAudit重建新的网格审计日志。在开启网格审计后,如果误删了存储审计日志的logproject,可以重新创建一个空白的网格审计日志。
DescribeNodesInstanceType查询数据面节点类型调用DescribeNodesInstanceType查询数据面节点类型,判断是否支持MultiBuffer性能加速。
DescribeCCMVersion查询CCM组件版本调用DescribeCCMVersion查询CCM组件版本。
GetCaCert获取CA证书调用GetCaCert获取CA证书。

权限管理

API标题API概述
GrantUserPermissions更新子账号授权信息调用GrantUserPermissions更新子账号授权信息。
DescribeUserPermissions获取子账号授权信息调用DescribeUserPermissions获取子账号授权信息。
DescribeUsersWithPermissions获取RBAC权限的RAM用户调用DescribeUsersWithPermissions获取所有具有RBAC权限的RAM用户或RAM角色ID。

网格资源

API标题API概述
UpdateMeshCRAggregation更新数据面KubeAPI访问Istio资源功能的启用状态调用UpdateMeshCRAggregation更新数据面KubeAPI访问Istio资源功能的启用状态。
ModifyApiServerEipResource解绑或绑定API Server的EIP调用ModifyApiServerEipResource解绑或绑定API Server的EIP。
DescribeVSwitches获取指定VPC内的虚拟交换机列表调用DescribeVSwitches获取指定地域,指定VPC内的虚拟交换机列表。
DescribeVpcs获取指定地域内可用的VPC调用DescribeVpcs获取指定地域内可用的VPC。
DescribeCens获取网络连通性检测结果调用DescribeCens获取同一服务网格下多集群跨VPC的网络连通性检测结果。
DescribeCrTemplates查询Istio资源YAML模板调用DescribeCrTemplates查询服务网格中常见使用场景下的Istio资源YAML模板。
DescribeEipResources查询EIP资源列表调用DescribeEipResources查询EIP资源列表。

数据面组件管理

API标题API概述
UpdateNamespaceScopeSidecarConfig更新Sidecar配置调用UpdateNamespaceScopeSidecarConfig更新命名空间级别的Sidecar配置。
UpdateIstioInjectionConfig更新Sidecar注入配置调用UpdateIstioInjectionConfig修改网格注入设置。
DescribeServiceMeshProxyStatus查询IstioProxy状态调用DescribeServiceMeshProxyStatus查询IstioProxy状态。
DescribeNamespaceScopeSidecarConfig查询Sidecar配置调用DescribeNamespaceScopeSidecarConfig查询命名空间级别的Sidecar配置设置。

集群

API标题API概述
AddClusterIntoServiceMesh添加一个集群到服务网格调用AddClusterIntoServiceMesh添加一个集群到服务网格。
RemoveClusterFromServiceMesh从服务网格中删除集群调用RemoveClusterFromServiceMesh接口从服务网格中删除一个集群。
UpdateASMNamespaceFromGuestCluster将数据平面集群Namespace同步到ASM实例调用UpdateASMNamespaceFromGuestCluster从加入服务网格的Kubernetes集群中同步命名空间信息。
DescribeServiceMeshClusters获取服务网格的可用集群调用DescribeServiceMeshClusters获取服务网格的可用集群。
DescribeClustersInServiceMesh获取服务网格所在集群的信息列表调用DescribeClustersInServiceMesh获取服务网格所在集群的信息列表。
DescribeGuestClusterPods获取集群的Pod列表调用DescribeGuestClusterPods获取指定K8s集群指定命名空间内的Pod。
DescribeGuestClusterNamespaces获取集群内的命名空间列表调用DescribeGuestClusterNamespaces获取加入服务网格的Kubernetes集群的命名空间列表。
DescribeReusableSlb获取可复用的CLB(原SLB)调用DescribeReusableSlb获取可复用的CLB(原SLB)。
GetRegisteredServiceEndpoints获取注册到网格内的服务端点信息调用GetRegisteredServiceEndpoints获取注册服务端点信息。
GetRegisteredServiceNamespaces获取注册服务所在的命名空间调用GetRegisteredServiceNamespaces获取注册服务的命名空间列表。

ASM网关

API标题API概述
CreateASMGateway创建ASM网关调用CreateASMGateway创建ASM网关。
CreateIstioGatewayRoutes创建ASM网关对应的路由调用CreateIstioGatewayRoutes创建ASM网关对应的路由。
CreateGatewaySecret创建网关密钥调用CreateGatewaySecret创建网关密钥。
CreateIstioGatewayDomains创建网关域名证书调用CreateIstioGatewayDomains创建网关域名证书。
DeleteGatewayRoute更新路由额外信息调用DeleteGatewayRoute删除网关路由。
DeleteGatewaySecret删除网关密钥调用DeleteGatewaySecret删除网关密钥。
DeleteIstioGatewayDomains删除网关路由调用DeleteIstioGatewayDomains删除网关路由。
UpdateASMGateway修改ASM网关调用UpdateASMGateway修改ASM网关。
UpdateASMGatewayImportedServices更新ASM网关导入的服务信息调用UpdateASMGatewayImportedServices更新ASM网关导入的服务信息,导入或删除网关关联的上游服务。
UpdateIstioGatewayRoutes更新网关路由调用UpdateIstioGatewayRoutes更新网关路由。
UpdateIstioRouteAdditionalStatus更新路由额外信息调用UpdateIstioRouteAdditionalStatus更新路由额外信息。
DescribeImportedServicesDetail获取ASM网关已导入服务的详细信息调用DescribeImportedServicesDetail获取ASM网关已导入服务的详细信息。
DescribeASMGatewayImportedServices获取ASM网关已导入的服务信息调用DescribeASMGatewayImportedServices获取ASM网关已导入的服务信息。
DescribeIstioGatewayRouteDetail查看网关路由详情调用DescribeIstioGatewayRouteDetail查看网关路由详情。
DescribeGatewaySecretDetails查询网关证书密钥详细信息调用DescribeGatewaySecretDetails查询网关证书密钥详细信息。
DescribeIstioGatewayDomains查询网关域名列表调用DescribeIstioGatewayDomains查询网关域名列表。
DescribeIstioGatewayRoutes查询ASM网关的路由列表调用DescribeIstioGatewayRoutes查询ASM网关的路由列表。

可观测性

API标题API概述
DescribeClusterGrafana获取集群的Grafana报表信息调用DescribeClusterGrafana获取服务网格内集群的Grafana报表信息。
DescribeClusterPrometheus获取集群的Prometheus公网地址调用DescribeClusterPrometheus获取服务网格内集群的Prometheus公网地址。
DescribeServiceMeshLogs获取网格日志调用DescribeServiceMeshLogs获取网格日志。
DescribeGuestClusterAccessLogDashboards获取数据面集群的访问日志报表调用DescribeGuestClusterAccessLogDashboards获取数据面集群的访问日志报表。
GetGrafanaDashboardUrl从ARMS获取Grafana仪表盘URL调用GetGrafanaDashboardUrl从ARMS获取Grafana仪表盘URL。

升级

API标题API概述
UpgradeMeshVersion升级服务网格的版本调用UpgradeMeshVersion升级服务网格的版本。
UpgradeMeshEditionPartially升级或切换ASM实例版本调用UpgradeMeshEditionPartially升级ASM实例或者将ASM实例切换为专业版。
DescribeUpgradeVersion获取服务网格的可更新版本信息调用DescribeUpgradeVersion获取服务网格的可更新版本信息。
DescribeServiceMeshUpgradeStatus查询ASM的升级状态调用DescribeServiceMeshUpgradeStatus查询ASM实例和ASM网关的升级状态。

流量泳道

API标题API概述
CreateSwimLane创建泳道调用CreateSwimLane创建泳道。
CreateSwimLaneGroup创建泳道组调用CreateSwimLaneGroup创建泳道组。
DeleteSwimLane删除指定泳道调用DeleteSwimLane删除指定泳道。
DeleteSwimLaneGroup删除指定泳道组调用DeleteSwimLaneGroup删除指定泳道组。删除泳道组对应也会删除泳道组下的泳道和相关引流规则。
UpdateSwimLane更新指定泳道信息调用UpdateSwimLane更新指定泳道信息。
UpdateSwimLaneGroup更新对应泳道组调用UpdateSwimLaneGroup更新对应泳道组。
GetSwimLaneDetail获取指定泳道详细信息调用GetSwimLaneDetail获取指定泳道详细信息。
GetSwimLaneGroupList获取网格实例下所有泳道组列表调用GetSwimLaneGroupList获取网格实例下所有泳道组列表。
GetSwimLaneList获取某个泳道组下所有泳道列表调用GetSwimLaneList获取某个泳道组下所有泳道列表。

其他

API标题API概述
GetDeploymentBySelector获取Selector指定的工作负载列表调用GetDeploymentBySelector获取Selector指定的工作负载列表。
UpdateControlPlaneLogConfig修改控制面日志采集配置修改控制面日志采集配置。
UntagResources删除标签接口调用UntagResources删除实例上的用户标签。
ListTagResources标签查询接口调用ListTagResources查询实例上的用户标签。
TagResources编辑标签接口调用TagResources添加或修改资源的用户标签。
UpdateWaypoint更新一个数据面集群中某个Waypoint配置
CreateWaypoint在数据面集群中创建一个Waypoint
DeleteWaypoint删除一个Waypoint
ListWaypoints获取数据面集群的Waypoint配置调用ListWaypoints获取数据面集群某个命名空间下所有Waypoint配置。
ListServiceAccounts获取数据面集群的ServiceAccount
  • 本页导读 (1)
文档反馈