本产品（
计算巢-服务商侧/2021-05-21）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
服务
| 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概述 |
|---|---|---|
| ListServiceInstanceUpgradeHistory | 查询服务实例升级历史 | 调用ListServiceInstanceUpgradeHistory查询服务实例的升级历史。 |
| 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 | 查询服务实例部署详情列表 | 查询服务实例部署详情列表。 |
| ListServiceInstanceResources | 查询服务实例包含的资源 | 调用ListServiceInstanceResources查询服务实例包含的资源。 |
| ListServiceInstanceBill | 查询服务实例账单 | 调用ListServiceInstanceBill查询服务实例账单 |
| ListServiceInstanceLogs | 查询服务实例的日志 | 调用ListServiceInstanceLogs查询服务实例的部署，升级和应用等日志。 |
部署物
| API | 标题 | API概述 |
|---|---|---|
| ListArtifactRisks | 查询部署物风险列表 | 获取部署物安全风险列表。 |
| CreateArtifact | 创建部署物 | 调用CreateArtifact创建部署物。 |
| DeleteArtifact | 删除部署物 | 当您不再需要部署物或部署物对应版本，调用DeleteArtifact删除部署物。 |
| UpdateArtifact | 更新部署物 | 调用UpdateArtifact更新部署物。 |
| GetArtifact | 查询部署物详情 | 调用GetArtifact查询部署物详情。 |
| ListArtifacts | 查询部署物列表 | 调用ListArtifacts查询部署物列表。 |
| ListArtifactVersions | 查询部署物版本信息 | 调用ListArtifactVersions查询部署物版本信息。 |
| ReleaseArtifact | 发布部署物 | 调用ReleaseArtifact发布部署物。 |
| GetUploadCredentials | 获取文件上传的访问密钥 | 获取上传文件的访问密钥。 |
| GetArtifactRepositoryCredentials | 服务商获取上传部署物所需的访问凭证 | 获取部署物上传所需的凭证。 |
| ListAcrImageTags | 查看镜像仓库中已上传的镜像版本 | 调用ListAcrImageTags查看镜像仓库中已上传的镜像版本。 |
| ListAcrImageRepositories | 查看已上传至ACR的镜像列表 | 调用ListAcrImageRepositories查看已上传至ACR的镜像列表。 |
服务使用申请
| API | 标题 | API概述 |
|---|---|---|
| CreateServiceUsage | 创建分销申请 | 创建服务分销申请。 |
| RejectServiceUsage | 拒绝服务申请 | 调用RejectServiceUsage拒绝服务申请。 |
| ApproveServiceUsage | 商家通过服务使用请求 | 商家调用ApproveServiceUsage通过服务使用请求。 |
| ListServiceUsages | 查看当前服务使用申请 | 查看用户自己当前的服务使用申请。 |
服务权限
| API | 标题 | API概述 |
|---|---|---|
| AddServiceSharedAccounts | 新增服务共享账号 | 调用AddServiceSharedAccounts新增服务的共享账号。 |
| RemoveServiceSharedAccounts | 删除共享账号 | 删除共享账号。 |
| ListServiceSharedAccounts | 获取服务共享账号列表 | 调用ListServiceSharedAccounts查看服务共享账号列表。 |
| UpdateSharedAccountPermission | 更新共享账号的权限 | 调用UpdateSharedAccountPermission更新共享账号的权限。 |
标签和资源组
| API | 标题 | API概述 |
|---|---|---|
| ListTagResources | 查询计算巢资源和标签的绑定关系 | 查询资源标签。 |
| TagResources | 创建并绑定标签 | 调用TagResources为服务实例的资源列表统一创建并绑定标签。 |
| UnTagResources | 删除标签 | 调用UntagResources删除服务实例资源的标签。 |
| ListTagValues | 查询标签键对应的标签值 | 查询标签键对应的标签值。 |
| ListTagKeys | 查询已有标签键信息 | 查询已有标签键信息。 |
服务商
| API | 标题 | API概述 |
|---|---|---|
| GetSupplierInformation | 查询服务商信息 | 获取服务商信息。 |
| CreateSupplierRegistration | 服务商提交入驻申请 | 注册成为服务商。 |
| ListSupplierRegistrations | 查看服务商入驻申请 | 查看服务商已经提交的入驻申请。 |
| UpdateSupplierInformation | 更新服务商信息 | 调用UpdateSupplierInformation更新服务商信息。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| PushMeteringData | 推送计量数据 | 该API只支持推送按量付费的计算巢服务实例的计量数据，推送的计量项需要定义为服务商上报。 |
| CreateServiceTestTask | 创建服务测试任务 | 调用CreateServiceTestTask创建服务测试任务。 |
| ListServiceTestTasks | 查询服务测试任务列表 | 调用ListServiceTestTasks查询服务模板测试信息。 |
| ListServiceTestTaskLogs | 查询服务测试任务日志 | 获取服务测试实时日志。 |
| GetServiceTestTask | 获取服务测试任务详情 | 当选择了不同的服务测试用例创建好服务测试任务后，可通过此API获取服务测试任务中每个用例执行的详细情况。 |
| GenerateDefaultServiceTestConfig | 生成默认的服务测试配置 | 调用GenerateDefaultServiceTestConfig修改服务测试配置。 |
| GetServiceRegistration | 获取服务审核申请详情 | 获取服务审核申请详情 |
| ListResellers | 查分销商 | 查询分销商用于前端展示。 |
| DeleteServiceTestCase | 删除服务测试用例 | 删除服务测试用例 |
| UpdateServiceTestCase | 更新服务测试用例 | 修改服务测试用例 |
| ListServiceTestCases | 查询当前服务版本下的服务测试用例集合 | 列表查询当前服务版本下的服务测试用例集合。 |
| CreateServiceTestCase | 创建服务测试用例 | 创建服务测试用例 |