全部产品
Search
文档中心

服务目录:API概览

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

服务发现

API标题API概述
GetProductAsEndUser终端用户查询产品信息终端用户调用GetProductAsEndUser接口查询产品信息。
ListProductsAsEndUser终端用户查询产品列表终端用户调用ListProductsAsEndUser接口查询产品列表。

服务请求

API标题API概述
ListLaunchOptions查询启动选项列表查询启动选项列表。
LaunchProduct启动产品启动产品。
TerminateProvisionedProduct终止实例终止实例。
UpdateProvisionedProduct更新实例更新实例。

计划

API标题API概述
CreateProvisionedProductPlan创建计划创建计划。
GetProvisionedProductPlan查询计划信息查询计划信息。
ListProvisionedProductPlans查询计划列表查询计划列表。可分用户维度和审批维度进行查询。
CancelProvisionedProductPlan取消计划取消计划。
UpdateProvisionedProductPlan更新计划更新计划。
ApproveProvisionedProductPlan审批计划审批人审批计划。
ListProvisionedProductPlanApprovers查询计划审批人列表查询计划审批人列表。
ExecuteProvisionedProductPlan执行计划执行计划。
DeleteProvisionedProductPlan删除计划删除计划。

实例

API标题API概述
GetProvisionedProduct查询实例信息查询实例信息。
ListProvisionedProducts查询实例列表查询实例列表。
GetTask查询任务信息查询任务信息。
ListTasks查询任务列表查询任务列表。

产品

API标题API概述
CopyProduct复制产品复制产品。
CreateProduct创建产品创建产品。
DeleteProduct删除产品删除产品。
UpdateProduct更新产品更新产品。
GetProductAsAdmin管理员查询产品信息管理员调用GetProductAsAdmin接口查询产品信息。
ListProductsAsAdmin管理员查询产品列表管理员调用ListProductsAsAdmin接口查询产品列表。

产品版本

API标题API概述
CreateProductVersion创建产品版本创建产品版本。
DeleteProductVersion删除产品版本删除产品版本。
UpdateProductVersion更新产品版本更新产品版本。
GetProductVersion查询产品版本信息查询产品版本信息。
ListProductVersions查询产品版本列表查询产品版本列表。

模板

API标题API概述
CreateTemplate创建模板创建模板。服务目录会保存用户上传的模板,并返回模板的URL地址。
GetTemplate查询模板详情查询模板详情。

产品组合

API标题API概述
CreatePortfolio创建产品组合创建产品组合。
AssociateProductWithPortfolio将产品加入产品组合将产品加入产品组合。
DeletePortfolio删除产品组合删除产品组合。
DisassociateProductFromPortfolio从产品组合中移除产品从产品组合中移除产品。
UpdatePortfolio更新产品组合更新产品组合。
GetPortfolio查询产品组合信息查询产品组合信息。
ListPortfolios查询产品组合列表查询产品组合列表。

约束

API标题API概述
CreateConstraint创建约束创建约束。
DeleteConstraint删除约束删除约束。
UpdateConstraint更新约束更新约束。
GetConstraint查询约束信息查询约束信息。

授权

API标题API概述
AssociatePrincipalWithPortfolio创建产品组合授权将产品组合授权给账号内的RAM用户或者RAM角色。
DisassociatePrincipalFromPortfolio删除产品组合授权删除产品组合授权。
ListPrincipals查询产品组合已授权的用户和角色列表查询产品组合已授权的RAM用户和RAM角色列表。

地域

API标题API概述
ListRegions查询地域列表查询地域列表。

标签选项

API标题API概述
GetTagOption查询标签选项信息查询标签选项详情。
DisAssociateTagOptionFromResource取消标签选项与资源的关联取消标签选项与资源的关联。
ListResourcesForTagOption查询标签选项关联的资源列表查询标签选项关联的资源列表。
UpdateTagOption更新标签选项更新标签选项。
ListTagOptions查询标签选项列表查询标签选项列表。
DeleteTagOption删除标签选项删除标签选项。
CreateTagOption创建标签选项创建标签选项。
AssociateTagOptionWithResource将标签选项关联到资源将标签选项关联到资源。