API概览

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

服务

API标题API概述
API标题API概述
CreateService创建服务通过地域ID、部署类型、服务类型、服务名称等参数,创建新的服务。
DeleteService删除服务通过地域ID、服务ID、服务版本删除指定服务。
UpdateService更新服务升级服务。
GetService查询服务详细信息调用GetService查询指定服务的详细信息。
ListServices查询服务信息通过指定地域ID、服务ID等参数,查询服务信息列表。例如,服务状态,服务版本,发布时间等信息。
PreLaunchService对服务进行预发布操作预发布服务
RegisterService注册服务注册部署物。
LaunchService上线服务调用LaunchService上线服务。
GetServiceProvisions查询服务开通状态和服务角色信息查询服务开通状态和服务角色信息。
GetServiceTemplateParameterConstraints查询ROS模板参数限制信息查询ROS模板参数限定值。
GetServiceEstimateCost查询创建服务实例的预估价格查询创建服务实例的预估价格。
WithdrawService下线服务版本下线服务版本。
GenerateServicePolicy创建服务实例前校验所需的权限调用GenerateServicePolicy创建服务实例前查询缺少的权限策略。
CancelServiceRegistration取消服务审核申请取消服务审核申请。
ListServiceRegistrations查询服务审核申请查询服务审核申请。

服务实例

API标题API概述
API标题API概述
RollbackServiceInstance回滚服务实例对升级后的服务实例进行回滚,默认回滚到上一个升级版本。
CreateServiceInstance创建并部署服务实例通过指定地域ID、服务ID、服务版本等参数,创建并部署服务实例。
DeleteServiceInstances删除服务实例通过指定地域ID、服务ID,删除服务实例。
UpdateServiceInstanceSpec变配服务实例变配服务实例。
UpdateServiceInstanceAttribute更新服务实例属性更新服务实例的属性。
ModifyServiceInstanceResources修改服务实例包含的资源修改服务实例的资源信息。
UpgradeServiceInstance升级服务实例使用地域ID、服务版本等参数调用UpgradeServiceInstance升级服务实例。
GetServiceInstance查询服务实例的详细信息通过服务实例 ID、地域 ID查询指定服务实例的详细信息。例如,服务实例的部署状态、模板名称、服务详情等信息。
ListServiceInstances查询服务实例列表查询服务实例列表。
DeployServiceInstance部署服务实例部署服务实例。
ContinueDeployServiceInstance继续部署服务实例服务实例部署失败后,通过指定地域ID、服务ID、服务实例配置参数,继续部署服务实例。
StartServiceInstance启动服务实例当服务实例状态为Stopped(已关机)、StartFailed(开机失败)时,调用StartServiceInstance接口启动服务实例。
StopServiceInstance关闭服务实例当服务实例状态为Deployed(已部署)、StopFailed(关机失败)时,调用StopServiceInstance接口关闭服务实例。
RestartServiceInstance重启服务实例当服务实例状态为Deployed(已部署)时,调用RestartServiceInstance接口重启服务实例。
ListServiceInstanceDeployDetails查询服务实例部署详情列表查询服务实例部署详情列表。

部署物

API标题API概述
API标题API概述
CreateArtifact创建部署物调用CreateArtifact创建部署物。
DeleteArtifact删除部署物当您不再需要部署物或部署物对应版本,调用DeleteArtifact删除部署物。
UpdateArtifact更新部署物调用UpdateArtifact更新部署物。
GetArtifact查询部署物详情调用GetArtifact查询部署物详情。
ListArtifacts查询部署物列表调用ListArtifacts查询部署物列表。
ListArtifactVersions查询部署物版本信息调用ListArtifactVersions查询部署物版本信息。
ReleaseArtifact发布部署物调用ReleaseArtifact发布部署物。
GetUploadCredentials获取文件上传的访问密钥获取上传文件的访问密钥。
GetArtifactRepositoryCredentials服务商获取上传部署物所需的访问凭证获取部署物上传所需的凭证。
ListAcrImageTags查看镜像仓库中已上传的镜像版本调用ListAcrImageTags查看镜像仓库中已上传的镜像版本。
ListAcrImageRepositories查看已上传至ACR的镜像列表调用ListAcrImageRepositories查看已上传至ACR的镜像列表。

服务使用申请

API标题API概述
API标题API概述
CreateServiceUsage创建分销申请创建服务分销申请。
RejectServiceUsage拒绝服务申请调用RejectServiceUsage拒绝服务申请。
ApproveServiceUsage商家通过服务使用请求商家调用ApproveServiceUsage通过服务使用请求。
ListServiceUsages查看当前服务使用申请查看用户自己当前的服务使用申请。

服务权限

API标题API概述
API标题API概述
AddServiceSharedAccounts新增服务共享账号调用AddServiceSharedAccounts新增服务的共享账号。
RemoveServiceSharedAccounts删除共享账号删除共享账号。
ListServiceSharedAccounts获取服务共享账号列表调用ListServiceSharedAccounts查看服务共享账号列表。
UpdateSharedAccountPermission更新共享账号的权限调用UpdateSharedAccountPermission更新共享账号的权限。

标签和资源组

API标题API概述
API标题API概述
TagResources创建并绑定标签调用TagResources为服务实例的资源列表统一创建并绑定标签。
UnTagResources删除标签调用UntagResources删除服务实例资源的标签。
ListTagValues查询标签键对应的标签值查询标签键对应的标签值。
ListTagKeys查询已有标签键信息查询已有标签键信息。

其他

API标题API概述
API标题API概述
PushMeteringData推送云市场计量数据推送云市场计量数据。
  • 本页导读 (1)
  • 服务
  • 服务实例
  • 部署物
  • 服务使用申请
  • 服务权限
  • 标签和资源组
  • 其他
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等