API标准及多语言预置SDK
本产品（servicecatalog/2021-09-01）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
服务发现
|
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 | 将标签选项关联到资源 | 将标签选项关联到资源。 |