summaryrefslogtreecommitdiff
path: root/data/zh_cn/servicecatalog/2021-09-01/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/servicecatalog/2021-09-01/api-docs.php')
-rw-r--r--data/zh_cn/servicecatalog/2021-09-01/api-docs.php11408
1 files changed, 4957 insertions, 6451 deletions
diff --git a/data/zh_cn/servicecatalog/2021-09-01/api-docs.php b/data/zh_cn/servicecatalog/2021-09-01/api-docs.php
index ec93f4b..3a80b8e 100644
--- a/data/zh_cn/servicecatalog/2021-09-01/api-docs.php
+++ b/data/zh_cn/servicecatalog/2021-09-01/api-docs.php
@@ -1,191 +1,114 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'servicecatalog',
- 'version' => '2021-09-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'servicecatalog', 'version' => '2021-09-01'],
'directories' => [
[
- 'id' => 156830,
- 'title' => '服务发现',
+ 'children' => ['GetProductAsEndUser', 'ListProductsAsEndUser'],
'type' => 'directory',
- 'children' => [
- 'GetProductAsEndUser',
- 'ListProductsAsEndUser',
- ],
+ 'title' => '服务发现',
+ 'id' => 48185,
],
[
- 'id' => 156834,
- 'title' => '服务请求',
+ 'children' => ['ListLaunchOptions', 'LaunchProduct', 'TerminateProvisionedProduct', 'UpdateProvisionedProduct'],
'type' => 'directory',
- 'children' => [
- 'ListLaunchOptions',
- 'LaunchProduct',
- 'TerminateProvisionedProduct',
- 'UpdateProvisionedProduct',
- ],
+ 'title' => '服务请求',
+ 'id' => 48188,
],
[
- 'id' => 168857,
- 'title' => '计划',
+ 'children' => ['CreateProvisionedProductPlan', 'GetProvisionedProductPlan', 'ListProvisionedProductPlans', 'CancelProvisionedProductPlan', 'UpdateProvisionedProductPlan', 'ApproveProvisionedProductPlan', 'ListProvisionedProductPlanApprovers', 'ExecuteProvisionedProductPlan', 'DeleteProvisionedProductPlan'],
'type' => 'directory',
- 'children' => [
- 'CreateProvisionedProductPlan',
- 'GetProvisionedProductPlan',
- 'ListProvisionedProductPlans',
- 'CancelProvisionedProductPlan',
- 'UpdateProvisionedProductPlan',
- 'ApproveProvisionedProductPlan',
- 'ListProvisionedProductPlanApprovers',
- 'ExecuteProvisionedProductPlan',
- 'DeleteProvisionedProductPlan',
- ],
+ 'title' => '计划',
+ 'id' => 48233,
],
[
- 'id' => 167563,
- 'title' => '实例',
+ 'children' => ['GetProvisionedProduct', 'ListProvisionedProducts', 'GetTask', 'ListTasks'],
'type' => 'directory',
- 'children' => [
- 'GetProvisionedProduct',
- 'ListProvisionedProducts',
- 'GetTask',
- 'ListTasks',
- ],
+ 'title' => '实例',
+ 'id' => 48228,
],
[
- 'id' => 156842,
- 'title' => '产品',
+ 'children' => ['CopyProduct', 'CreateProduct', 'DeleteProduct', 'UpdateProduct', 'GetProductAsAdmin', 'ListProductsAsAdmin'],
'type' => 'directory',
- 'children' => [
- 'CopyProduct',
- 'CreateProduct',
- 'DeleteProduct',
- 'UpdateProduct',
- 'GetProductAsAdmin',
- 'ListProductsAsAdmin',
- ],
+ 'title' => '产品',
+ 'id' => 48193,
],
[
- 'id' => 156848,
- 'title' => '产品版本',
+ 'children' => ['CreateProductVersion', 'DeleteProductVersion', 'UpdateProductVersion', 'GetProductVersion', 'ListProductVersions'],
'type' => 'directory',
- 'children' => [
- 'CreateProductVersion',
- 'DeleteProductVersion',
- 'UpdateProductVersion',
- 'GetProductVersion',
- 'ListProductVersions',
- ],
+ 'title' => '产品版本',
+ 'id' => 48200,
],
[
- 'id' => 156854,
- 'title' => '模板',
+ 'children' => ['CreateTemplate', 'GetTemplate'],
'type' => 'directory',
- 'children' => [
- 'CreateTemplate',
- 'GetTemplate',
- ],
+ 'title' => '模板',
+ 'id' => 48206,
],
[
- 'id' => 156857,
- 'title' => '产品组合',
+ 'children' => ['CreatePortfolio', 'AssociateProductWithPortfolio', 'DeletePortfolio', 'DisassociateProductFromPortfolio', 'UpdatePortfolio', 'GetPortfolio', 'ListPortfolios'],
'type' => 'directory',
- 'children' => [
- 'CreatePortfolio',
- 'AssociateProductWithPortfolio',
- 'DeletePortfolio',
- 'DisassociateProductFromPortfolio',
- 'UpdatePortfolio',
- 'GetPortfolio',
- 'ListPortfolios',
- ],
+ 'title' => '产品组合',
+ 'id' => 48209,
],
[
- 'id' => 156865,
- 'title' => '约束',
+ 'children' => ['CreateConstraint', 'DeleteConstraint', 'UpdateConstraint', 'GetConstraint'],
'type' => 'directory',
- 'children' => [
- 'CreateConstraint',
- 'DeleteConstraint',
- 'UpdateConstraint',
- 'GetConstraint',
- ],
+ 'title' => '约束',
+ 'id' => 48217,
],
[
- 'id' => 156871,
- 'title' => '授权',
+ 'children' => ['AssociatePrincipalWithPortfolio', 'DisassociatePrincipalFromPortfolio', 'ListPrincipals'],
'type' => 'directory',
- 'children' => [
- 'AssociatePrincipalWithPortfolio',
- 'DisassociatePrincipalFromPortfolio',
- 'ListPrincipals',
- ],
+ 'title' => '授权',
+ 'id' => 48222,
],
[
- 'id' => 156875,
- 'title' => '地域',
+ 'children' => ['ListRegions'],
'type' => 'directory',
- 'children' => [
- 'ListRegions',
- ],
+ 'title' => '地域',
+ 'id' => 48226,
],
[
- 'id' => 181704,
- 'title' => '标签选项',
+ 'children' => ['GetTagOption', 'DisAssociateTagOptionFromResource', 'ListResourcesForTagOption', 'UpdateTagOption', 'ListTagOptions', 'DeleteTagOption', 'CreateTagOption', 'AssociateTagOptionWithResource'],
'type' => 'directory',
- 'children' => [
- 'GetTagOption',
- 'DisAssociateTagOptionFromResource',
- 'ListResourcesForTagOption',
- 'UpdateTagOption',
- 'ListTagOptions',
- 'DeleteTagOption',
- 'CreateTagOption',
- 'AssociateTagOptionWithResource',
- ],
+ 'title' => '标签选项',
+ 'id' => 48243,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetProductAsEndUser' => [
- 'summary' => '终端用户调用GetProductAsEndUser接口查询产品信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ApproveProvisionedProductPlan' => [
+ 'summary' => '审批人审批计划。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'ProductId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'name' => 'PlanId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '计划ID', 'description' => '计划ID。', 'type' => 'string', 'required' => true, 'example' => 'plan-bp1jvmdk2k****'],
+ ],
+ [
+ 'name' => 'ApprovalAction',
+ 'in' => 'formData',
+ 'schema' => ['title' => '审批动作,取值Approve表示同意,Reject表示拒绝', 'description' => '审批动作。取值:'."\n"
+ ."\n\n"
+ .'- Approve:同意。'."\n"
+ .'- Reject:拒绝。', 'type' => 'string', 'required' => true, 'example' => 'Approve'],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => ['title' => '审批意见', 'description' => '审批意见。', 'type' => 'string', 'required' => false, 'example' => 'Approved. Resource creation is allowed.'],
],
],
'responses' => [
@@ -195,214 +118,150 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductSummary' => [
- 'title' => '产品详情',
- 'description' => '产品概要信息。',
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'title' => '产品描述',
- 'description' => '产品描述。',
- 'type' => 'string',
- 'example' => '这是一个产品描述',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '产品创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductArn' => [
- 'title' => '产品ARN',
- 'description' => '产品ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名称',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProviderName' => [
- 'title' => '提供者名称',
- 'description' => '产品提供者。',
- 'type' => 'string',
- 'example' => 'IT团队',
- ],
- 'ProductType' => [
- 'title' => '产品类型',
- 'description' => '产品类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'example' => 'Ros',
- ],
- 'HasDefaultLaunchOption' => [
- 'description' => '是否存在默认启动选项。取值:'."\n"
- ."\n"
- .'- true:存在默认启动选项,启动产品或更新实例时无需填写PortfolioId。'."\n"
- .'- false:没有默认启动选项,启动产品或更新实例时必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。'."\n"
- ."\n"
- .'> 如果产品仅被加入到一个产品组合,则会存在默认启动选项。如果产品被加入到多个产品组合,则会同时存在多个启动选项,但此时没有默认启动选项。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TemplateType' => [
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'example' => 'RosTerraformTemplate',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductSummary\\": {\\n \\"Description\\": \\"这是一个产品描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProviderName\\": \\"IT团队\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"HasDefaultLaunchOption\\": true,\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n}","type":"json"}]',
- 'title' => '终端用户查询产品信息',
- 'description' => '请确保终端用户已被管理员授予相关产品的使用权限。具体操作,请参见[为终端用户授予访问权限](~~405233~~)。',
- ],
- 'ListProductsAsEndUser' => [
- 'summary' => '终端用户调用ListProductsAsEndUser接口查询产品列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ 'title' => '审批计划',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApproveProvisionedProductPlan'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ApproveProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AssociatePrincipalWithPortfolio' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
],
'parameters' => [
[
- 'name' => 'Filters',
- 'in' => 'query',
- 'style' => 'repeatList',
+ 'name' => 'PortfolioId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
+ ],
+ [
+ 'name' => 'PrincipalType',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'RAM实体类型', 'description' => 'RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'required' => true, 'example' => 'RamUser'],
+ ],
+ [
+ 'name' => 'PrincipalId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'RAM实体ID', 'description' => 'RAM实体ID。'."\n"
+ ."\n"
+ .'获取RAM用户ID的方法,请参见[GetUser](~~28681~~)。'."\n"
+ ."\n"
+ .'获取RAM角色ID的方法,请参见[GetRole](~~28711~~)。', 'type' => 'string', 'required' => false, 'example' => '24477111603637****'],
+ ],
+ [
+ 'name' => 'PrincipalPattern',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'example' => 'user/userName'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '过滤条件',
- 'description' => '过滤条件。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '过滤条件的名称',
- 'description' => '过滤条件的名称。取值:'."\n"
- ."\n"
- .'- ProductName:按产品名称查找,完整匹配(忽略大小写)。'."\n"
- .'- FullTextSearch:全文检索,按产品名称、产品提供者、产品描述查找,模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ProductName',
- ],
- 'Value' => [
- 'title' => '过滤条件的值',
- 'description' => '过滤条件的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DEMO-创建ECS',
- ],
- ],
- 'required' => false,
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
- 'required' => false,
- 'maxItems' => 5,
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '创建产品组合授权',
+ 'summary' => '将产品组合授权给账号内的RAM用户或者RAM角色。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociatePrincipalWithPortfolio'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SortBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示产品创建时间。'."\n"
- .'默认取值CreateTime。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:AssociatePrincipalWithPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'AssociateProductWithPortfolio' => [
+ 'summary' => '将产品加入产品组合。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'SortOrder',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序方式',
- 'description' => '排序方式。取值:'."\n"
- ."\n"
- .'- Asc:正序。'."\n"
- .'- Desc(默认值):倒序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'ProductId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'name' => 'PortfolioId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
],
],
'responses' => [
@@ -412,159 +271,61 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductSummaries' => [
- 'title' => '产品列表',
- 'description' => '产品列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '产品概要信息。',
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'title' => '产品描述',
- 'description' => '产品描述。',
- 'type' => 'string',
- 'example' => '这是一个产品描述',
- ],
- 'CreateTime' => [
- 'title' => '产品创建时间',
- 'description' => '产品创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductArn' => [
- 'title' => '产品ARN',
- 'description' => '产品ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名字',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProviderName' => [
- 'title' => '产品提供方',
- 'description' => '产品提供者。',
- 'type' => 'string',
- 'example' => 'IT团队',
- ],
- 'ProductType' => [
- 'title' => '产品类型',
- 'description' => '产品类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'example' => 'Ros',
- ],
- 'HasDefaultLaunchOption' => [
- 'title' => '是否存在默认的启动选项',
- 'description' => '是否存在默认启动选项。取值:'."\n"
- ."\n"
- .'- true:存在默认启动选项,启动产品或更新实例时无需填写PortfolioId。'."\n"
- .'- false:没有默认启动选项,启动产品或更新实例时必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。'."\n"
- ."\n"
- .'> 如果产品仅被加入到一个产品组合,则会存在默认启动选项。如果产品被加入到多个产品组合,则会同时存在多个启动选项,但此时没有默认启动选项。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TemplateType' => [
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'example' => 'RosTerraformTemplate',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页时每页显示的数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductSummaries\\": [\\n {\\n \\"Description\\": \\"这是一个产品描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProviderName\\": \\"IT团队\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"HasDefaultLaunchOption\\": true,\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- 'title' => '终端用户查询产品列表',
- 'description' => '请确保终端用户已被管理员授予相关产品的使用权限。具体操作,请参见[为终端用户授予访问权限](~~405233~~)。',
- ],
- 'ListLaunchOptions' => [
- 'summary' => '查询启动选项列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '将产品加入产品组合',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T02:23:57.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateProductWithPortfolio'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:AssociateProductWithPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'AssociateTagOptionWithResource' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ProductId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'name' => 'ResourceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '标签选项绑定的资源ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp15p96922****'],
+ ],
+ [
+ 'name' => 'TagOptionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '标签选项ID。', 'type' => 'string', 'required' => true, 'example' => 'tag-bp1u6mdf3d****'],
],
],
'responses' => [
@@ -574,245 +335,207 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'LaunchOptionSummaries' => [
- 'title' => '启动选项概要',
- 'description' => '启动选项列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'PortfolioName' => [
- 'title' => '产品组合名称',
- 'description' => '产品组合名称。',
- 'type' => 'string',
- 'example' => 'DEMO-IT服务',
- ],
- 'ConstraintSummaries' => [
- 'title' => '约束概要',
- 'description' => '约束列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ConstraintType' => [
- 'title' => '约束类型',
- 'description' => '约束类型。取值:'."\n"
- .'1. Launch:启动约束。'."\n"
- .'2. Template:模板约束。'."\n"
- .'3. Approval:审批约束。'."\n"
- .'4. StackRegion:地域约束。',
- 'type' => 'string',
- 'example' => 'Launch',
- ],
- 'Description' => [
- 'title' => '约束描述',
- 'description' => '约束描述。',
- 'type' => 'string',
- 'example' => 'Launch as local role TestRole',
- ],
- 'OperationTypes' => [
- 'title' => '操作类型,当约束类型为审批约束时不为空',
- 'description' => '需被审批的操作类型列表,当约束类型为审批约束时不为空。',
- 'type' => 'array',
- 'items' => [
- 'description' => '操作类型,当约束类型为审批约束时不为空。',
- 'type' => 'string',
- 'example' => 'All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct',
- ],
- ],
- 'StackRegions' => [
- 'description' => '终端用户可启动的地域列表,当约束类型为地域约束时不为空。',
- 'type' => 'array',
- 'items' => [
- 'description' => '终端用户可启动的地域。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC833558-AFF4-5935-9AB6-8A12EE7D****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"LaunchOptionSummaries\\": [\\n {\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"PortfolioName\\": \\"DEMO-IT服务\\",\\n \\"ConstraintSummaries\\": [\\n {\\n \\"ConstraintType\\": \\"Launch\\",\\n \\"Description\\": \\"Launch as local role TestRole\\",\\n \\"OperationTypes\\": [\\n \\"All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct\\"\\n ],\\n \\"StackRegions\\": [\\n \\"cn-hangzhou\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询启动选项列表',
- ],
- 'LaunchProduct' => [
- 'summary' => '启动产品。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '将标签选项关联到资源',
+ 'summary' => '将标签选项关联到资源。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateTagOptionWithResource'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:AssociateTagOptionWithResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC833558-AFF4-5935-9AB6-8A12EE7D****\\"\\n}","type":"json"}]',
+ ],
+ 'CancelProvisionedProductPlan' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'ProvisionedProductName',
+ 'name' => 'PlanId',
'in' => 'formData',
+ 'schema' => ['title' => '计划ID', 'description' => '计划ID。', 'type' => 'string', 'required' => true, 'example' => 'plan-bp1jvmdk2k****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '实例名称',
- 'description' => '实例名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DEMO-ECS实例',
- 'maxLength' => 100,
- 'minLength' => 1,
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '取消计划',
+ 'summary' => '取消计划。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelProvisionedProductPlan'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PortfolioId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。'."\n"
- ."\n"
- .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'port-bp1yt7582g****',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CancelProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'CopyProduct' => [
+ 'summary' => '复制产品。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ProductId',
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'SourceProductArn',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'schema' => ['title' => '', 'description' => '源产品ARN。'."\n"
+ .'><notice>被复制产品ARN可来自本账号下的产品,也可来自其他账号通过产品组合共享的产品。></notice>', 'type' => 'string', 'required' => true, 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'."\n"],
],
[
- 'name' => 'ProductVersionId',
+ 'name' => 'TargetProductName',
'in' => 'formData',
+ 'schema' => ['description' => '目标产品名称。', 'type' => 'string', 'required' => false, 'example' => 'DEMO-ECS'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '复制产品',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyProduct'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Parameters',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '用户输入的模板参数。'."\n"
- ."\n"
- .'N最大值为200。'."\n"
- ."\n"
- .'> Parameters为可选参数。如果需要指定Parameters,则Parameters.N.ParameterKey和Parameters.N.ParameterValue必须同时指定。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ParameterKey' => [
- 'description' => '模板中定义的参数名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instance_type',
- ],
- 'ParameterValue' => [
- 'description' => '用户输入的模板参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.s6-c1m1.small',
- ],
- ],
- 'required' => false,
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CopyProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#productId}'],
],
- 'required' => false,
- 'maxItems' => 200,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateConstraint' => [
+ 'summary' => '创建约束。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
[
- 'name' => 'StackRegionId',
+ 'name' => 'ConstraintType',
'in' => 'formData',
- 'schema' => [
- 'title' => 'ROS资源栈所属的地域ID',
- 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n"
- ."\n"
- .'获取ROS支持的地域列表的方法,请参见[DescribeRegions](~~131035~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => '约束类型', 'description' => '约束类型。'."\n"
+ ."\n"
+ .'取值为Launch,表示启动约束。', 'type' => 'string', 'required' => true, 'example' => 'Launch'],
],
[
- 'name' => 'Tags',
+ 'name' => 'Config',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '用户输入的自定义标签。'."\n"
- ."\n"
- .'N最大值为20。'."\n"
- ."\n"
- .'> - Tags为可选参数。如果需要指定Tags,则Tags.N.Key和Tags.N.Value必须同时指定。'."\n"
- .'> - 此标签会传递到资源栈中每个支持标签的资源中。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '用户输入的自定义标签键。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '用户输入的自定义标签值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 20,
- ],
+ 'schema' => ['title' => '约束配置', 'description' => '约束配置。'."\n"
+ ."\n"
+ .'格式:{ "LocalRoleName": "<role_name\\>" }', 'type' => 'string', 'required' => true, 'example' => '{ "LocalRoleName": "TestRole" }'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '约束描述', 'description' => '约束描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'Launch as local role TestRole'],
+ ],
+ [
+ 'name' => 'PortfolioId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '约束所属的产品组合ID', 'description' => '约束所属的产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
+ ],
+ [
+ 'name' => 'ProductId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '约束对应的产品ID', 'description' => '约束对应的产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
],
'responses' => [
@@ -822,42 +545,47 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ConstraintId' => ['title' => '约束ID', 'description' => '约束ID。', 'type' => 'string', 'example' => 'cons-bp1yx7x42v****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '创建约束',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConstraint'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'ram:PassRole', 'validationType' => 'always'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\"\\n}","type":"json"}]',
- 'title' => '启动产品',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ConstraintId\\": \\"cons-bp1yx7x42v****\\"\\n}","type":"json"}]',
],
- 'TerminateProvisionedProduct' => [
- 'summary' => '终止实例。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreatePortfolio' => [
+ 'summary' => '创建产品组合。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -866,19 +594,33 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ProvisionedProductId',
+ 'name' => 'PortfolioName',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pp-bp1ddg1n2a****',
- ],
+ 'schema' => ['title' => '产品组合名称', 'description' => '产品组合名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'DEMO-IT Service', 'maxLength' => 100, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合描述', 'description' => '产品组合描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a portfolio description.'],
+ ],
+ [
+ 'name' => 'ProviderName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '提供者名称', 'description' => '产品组合提供者。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'IT team', 'maxLength' => 100, 'minLength' => 1],
],
],
'responses' => [
@@ -888,37 +630,43 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '终止实例',
- 'description' => '终止实例后实例将从实例列表中删除,终端用户后续无法正常管理该实例的生命周期,请谨慎操作。',
- ],
- 'UpdateProvisionedProduct' => [
- 'summary' => '更新实例。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\"\\n}","type":"json"}]',
+ 'title' => '创建产品组合',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePortfolio'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreatePortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateProduct' => [
+ 'summary' => '创建产品。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -926,129 +674,196 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
'parameters' => [
[
- 'name' => 'PortfolioId',
+ 'name' => 'ProductName',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。'."\n"
- ."\n"
- .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'schema' => ['title' => '产品名称', 'description' => '产品名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'DEMO-Create ECS', 'maxLength' => 100, 'minLength' => 1],
],
[
- 'name' => 'ProductId',
+ 'name' => 'ProductType',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'schema' => ['title' => '产品类型', 'description' => '产品类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'required' => true, 'example' => 'Ros'],
],
[
- 'name' => 'ProductVersionId',
+ 'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。'."\n"
- ."\n"
- .'> 当输入的ProductVersionId和Parameters与之前相比,两者都没有变化时,不允许更新实例。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****',
- ],
+ 'schema' => ['title' => '产品描述', 'description' => '产品描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a product description.'],
],
[
- 'name' => 'Parameters',
+ 'name' => 'ProviderName',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'schema' => ['title' => '提供者名称', 'description' => '产品提供者。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'IT team', 'maxLength' => 100, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'ProductVersionParameters',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '用户输入的模板参数。'."\n"
- ."\n"
- .'N最大值为200。'."\n"
- ."\n"
- .'> - Parameters为可选参数。如果需要指定Parameters,则Parameters.N.ParameterKey和Parameters.N.ParameterValue必须同时指定。'."\n"
- .'> - 当输入的ProductVersionId和Parameters与之前相比,两者都没有变化时,不允许更新实例。'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ParameterKey' => [
- 'description' => '模板中定义的参数名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instance_type',
- ],
- 'ParameterValue' => [
- 'description' => '用户输入的模板参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.s6-c1m1.small',
- ],
- ],
- 'required' => false,
+ 'title' => '产品版本相关的参数',
+ 'description' => '产品版本信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => '1.0', 'maxLength' => 100, 'minLength' => 1],
+ 'TemplateType' => ['title' => '模板类型', 'description' => '模板类型。'."\n"
+ ."\n"
+ .'取值为RosTerraformTemplate,表示阿里云资源编排服务(ROS)支持的Terraform模板。', 'type' => 'string', 'required' => false, 'example' => 'RosTerraformTemplate'],
+ 'TemplateUrl' => ['title' => '模板的URL地址', 'description' => '模板的URL地址。'."\n"
+ ."\n"
+ .'获取模板URL地址的方法,请参见[CreateTemplate](~~CreateTemplate~~)。', 'type' => 'string', 'required' => false, 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json'],
+ 'Description' => ['title' => '产品版本描述', 'description' => '产品版本描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a product version description.'],
+ 'Guidance' => ['title' => '推荐信息', 'description' => '推荐信息。取值:'."\n"
+ ."\n"
+ .'- Default(默认值):无。'."\n"
+ .'- Recommended:稳定版。'."\n"
+ .'- Latest:最新版。'."\n"
+ .'- Deprecated:将废弃。', 'type' => 'string', 'required' => false, 'example' => 'Default'],
+ 'Active' => ['title' => '是否启用', 'description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
- 'maxItems' => 200,
],
],
[
- 'name' => 'ProvisionedProductId',
+ 'name' => 'TemplateType',
'in' => 'formData',
+ 'schema' => ['description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'required' => false, 'example' => 'RosTerraformTemplate'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pp-bp1ddg1n2a****',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductVersionId' => ['description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ ],
],
],
- [
- 'name' => 'Tags',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '用户输入的自定义标签。'."\n"
- ."\n"
- .'N最大值为20。'."\n"
- ."\n"
- .'> - Tags为可选参数。如果需要指定Tags,则Tags.N.Key和Tags.N.Value必须同时指定。'."\n"
- .'> - 此标签会传递到资源栈中每个支持标签的资源中。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '用户输入的自定义标签键。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '用户输入的自定义标签值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
- ],
- 'required' => false,
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\"\\n}","type":"json"}]',
+ 'title' => '创建产品',
+ 'description' => '调用该接口前,请先调用[CreateTemplate](~~CreateTemplate~~)创建模板。',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-27T10:57:48.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-12-26T03:37:34.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-12-02T01:51:02.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/*'],
],
- 'required' => false,
- 'maxItems' => 20,
],
],
],
+ ],
+ 'CreateProductVersion' => [
+ 'summary' => '创建产品版本。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'ProductVersionName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本名称', 'description' => '产品版本名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => '1.0', 'maxLength' => 100, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模板类型', 'description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'required' => true, 'example' => 'RosTerraformTemplate'],
+ ],
+ [
+ 'name' => 'TemplateUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模板的OSS地址', 'description' => '模板的URL地址。'."\n"
+ ."\n"
+ .'获取模板URL地址的方法,请参见[CreateTemplate](~~CreateTemplate~~)。', 'type' => 'string', 'required' => true, 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本描述', 'description' => '产品版本描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a product version description.'],
+ ],
+ [
+ 'name' => 'Guidance',
+ 'in' => 'formData',
+ 'schema' => ['title' => '推荐信息', 'description' => '推荐信息。取值:'."\n"
+ ."\n"
+ .'- Default(默认值):无。'."\n"
+ .'- Recommended:稳定版。'."\n"
+ .'- Latest:最新版。'."\n"
+ .'- Deprecated:将废弃。', 'type' => 'string', 'required' => false, 'example' => 'Default'],
+ ],
+ [
+ 'name' => 'Active',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否启用', 'description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'ProductId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本所属的产品ID', 'description' => '产品版本所属的产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
@@ -1056,136 +871,94 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\"\\n}","type":"json"}]',
+ 'title' => '创建产品版本',
+ 'description' => '调用该接口前,请先调用[CreateTemplate](~~CreateTemplate~~)创建模板。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\"\\n}","type":"json"}]',
- 'title' => '更新实例',
],
'CreateProvisionedProductPlan' => [
'summary' => '创建计划。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'PlanName',
'in' => 'formData',
- 'schema' => [
- 'title' => '计划名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'description' => '计划名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DEMO-ECS实例',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
+ 'schema' => ['title' => '计划名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'description' => '计划名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'DEMO-ECS-Instance', 'maxLength' => 100, 'minLength' => 1],
],
[
'name' => 'PlanType',
'in' => 'formData',
- 'schema' => [
- 'title' => '计划类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'description' => '计划类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ros',
- ],
+ 'schema' => ['title' => '计划类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'description' => '计划类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'required' => true, 'example' => 'Ros'],
],
[
'name' => 'ProvisionedProductName',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'description' => '实例名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DEMO-ECS实例',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
+ 'schema' => ['title' => '实例名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'description' => '实例名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'DEMO-ECS-Instance', 'maxLength' => 100, 'minLength' => 1],
],
[
'name' => 'PortfolioId',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID。',
- 'description' => '产品组合ID。'."\n"
- ."\n"
- .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'schema' => ['title' => '产品组合ID。', 'description' => '产品组合ID。'."\n"
+ ."\n"
+ .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。', 'type' => 'string', 'required' => false, 'example' => 'port-bp1yt7582g****'],
],
[
'name' => 'ProductId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'ProductId',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'schema' => ['title' => 'ProductId', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
[
'name' => 'ProductVersionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本ID。'."\n"
- ."\n",
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****',
- ],
+ 'schema' => ['title' => '产品版本ID。'."\n"
+ ."\n", 'description' => '产品版本ID。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'],
],
[
'name' => 'Parameters',
@@ -1204,23 +977,12 @@
'items' => [
'type' => 'object',
'properties' => [
- 'ParameterKey' => [
- 'title' => '模板中定义的参数名称。'."\n"
- ."\n",
- 'description' => '模板中定义的参数名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instance_type',
- ],
- 'ParameterValue' => [
- 'title' => '用户输入的模板参数值。',
- 'description' => '用户输入的模板参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.s6-c1m1.small',
- ],
+ 'ParameterKey' => ['title' => '模板中定义的参数名称。'."\n"
+ ."\n", 'description' => '模板中定义的参数名称。', 'type' => 'string', 'required' => false, 'example' => 'instance_type'],
+ 'ParameterValue' => ['title' => '用户输入的模板参数值。', 'description' => '用户输入的模板参数值。', 'type' => 'string', 'required' => false, 'example' => 'ecs.s6-c1m1.small'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
'maxItems' => 200,
@@ -1229,15 +991,9 @@
[
'name' => 'StackRegionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。',
- 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n"
- ."\n"
- .'获取ROS支持的地域列表的方法,请参见[DescribeRegions](~~131035~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['title' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。', 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n"
+ ."\n"
+ .'获取ROS支持的地域列表的方法,请参见[DescribeRegions](~~131035~~)。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Tags',
@@ -1269,19 +1025,14 @@
'enumValueTitles' => [],
'example' => 'k1',
],
- 'Value' => [
- 'title' => '用户输入的自定义标签值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以acs:开头,不能包含http://或者https://。',
- 'description' => '用户输入的自定义标签值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
+ 'Value' => ['title' => '用户输入的自定义标签值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以acs:开头,不能包含http://或者https://。', 'description' => '用户输入的自定义标签值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
'maxItems' => 20,
@@ -1290,29 +1041,17 @@
[
'name' => 'OperationType',
'in' => 'formData',
- 'schema' => [
- 'title' => '计划操作类型,取值为All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct。',
- 'description' => '计划操作类型,取值:'."\n"
- .'- LaunchProduct(默认):启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LaunchProduct',
- ],
+ 'schema' => ['title' => '计划操作类型,取值为All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct。', 'description' => '计划操作类型,取值:'."\n"
+ .'- LaunchProduct(默认):启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'required' => false, 'example' => 'LaunchProduct'],
],
[
'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '计划描述',
- 'description' => '计划描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '创建ECS',
- ],
+ 'schema' => ['title' => '计划描述', 'description' => '计划描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'Create ECS'],
],
],
'responses' => [
@@ -1323,874 +1062,385 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'PlanId' => [
- 'title' => '计划ID。',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'example' => 'plan-bp1jvmdk2k****',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID。',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'PlanId' => ['title' => '计划ID。', 'description' => '计划ID。', 'type' => 'string', 'example' => 'plan-bp1jvmdk2k****'],
+ 'ProvisionedProductId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PlanId\\": \\"plan-bp1jvmdk2k****\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\"\\n}","type":"json"}]',
'title' => '创建计划',
- ],
- 'GetProvisionedProductPlan' => [
- 'summary' => '查询计划信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-16T08:01:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-06-30T06:39:12.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProvisionedProductPlan'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateTagOption' => [
+ 'summary' => '创建标签选项。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PlanId',
+ 'name' => 'Key',
'in' => 'formData',
- 'schema' => [
- 'description' => '计划ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'plan-bp1jvmdk2k****',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '用户输入的标签选项键。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => true, 'example' => 'k1', 'maxLength' => 128, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'Value',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户输入的标签选项值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => true, 'example' => 'v1', 'maxLength' => 128, 'minLength' => 1],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'PlanDetail' => [
- 'title' => '计划详情。'."\n"
- ."\n",
- 'description' => '计划详情。',
- 'type' => 'object',
- 'properties' => [
- 'PlanId' => [
- 'title' => '计划ID。',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'example' => 'plan-bp1jvmdk2k****',
- ],
- 'PlanName' => [
- 'title' => '计划名称。'."\n"
- ."\n",
- 'description' => '计划名称。',
- 'type' => 'string',
- 'example' => 'DEMO-ECS实例',
- ],
- 'PlanType' => [
- 'title' => '计划类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'description' => '计划类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'example' => 'Ros',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID。'."\n"
- ."\n",
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'ProductId' => [
- 'title' => '产品ID。'."\n"
- ."\n",
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID。'."\n"
- ."\n",
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID。'."\n"
- ."\n",
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
- 'ProvisionedProductName' => [
- 'title' => '实例名称。',
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'DEMO-ECS实例',
- ],
- 'Parameters' => [
- 'title' => '用户输入的模板参数。'."\n"
- ."\n",
- 'description' => '用户输入的模板参数。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ParameterKey' => [
- 'title' => '模板中定义的参数名称。'."\n"
- ."\n",
- 'description' => '模板中定义的参数名称。',
- 'type' => 'string',
- 'example' => 'instance_type',
- ],
- 'ParameterValue' => [
- 'title' => '用户输入的模板参数值。'."\n"
- ."\n",
- 'description' => '用户输入的模板参数值。',
- 'type' => 'string',
- 'example' => 'ecs.s6-c1m1.small',
- ],
- ],
- ],
- ],
- 'StackId' => [
- 'title' => '阿里云资源编排服务(ROS)资源栈ID。'."\n"
- ."\n",
- 'description' => '阿里云资源编排服务(ROS)资源栈ID。',
- 'type' => 'string',
- 'example' => '137e31df-3754-40b4-be2f-c793ad84****',
- ],
- 'StackRegionId' => [
- 'title' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n"
- ."\n",
- 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Status' => [
- 'title' => '计划状态。',
- 'description' => '计划状态。取值:'."\n"
- .'- PreviewInProgress:预检中。'."\n"
- .'- PreviewSuccess:预检成功。'."\n"
- .'- PreviewFailed:预检失败。'."\n"
- .'- ApplicationInProgress:审批中。'."\n"
- .'- ApplicationApproved:审批通过。'."\n"
- .'- ApplicationRejected:审批被拒绝。'."\n"
- .'- ExecuteInProgress:执行中。'."\n"
- .'- ExecuteSuccess:执行成功。'."\n"
- .'- ExecuteFailed:执行失败。'."\n"
- .'- Canceled:已取消。',
- 'type' => 'string',
- 'example' => 'PreviewSuccess',
- ],
- 'StatusMessage' => [
- 'title' => '计划状态信息。',
- 'description' => '计划状态信息。'."\n"
- ."\n"
- .'> 仅在计划状态为PreviewFailed或ExecuteFailed时,返回该参数。',
- 'type' => 'string',
- 'example' => 'Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...',
- ],
- 'CreateTime' => [
- 'title' => '计划创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'description' => '计划创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-23T09:46:27Z',
- ],
- 'UpdateTime' => [
- 'title' => '计划最后更新时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'description' => '计划最后更新时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-23T09:47:29Z',
- ],
- 'Tags' => [
- 'title' => '用户自定义标签列表。'."\n"
- ."\n",
- 'description' => '用户自定义标签列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '用户自定义标签键。'."\n"
- ."\n",
- 'description' => '用户自定义标签键。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'title' => '用户自定义标签值。'."\n"
- ."\n",
- 'description' => '用户自定义标签值。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- ],
- ],
- ],
- 'OperationType' => [
- 'title' => '计划操作类型,取值为All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct。',
- 'description' => '计划操作类型。取值:'."\n"
- ."\n"
- .'- LaunchProduct:启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'example' => 'LaunchProduct',
- ],
- 'Description' => [
- 'title' => '计划描述。',
- 'description' => '计划描述。',
- 'type' => 'string',
- 'example' => '创建ECS。',
- ],
- 'AssignedApprovers' => [
- 'title' => '计划审批人列表。',
- 'description' => '计划审批人列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PrincipalType' => [
- 'title' => '计划审批人的RAM实体类型。取值:'."\n"
- ."\n"
- .'RamUser:RAM用户。'."\n"
- .'RamRole:RAM角色。'."\n",
- 'description' => '计划审批人的RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'PrincipalName' => [
- 'title' => '计划归属人的RAM实体名称。'."\n",
- 'description' => '计划审批人的RAM实体名称。',
- 'type' => 'string',
- 'example' => 'approver',
- ],
- ],
- ],
- ],
- 'OwnerPrincipalType' => [
- 'title' => '计划归属人的RAM实体类型。取值:'."\n"
- ."\n"
- .'RamUser:RAM用户。'."\n"
- .'RamRole:RAM角色。'."\n",
- 'description' => '计划归属人的RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'OwnerPrincipalId' => [
- 'title' => '计划归属人的RAM实体ID。'."\n"
- ."\n",
- 'description' => '计划归属人的RAM实体ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '27740196382623****',
- ],
- 'ApprovalDetail' => [
- 'title' => '计划审批详情。',
- 'description' => '计划审批详情。',
- 'type' => 'object',
- 'properties' => [
- 'OperationRecords' => [
- 'title' => '用户操作记录。',
- 'description' => '操作记录。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Operator' => [
- 'title' => '操作人。',
- 'description' => '已对计划进行操作的RAM实体。',
- 'type' => 'object',
- 'properties' => [
- 'PrincipalType' => [
- 'title' => '操作人的RAM实体类型。取值:'."\n"
- ."\n"
- .'RamUser:RAM用户。'."\n"
- .'RamRole:RAM角色。',
- 'description' => 'RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'PrincipalId' => [
- 'title' => '操作人的RAM实体ID。',
- 'description' => 'RAM实体ID。',
- 'type' => 'string',
- 'example' => '277401963826235***'."\n",
- ],
- 'PrincipalName' => [
- 'title' => '操作人的RAM实体名称。',
- 'description' => '操作人的RAM实体名称。',
- 'type' => 'string',
- 'example' => 'approver',
- ],
- ],
- ],
- 'Comment' => [
- 'title' => '操作人的审批附加意见。',
- 'description' => '操作人的审批附加意见。',
- 'type' => 'string',
- 'example' => '同意。',
- ],
- 'CreateTime' => [
- 'title' => '操作时间。',
- 'description' => '操作时间。',
- 'type' => 'string',
- 'example' => '2022-03-22T05:56:14Z',
- ],
- 'ApprovalAction' => [
- 'title' => '操作人对计划进行的操作类型。取值:'."\n"
- ."\n"
- .'Submit:提交计划。'."\n"
- .'Cancel:取消计划。'."\n"
- .'Approve:审批通过。'."\n"
- .'Reject:审批拒绝。',
- 'description' => '操作人对计划进行的操作类型。取值:'."\n"
- ."\n"
- .'- Submit:提交计划。'."\n"
- .'- Cancel:取消计划。'."\n"
- .'- Approve:审批通过。'."\n"
- .'- Reject:审批拒绝。',
- 'type' => 'string',
- 'example' => 'Approve',
- ],
- ],
- ],
- ],
- 'TodoTaskActivities' => [
- 'title' => '计划正在执行的操作。',
- 'description' => '计划正在执行的操作。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ActivityName' => [
- 'title' => '计划正在执行的活动名。',
- 'description' => '计划正在执行的操作名。',
- 'type' => 'string',
- 'example' => 'ApproverNode-1',
- ],
- 'Tasks' => [
- 'title' => '委派任务列表。',
- 'description' => '委派任务列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Operator' => [
- 'title' => '操作人。',
- 'description' => '可对计划进行操作的RAM实体。',
- 'type' => 'object',
- 'properties' => [
- 'PrincipalType' => [
- 'title' => '操作人的RAM实体类型。取值:'."\n"
- ."\n"
- .'RamUser:RAM用户。'."\n"
- .'RamRole:RAM角色。',
- 'description' => 'RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'PrincipalName' => [
- 'title' => '操作人的RAM实体名称。',
- 'description' => 'RAM实体名称。',
- 'type' => 'string',
- 'example' => 'approver',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'OwnerPrincipalName' => [
- 'title' => '计划归属人的RAM实体名称。',
- 'description' => '计划归属人的RAM实体名称。',
- 'type' => 'string',
- 'example' => 'endUser',
- ],
- 'Uid' => [
- 'title' => '计划归属人的云账号ID。',
- 'description' => '计划归属人的云账号ID。',
- 'type' => 'string',
- 'example' => '146611588617****',
- ],
- ],
- ],
- 'ProductDetail' => [
- 'title' => '计划产品详情。',
- 'description' => '计划产品详情。',
- 'type' => 'object',
- 'properties' => [
- 'ProductArn' => [
- 'title' => '产品ARN。'."\n"
- ."\n",
- 'description' => '产品ARN。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****',
- ],
- 'Description' => [
- 'title' => '产品描述。'."\n"
- ."\n",
- 'description' => '产品描述。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '这是一个产品描述',
- ],
- 'CreateTime' => [
- 'title' => '创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'description' => '创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'ProductId' => [
- 'title' => '产品ID。'."\n"
- ."\n",
- 'description' => '产品ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名称。'."\n"
- ."\n",
- 'description' => '产品名称。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProviderName' => [
- 'title' => '产品提供者。'."\n"
- ."\n",
- 'description' => '产品提供者。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'IT团队',
- ],
- 'ProductType' => [
- 'title' => '产品类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'description' => '产品类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'example' => 'Ros',
- ],
- ],
- ],
- 'ResourceChanges' => [
- 'title' => '计划资源变更列表。',
- 'description' => '计划资源变更列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'LogicalResourceId' => [
- 'title' => '资源逻辑ID。',
- 'description' => '资源逻辑ID。',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- 'PhysicalResourceId' => [
- 'title' => '资源物理ID。'."\n"
- ."\n"
- .'当Action为Modify或Remove时,返回本参数。',
- 'description' => '资源物理ID。'."\n"
- ."\n"
- .'> 当Action为Modify或Remove时,返回本参数。',
- 'type' => 'string',
- 'example' => 'i-bp13lmam3qd9q6il****',
- ],
- 'Replacement' => [
- 'title' => '模板是否为替换更新。取值:'."\n"
- ."\n"
- .'True:替换更新。'."\n"
- .'False:修改更新。'."\n"
- .'Conditional:可能是替换更新,模板运行时才能确定。',
- 'description' => '模板是否为替换更新。取值:'."\n"
- ."\n"
- .'- True:替换更新。'."\n"
- .'- False:修改更新。'."\n"
- .'- Conditional:可能是替换更新,模板运行时才能确定。'."\n"
- .'> 当Action为Modify时,返回本参数。',
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'ResourceType' => [
- 'title' => '资源类型。',
- 'description' => '资源类型。',
- 'type' => 'string',
- 'example' => 'alicloud_instance'."\n",
- ],
- 'Action' => [
- 'title' => '资源行为。取值:'."\n"
- ."\n"
- .'Add:增加资源。'."\n"
- .'Modify:修改资源。'."\n"
- .'Remove:删除资源。'."\n"
- .'None:无变化。',
- 'description' => '资源行为。取值:'."\n"
- ."\n"
- .'- Add:增加资源。'."\n"
- .'- Modify:修改资源。'."\n"
- .'- Remove:删除资源。'."\n"
- .'- None:无变化。',
- 'type' => 'string',
- 'example' => 'Add',
- ],
- ],
- ],
- ],
- 'ProductVersionDetail' => [
- 'title' => '产品版本详情',
- 'description' => '产品版本详情。',
+ 'TagOptionDetail' => [
+ 'description' => '标签选项详情。',
'type' => 'object',
'properties' => [
- 'Active' => [
- 'title' => '是否启用',
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Description' => [
- 'title' => '产品版本描述',
- 'description' => '产品版本描述。',
- 'type' => 'string',
- 'example' => '这是一个产品版本描述',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '产品版本创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'Guidance' => [
- 'title' => '推荐信息',
- 'description' => '推荐信息。取值:'."\n"
- ."\n"
- .'- Default(默认值):无。'."\n"
- .'- Recommended:稳定版。'."\n"
- .'- Latest:最新版。'."\n"
- .'- Deprecated:将废弃。',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。',
- 'type' => 'string',
- 'example' => '1.0.0',
- ],
- 'ProductId' => [
- 'title' => '产品版本所属的产品ID',
- 'description' => '产品版本所属的产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'TemplateUrl' => [
- 'title' => '模板的OSS地址',
- 'description' => '模板的URL地址。',
- 'type' => 'string',
- 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json',
- ],
- 'TemplateType' => [
- 'title' => '模板类型',
- 'description' => '模板类型。'."\n"
- ."\n"
- .'取值为RosTerraformTemplate,表示阿里云资源编排服务(ROS)支持的Terraform模板。',
- 'type' => 'string',
- 'example' => 'RosTerraformTemplate',
- ],
+ 'Active' => ['description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'TagOptionId' => ['description' => '标签选项ID。', 'type' => 'string', 'example' => 'tag-bp1r3mxq3t****'],
+ 'Key' => ['description' => '用户输入的标签选项键。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '用户输入的标签选项值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'example' => 'v1'],
+ 'Owner' => ['description' => '标签选项归属人云账号ID。', 'type' => 'string', 'example' => '133413081827****'."\n"],
],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A48A5F12-6098-54A1-A389-6834AF27****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PlanDetail\\": {\\n \\"PlanId\\": \\"plan-bp1jvmdk2k****\\",\\n \\"PlanName\\": \\"DEMO-ECS实例\\",\\n \\"PlanType\\": \\"Ros\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"DEMO-ECS实例\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"instance_type\\",\\n \\"ParameterValue\\": \\"ecs.s6-c1m1.small\\"\\n }\\n ],\\n \\"StackId\\": \\"137e31df-3754-40b4-be2f-c793ad84****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"PreviewSuccess\\",\\n \\"StatusMessage\\": \\"Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"UpdateTime\\": \\"2022-05-23T09:47:29Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"OperationType\\": \\"LaunchProduct\\",\\n \\"Description\\": \\"创建ECS。\\",\\n \\"AssignedApprovers\\": [\\n {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalName\\": \\"approver\\"\\n }\\n ],\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"27740196382623****\\",\\n \\"ApprovalDetail\\": {\\n \\"OperationRecords\\": [\\n {\\n \\"Operator\\": {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalId\\": \\"277401963826235***\\\\n\\",\\n \\"PrincipalName\\": \\"approver\\"\\n },\\n \\"Comment\\": \\"同意。\\",\\n \\"CreateTime\\": \\"2022-03-22T05:56:14Z\\",\\n \\"ApprovalAction\\": \\"Approve\\"\\n }\\n ],\\n \\"TodoTaskActivities\\": [\\n {\\n \\"ActivityName\\": \\"ApproverNode-1\\",\\n \\"Tasks\\": [\\n {\\n \\"Operator\\": {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalName\\": \\"approver\\"\\n }\\n }\\n ]\\n }\\n ]\\n },\\n \\"OwnerPrincipalName\\": \\"endUser\\",\\n \\"Uid\\": \\"146611588617****\\"\\n },\\n \\"ProductDetail\\": {\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"Description\\": \\"这是一个产品描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProviderName\\": \\"IT团队\\",\\n \\"ProductType\\": \\"Ros\\"\\n },\\n \\"ResourceChanges\\": [\\n {\\n \\"LogicalResourceId\\": \\"instance\\",\\n \\"PhysicalResourceId\\": \\"i-bp13lmam3qd9q6il****\\",\\n \\"Replacement\\": \\"True\\",\\n \\"ResourceType\\": \\"alicloud_instance\\\\n\\",\\n \\"Action\\": \\"Add\\"\\n }\\n ],\\n \\"ProductVersionDetail\\": {\\n \\"Active\\": true,\\n \\"Description\\": \\"这是一个产品版本描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"Guidance\\": \\"Default\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0.0\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询计划信息',
- ],
- 'ListProvisionedProductPlans' => [
- 'summary' => '查询计划列表。可分用户维度和审批维度进行查询。',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建标签选项',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTagOption'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagOptionDetail\\": {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1r3mxq3t****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n },\\n \\"RequestId\\": \\"A48A5F12-6098-54A1-A389-6834AF27****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateTemplate' => [
+ 'summary' => '创建模板。服务目录会保存用户上传的模板,并返回模板的URL地址。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Filters',
- 'in' => 'query',
+ 'name' => 'TemplateBody',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模板内容', 'description' => '模板内容。'."\n"
+ ."\n"
+ .'关于模板语法的详情,请参见[Terraform类型模板结构](~~184397~~)。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "ROSTemplateFormatVersion": "2015-09-01",'."\n"
+ .' "Transform": "Aliyun::Terraform-v1.1",'."\n"
+ .' "Workspace": {'."\n"
+ .' "main.tf": "variable \\"name\\" { default = \\"auto_provisioning_group\\"}"'."\n"
+ .' },'."\n"
+ .' "Outputs": {}'."\n"
+ .'}'],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模板类型', 'description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'required' => true, 'example' => 'RosTerraformTemplate'],
+ ],
+ [
+ 'name' => 'TerraformVariables',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'title' => '过滤条件。',
- 'description' => '过滤条件。',
+ 'description' => 'Terraform模板变量设置,以结构化的方式表示,服务目录会将变量设置应用到模板中。'."\n"
+ ."\n"
+ .'> 变量必须在Terraform模板中存在。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '过滤条件的名称。取值:'."\n"
- ."\n"
- .'ProvisionedProductPlanName:按计划名称查找,完整匹配(忽略大小写)。'."\n"
- .'ProvisionedProductPlanApprover:按审批人精确查找,格式为RamUser/RamRole:审批人名称,可多选。'."\n"
- .'ProvisionedProductPlanApproverName:按审批人名称查找,直接输入审批人的RAM实体名称,可多选。'."\n"
- .'ProvisionedProductPlanStatus:按计划状态查找,直接输入审批人的RAM实体名称,可多选。'."\n"
- .'ProvisionedProductPlanOwnerUid:按计划归属云账号ID精确查找。'."\n"
- .'FullTextSearch:全文检索,按计划名称查找,模糊匹配。',
- 'description' => '过滤条件的名称。取值:'."\n"
- ."\n"
- .'- ProvisionedProductPlanName:按计划名称查找,完整匹配(忽略大小写)。'."\n"
- .'- ProvisionedProductPlanApprover:按审批人精确查找,格式为`RamUser/RamRole:<审批人名称>`,可多选。'."\n"
- .'- ProvisionedProductPlanApproverName:按审批人名称查找,直接输入审批人的RAM实体名称,可多选。'."\n"
- .'- ProvisionedProductPlanStatus:按计划状态查找,直接输入计划状态,可多选。'."\n"
- .'- ProvisionedProductPlanOwnerUid:按计划归属云账号ID精确查找。'."\n"
- .'- FullTextSearch:全文检索,按计划名称查找,模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'FullTextSearch',
- ],
- 'Value' => [
- 'title' => '过滤条件的值。'."\n"
- ."\n",
- 'description' => '过滤条件的值。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ECS',
- ],
+ 'VariableName' => ['description' => '变量名称。', 'type' => 'string', 'required' => false, 'example' => 'instance_type'],
+ 'Description' => ['description' => '变量描述。'."\n"
+ ."\n"
+ .'关于变量描述的格式,请参见[Terraform代码开发方式和建议](~~322216~~)。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "Label": { "zh-cn": "实例规格", "en": "Instance Type" },'."\n"
+ .' "AllowedValues": ['."\n"
+ .' "ecs.s6-c1m1.small",'."\n"
+ .' "ecs.s6-c1m2.large",'."\n"
+ .' "ecs.s6-c1m2.xlarge"'."\n"
+ .' ]'."\n"
+ .'}'."\n"],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
- 'maxItems' => 5,
+ 'maxItems' => 20,
],
],
- [
- 'name' => 'SortBy',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示实例创建时间。',
- 'description' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示计划创建时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'TemplateUrl' => ['title' => '模板的OSS地址', 'description' => '模板的URL地址。', 'type' => 'string', 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '创建模板',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-22T02:59:38.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SortOrder',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序方式。取值:'."\n"
- ."\n"
- .'Asc:正序。'."\n"
- .'Desc:倒序。',
- 'description' => '排序方式。取值:'."\n"
- ."\n"
- .'- Asc:正序。'."\n"
- .'- Desc(默认值):倒序。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Asc' => 'Asc',
- 'Desc' => 'Desc',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'example' => 'Desc',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteConstraint' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
[
- 'name' => 'PageSize',
- 'in' => 'query',
+ 'name' => 'ConstraintId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '约束ID', 'description' => '约束ID。', 'type' => 'string', 'required' => true, 'example' => 'cons-bp1yx7x42v****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ ],
],
],
- [
- 'name' => 'AccessLevelFilter',
- 'in' => 'query',
- 'schema' => [
- 'title' => '访问过滤器。取值:'."\n"
- ."\n"
- .'User(默认值):用户。'."\n"
- .'Account:账号。'."\n"
- .'ResourceDirectory:资源目录。',
- 'description' => '访问过滤器。取值:'."\n"
- ."\n"
- .'- User(默认值):用户。'."\n"
- .'- Account:账号。'."\n"
- .'- ResourceDirectory:资源目录。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'User',
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '删除约束',
+ 'summary' => '删除约束。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'DeletePortfolio' => [
+ 'summary' => '删除产品组合。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ApprovalFilter',
- 'in' => 'query',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
+ [
+ 'name' => 'PortfolioId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '审批维度访问过滤器。取值:'."\n"
- ."\n"
- .'ReceivedRequests:待审批的。'."\n"
- .'ApprovalHistory:审批历史。'."\n"
- .'AccountRequests:账号级别全部审批。'."\n"
- .'ResourceDirectoryRequests:资源目录级别全部审批。',
- 'description' => '审批维度访问过滤器。取值:'."\n"
- ."\n"
- .'- ReceivedRequests:待我审批。'."\n"
- .'- ApprovalHistory:审批历史。'."\n"
- .'- AccountRequests:账号级别全部审批。'."\n"
- .'- ResourceDirectoryRequests:资源目录级别全部审批。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ReceivedRequests',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '删除产品组合',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePortfolio'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ProvisionedProductId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例ID。',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pp-bp1ddg1n2a****',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeletePortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteProduct' => [
+ 'summary' => '删除产品。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
+ [
+ 'name' => 'ProductId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
@@ -2198,308 +1448,39 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****',
- ],
- 'PlanDetails' => [
- 'title' => '计划列表。'."\n",
- 'description' => '计划列表。'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PlanId' => [
- 'title' => '计划ID。',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'example' => 'plan-bp18mmdh2u****',
- ],
- 'PlanName' => [
- 'title' => '计划名称。'."\n",
- 'description' => '计划名称。'."\n",
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS-637****',
- ],
- 'PlanType' => [
- 'title' => '计划类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'description' => '计划类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'example' => 'Ros',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID。'."\n",
- 'description' => '产品组合ID。'."\n",
- 'type' => 'string',
- 'example' => 'port-bp1438kf2j****',
- ],
- 'ProductId' => [
- 'title' => '产品ID。'."\n",
- 'description' => '产品ID。'."\n",
- 'type' => 'string',
- 'example' => 'prod-bp1rtrnh2c****',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID。'."\n",
- 'description' => '产品版本ID。'."\n",
- 'type' => 'string',
- 'example' => 'pv-bp19udk22v****',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID。'."\n",
- 'description' => '实例ID。'."\n",
- 'type' => 'string',
- 'example' => 'pp-bp1c35162d****',
- ],
- 'Parameters' => [
- 'title' => '用户输入的模板参数。'."\n",
- 'description' => '用户输入的模板参数。'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ParameterKey' => [
- 'title' => '模板中定义的参数名称。'."\n",
- 'description' => '模板中定义的参数名称。'."\n",
- 'type' => 'string',
- 'example' => 'role_name',
- ],
- 'ParameterValue' => [
- 'title' => '用户输入的模板参数值。'."\n",
- 'description' => '用户输入的模板参数值。'."\n",
- 'type' => 'string',
- 'example' => 'Test-8',
- ],
- ],
- ],
- ],
- 'ProvisionedProductName' => [
- 'title' => '实例名称。',
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'rds-MYSQL-875****',
- ],
- 'StackId' => [
- 'title' => '阿里云资源编排服务(ROS)资源栈ID。'."\n",
- 'description' => '阿里云资源编排服务(ROS)资源栈ID。'."\n",
- 'type' => 'string',
- 'example' => '2599090a-309e-4306-b989-17ba66a9****',
- ],
- 'StackRegionId' => [
- 'title' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n",
- 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'Status' => [
- 'title' => '计划状态。',
- 'description' => '计划状态。取值:'."\n"
- .'- PreviewInProgress:预检中。'."\n"
- .'- PreviewSuccess:预检成功。'."\n"
- .'- PreviewFailed:预检失败。'."\n"
- .'- ApplicationInProgress:审批中。'."\n"
- .'- ApplicationApproved:审批通过。'."\n"
- .'- ApplicationRejected:审批被拒绝。'."\n"
- .'- ExecuteInProgress:执行中。'."\n"
- .'- ExecuteSuccess:执行成功。'."\n"
- .'- ExecuteFailed:执行失败。'."\n"
- .'- Canceled:已取消。',
- 'type' => 'string',
- 'example' => 'PreviewSuccess',
- ],
- 'StatusMessage' => [
- 'title' => '计划状态信息。',
- 'description' => '计划状态信息。'."\n"
- ."\n"
- .'> 仅在计划状态为PreviewFailed或ExecuteFailed时,返回该参数。',
- 'type' => 'string',
- 'example' => 'Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...',
- ],
- 'CreateTime' => [
- 'title' => '计划创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'description' => '计划创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-09-13T02:01:22Z',
- ],
- 'UpdateTime' => [
- 'title' => '计划最后更新时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'description' => '计划最后更新时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-07-18T06:02:35.075Z',
- ],
- 'Tags' => [
- 'title' => '用户自定义标签列表。'."\n",
- 'description' => '用户自定义标签列表。'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '用户自定义标签键。'."\n",
- 'description' => '用户自定义标签键。'."\n",
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'title' => '用户自定义标签值。'."\n",
- 'description' => '用户自定义标签值。'."\n",
- 'type' => 'string',
- 'example' => 'v1',
- ],
- ],
- ],
- ],
- 'OperationType' => [
- 'title' => '计划操作类型,取值为All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct。',
- 'description' => '计划操作类型。取值:'."\n"
- .'- LaunchProduct(默认):启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'example' => 'LaunchProduct',
- ],
- 'AssignedApprovers' => [
- 'title' => '计划审批人列表。',
- 'description' => '计划审批人列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PrincipalType' => [
- 'title' => '计划审批人的RAM实体类型。取值:'."\n"
- ."\n"
- .'RamUser:RAM用户。'."\n"
- .'RamRole:RAM角色。',
- 'description' => '计划审批人的RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'PrincipalName' => [
- 'title' => '计划归属人的RAM实体名称。'."\n",
- 'description' => '计划审批人的RAM实体名称。',
- 'type' => 'string',
- 'example' => 'endUser',
- ],
- ],
- ],
- ],
- 'ProductName' => [
- 'title' => '产品名称。'."\n",
- 'description' => '产品名称。'."\n",
- 'type' => 'string',
- 'example' => '创建ECS',
- ],
- 'Description' => [
- 'title' => '计划描述。',
- 'description' => '计划描述。',
- 'type' => 'string',
- 'example' => '开发团队使用',
- ],
- 'OwnerPrincipalType' => [
- 'title' => '计划归属人的RAM实体类型。取值:'."\n"
- ."\n"
- .'RamUser:RAM用户。'."\n"
- .'RamRole:RAM角色。',
- 'description' => '计划归属人的RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'OwnerPrincipalId' => [
- 'title' => '计划归属人的RAM实体ID。'."\n",
- 'description' => '计划归属人的RAM实体ID。'."\n",
- 'type' => 'string',
- 'example' => '24477111603637****'."\n",
- ],
- 'OwnerPrincipalName' => [
- 'title' => '计划归属人的RAM实体名称。',
- 'description' => '计划归属人的RAM实体名称。',
- 'type' => 'string',
- 'example' => 'enduser',
- ],
- 'Uid' => [
- 'title' => '计划归属人的云账号ID。',
- 'description' => '计划归属人的云账号ID。',
- 'type' => 'string',
- 'example' => '146611588617****',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '总记录数。',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '16',
- ],
- 'PageNumber' => [
- 'title' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '删除产品',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\",\\n \\"PlanDetails\\": [\\n {\\n \\"PlanId\\": \\"plan-bp18mmdh2u****\\",\\n \\"PlanName\\": \\"DEMO-创建ECS-637****\\",\\n \\"PlanType\\": \\"Ros\\",\\n \\"PortfolioId\\": \\"port-bp1438kf2j****\\",\\n \\"ProductId\\": \\"prod-bp1rtrnh2c****\\",\\n \\"ProductVersionId\\": \\"pv-bp19udk22v****\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1c35162d****\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"role_name\\",\\n \\"ParameterValue\\": \\"Test-8\\"\\n }\\n ],\\n \\"ProvisionedProductName\\": \\"rds-MYSQL-875****\\",\\n \\"StackId\\": \\"2599090a-309e-4306-b989-17ba66a9****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"PreviewSuccess\\",\\n \\"StatusMessage\\": \\"Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-09-13T02:01:22Z\\",\\n \\"UpdateTime\\": \\"2022-07-18T06:02:35.075Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"OperationType\\": \\"LaunchProduct\\",\\n \\"AssignedApprovers\\": [\\n {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalName\\": \\"endUser\\"\\n }\\n ],\\n \\"ProductName\\": \\"创建ECS\\",\\n \\"Description\\": \\"开发团队使用\\",\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"24477111603637****\\\\n\\",\\n \\"OwnerPrincipalName\\": \\"enduser\\",\\n \\"Uid\\": \\"146611588617****\\"\\n }\\n ],\\n \\"TotalCount\\": 16,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- 'title' => '查询计划列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
],
- 'CancelProvisionedProductPlan' => [
- 'summary' => '取消计划。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteProductVersion' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2507,22 +1488,12 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'PlanId',
+ 'name' => 'ProductVersionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '计划ID',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'plan-bp1jvmdk2k****',
- ],
+ 'schema' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'],
],
],
'responses' => [
@@ -2532,39 +1503,40 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '删除产品版本',
+ 'summary' => '删除产品版本。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '取消计划',
],
- 'UpdateProvisionedProductPlan' => [
- 'summary' => '更新计划。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteProvisionedProductPlan' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2572,201 +1544,184 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'PlanId',
'in' => 'formData',
+ 'schema' => ['description' => '计划ID。', 'type' => 'string', 'required' => true, 'example' => 'plan-bp1jvmdk2k****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '计划ID。',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'plan-bp1jvmdk2k****'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '删除计划',
+ 'summary' => '删除计划。',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-14T02:23:42.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-12T11:57:27.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProvisionedProductPlan'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PortfolioId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID。',
- 'description' => '产品组合ID。'."\n"
- .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'port-bp1yt7582g****'."\n",
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteTagOption' => [
+ 'summary' => '删除标签选项。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ProductId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品ID。',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****'."\n",
- ],
+ 'AK' => [],
],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'ProductVersionId',
+ 'name' => 'TagOptionId',
'in' => 'formData',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '标签选项ID。', 'type' => 'string', 'required' => true, 'example' => 'tag-bp1u6mdf3d****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '产品版本ID。',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除标签选项',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTagOption'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '计划描述。',
- 'description' => '计划描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用于创建ECS',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\"\\n}","type":"json"}]',
+ ],
+ 'DisAssociateTagOptionFromResource' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Parameters',
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '用户输入的模板参数。'."\n",
- 'description' => '用户输入的模板参数。'."\n"
- ."\n"
- .'N最大值为200。'."\n"
- ."\n"
- .'> Parameters为可选参数。如果需要指定Parameters,则Parameters.N.ParameterKey和Parameters.N.ParameterValue必须同时指定。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ParameterKey' => [
- 'title' => '模板中定义的参数名称。'."\n",
- 'description' => '模板中定义的参数名称。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instance_type',
- ],
- 'ParameterValue' => [
- 'title' => '用户输入的模板参数值。'."\n",
- 'description' => '用户输入的模板参数值。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.s6-c1m1.small'."\n",
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '标签选项绑定的资源ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp14katy3d****'],
],
[
- 'name' => 'Tags',
+ 'name' => 'TagOptionId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '用户自定义标签列表。'."\n",
- 'description' => '用户输入的自定义标签。'."\n"
- ."\n"
- .'N最大值为20。'."\n"
- ."\n"
- .'> - Tags为可选参数。如果需要指定Tags,则Tags.N.Key和Tags.N.Value必须同时指定。'."\n"
- .'> - 此标签会传递到资源栈中每个支持标签的资源中。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '用户自定义标签键。'."\n",
- 'description' => '用户输入的自定义标签键。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- 'Value' => [
- 'title' => '用户自定义标签值。'."\n",
- 'description' => '用户输入的自定义标签值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 20,
- ],
+ 'schema' => ['description' => '标签选项ID。', 'type' => 'string', 'required' => true, 'example' => 'tag-bp1u6mdf3d****'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****'."\n",
- ],
- 'PlanId' => [
- 'title' => '计划ID',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'example' => 'plan-bp1jvmdk2k****'."\n",
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****'."\n",
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7E23D1F3-4333-587B-909C-39EA4626****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '取消标签选项与资源的关联',
+ 'summary' => '取消标签选项与资源的关联。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisAssociateTagOptionFromResource'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DisAssociateTagOptionFromResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#portfolioId}'],
+ ['validationType' => 'conditional', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#productId}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\\\n\\",\\n \\"PlanId\\": \\"plan-bp1jvmdk2k****\\\\n\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\\\n\\"\\n}","type":"json"}]',
- 'title' => '更新计划',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E23D1F3-4333-587B-909C-39EA4626****\\"\\n}","type":"json"}]',
],
- 'ApproveProvisionedProductPlan' => [
- 'summary' => '审批人审批计划。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DisassociatePrincipalFromPortfolio' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2775,46 +1730,38 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
],
'parameters' => [
[
- 'name' => 'PlanId',
+ 'name' => 'PortfolioId',
'in' => 'formData',
- 'schema' => [
- 'title' => '计划ID',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'plan-bp1jvmdk2k****',
- ],
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
],
[
- 'name' => 'ApprovalAction',
+ 'name' => 'PrincipalType',
'in' => 'formData',
- 'schema' => [
- 'title' => '审批动作,取值Approve表示同意,Reject表示拒绝',
- 'description' => '审批动作。取值:'."\n"
- ."\n\n"
- .'- Approve:同意。'."\n"
- .'- Reject:拒绝。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Approve',
- ],
+ 'schema' => ['title' => 'RAM实体类型', 'description' => 'RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'required' => true, 'example' => 'RamUser'],
],
[
- 'name' => 'Comment',
+ 'name' => 'PrincipalId',
'in' => 'formData',
- 'schema' => [
- 'title' => '审批意见',
- 'description' => '审批意见。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '审批通过,允许创建资源',
- ],
+ 'schema' => ['title' => 'RAM实体ID', 'description' => 'RAM实体ID。'."\n"
+ ."\n"
+ .'获取RAM用户ID的方法,请参见[GetUser](~~28681~~)。'."\n"
+ ."\n"
+ .'获取RAM角色ID的方法,请参见[GetRole](~~28711~~)。', 'type' => 'string', 'required' => false, 'example' => '24477111603637****'],
+ ],
+ [
+ 'name' => 'PrincipalPattern',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'example' => 'user/userName'],
],
],
'responses' => [
@@ -2824,188 +1771,107 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '删除产品组合授权',
+ 'summary' => '删除产品组合授权。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '审批计划',
- ],
- 'ListProvisionedProductPlanApprovers' => [
- 'summary' => '查询计划审批人列表。',
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DisassociatePrincipalFromPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'DisassociateProductFromPortfolio' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'AccessLevelFilter',
- 'in' => 'query',
- 'schema' => [
- 'title' => '访问过滤器',
- 'description' => '访问过滤器。取值:'."\n"
- ."\n"
- .'- User(默认值):用户。'."\n"
- .'- Account:账号。'."\n"
- .'- ResourceDirectory:资源目录。'."\n"
- ."\n"
- .'> 必须指定`ApprovalFilter`和`AccessLevelFilter`两个参数中的一个参数,但不能同时指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'User',
- ],
- ],
- [
- 'name' => 'Filters',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '过滤条件,支持Key值为ProvisionedProductPlanApproverName',
- 'description' => '过滤条件。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '过滤条件的名称',
- 'description' => '过滤条件的名称。取值:'."\n"
- ."\n"
- .'- ProvisionedProductPlanApproverName:按审批人名称模糊匹配',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ProvisionedProductPlanApproverName',
- ],
- 'Value' => [
- 'title' => '过滤条件的值',
- 'description' => '过滤条件的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'approver',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 5,
- ],
+ 'name' => 'ProductId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
[
- 'name' => 'ApprovalFilter',
- 'in' => 'query',
- 'schema' => [
- 'title' => '审批维度访问过滤器',
- 'description' => '审批维度访问过滤器。取值:'."\n"
- .'- AccountRequests:账号级别全部审批。'."\n"
- .'- ResourceDirectoryRequests:资源目录级别全部审批。'."\n"
- .'> 必须指定`ApprovalFilter`和`AccessLevelFilter`两个参数中的一个参数,但不能同时指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AccountRequests',
- ],
+ 'name' => 'PortfolioId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****',
- ],
- 'Approvers' => [
- 'title' => '审批人列表',
- 'description' => '审批人列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PrincipalName' => [
- 'title' => '审批人名称',
- 'description' => '审批人名称。',
- 'type' => 'string',
- 'example' => 'approver-1',
- ],
- 'PrincipalType' => [
- 'title' => 'RAM实体类型',
- 'description' => '计划审批人的RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '从产品组合中移除产品',
+ 'summary' => '从产品组合中移除产品。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T02:23:57.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DisassociateProductFromPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\",\\n \\"Approvers\\": [\\n {\\n \\"PrincipalName\\": \\"approver-1\\",\\n \\"PrincipalType\\": \\"RamUser\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询计划审批人列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
],
'ExecuteProvisionedProductPlan' => [
'summary' => '执行计划。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3017,13 +1883,7 @@
[
'name' => 'PlanId',
'in' => 'formData',
- 'schema' => [
- 'title' => '计划ID',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'plan-bp1jvmdk2k****',
- ],
+ 'schema' => ['title' => '计划ID', 'description' => '计划ID。', 'type' => 'string', 'required' => true, 'example' => 'plan-bp1jvmdk2k****'],
],
],
'responses' => [
@@ -3033,62 +1893,58 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'PlanId' => [
- 'title' => '计划ID',
- 'description' => '计划ID。',
- 'type' => 'string',
- 'example' => 'plan-bp1jvmdk2k****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'PlanId' => ['title' => '计划ID', 'description' => '计划ID。', 'type' => 'string', 'example' => 'plan-bp1jvmdk2k****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PlanId\\": \\"plan-bp1jvmdk2k****\\"\\n}","type":"json"}]',
'title' => '执行计划',
- ],
- 'DeleteProvisionedProductPlan' => [
- 'summary' => '删除计划。',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteProvisionedProductPlan'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ExecuteProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PlanId\\": \\"plan-bp1jvmdk2k****\\"\\n}","type":"json"}]',
+ ],
+ 'GetConstraint' => [
+ 'summary' => '查询约束信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'PlanId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '计划ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'plan-bp1jvmdk2k****',
- ],
+ 'name' => 'ConstraintId',
+ 'in' => 'query',
+ 'schema' => ['title' => '约束ID', 'description' => '约束ID。', 'type' => 'string', 'required' => true, 'example' => 'cons-bp1yx7x42v****'],
],
],
'responses' => [
@@ -3098,11 +1954,27 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ConstraintDetail' => [
+ 'title' => '约束详情',
+ 'description' => '约束详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Config' => ['title' => '约束配置', 'description' => '约束配置。'."\n"
+ ."\n"
+ .'格式:{ "LocalRoleName": "<role_name\\>" }', 'type' => 'string', 'example' => '{ "LocalRoleName": "TestRole" }'],
+ 'Description' => ['title' => '描述', 'description' => '约束描述。', 'type' => 'string', 'example' => 'Launch as local role TestRole'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '约束创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:11:26Z'],
+ 'ConstraintId' => ['title' => '约束ID', 'description' => '约束ID。', 'type' => 'string', 'example' => 'cons-bp1yx7x42v****'],
+ 'PortfolioId' => ['title' => '约束所属的产品组合ID', 'description' => '约束所属的产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'ProductId' => ['title' => '约束的产品ID', 'description' => '约束对应的产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ConstraintType' => ['title' => '约束类型', 'description' => '约束类型。'."\n"
+ ."\n"
+ .'取值为Launch,表示启动约束。', 'type' => 'string', 'example' => 'Launch'],
+ 'ProductName' => ['description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ ],
],
],
],
@@ -3110,25 +1982,35 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '删除计划',
- ],
- 'GetProvisionedProduct' => [
- 'summary' => '查询实例信息。',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ConstraintDetail\\": {\\n \\"Config\\": \\"{ \\\\\\"LocalRoleName\\\\\\": \\\\\\"TestRole\\\\\\" }\\",\\n \\"Description\\": \\"Launch as local role TestRole\\",\\n \\"CreateTime\\": \\"2022-04-12T06:11:26Z\\",\\n \\"ConstraintId\\": \\"cons-bp1yx7x42v****\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ConstraintType\\": \\"Launch\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询约束信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-27T07:47:14.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetPortfolio' => [
+ 'summary' => '查询产品组合信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3136,178 +2018,54 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ProvisionedProductId',
+ 'name' => 'PortfolioId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pp-bp1ddg1n2a****',
- ],
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProvisionedProductDetail' => [
- 'title' => '实例信息',
- 'description' => '实例详情。',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'PortfolioDetail' => [
+ 'title' => '产品组合详情',
+ 'description' => '产品组合详情。',
'type' => 'object',
'properties' => [
- 'ProvisionedProductId' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
- 'ProvisionedProductArn' => [
- 'title' => '实例ARN',
- 'description' => '实例ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****',
- ],
- 'ProvisionedProductName' => [
- 'title' => '实例名称',
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'DEMO-ECS实例',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名称',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'LastTaskId' => [
- 'title' => '上一次执行的任务ID',
- 'description' => '上一次执行的任务ID。',
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'LastProvisioningTaskId' => [
- 'title' => '上一次执行的实例操作任务ID',
- 'description' => '上一次执行的实例操作任务ID。'."\n"
- ."\n"
- .'实例操作包括:'."\n"
- ."\n"
- .'- LaunchProduct:启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。'."\n",
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'LastSuccessfulProvisioningTaskId' => [
- 'title' => '上一次成功执行的实例操作任务ID',
- 'description' => '上一次成功执行的实例操作任务ID。'."\n"
- ."\n"
- .'实例操作包括:'."\n"
- ."\n"
- .'- LaunchProduct:启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'OwnerPrincipalType' => [
- 'title' => '归属人的RAM实体类型',
- 'description' => '实例归属人的RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'OwnerPrincipalId' => [
- 'title' => '归属人的RAM实体ID',
- 'description' => '实例归属人的RAM实体ID。',
- 'type' => 'string',
- 'example' => '24477111603637****',
- ],
- 'Status' => [
- 'title' => '实例状态',
- 'description' => '实例状态。取值:'."\n"
- ."\n"
- .'- Available:可用。'."\n"
- .'- UnderChange:变更中。'."\n"
- .'- Error:异常。',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'StatusMessage' => [
- 'title' => '实例状态说明',
- 'description' => '实例状态信息。'."\n"
- ."\n"
- .'> 仅在实例状态为Error时,返回该参数。',
- 'type' => 'string',
- 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '实例创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-23T09:46:27Z',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'StackId' => [
- 'title' => 'ROS资源栈的ID',
- 'description' => '阿里云资源编排服务(ROS)资源栈ID。',
- 'type' => 'string',
- 'example' => '137e31df-3754-40b4-be2f-c793ad84****',
- ],
- 'StackRegionId' => [
- 'title' => 'ROS资源栈所属的地域ID',
- 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ProvisionedProductType' => [
- 'description' => '实例类型。'."\n"
+ 'PortfolioArn' => ['title' => '产品组合ARN', 'description' => '产品组合ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'Description' => ['title' => '产品组合描述', 'description' => '产品组合描述。', 'type' => 'string', 'example' => 'This is a portfolio description.'],
+ 'CreateTime' => ['title' => '产品组合创建时间', 'description' => '产品组合创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:11:12Z'],
+ 'PortfolioName' => ['title' => '产品组合名称', 'description' => '产品组合名称。', 'type' => 'string', 'example' => 'DEMO-IT Service'],
+ 'ProviderName' => ['title' => '提供者名称', 'description' => '产品组合提供者。', 'type' => 'string', 'example' => 'IT team'],
+ ],
+ ],
+ 'TagOptions' => [
+ 'description' => '产品组合关联的标签选项列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Active' => ['description' => '是否启用。取值:'."\n"
."\n"
- .'取值为RosStack,表示阿里云资源编排服务(ROS)的资源栈。',
- 'type' => 'string',
- 'example' => 'RosStack',
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'TagOptionId' => ['description' => '标签选项ID。', 'type' => 'string', 'example' => 'tag-bp1q65xd3j****'],
+ 'Key' => ['description' => '标签选项键。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '标签选项值。', 'type' => 'string', 'example' => 'v1'],
+ 'Owner' => ['description' => '标签选项归属人ID。', 'type' => 'string', 'example' => '133413081827****'."\n"],
],
+ 'description' => '',
],
],
],
@@ -3316,25 +2074,35 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProvisionedProductDetail\\": {\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"DEMO-ECS实例\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"LastTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastSuccessfulProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"24477111603637****\\",\\n \\"Status\\": \\"Available\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"StackId\\": \\"137e31df-3754-40b4-be2f-c793ad84****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"ProvisionedProductType\\": \\"RosStack\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询实例信息',
- ],
- 'ListProvisionedProducts' => [
- 'summary' => '查询实例列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PortfolioDetail\\": {\\n \\"PortfolioArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"Description\\": \\"This is a portfolio description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:11:12Z\\",\\n \\"PortfolioName\\": \\"DEMO-IT Service\\",\\n \\"ProviderName\\": \\"IT team\\"\\n },\\n \\"TagOptions\\": [\\n {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1q65xd3j****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询产品组合信息',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-24T03:04:13.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetProductAsAdmin' => [
+ 'summary' => '管理员调用GetProductAsAdmin接口查询产品信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3342,327 +2110,193 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Filters',
+ 'name' => 'ProductId',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '过滤条件',
- 'description' => '过滤条件。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '过滤条件的名称',
- 'description' => '过滤条件的名称。取值:'."\n"
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductDetail' => [
+ 'title' => '产品详情',
+ 'description' => '产品详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductArn' => ['title' => '产品ARN', 'description' => '产品ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'],
+ 'Description' => ['title' => '产品描述', 'description' => '产品描述。', 'type' => 'string', 'example' => 'This is a product description.'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间。'."\n"
."\n"
- .'- ProvisionedProductName:按实例名称查找,完整匹配(忽略大小写)。'."\n"
- .'- FullTextSearch:全文检索,按实例名称查找,模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ProvisionedProductName',
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名称', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProviderName' => ['title' => '提供者名称', 'description' => '产品提供者。', 'type' => 'string', 'example' => 'IT team'],
+ 'ProductType' => ['title' => '产品类型', 'description' => '产品类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'example' => 'Ros'],
+ 'TemplateType' => ['title' => '产品模板类型', 'description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'example' => 'RosTerraformTemplate'],
],
- 'Value' => [
- 'title' => '过滤条件的值',
- 'description' => '过滤条件的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DEMO-ECS实例',
+ ],
+ 'TagOptions' => [
+ 'description' => '产品关联的标签选项列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Active' => ['description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'TagOptionId' => ['description' => '标签选项ID。', 'type' => 'string', 'example' => 'tag-bp1q65xd3j****'],
+ 'Key' => ['description' => '标签选项键。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '标签选项值。', 'type' => 'string', 'example' => 'v1'],
+ 'Owner' => ['description' => '标签选项归属人ID。', 'type' => 'string', 'example' => '133413081827****'."\n"],
+ ],
+ 'description' => '',
],
],
- 'required' => false,
],
- 'required' => false,
- 'maxItems' => 5,
- ],
- ],
- [
- 'name' => 'SortBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示实例创建时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
],
],
- [
- 'name' => 'SortOrder',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序方式',
- 'description' => '排序方式。取值:'."\n"
- ."\n"
- .'- Asc:正序。'."\n"
- .'- Desc(默认值):倒序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- ],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductDetail\\": {\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"Description\\": \\"This is a product description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProviderName\\": \\"IT team\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n },\\n \\"TagOptions\\": [\\n {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1q65xd3j****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '管理员查询产品信息',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-27T10:57:48.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2023-03-24T03:04:13.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProductAsAdmin',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
+ ],
+ ],
+ 'GetProductAsEndUser' => [
+ 'summary' => '终端用户调用GetProductAsEndUser接口查询产品信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ ],
+ 'parameters' => [
[
- 'name' => 'AccessLevelFilter',
+ 'name' => 'ProductId',
'in' => 'query',
- 'schema' => [
- 'title' => '访问过滤器',
- 'description' => '访问过滤器。取值:'."\n"
- ."\n"
- .'- User(默认值):用户。'."\n"
- .'- Account:账号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'User',
- ],
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'ProvisionedProductDetails' => [
- 'title' => '实例列表',
- 'description' => '实例列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'PortfolioItemType',
- 'description' => '实例详情。',
- 'type' => 'object',
- 'properties' => [
- 'ProvisionedProductName' => [
- 'title' => '实例名称',
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'DEMO-ECS实例',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
- 'ProvisionedProductArn' => [
- 'title' => '实例ARN',
- 'description' => '实例ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名称',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'LastTaskId' => [
- 'title' => '上一次执行的任务ID',
- 'description' => '上一次执行的任务ID。',
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'LastProvisioningTaskId' => [
- 'title' => '上一次执行的实例操作任务ID',
- 'description' => '上一次执行的实例操作任务ID。'."\n"
- ."\n"
- .'实例操作包括:'."\n"
- ."\n"
- .'- LaunchProduct:启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'LastSuccessfulProvisioningTaskId' => [
- 'title' => '上一次成功执行的实例操作任务ID',
- 'description' => '上一次成功执行的实例操作任务ID。'."\n"
- ."\n"
- .'实例操作包括:'."\n"
- ."\n"
- .'- LaunchProduct:启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'OwnerPrincipalType' => [
- 'title' => '归属人的RAM实体类型',
- 'description' => '实例归属人的RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'OwnerPrincipalId' => [
- 'title' => '归属人的RAM实体ID',
- 'description' => '实例归属人的RAM实体ID。',
- 'type' => 'string',
- 'example' => '24477111603637****',
- ],
- 'Status' => [
- 'title' => '实例状态',
- 'description' => '实例状态。取值:'."\n"
- ."\n"
- .'- Available:可用。'."\n"
- .'- UnderChange:变更中。'."\n"
- .'- Error:异常。',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'StatusMessage' => [
- 'title' => '实例状态说明',
- 'description' => '实例状态说明。'."\n"
- ."\n"
- .'> 仅在实例状态为Error时,返回该参数。',
- 'type' => 'string',
- 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '实例创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-23T09:46:27Z',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'StackId' => [
- 'title' => 'ROS资源栈的ID',
- 'description' => '阿里云资源编排服务(ROS)资源栈ID。',
- 'type' => 'string',
- 'example' => '137e31df-3754-40b4-be2f-c793ad84****',
- ],
- 'StackRegionId' => [
- 'title' => 'ROS资源栈所属的地域ID',
- 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ProvisionedProductType' => [
- 'description' => '实例类型。'."\n"
- ."\n"
- .'取值为RosStack,表示阿里云资源编排服务(ROS)的资源栈。',
- 'type' => 'string',
- 'example' => 'RosStack',
- ],
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductSummary' => [
+ 'title' => '产品详情',
+ 'description' => '产品概要信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['title' => '产品描述', 'description' => '产品描述。', 'type' => 'string', 'example' => 'This is a product description.'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '产品创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductArn' => ['title' => '产品ARN', 'description' => '产品ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名称', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProviderName' => ['title' => '提供者名称', 'description' => '产品提供者。', 'type' => 'string', 'example' => 'IT team'],
+ 'ProductType' => ['title' => '产品类型', 'description' => '产品类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'example' => 'Ros'],
+ 'HasDefaultLaunchOption' => ['description' => '是否存在默认启动选项。取值:'."\n"
+ ."\n"
+ .'- true:存在默认启动选项,启动产品或更新实例时无需填写PortfolioId。'."\n"
+ .'- false:没有默认启动选项,启动产品或更新实例时必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。'."\n"
+ ."\n"
+ .'> 如果产品仅被加入到一个产品组合,则会存在默认启动选项。如果产品被加入到多个产品组合,则会同时存在多个启动选项,但此时没有默认启动选项。', 'type' => 'boolean', 'example' => 'true'],
+ 'TemplateType' => ['description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'example' => 'RosTerraformTemplate'],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页时每页显示的数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductSummary\\": {\\n \\"Description\\": \\"This is a product description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProviderName\\": \\"IT team\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"HasDefaultLaunchOption\\": true,\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n}","type":"json"}]',
+ 'title' => '终端用户查询产品信息',
+ 'description' => '请确保终端用户已被管理员授予相关产品的使用权限。具体操作,请参见[为终端用户授予访问权限](~~405233~~)。',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-27T10:57:47.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-02-21T06:49:09.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProductAsEndUser',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProvisionedProductDetails\\": [\\n {\\n \\"ProvisionedProductName\\": \\"DEMO-ECS实例\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"LastTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastSuccessfulProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"24477111603637****\\",\\n \\"Status\\": \\"Available\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"StackId\\": \\"137e31df-3754-40b4-be2f-c793ad84****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"ProvisionedProductType\\": \\"RosStack\\"\\n }\\n ],\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- 'title' => '查询实例列表',
],
- 'GetTask' => [
- 'summary' => '查询任务信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetProductVersion' => [
+ 'summary' => '查询产品版本信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3670,20 +2304,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'task-bp1dmg242c****',
- ],
+ 'name' => 'ProductVersionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'],
],
],
'responses' => [
@@ -3693,245 +2319,75 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'TaskDetail' => [
- 'title' => '任务信息',
- 'description' => '任务详情。',
+ 'ProductVersionDetail' => [
+ 'title' => '产品版本详情',
+ 'description' => '产品版本详情。',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'TaskType' => [
- 'title' => '任务类型',
- 'description' => '任务类型。取值:'."\n"
- ."\n"
- .'- LaunchProduct:启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'example' => 'LaunchProduct',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名称',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
- 'ProvisionedProductName' => [
- 'title' => '实例名称',
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'DEMO-ECS实例',
- ],
- 'Parameters' => [
- 'description' => '用户输入的模板参数。',
- 'type' => 'array',
- 'items' => [
- 'description' => '用户输入的模板参数。',
- 'type' => 'object',
- 'properties' => [
- 'ParameterKey' => [
- 'description' => '模板中定义的参数名称。',
- 'type' => 'string',
- 'example' => 'instance_type',
- ],
- 'ParameterValue' => [
- 'description' => '用户输入的模板参数值。',
- 'type' => 'string',
- 'example' => 'ecs.s6-c1m1.small',
- ],
- ],
- ],
- ],
- 'Outputs' => [
- 'description' => '模板的输出值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '模板的输出值。',
- 'type' => 'object',
- 'properties' => [
- 'OutputKey' => [
- 'description' => '模板中定义的输出值名称。',
- 'type' => 'string',
- 'example' => 'instance_id',
- ],
- 'OutputValue' => [
- 'description' => '模板中定义的输出值的内容。',
- 'type' => 'string',
- 'example' => 'i-xxxxxx',
- ],
- 'Description' => [
- 'description' => '模板中定义的输出值的描述。',
- 'type' => 'string',
- 'example' => 'The ECS instance ID.',
- ],
- ],
- ],
- ],
- 'Log' => [
- 'description' => '实例相关输出日志。',
- 'type' => 'object',
- 'properties' => [
- 'TerraformLogs' => [
- 'description' => 'Terraform输出日志。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Terraform输出日志。',
- 'type' => 'object',
- 'properties' => [
- 'Command' => [
- 'description' => '执行的Terraform命令名称。取值:'."\n"
- ."\n"
- .'- apply'."\n"
- .'- plan'."\n"
- .'- destroy'."\n"
- .'- version'."\n"
- ."\n"
- .'关于命令含义的更多信息,请参见[Command](https://www.terraform.io/cli/commands)。',
- 'type' => 'string',
- 'example' => 'apply',
- ],
- 'Stream' => [
- 'description' => '输出流。取值:'."\n"
- ."\n"
- .'- stdout:标准输出。'."\n"
- .'- stderr:标准错误输出。',
- 'type' => 'string',
- 'example' => 'stdout',
- ],
- 'Content' => [
- 'description' => '当前命令在当前输出流中输出的内容。',
- 'type' => 'string',
- 'example' => 'Apply complete! Resources: 42 added, 0 changed, 0 destroyed.',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '任务状态。取值:'."\n"
- ."\n"
- .'- Succeeded:成功。'."\n"
- .'- InProgress:运行中。'."\n"
- .'- Failed:失败。',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'StatusMessage' => [
- 'title' => '任务状态说明',
- 'description' => '任务状态信息。'."\n"
- ."\n"
- .'> 仅在任务状态为Failed时,返回该参数。',
- 'type' => 'string',
- 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '任务创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-23T09:46:27Z',
- ],
- 'UpdateTime' => [
- 'description' => '任务最后更新时间。'."\n"
+ 'Active' => [
+ 'title' => '是否启用',
+ 'description' => '是否启用。取值:'."\n"
."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-23T09:47:29Z',
- ],
- 'TaskTags' => [
- 'description' => '自定义标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义标签。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '自定义标签键。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '自定义标签值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- ],
- ],
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。',
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
],
+ 'Description' => ['title' => '产品版本描述', 'description' => '产品版本描述。', 'type' => 'string', 'example' => 'This is a product version description.'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '产品版本创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'Guidance' => ['title' => '推荐信息', 'description' => '推荐信息。取值:'."\n"
+ ."\n"
+ .'- Default(默认值):无。'."\n"
+ .'- Recommended:稳定版。'."\n"
+ .'- Latest:最新版。'."\n"
+ .'- Deprecated:将废弃。', 'type' => 'string', 'example' => 'Default'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。', 'type' => 'string', 'example' => '1.0'],
+ 'ProductId' => ['title' => '产品版本所属的产品ID', 'description' => '产品版本所属的产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'TemplateUrl' => ['title' => '模板的OSS地址', 'description' => '模板的URL地址。', 'type' => 'string', 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json'],
+ 'TemplateType' => ['title' => '模板类型', 'description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'example' => 'RosTerraformTemplate'],
],
],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProductVersionDetail\\": {\\n \\"Active\\": true,\\n \\"Description\\": \\"This is a product version description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"Guidance\\": \\"Default\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n },\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ 'title' => '查询产品版本信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TaskDetail\\": {\\n \\"TaskId\\": \\"task-bp1dmg242c****\\",\\n \\"TaskType\\": \\"LaunchProduct\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"DEMO-ECS实例\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"instance_type\\",\\n \\"ParameterValue\\": \\"ecs.s6-c1m1.small\\"\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputKey\\": \\"instance_id\\",\\n \\"OutputValue\\": \\"i-xxxxxx\\",\\n \\"Description\\": \\"The ECS instance ID.\\"\\n }\\n ],\\n \\"Log\\": {\\n \\"TerraformLogs\\": [\\n {\\n \\"Command\\": \\"apply\\",\\n \\"Stream\\": \\"stdout\\",\\n \\"Content\\": \\"Apply complete! Resources: 42 added, 0 changed, 0 destroyed.\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"Succeeded\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"UpdateTime\\": \\"2022-05-23T09:47:29Z\\",\\n \\"TaskTags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '查询任务信息',
],
- 'ListTasks' => [
- 'summary' => '查询任务列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetProvisionedProduct' => [
+ 'summary' => '查询实例信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3939,292 +2395,442 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'SortBy',
+ 'name' => 'ProvisionedProductId',
'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示任务创建时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pp-bp1ddg1n2a****'],
],
- [
- 'name' => 'SortOrder',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '排序方式',
- 'description' => '排序方式。取值:'."\n"
- ."\n"
- .'- Asc:正序。'."\n"
- .'- Desc:倒序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProvisionedProductDetail' => [
+ 'title' => '实例信息',
+ 'description' => '实例详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProvisionedProductId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
+ 'ProvisionedProductArn' => ['title' => '实例ARN', 'description' => '实例ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****'],
+ 'ProvisionedProductName' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'DEMO-ECS-Instance'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名称', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。', 'type' => 'string', 'example' => '1.0'],
+ 'LastTaskId' => ['title' => '上一次执行的任务ID', 'description' => '上一次执行的任务ID。', 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'LastProvisioningTaskId' => ['title' => '上一次执行的实例操作任务ID', 'description' => '上一次执行的实例操作任务ID。'."\n"
+ ."\n"
+ .'实例操作包括:'."\n"
+ ."\n"
+ .'- LaunchProduct:启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。'."\n", 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'LastSuccessfulProvisioningTaskId' => ['title' => '上一次成功执行的实例操作任务ID', 'description' => '上一次成功执行的实例操作任务ID。'."\n"
+ ."\n"
+ .'实例操作包括:'."\n"
+ ."\n"
+ .'- LaunchProduct:启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'OwnerPrincipalType' => ['title' => '归属人的RAM实体类型', 'description' => '实例归属人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'OwnerPrincipalId' => ['title' => '归属人的RAM实体ID', 'description' => '实例归属人的RAM实体ID。', 'type' => 'string', 'example' => '24477111603637****'],
+ 'Status' => ['title' => '实例状态', 'description' => '实例状态。取值:'."\n"
+ ."\n"
+ .'- Available:可用。'."\n"
+ .'- UnderChange:变更中。'."\n"
+ .'- Error:异常。', 'type' => 'string', 'example' => 'Available'],
+ 'StatusMessage' => ['title' => '实例状态说明', 'description' => '实例状态信息。'."\n"
+ ."\n"
+ .'> 仅在实例状态为Error时,返回该参数。', 'type' => 'string', 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '实例创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-23T09:46:27Z'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'StackId' => ['title' => 'ROS资源栈的ID', 'description' => '阿里云资源编排服务(ROS)资源栈ID。', 'type' => 'string', 'example' => '137e31df-3754-40b4-be2f-c793ad84****'],
+ 'StackRegionId' => ['title' => 'ROS资源栈所属的地域ID', 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'ProvisionedProductType' => ['description' => '实例类型。'."\n"
+ ."\n"
+ .'取值为RosStack,表示阿里云资源编排服务(ROS)的资源栈。', 'type' => 'string', 'example' => 'RosStack'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProvisionedProductDetail\\": {\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"DEMO-ECS-Instance\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"LastTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastSuccessfulProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"24477111603637****\\",\\n \\"Status\\": \\"Available\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"StackId\\": \\"137e31df-3754-40b4-be2f-c793ad84****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"ProvisionedProductType\\": \\"RosStack\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询实例信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-27T07:47:14.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2021-12-28T03:48:53.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProvisionedProduct'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProvisionedProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
+ ],
+ ],
+ 'GetProvisionedProductPlan' => [
+ 'summary' => '查询计划信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'AK' => [],
],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'ProvisionedProductId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pp-bp1ddg1n2a****',
- ],
+ 'name' => 'PlanId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '计划ID。', 'type' => 'string', 'required' => true, 'example' => 'plan-bp1jvmdk2k****'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'TaskDetails' => [
- 'title' => '实例列表',
- 'description' => '任务列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'PortfolioItemType',
- 'description' => '任务详情。',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '实例名称',
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => 'task-bp1dmg242c****',
- ],
- 'TaskType' => [
- 'title' => '实例ARN',
- 'description' => '任务类型。取值:'."\n"
- ."\n"
- .'- LaunchProduct:启动产品。'."\n"
- .'- UpdateProvisionedProduct:更新实例。'."\n"
- .'- TerminateProvisionedProduct:终止实例。',
- 'type' => 'string',
- 'example' => 'LaunchProduct',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名称',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-ECS',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'ProvisionedProductId' => [
- 'title' => '实例ID',
- 'description' => '实例ID。',
- 'type' => 'string',
- 'example' => 'pp-bp1ddg1n2a****',
- ],
- 'ProvisionedProductName' => [
- 'title' => '实例名称',
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'Test-ECS',
- ],
- 'Parameters' => [
- 'description' => '用户输入的模板参数。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ParameterKey' => [
- 'description' => '模板中定义的参数名称。',
- 'type' => 'string',
- 'example' => 'instance_type',
- ],
- 'ParameterValue' => [
- 'description' => '用户输入的模板参数值。',
- 'type' => 'string',
- 'example' => 'ecs.s6-c1m1.small',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'PlanDetail' => [
+ 'title' => '计划详情。'."\n"
+ ."\n",
+ 'description' => '计划详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PlanId' => ['title' => '计划ID。', 'description' => '计划ID。', 'type' => 'string', 'example' => 'plan-bp1jvmdk2k****'],
+ 'PlanName' => ['title' => '计划名称。'."\n"
+ ."\n", 'description' => '计划名称。', 'type' => 'string', 'example' => 'DEMO-ECS-Instance'],
+ 'PlanType' => ['title' => '计划类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'description' => '计划类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'example' => 'Ros'],
+ 'PortfolioId' => ['title' => '产品组合ID。'."\n"
+ ."\n", 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'ProductId' => ['title' => '产品ID。'."\n"
+ ."\n", 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductVersionId' => ['title' => '产品版本ID。'."\n"
+ ."\n", 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProvisionedProductId' => ['title' => '实例ID。'."\n"
+ ."\n", 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
+ 'ProvisionedProductName' => ['title' => '实例名称。', 'description' => '实例名称。', 'type' => 'string', 'example' => 'DEMO-ECS-Instance'],
+ 'Parameters' => [
+ 'title' => '用户输入的模板参数。'."\n"
+ ."\n",
+ 'description' => '用户输入的模板参数。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterKey' => ['title' => '模板中定义的参数名称。'."\n"
+ ."\n", 'description' => '模板中定义的参数名称。', 'type' => 'string', 'example' => 'instance_type'],
+ 'ParameterValue' => ['title' => '用户输入的模板参数值。'."\n"
+ ."\n", 'description' => '用户输入的模板参数值。', 'type' => 'string', 'example' => 'ecs.s6-c1m1.small'],
],
- ],
- 'Outputs' => [
- 'description' => '模板的输出值。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'OutputKey' => [
- 'description' => '模板中定义的输出值名称。',
- 'type' => 'string',
- 'example' => 'instance_id',
- ],
- 'OutputValue' => [
- 'description' => '模板中定义的输出值的内容。',
- 'type' => 'string',
- 'example' => 'i-xxxxxx',
- ],
- 'Description' => [
- 'description' => '模板中定义的输出值的描述。',
- 'type' => 'string',
- 'example' => 'The ECS instance ID.',
- ],
- ],
+ 'description' => '',
+ ],
+ ],
+ 'StackId' => ['title' => '阿里云资源编排服务(ROS)资源栈ID。'."\n"
+ ."\n", 'description' => '阿里云资源编排服务(ROS)资源栈ID。', 'type' => 'string', 'example' => '137e31df-3754-40b4-be2f-c793ad84****'],
+ 'StackRegionId' => ['title' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n"
+ ."\n", 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'Status' => ['title' => '计划状态。', 'description' => '计划状态。取值:'."\n"
+ .'- PreviewInProgress:预检中。'."\n"
+ .'- PreviewSuccess:预检成功。'."\n"
+ .'- PreviewFailed:预检失败。'."\n"
+ .'- ApplicationInProgress:审批中。'."\n"
+ .'- ApplicationApproved:审批通过。'."\n"
+ .'- ApplicationRejected:审批被拒绝。'."\n"
+ .'- ExecuteInProgress:执行中。'."\n"
+ .'- ExecuteSuccess:执行成功。'."\n"
+ .'- ExecuteFailed:执行失败。'."\n"
+ .'- Canceled:已取消。', 'type' => 'string', 'example' => 'PreviewSuccess'],
+ 'StatusMessage' => ['title' => '计划状态信息。', 'description' => '计划状态信息。'."\n"
+ ."\n"
+ .'> 仅在计划状态为PreviewFailed或ExecuteFailed时,返回该参数。', 'type' => 'string', 'example' => 'Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...'],
+ 'CreateTime' => ['title' => '计划创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'description' => '计划创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-23T09:46:27Z'],
+ 'UpdateTime' => ['title' => '计划最后更新时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'description' => '计划最后更新时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-23T09:47:29Z'],
+ 'Tags' => [
+ 'title' => '用户自定义标签列表。'."\n"
+ ."\n",
+ 'description' => '用户自定义标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '用户自定义标签键。'."\n"
+ ."\n", 'description' => '用户自定义标签键。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['title' => '用户自定义标签值。'."\n"
+ ."\n", 'description' => '用户自定义标签值。', 'type' => 'string', 'example' => 'v1'],
],
+ 'description' => '',
],
- 'Log' => [
- 'description' => '实例相关输出日志。',
+ ],
+ 'OperationType' => ['title' => '计划操作类型,取值为All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct。', 'description' => '计划操作类型。取值:'."\n"
+ ."\n"
+ .'- LaunchProduct:启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'example' => 'LaunchProduct'],
+ 'Description' => ['title' => '计划描述。', 'description' => '计划描述。', 'type' => 'string', 'example' => 'Create ECS'],
+ 'AssignedApprovers' => [
+ 'title' => '计划审批人列表。',
+ 'description' => '计划审批人列表。',
+ 'type' => 'array',
+ 'items' => [
'type' => 'object',
'properties' => [
- 'TerraformLogs' => [
- 'description' => 'Terraform输出日志。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Command' => [
- 'description' => '执行的Terraform命令名称。取值:'."\n"
- ."\n"
- .'- apply'."\n"
- .'- plan'."\n"
- .'- destroy'."\n"
- .'- version'."\n"
+ 'PrincipalType' => ['title' => '计划审批人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'RamUser:RAM用户。'."\n"
+ .'RamRole:RAM角色。'."\n", 'description' => '计划审批人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'PrincipalName' => ['title' => '计划归属人的RAM实体名称。'."\n", 'description' => '计划审批人的RAM实体名称。', 'type' => 'string', 'example' => 'approver'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'OwnerPrincipalType' => ['title' => '计划归属人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'RamUser:RAM用户。'."\n"
+ .'RamRole:RAM角色。'."\n", 'description' => '计划归属人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'OwnerPrincipalId' => ['title' => '计划归属人的RAM实体ID。'."\n"
+ ."\n", 'description' => '计划归属人的RAM实体ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => '27740196382623****'],
+ 'ApprovalDetail' => [
+ 'title' => '计划审批详情。',
+ 'description' => '计划审批详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OperationRecords' => [
+ 'title' => '用户操作记录。',
+ 'description' => '操作记录。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Operator' => [
+ 'title' => '操作人。',
+ 'description' => '已对计划进行操作的RAM实体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PrincipalType' => ['title' => '操作人的RAM实体类型。取值:'."\n"
."\n"
- .'关于命令含义的更多信息,请参见[Command](https://www.terraform.io/cli/commands)。',
- 'type' => 'string',
- 'example' => 'apply',
- ],
- 'Stream' => [
- 'description' => '输出流。取值:'."\n"
+ .'RamUser:RAM用户。'."\n"
+ .'RamRole:RAM角色。', 'description' => 'RAM实体类型。取值:'."\n"
."\n"
- .'- stdout:标准输出。'."\n"
- .'- stderr:标准错误输出。',
- 'type' => 'string',
- 'example' => 'stdout',
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'PrincipalId' => ['title' => '操作人的RAM实体ID。', 'description' => 'RAM实体ID。', 'type' => 'string', 'example' => '277401963826235***'."\n"],
+ 'PrincipalName' => ['title' => '操作人的RAM实体名称。', 'description' => '操作人的RAM实体名称。', 'type' => 'string', 'example' => 'approver'],
],
- 'Content' => [
- 'description' => '当前命令在当前输出流中输出的内容。',
- 'type' => 'string',
- 'example' => 'Apply complete! Resources: 42 added, 0 changed, 0 destroyed.',
+ ],
+ 'Comment' => ['title' => '操作人的审批附加意见。', 'description' => '操作人的审批附加意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'CreateTime' => ['title' => '操作时间。', 'description' => '操作时间。', 'type' => 'string', 'example' => '2022-03-22T05:56:14Z'],
+ 'ApprovalAction' => ['title' => '操作人对计划进行的操作类型。取值:'."\n"
+ ."\n"
+ .'Submit:提交计划。'."\n"
+ .'Cancel:取消计划。'."\n"
+ .'Approve:审批通过。'."\n"
+ .'Reject:审批拒绝。', 'description' => '操作人对计划进行的操作类型。取值:'."\n"
+ ."\n"
+ .'- Submit:提交计划。'."\n"
+ .'- Cancel:取消计划。'."\n"
+ .'- Approve:审批通过。'."\n"
+ .'- Reject:审批拒绝。', 'type' => 'string', 'example' => 'Approve'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'TodoTaskActivities' => [
+ 'title' => '计划正在执行的操作。',
+ 'description' => '计划正在执行的操作。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ActivityName' => ['title' => '计划正在执行的活动名。', 'description' => '计划正在执行的操作名。', 'type' => 'string', 'example' => 'ApproverNode-1'],
+ 'Tasks' => [
+ 'title' => '委派任务列表。',
+ 'description' => '委派任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Operator' => [
+ 'title' => '操作人。',
+ 'description' => '可对计划进行操作的RAM实体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PrincipalType' => ['title' => '操作人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'RamUser:RAM用户。'."\n"
+ .'RamRole:RAM角色。', 'description' => 'RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'PrincipalName' => ['title' => '操作人的RAM实体名称。', 'description' => 'RAM实体名称。', 'type' => 'string', 'example' => 'approver'],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
],
- 'Status' => [
- 'title' => '实例状态',
- 'description' => '任务状态。取值:'."\n"
- ."\n"
- .'- Succeeded:成功。'."\n"
- .'- InProgress:运行中。'."\n"
- .'- Failed:失败。',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'StatusMessage' => [
- 'title' => '实例状态说明',
- 'description' => '任务状态信息。'."\n"
- ."\n"
- .'> 仅在任务状态为Failed时,返回该参数。',
- 'type' => 'string',
- 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '任务创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-23T09:46:27Z',
- ],
- 'UpdateTime' => [
- 'description' => '任务最后更新时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-05-26T03:28:45Z',
- ],
],
+ 'OwnerPrincipalName' => ['title' => '计划归属人的RAM实体名称。', 'description' => '计划归属人的RAM实体名称。', 'type' => 'string', 'example' => 'endUser'],
+ 'Uid' => ['title' => '计划归属人的云账号ID。', 'description' => '计划归属人的云账号ID。', 'type' => 'string', 'example' => '146611588617****'],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'ProductDetail' => [
+ 'title' => '计划产品详情。',
+ 'description' => '计划产品详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductArn' => ['title' => '产品ARN。'."\n"
+ ."\n", 'description' => '产品ARN。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'],
+ 'Description' => ['title' => '产品描述。'."\n"
+ ."\n", 'description' => '产品描述。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'This is a product description.'],
+ 'CreateTime' => ['title' => '创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'description' => '创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'ProductId' => ['title' => '产品ID。'."\n"
+ ."\n", 'description' => '产品ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名称。'."\n"
+ ."\n", 'description' => '产品名称。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProviderName' => ['title' => '产品提供者。'."\n"
+ ."\n", 'description' => '产品提供者。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'IT team'],
+ 'ProductType' => ['title' => '产品类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'description' => '产品类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'example' => 'Ros'],
+ ],
],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'ResourceChanges' => [
+ 'title' => '计划资源变更列表。',
+ 'description' => '计划资源变更列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'LogicalResourceId' => ['title' => '资源逻辑ID。', 'description' => '资源逻辑ID。', 'type' => 'string', 'example' => 'instance'],
+ 'PhysicalResourceId' => ['title' => '资源物理ID。'."\n"
+ ."\n"
+ .'当Action为Modify或Remove时,返回本参数。', 'description' => '资源物理ID。'."\n"
+ ."\n"
+ .'> 当Action为Modify或Remove时,返回本参数。', 'type' => 'string', 'example' => 'i-bp13lmam3qd9q6il****'],
+ 'Replacement' => ['title' => '模板是否为替换更新。取值:'."\n"
+ ."\n"
+ .'True:替换更新。'."\n"
+ .'False:修改更新。'."\n"
+ .'Conditional:可能是替换更新,模板运行时才能确定。', 'description' => '模板是否为替换更新。取值:'."\n"
+ ."\n"
+ .'- True:替换更新。'."\n"
+ .'- False:修改更新。'."\n"
+ .'- Conditional:可能是替换更新,模板运行时才能确定。'."\n"
+ .'> 当Action为Modify时,返回本参数。', 'type' => 'string', 'example' => 'True'],
+ 'ResourceType' => ['title' => '资源类型。', 'description' => '资源类型。', 'type' => 'string', 'example' => 'alicloud_instance'."\n"],
+ 'Action' => ['title' => '资源行为。取值:'."\n"
+ ."\n"
+ .'Add:增加资源。'."\n"
+ .'Modify:修改资源。'."\n"
+ .'Remove:删除资源。'."\n"
+ .'None:无变化。', 'description' => '资源行为。取值:'."\n"
+ ."\n"
+ .'- Add:增加资源。'."\n"
+ .'- Modify:修改资源。'."\n"
+ .'- Remove:删除资源。'."\n"
+ .'- None:无变化。', 'type' => 'string', 'example' => 'Add'],
+ ],
+ 'description' => '',
+ ],
],
- 'PageSize' => [
- 'description' => '分页时每页显示的数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
+ 'ProductVersionDetail' => [
+ 'title' => '产品版本详情',
+ 'description' => '产品版本详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Active' => ['title' => '是否启用', 'description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'Description' => ['title' => '产品版本描述', 'description' => '产品版本描述。', 'type' => 'string', 'example' => 'This is a product version description.'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '产品版本创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'Guidance' => ['title' => '推荐信息', 'description' => '推荐信息。取值:'."\n"
+ ."\n"
+ .'- Default(默认值):无。'."\n"
+ .'- Recommended:稳定版。'."\n"
+ .'- Latest:最新版。'."\n"
+ .'- Deprecated:将废弃。', 'type' => 'string', 'example' => 'Default'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。', 'type' => 'string', 'example' => '1.0.0'],
+ 'ProductId' => ['title' => '产品版本所属的产品ID', 'description' => '产品版本所属的产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'TemplateUrl' => ['title' => '模板的OSS地址', 'description' => '模板的URL地址。', 'type' => 'string', 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json'],
+ 'TemplateType' => ['title' => '模板类型', 'description' => '模板类型。'."\n"
+ ."\n"
+ .'取值为RosTerraformTemplate,表示阿里云资源编排服务(ROS)支持的Terraform模板。', 'type' => 'string', 'example' => 'RosTerraformTemplate'],
+ ],
],
],
],
@@ -4232,57 +2838,53 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskDetails\\": [\\n {\\n \\"TaskId\\": \\"task-bp1dmg242c****\\",\\n \\"TaskType\\": \\"LaunchProduct\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"Test-ECS\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"instance_type\\",\\n \\"ParameterValue\\": \\"ecs.s6-c1m1.small\\"\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputKey\\": \\"instance_id\\",\\n \\"OutputValue\\": \\"i-xxxxxx\\",\\n \\"Description\\": \\"The ECS instance ID.\\"\\n }\\n ],\\n \\"Log\\": {\\n \\"TerraformLogs\\": [\\n {\\n \\"Command\\": \\"apply\\",\\n \\"Stream\\": \\"stdout\\",\\n \\"Content\\": \\"Apply complete! Resources: 42 added, 0 changed, 0 destroyed.\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"Succeeded\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"UpdateTime\\": \\"2022-05-26T03:28:45Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- 'title' => '查询任务列表',
- ],
- 'CopyProduct' => [
- 'summary' => '复制产品。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PlanDetail\\": {\\n \\"PlanId\\": \\"plan-bp1jvmdk2k****\\",\\n \\"PlanName\\": \\"DEMO-ECS-Instance\\",\\n \\"PlanType\\": \\"Ros\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"DEMO-ECS-Instance\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"instance_type\\",\\n \\"ParameterValue\\": \\"ecs.s6-c1m1.small\\"\\n }\\n ],\\n \\"StackId\\": \\"137e31df-3754-40b4-be2f-c793ad84****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"PreviewSuccess\\",\\n \\"StatusMessage\\": \\"Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"UpdateTime\\": \\"2022-05-23T09:47:29Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"OperationType\\": \\"LaunchProduct\\",\\n \\"Description\\": \\"Create ECS\\",\\n \\"AssignedApprovers\\": [\\n {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalName\\": \\"approver\\"\\n }\\n ],\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"27740196382623****\\",\\n \\"ApprovalDetail\\": {\\n \\"OperationRecords\\": [\\n {\\n \\"Operator\\": {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalId\\": \\"277401963826235***\\\\n\\",\\n \\"PrincipalName\\": \\"approver\\"\\n },\\n \\"Comment\\": \\"Agree\\",\\n \\"CreateTime\\": \\"2022-03-22T05:56:14Z\\",\\n \\"ApprovalAction\\": \\"Approve\\"\\n }\\n ],\\n \\"TodoTaskActivities\\": [\\n {\\n \\"ActivityName\\": \\"ApproverNode-1\\",\\n \\"Tasks\\": [\\n {\\n \\"Operator\\": {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalName\\": \\"approver\\"\\n }\\n }\\n ]\\n }\\n ]\\n },\\n \\"OwnerPrincipalName\\": \\"endUser\\",\\n \\"Uid\\": \\"146611588617****\\"\\n },\\n \\"ProductDetail\\": {\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"Description\\": \\"This is a product description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProviderName\\": \\"IT team\\",\\n \\"ProductType\\": \\"Ros\\"\\n },\\n \\"ResourceChanges\\": [\\n {\\n \\"LogicalResourceId\\": \\"instance\\",\\n \\"PhysicalResourceId\\": \\"i-bp13lmam3qd9q6il****\\",\\n \\"Replacement\\": \\"True\\",\\n \\"ResourceType\\": \\"alicloud_instance\\\\n\\",\\n \\"Action\\": \\"Add\\"\\n }\\n ],\\n \\"ProductVersionDetail\\": {\\n \\"Active\\": true,\\n \\"Description\\": \\"This is a product version description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"Guidance\\": \\"Default\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0.0\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询计划信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-16T08:01:19.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-11-14T02:23:42.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProvisionedProductPlan'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetTagOption' => [
+ 'summary' => '查询标签选项详情。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'SourceProductArn',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '',
- 'description' => '源产品ARN。'."\n"
- .'><notice>被复制产品ARN可来自本账号下的产品,也可来自其他账号通过产品组合共享的产品。></notice>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'."\n",
- ],
- ],
- [
- 'name' => 'TargetProductName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '目标产品名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DEMO-ECS',
- ],
+ 'name' => 'TagOptionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '标签选项ID。', 'type' => 'string', 'required' => true, 'example' => 'tag-bp1r3mxq3t****'],
],
],
'responses' => [
@@ -4292,197 +2894,70 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****',
+ 'TagOptionDetail' => [
+ 'description' => '标签选项详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Active' => ['description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true:启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'TagOptionId' => ['description' => '标签选项ID。', 'type' => 'string', 'example' => 'tag-bp15qmwz3r****'],
+ 'Key' => ['description' => '标签选项键。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '标签选项值。', 'type' => 'string', 'example' => 'v1'],
+ 'Owner' => ['description' => '标签选项归属人云账号ID。', 'type' => 'string', 'example' => '133413081827****'],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C1509725-055D-5C7B-9420-8B737DBD****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\"\\n}","type":"json"}]',
- 'title' => '复制产品',
- ],
- 'CreateProduct' => [
- 'summary' => '创建产品。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询标签选项信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTagOption'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagOptionDetail\\": {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp15qmwz3r****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\"\\n },\\n \\"RequestId\\": \\"C1509725-055D-5C7B-9420-8B737DBD****\\"\\n}","type":"json"}]',
+ ],
+ 'GetTask' => [
+ 'summary' => '查询任务信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ProductName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品名称',
- 'description' => '产品名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DEMO-创建ECS',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'ProductType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品类型',
- 'description' => '产品类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ros',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品描述',
- 'description' => '产品描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一个产品描述',
- ],
- ],
- [
- 'name' => 'ProviderName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '提供者名称',
- 'description' => '产品提供者。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'IT团队',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'ProductVersionParameters',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '产品版本相关的参数',
- 'description' => '产品版本信息。',
- 'type' => 'object',
- 'properties' => [
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
- 'TemplateType' => [
- 'title' => '模板类型',
- 'description' => '模板类型。'."\n"
- ."\n"
- .'取值为RosTerraformTemplate,表示阿里云资源编排服务(ROS)支持的Terraform模板。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RosTerraformTemplate',
- ],
- 'TemplateUrl' => [
- 'title' => '模板的URL地址',
- 'description' => '模板的URL地址。'."\n"
- ."\n"
- .'获取模板URL地址的方法,请参见[CreateTemplate](~~CreateTemplate~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json',
- ],
- 'Description' => [
- 'title' => '产品版本描述',
- 'description' => '产品版本描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一个产品版本描述',
- ],
- 'Guidance' => [
- 'title' => '推荐信息',
- 'description' => '推荐信息。取值:'."\n"
- ."\n"
- .'- Default(默认值):无。'."\n"
- .'- Recommended:稳定版。'."\n"
- .'- Latest:最新版。'."\n"
- .'- Deprecated:将废弃。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Default',
- ],
- 'Active' => [
- 'title' => '是否启用',
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'TemplateType',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RosTerraformTemplate',
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => 'task-bp1dmg242c****'],
],
],
'responses' => [
@@ -4492,22 +2967,110 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductVersionId' => [
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'TaskDetail' => [
+ 'title' => '任务信息',
+ 'description' => '任务详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID。', 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'TaskType' => ['title' => '任务类型', 'description' => '任务类型。取值:'."\n"
+ ."\n"
+ .'- LaunchProduct:启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'example' => 'LaunchProduct'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名称', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。', 'type' => 'string', 'example' => '1.0'],
+ 'ProvisionedProductId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
+ 'ProvisionedProductName' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'DEMO-ECS-Instance'],
+ 'Parameters' => [
+ 'description' => '用户输入的模板参数。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '用户输入的模板参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterKey' => ['description' => '模板中定义的参数名称。', 'type' => 'string', 'example' => 'instance_type'],
+ 'ParameterValue' => ['description' => '用户输入的模板参数值。', 'type' => 'string', 'example' => 'ecs.s6-c1m1.small'],
+ ],
+ ],
+ ],
+ 'Outputs' => [
+ 'description' => '模板的输出值。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '模板的输出值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OutputKey' => ['description' => '模板中定义的输出值名称。', 'type' => 'string', 'example' => 'instance_id'],
+ 'OutputValue' => ['description' => '模板中定义的输出值的内容。', 'type' => 'string', 'example' => 'i-xxxxxx'],
+ 'Description' => ['description' => '模板中定义的输出值的描述。', 'type' => 'string', 'example' => 'The ECS instance ID.'],
+ ],
+ ],
+ ],
+ 'Log' => [
+ 'description' => '实例相关输出日志。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TerraformLogs' => [
+ 'description' => 'Terraform输出日志。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Terraform输出日志。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Command' => ['description' => '执行的Terraform命令名称。取值:'."\n"
+ ."\n"
+ .'- apply'."\n"
+ .'- plan'."\n"
+ .'- destroy'."\n"
+ .'- version'."\n"
+ ."\n"
+ .'关于命令含义的更多信息,请参见[Command](https://www.terraform.io/cli/commands)。', 'type' => 'string', 'example' => 'apply'],
+ 'Stream' => ['description' => '输出流。取值:'."\n"
+ ."\n"
+ .'- stdout:标准输出。'."\n"
+ .'- stderr:标准错误输出。', 'type' => 'string', 'example' => 'stdout'],
+ 'Content' => ['description' => '当前命令在当前输出流中输出的内容。', 'type' => 'string', 'example' => 'Apply complete! Resources: 42 added, 0 changed, 0 destroyed.'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Status' => ['title' => '任务状态', 'description' => '任务状态。取值:'."\n"
+ ."\n"
+ .'- Succeeded:成功。'."\n"
+ .'- InProgress:运行中。'."\n"
+ .'- Failed:失败。', 'type' => 'string', 'example' => 'Succeeded'],
+ 'StatusMessage' => ['title' => '任务状态说明', 'description' => '任务状态信息。'."\n"
+ ."\n"
+ .'> 仅在任务状态为Failed时,返回该参数。', 'type' => 'string', 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '任务创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-23T09:46:27Z'],
+ 'UpdateTime' => ['description' => '任务最后更新时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-23T09:47:29Z'],
+ 'TaskTags' => [
+ 'description' => '自定义标签。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '自定义标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '自定义标签键。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '自定义标签值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'example' => 'v1'],
+ ],
+ ],
+ ],
+ ],
],
],
],
@@ -4515,46 +3078,60 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\"\\n}","type":"json"}]',
- 'title' => '创建产品',
- 'description' => '调用该接口前,请先调用[CreateTemplate](~~CreateTemplate~~)创建模板。',
- ],
- 'DeleteProduct' => [
- 'summary' => '删除产品。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TaskDetail\\": {\\n \\"TaskId\\": \\"task-bp1dmg242c****\\",\\n \\"TaskType\\": \\"LaunchProduct\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"DEMO-ECS-Instance\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"instance_type\\",\\n \\"ParameterValue\\": \\"ecs.s6-c1m1.small\\"\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputKey\\": \\"instance_id\\",\\n \\"OutputValue\\": \\"i-xxxxxx\\",\\n \\"Description\\": \\"The ECS instance ID.\\"\\n }\\n ],\\n \\"Log\\": {\\n \\"TerraformLogs\\": [\\n {\\n \\"Command\\": \\"apply\\",\\n \\"Stream\\": \\"stdout\\",\\n \\"Content\\": \\"Apply complete! Resources: 42 added, 0 changed, 0 destroyed.\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"Succeeded\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"UpdateTime\\": \\"2022-05-23T09:47:29Z\\",\\n \\"TaskTags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '查询任务信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-16T08:01:20.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-05-27T07:47:14.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2021-12-29T07:49:30.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTemplate' => [
+ 'summary' => '查询模板详情。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ProductId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
+ ],
+ [
+ 'name' => 'ProductVersionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'],
],
],
'responses' => [
@@ -4564,36 +3141,52 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'TemplateBody' => ['title' => '模板内容', 'description' => '模板内容。'."\n"
+ ."\n"
+ .'关于模板语法的详情,请参见[Terraform类型模板结构](~~184397~~)。', 'type' => 'string', 'example' => '{'."\n"
+ .' "ROSTemplateFormatVersion": "2015-09-01",'."\n"
+ .' "Transform": "Aliyun::Terraform-v1.1",'."\n"
+ .' "Workspace": {'."\n"
+ .' "main.tf": "variable \\"name\\" { default = \\"auto_provisioning_group\\"}"'."\n"
+ .' },'."\n"
+ .' "Outputs": {}'."\n"
+ .'}'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '删除产品',
- ],
- 'UpdateProduct' => [
- 'summary' => '更新产品。',
- 'methods' => [
- 'post',
+ 'title' => '查询模板详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TemplateBody\\": \\"{\\\\n \\\\\\"ROSTemplateFormatVersion\\\\\\": \\\\\\"2015-09-01\\\\\\",\\\\n \\\\\\"Transform\\\\\\": \\\\\\"Aliyun::Terraform-v1.1\\\\\\",\\\\n \\\\\\"Workspace\\\\\\": {\\\\n \\\\\\"main.tf\\\\\\": \\\\\\"variable \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\" { default = \\\\\\\\\\\\\\"auto_provisioning_group\\\\\\\\\\\\\\"}\\\\\\"\\\\n },\\\\n \\\\\\"Outputs\\\\\\": {}\\\\n}\\"\\n}","type":"json"}]',
+ ],
+ 'LaunchProduct' => [
+ 'summary' => '启动产品。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4601,62 +3194,90 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'ProductName',
+ 'name' => 'ProvisionedProductName',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品名称',
- 'description' => '产品名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Test-ECS',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
+ 'schema' => ['title' => '实例名称', 'description' => '实例名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'DEMO-ECS-Instance', 'maxLength' => 100, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'PortfolioId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。'."\n"
+ ."\n"
+ .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。', 'type' => 'string', 'required' => false, 'example' => 'port-bp1yt7582g****'],
],
[
'name' => 'ProductId',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
[
- 'name' => 'Description',
+ 'name' => 'ProductVersionId',
'in' => 'formData',
+ 'schema' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '产品描述',
- 'description' => '产品描述。'."\n"
+ 'description' => '用户输入的模板参数。'."\n"
."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
+ .'N最大值为200。'."\n"
+ ."\n"
+ .'> Parameters为可选参数。如果需要指定Parameters,则Parameters.N.ParameterKey和Parameters.N.ParameterValue必须同时指定。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterKey' => ['description' => '模板中定义的参数名称。', 'type' => 'string', 'required' => false, 'example' => 'instance_type'],
+ 'ParameterValue' => ['description' => '用户输入的模板参数值。', 'type' => 'string', 'required' => false, 'example' => 'ecs.s6-c1m1.small'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => 'This is a product description.',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'ProviderName',
+ 'name' => 'StackRegionId',
'in' => 'formData',
+ 'schema' => ['title' => 'ROS资源栈所属的地域ID', 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n"
+ ."\n"
+ .'获取ROS支持的地域列表的方法,请参见[DescribeRegions](~~131035~~)。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '提供者名称',
- 'description' => '产品提供者。'."\n"
+ 'description' => '用户输入的自定义标签。'."\n"
."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'IT team',
- 'maxLength' => 100,
- 'minLength' => 1,
+ .'N最大值为20。'."\n"
+ ."\n"
+ .'> - Tags为可选参数。如果需要指定Tags,则Tags.N.Key和Tags.N.Value必须同时指定。'."\n"
+ .'> - 此标签会传递到资源栈中每个支持标签的资源中。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '用户输入的自定义标签键。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'Value' => ['description' => '用户输入的自定义标签值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
],
],
],
@@ -4667,43 +3288,48 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProvisionedProductId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\"\\n}","type":"json"}]',
+ 'title' => '启动产品',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-16T08:01:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-31T07:40:30.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-27T07:47:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-12-28T03:48:53.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchProduct'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:LaunchProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\"\\n}","type":"json"}]',
- 'title' => '更新产品',
],
- 'GetProductAsAdmin' => [
- 'summary' => '管理员调用GetProductAsAdmin接口查询产品信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListLaunchOptions' => [
+ 'summary' => '查询启动选项列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4712,19 +3338,16 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
],
'parameters' => [
[
'name' => 'ProductId',
'in' => 'query',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
],
'responses' => [
@@ -4734,109 +3357,46 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductDetail' => [
- 'title' => '产品详情',
- 'description' => '产品详情。',
- 'type' => 'object',
- 'properties' => [
- 'ProductArn' => [
- 'title' => '产品ARN',
- 'description' => '产品ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****',
- ],
- 'Description' => [
- 'title' => '产品描述',
- 'description' => '产品描述。',
- 'type' => 'string',
- 'example' => '这是一个产品描述',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名称',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProviderName' => [
- 'title' => '提供者名称',
- 'description' => '产品提供者。',
- 'type' => 'string',
- 'example' => 'IT团队',
- ],
- 'ProductType' => [
- 'title' => '产品类型',
- 'description' => '产品类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'example' => 'Ros',
- ],
- 'TemplateType' => [
- 'title' => '产品模板类型',
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'example' => 'RosTerraformTemplate',
- ],
- ],
- ],
- 'TagOptions' => [
- 'description' => '产品关联的标签选项列表。',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'LaunchOptionSummaries' => [
+ 'title' => '启动选项概要',
+ 'description' => '启动选项列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Active' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TagOptionId' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'example' => 'tag-bp1q65xd3j****',
- ],
- 'Key' => [
- 'description' => '标签选项键。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '标签选项值。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Owner' => [
- 'description' => '标签选项归属人ID。',
- 'type' => 'string',
- 'example' => '133413081827****'."\n",
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'PortfolioName' => ['title' => '产品组合名称', 'description' => '产品组合名称。', 'type' => 'string', 'example' => 'DEMO-IT Service'],
+ 'ConstraintSummaries' => [
+ 'title' => '约束概要',
+ 'description' => '约束列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ConstraintType' => ['title' => '约束类型', 'description' => '约束类型。取值:'."\n"
+ .'1. Launch:启动约束。'."\n"
+ .'2. Template:模板约束。'."\n"
+ .'3. Approval:审批约束。'."\n"
+ .'4. StackRegion:地域约束。', 'type' => 'string', 'example' => 'Launch'],
+ 'Description' => ['title' => '约束描述', 'description' => '约束描述。', 'type' => 'string', 'example' => 'Launch as local role TestRole'],
+ 'OperationTypes' => [
+ 'title' => '操作类型,当约束类型为审批约束时不为空',
+ 'description' => '需被审批的操作类型列表,当约束类型为审批约束时不为空。',
+ 'type' => 'array',
+ 'items' => ['description' => '操作类型,当约束类型为审批约束时不为空。', 'type' => 'string', 'example' => 'All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct'],
+ ],
+ 'StackRegions' => [
+ 'description' => '终端用户可启动的地域列表,当约束类型为地域约束时不为空。',
+ 'type' => 'array',
+ 'items' => ['description' => '终端用户可启动的地域。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ 'description' => '',
+ ],
],
],
+ 'description' => '',
],
],
],
@@ -4845,25 +3405,34 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductDetail\\": {\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"Description\\": \\"这是一个产品描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProviderName\\": \\"IT团队\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n },\\n \\"TagOptions\\": [\\n {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1q65xd3j****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '管理员查询产品信息',
- ],
- 'ListProductsAsAdmin' => [
- 'summary' => '管理员调用ListProductsAsAdmin接口查询产品列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"LaunchOptionSummaries\\": [\\n {\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"PortfolioName\\": \\"DEMO-IT Service\\",\\n \\"ConstraintSummaries\\": [\\n {\\n \\"ConstraintType\\": \\"Launch\\",\\n \\"Description\\": \\"Launch as local role TestRole\\",\\n \\"OperationTypes\\": [\\n \\"All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct\\"\\n ],\\n \\"StackRegions\\": [\\n \\"cn-hangzhou\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询启动选项列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLaunchOptions'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListLaunchOptions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListPortfolios' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4875,22 +3444,14 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PortfolioId',
+ 'name' => 'ProductId',
'in' => 'query',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => false, 'example' => 'prod-bp18r7q127****'],
],
[
'name' => 'Filters',
@@ -4903,25 +3464,14 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '过滤条件的名称',
- 'description' => '过滤条件的名称。取值:'."\n"
- ."\n"
- .'- ProductName:按产品名称查找,完整匹配(忽略大小写)。'."\n"
- .'- FullTextSearch:全文检索,按产品名称、产品提供者、产品描述查找,模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ProductName',
- ],
- 'Value' => [
- 'title' => '过滤条件的值',
- 'description' => '过滤条件的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DEMO-创建ECS',
- ],
+ 'Key' => ['title' => '过滤条件的名称', 'description' => '过滤条件的名称。取值:'."\n"
+ ."\n"
+ .'- PortfolioName:按产品组合名称查找,完整匹配(忽略大小写)。'."\n"
+ .'- FullTextSearch:全文检索,按产品组合名称、产品组合提供者、产品组合描述查找,模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'PortfolioName'],
+ 'Value' => ['title' => '过滤条件的值', 'description' => '过滤条件的值。', 'type' => 'string', 'required' => false, 'example' => 'DEMO-IT'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
'maxItems' => 5,
@@ -4930,69 +3480,40 @@
[
'name' => 'SortBy',
'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示产品创建时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
- ],
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示产品组合创建时间。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
],
[
'name' => 'SortOrder',
'in' => 'query',
- 'schema' => [
- 'title' => '排序方式',
- 'description' => '排序方式。取值:'."\n"
- ."\n"
- .'- Asc:正序。'."\n"
- .'- Desc:倒序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- ],
+ 'schema' => ['title' => '排序方式', 'description' => '排序方式。取值:'."\n"
+ ."\n"
+ .'- Asc:正序。'."\n"
+ .'- Desc:倒序。', 'type' => 'string', 'required' => false, 'example' => 'Desc'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Scope',
'in' => 'query',
- 'schema' => [
- 'description' => '查询范围。取值:'."\n"
- ."\n"
- .'- Local(默认值):在当前账号中创建的产品。'."\n"
- .'- Imported:从其他账号导入的产品。'."\n"
- .'- All:所有可以使用的产品。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Local',
- ],
+ 'schema' => ['description' => '查询范围。取值:'."\n"
+ ."\n"
+ .'- Local(默认值):在当前账号中创建的产品组合。'."\n"
+ .'- Import:从其他账号导入的产品组合。'."\n"
+ .'- All:所有可以使用的产品组合。', 'type' => 'string', 'required' => false, 'example' => 'Local'],
],
],
'responses' => [
@@ -5002,226 +3523,85 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductDetails' => [
- 'title' => '产品列表',
- 'description' => '产品列表。',
+ 'PortfolioDetails' => [
+ 'title' => '产品组合列表',
+ 'description' => '产品组合列表。',
'type' => 'array',
'items' => [
- 'description' => '产品详情。',
+ 'title' => 'PortfolioItemType',
+ 'description' => '产品组合详情。',
'type' => 'object',
'properties' => [
- 'ProductArn' => [
- 'title' => '产品ARN',
- 'description' => '产品ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****',
- ],
- 'Description' => [
- 'title' => '产品描述',
- 'description' => '产品描述。',
- 'type' => 'string',
- 'example' => '这是一个产品描述',
- ],
- 'CreateTime' => [
- 'title' => '产品创建时间',
- 'description' => '产品创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'ProductId' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ProductName' => [
- 'title' => '产品名字',
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- 'ProviderName' => [
- 'title' => '产品提供方',
- 'description' => '产品提供者。',
- 'type' => 'string',
- 'example' => 'IT团队',
- ],
- 'ProductType' => [
- 'title' => '产品类型',
- 'description' => '产品类型。'."\n"
- ."\n"
- .'取值为Ros,表示阿里云资源编排服务(ROS)。',
- 'type' => 'string',
- 'example' => 'Ros',
- ],
- 'TemplateType' => [
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'example' => 'RosTerraformTemplate',
- ],
+ 'Description' => ['title' => '产品组合描述', 'description' => '产品组合描述。', 'type' => 'string', 'example' => 'This is a product portfolio description.'],
+ 'PortfolioName' => ['title' => '产品组合名称', 'description' => '产品组合名称。', 'type' => 'string', 'example' => 'DEMO-IT'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '产品组合创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:11:12Z'],
+ 'ProviderName' => ['title' => '提供者名称', 'description' => '产品组合提供者。', 'type' => 'string', 'example' => 'IT team'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'PortfolioArn' => ['title' => '产品组合ARN', 'description' => '产品组合ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****'],
],
],
],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页时每页显示的数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页时每页显示的数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '查询产品组合列表',
+ 'summary' => '查询产品组合列表。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-27T07:47:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:09.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:09.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListPortfolios',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductDetails\\": [\\n {\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"Description\\": \\"这是一个产品描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\",\\n \\"ProviderName\\": \\"IT团队\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- 'title' => '管理员查询产品列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PortfolioDetails\\": [\\n {\\n \\"Description\\": \\"This is a product portfolio description.\\",\\n \\"PortfolioName\\": \\"DEMO-IT\\",\\n \\"CreateTime\\": \\"2022-04-12T06:11:12Z\\",\\n \\"ProviderName\\": \\"IT team\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"PortfolioArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****\\"\\n }\\n ],\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
],
- 'CreateProductVersion' => [
- 'summary' => '创建产品版本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListPrincipals' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
],
'parameters' => [
[
- 'name' => 'ProductVersionName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1.0',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'TemplateType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模板类型',
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RosTerraformTemplate',
- ],
- ],
- [
- 'name' => 'TemplateUrl',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模板的OSS地址',
- 'description' => '模板的URL地址。'."\n"
- ."\n"
- .'获取模板URL地址的方法,请参见[CreateTemplate](~~CreateTemplate~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本描述',
- 'description' => '产品版本描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一个产品版本描述',
- ],
- ],
- [
- 'name' => 'Guidance',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '推荐信息',
- 'description' => '推荐信息。取值:'."\n"
- ."\n"
- .'- Default(默认值):无。'."\n"
- .'- Recommended:稳定版。'."\n"
- .'- Latest:最新版。'."\n"
- .'- Deprecated:将废弃。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Default',
- ],
- ],
- [
- 'name' => 'Active',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否启用',
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'ProductId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本所属的产品ID',
- 'description' => '产品版本所属的产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'name' => 'PortfolioId',
+ 'in' => 'query',
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
],
],
'responses' => [
@@ -5231,17 +3611,23 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'Principals' => [
+ 'title' => 'RAM实体列表',
+ 'description' => 'RAM实体列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'RAM实体信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PrincipalType' => ['title' => 'RAM实体类型', 'description' => 'RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'PrincipalId' => ['title' => 'RAM实体ID', 'description' => 'RAM实体ID。', 'type' => 'string', 'example' => '24477111603637****'],
+ 'PrincipalPattern' => ['type' => 'string'],
+ ],
+ ],
],
],
],
@@ -5249,46 +3635,47 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '查询产品组合已授权的用户和角色列表',
+ 'summary' => '查询产品组合已授权的RAM用户和RAM角色列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListPrincipals',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\"\\n}","type":"json"}]',
- 'title' => '创建产品版本',
- 'description' => '调用该接口前,请先调用[CreateTemplate](~~CreateTemplate~~)创建模板。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"Principals\\": [\\n {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalId\\": \\"24477111603637****\\",\\n \\"PrincipalPattern\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DeleteProductVersion' => [
- 'summary' => '删除产品版本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListProductVersions' => [
+ 'summary' => '查询产品版本列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ProductVersionId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****',
- ],
+ 'name' => 'ProductId',
+ 'in' => 'query',
+ 'schema' => ['title' => '产品版本所属的产品ID', 'description' => '产品版本所属的产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
],
'responses' => [
@@ -5298,11 +3685,39 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductVersionDetails' => [
+ 'title' => '产品版本列表',
+ 'description' => '产品版本列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '产品版本详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Active' => ['title' => '是否启用', 'description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'Description' => ['title' => '产品版本描述', 'description' => '产品版本描述。', 'type' => 'string', 'example' => 'This is a product version description.'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '产品版本创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'Guidance' => ['title' => '推荐信息', 'description' => '推荐信息。取值:'."\n"
+ ."\n"
+ .'- Default(默认值):无。'."\n"
+ .'- Recommended:稳定版。'."\n"
+ .'- Latest:最新版。'."\n"
+ .'- Deprecated:将废弃。', 'type' => 'string', 'example' => 'Default'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。', 'type' => 'string', 'example' => '1.0'],
+ 'TemplateUrl' => ['title' => '模板的OSS地址', 'description' => '模板的URL地址。', 'type' => 'string', 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json'],
+ 'TemplateType' => ['title' => '模板类型', 'description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'example' => 'RosTerraformTemplate'],
+ 'ProductId' => ['description' => '产品版本所属的产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ ],
+ ],
],
],
],
@@ -5310,103 +3725,116 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '删除产品版本',
- ],
- 'UpdateProductVersion' => [
- 'summary' => '更新产品版本。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductVersionDetails\\": [\\n {\\n \\"Active\\": true,\\n \\"Description\\": \\"This is a product version description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"Guidance\\": \\"Default\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询产品版本列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-27T07:47:14.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProductVersions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListProductsAsAdmin' => [
+ 'summary' => '管理员调用ListProductsAsAdmin接口查询产品列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ProductVersionId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****',
- ],
+ 'name' => 'PortfolioId',
+ 'in' => 'query',
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => false, 'example' => 'port-bp1yt7582g****'],
],
[
- 'name' => 'ProductVersionName',
- 'in' => 'formData',
+ 'name' => 'Filters',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1.0',
- 'maxLength' => 100,
- 'minLength' => 1,
+ 'title' => '过滤条件',
+ 'description' => '过滤条件。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '过滤条件的名称', 'description' => '过滤条件的名称。取值:'."\n"
+ ."\n"
+ .'- ProductName:按产品名称查找,完整匹配(忽略大小写)。'."\n"
+ .'- FullTextSearch:全文检索,按产品名称、产品提供者、产品描述查找,模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'ProductName'],
+ 'Value' => ['title' => '过滤条件的值', 'description' => '过滤条件的值。', 'type' => 'string', 'required' => false, 'example' => 'DEMO-Create ECS'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
],
],
[
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品版本描述',
- 'description' => '产品版本描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一个产品版本描述',
- ],
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示产品创建时间。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
],
[
- 'name' => 'Guidance',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '推荐信息',
- 'description' => '推荐信息。取值:'."\n"
- ."\n"
- .'- Default(默认值):无。'."\n"
- .'- Recommended:稳定版。'."\n"
- .'- Latest:最新版。'."\n"
- .'- Deprecated:将废弃。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Default',
- ],
+ 'name' => 'SortOrder',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方式', 'description' => '排序方式。取值:'."\n"
+ ."\n"
+ .'- Asc:正序。'."\n"
+ .'- Desc:倒序。', 'type' => 'string', 'required' => false, 'example' => 'Desc'],
],
[
- 'name' => 'Active',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否启用',
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Scope',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询范围。取值:'."\n"
+ ."\n"
+ .'- Local(默认值):在当前账号中创建的产品。'."\n"
+ .'- Imported:从其他账号导入的产品。'."\n"
+ .'- All:所有可以使用的产品。', 'type' => 'string', 'required' => false, 'example' => 'Local'],
],
],
'responses' => [
@@ -5416,43 +3844,75 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductDetails' => [
+ 'title' => '产品列表',
+ 'description' => '产品列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '产品详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductArn' => ['title' => '产品ARN', 'description' => '产品ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'],
+ 'Description' => ['title' => '产品描述', 'description' => '产品描述。', 'type' => 'string', 'example' => 'This is a product description.'],
+ 'CreateTime' => ['title' => '产品创建时间', 'description' => '产品创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名字', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProviderName' => ['title' => '产品提供方', 'description' => '产品提供者。', 'type' => 'string', 'example' => 'IT team'],
+ 'ProductType' => ['title' => '产品类型', 'description' => '产品类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'example' => 'Ros'],
+ 'TemplateType' => ['description' => '产品模板类型。取值:'."\n"
+ ."\n"
+ .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'example' => 'RosTerraformTemplate'],
+ ],
+ ],
],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页时每页显示的数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductDetails\\": [\\n {\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"Description\\": \\"This is a product description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProviderName\\": \\"IT team\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
+ 'title' => '管理员查询产品列表',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-27T10:57:48.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-05-27T07:47:14.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProductsAsAdmin',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\"\\n}","type":"json"}]',
- 'title' => '更新产品版本',
],
- 'GetProductVersion' => [
- 'summary' => '查询产品版本信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListProductsAsEndUser' => [
+ 'summary' => '终端用户调用ListProductsAsEndUser接口查询产品列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5462,19 +3922,66 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ProductVersionId',
+ 'name' => 'Filters',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****',
+ 'title' => '过滤条件',
+ 'description' => '过滤条件。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '过滤条件的名称', 'description' => '过滤条件的名称。取值:'."\n"
+ ."\n"
+ .'- ProductName:按产品名称查找,完整匹配(忽略大小写)。'."\n"
+ .'- FullTextSearch:全文检索,按产品名称、产品提供者、产品描述查找,模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'ProductName'],
+ 'Value' => ['title' => '过滤条件的值', 'description' => '过滤条件的值。', 'type' => 'string', 'required' => false, 'example' => 'DEMO-Create ECS'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
],
],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示产品创建时间。'."\n"
+ .'默认取值CreateTime。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
+ ],
+ [
+ 'name' => 'SortOrder',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方式', 'description' => '排序方式。取值:'."\n"
+ ."\n"
+ .'- Asc:正序。'."\n"
+ .'- Desc(默认值):倒序。', 'type' => 'string', 'required' => false, 'example' => 'Desc'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
],
'responses' => [
200 => [
@@ -5483,112 +3990,82 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'ProductVersionDetail' => [
- 'title' => '产品版本详情',
- 'description' => '产品版本详情。',
- 'type' => 'object',
- 'properties' => [
- 'Active' => [
- 'title' => '是否启用',
- 'description' => '是否启用。取值:'."\n"
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductSummaries' => [
+ 'title' => '产品列表',
+ 'description' => '产品列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '产品概要信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['title' => '产品描述', 'description' => '产品描述。', 'type' => 'string', 'example' => 'This is a product description.'],
+ 'CreateTime' => ['title' => '产品创建时间', 'description' => '产品创建时间。'."\n"
."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'enumValueTitles' => [],
- 'example' => 'true',
- ],
- 'Description' => [
- 'title' => '产品版本描述',
- 'description' => '产品版本描述。',
- 'type' => 'string',
- 'example' => '这是一个产品版本描述',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '产品版本创建时间。'."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-04-12T06:10:37Z'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductArn' => ['title' => '产品ARN', 'description' => '产品ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名字', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProviderName' => ['title' => '产品提供方', 'description' => '产品提供者。', 'type' => 'string', 'example' => 'IT team'],
+ 'ProductType' => ['title' => '产品类型', 'description' => '产品类型。'."\n"
."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'Guidance' => [
- 'title' => '推荐信息',
- 'description' => '推荐信息。取值:'."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'example' => 'Ros'],
+ 'HasDefaultLaunchOption' => ['title' => '是否存在默认的启动选项', 'description' => '是否存在默认启动选项。取值:'."\n"
."\n"
- .'- Default(默认值):无。'."\n"
- .'- Recommended:稳定版。'."\n"
- .'- Latest:最新版。'."\n"
- .'- Deprecated:将废弃。',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'ProductId' => [
- 'title' => '产品版本所属的产品ID',
- 'description' => '产品版本所属的产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'TemplateUrl' => [
- 'title' => '模板的OSS地址',
- 'description' => '模板的URL地址。',
- 'type' => 'string',
- 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json',
- ],
- 'TemplateType' => [
- 'title' => '模板类型',
- 'description' => '产品模板类型。取值:'."\n"
+ .'- true:存在默认启动选项,启动产品或更新实例时无需填写PortfolioId。'."\n"
+ .'- false:没有默认启动选项,启动产品或更新实例时必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。'."\n"
+ ."\n"
+ .'> 如果产品仅被加入到一个产品组合,则会存在默认启动选项。如果产品被加入到多个产品组合,则会同时存在多个启动选项,但此时没有默认启动选项。', 'type' => 'boolean', 'example' => 'true'],
+ 'TemplateType' => ['description' => '产品模板类型。取值:'."\n"
."\n"
.'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'example' => 'RosTerraformTemplate',
+ .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。', 'type' => 'string', 'example' => 'RosTerraformTemplate'],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页时每页显示的数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductSummaries\\": [\\n {\\n \\"Description\\": \\"This is a product description.\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProviderName\\": \\"IT team\\",\\n \\"ProductType\\": \\"Ros\\",\\n \\"HasDefaultLaunchOption\\": true,\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
+ 'title' => '终端用户查询产品列表',
+ 'description' => '请确保终端用户已被管理员授予相关产品的使用权限。具体操作,请参见[为终端用户授予访问权限](~~405233~~)。',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-27T10:57:48.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-05-27T07:47:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProductsAsEndUser',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProductVersionDetail\\": {\\n \\"Active\\": true,\\n \\"Description\\": \\"这是一个产品版本描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"Guidance\\": \\"Default\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\"\\n },\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '查询产品版本信息',
],
- 'ListProductVersions' => [
- 'summary' => '查询产品版本列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListProvisionedProductPlanApprovers' => [
+ 'summary' => '查询计划审批人列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5598,108 +4075,78 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ProductId',
+ 'name' => 'AccessLevelFilter',
'in' => 'query',
+ 'schema' => ['title' => '访问过滤器', 'description' => '访问过滤器。取值:'."\n"
+ ."\n"
+ .'- User(默认值):用户。'."\n"
+ .'- Account:账号。'."\n"
+ .'- ResourceDirectory:资源目录。'."\n"
+ ."\n"
+ .'> 必须指定`ApprovalFilter`和`AccessLevelFilter`两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'User'],
+ ],
+ [
+ 'name' => 'Filters',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '产品版本所属的产品ID',
- 'description' => '产品版本所属的产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
+ 'title' => '过滤条件,支持Key值为ProvisionedProductPlanApproverName',
+ 'description' => '过滤条件。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '过滤条件的名称', 'description' => '过滤条件的名称。取值:'."\n"
+ ."\n"
+ .'- ProvisionedProductPlanApproverName:按审批人名称模糊匹配', 'type' => 'string', 'required' => false, 'example' => 'ProvisionedProductPlanApproverName'],
+ 'Value' => ['title' => '过滤条件的值', 'description' => '过滤条件的值。', 'type' => 'string', 'required' => false, 'example' => 'approver'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
],
],
+ [
+ 'name' => 'ApprovalFilter',
+ 'in' => 'query',
+ 'schema' => ['title' => '审批维度访问过滤器', 'description' => '审批维度访问过滤器。取值:'."\n"
+ .'- AccountRequests:账号级别全部审批。'."\n"
+ .'- ResourceDirectoryRequests:资源目录级别全部审批。'."\n"
+ .'> 必须指定`ApprovalFilter`和`AccessLevelFilter`两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'AccountRequests'],
+ ],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ProductVersionDetails' => [
- 'title' => '产品版本列表',
- 'description' => '产品版本列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****'],
+ 'Approvers' => [
+ 'title' => '审批人列表',
+ 'description' => '审批人列表。',
'type' => 'array',
'items' => [
- 'description' => '产品版本详情。',
'type' => 'object',
'properties' => [
- 'Active' => [
- 'title' => '是否启用',
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Description' => [
- 'title' => '产品版本描述',
- 'description' => '产品版本描述。',
- 'type' => 'string',
- 'example' => '这是一个产品版本描述。',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '产品版本创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:10:37Z',
- ],
- 'Guidance' => [
- 'title' => '推荐信息',
- 'description' => '推荐信息。取值:'."\n"
- ."\n"
- .'- Default(默认值):无。'."\n"
- .'- Recommended:稳定版。'."\n"
- .'- Latest:最新版。'."\n"
- .'- Deprecated:将废弃。',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'ProductVersionId' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'example' => 'pv-bp15e79d26****',
- ],
- 'ProductVersionName' => [
- 'title' => '产品版本名称',
- 'description' => '产品版本名称。',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'TemplateUrl' => [
- 'title' => '模板的OSS地址',
- 'description' => '模板的URL地址。',
- 'type' => 'string',
- 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json',
- ],
- 'TemplateType' => [
- 'title' => '模板类型',
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'example' => 'RosTerraformTemplate',
- ],
- 'ProductId' => [
- 'description' => '产品版本所属的产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'PrincipalName' => ['title' => '审批人名称', 'description' => '审批人名称。', 'type' => 'string', 'example' => 'approver-1'],
+ 'PrincipalType' => ['title' => 'RAM实体类型', 'description' => '计划审批人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
],
+ 'description' => '',
],
],
],
@@ -5708,192 +4155,175 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductVersionDetails\\": [\\n {\\n \\"Active\\": true,\\n \\"Description\\": \\"这是一个产品版本描述。\\",\\n \\"CreateTime\\": \\"2022-04-12T06:10:37Z\\",\\n \\"Guidance\\": \\"Default\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\",\\n \\"TemplateType\\": \\"RosTerraformTemplate\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询产品版本列表',
- ],
- 'CreateTemplate' => [
- 'summary' => '创建模板。服务目录会保存用户上传的模板,并返回模板的URL地址。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询计划审批人列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProvisionedProductPlanApprovers'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProvisionedProductPlanApprovers',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\",\\n \\"Approvers\\": [\\n {\\n \\"PrincipalName\\": \\"approver-1\\",\\n \\"PrincipalType\\": \\"RamUser\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListProvisionedProductPlans' => [
+ 'summary' => '查询计划列表。可分用户维度和审批维度进行查询。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'TemplateBody',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模板内容',
- 'description' => '模板内容。'."\n"
- ."\n"
- .'关于模板语法的详情,请参见[Terraform类型模板结构](~~184397~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{'."\n"
- .' "ROSTemplateFormatVersion": "2015-09-01",'."\n"
- .' "Transform": "Aliyun::Terraform-v1.1",'."\n"
- .' "Workspace": {'."\n"
- .' "main.tf": "variable \\"name\\" { default = \\"auto_provisioning_group\\"}"'."\n"
- .' },'."\n"
- .' "Outputs": {}'."\n"
- .'}',
- ],
- ],
- [
- 'name' => 'TemplateType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模板类型',
- 'description' => '产品模板类型。取值:'."\n"
- ."\n"
- .'- RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的Terraform模板。'."\n"
- .'- RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RosTerraformTemplate',
- ],
- ],
- [
- 'name' => 'TerraformVariables',
- 'in' => 'formData',
+ 'name' => 'Filters',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'Terraform模板变量设置,以结构化的方式表示,服务目录会将变量设置应用到模板中。'."\n"
- ."\n"
- .'> 变量必须在Terraform模板中存在。',
+ 'title' => '过滤条件。',
+ 'description' => '过滤条件。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'VariableName' => [
- 'description' => '变量名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instance_type',
- ],
- 'Description' => [
- 'description' => '变量描述。'."\n"
+ 'Key' => [
+ 'title' => '过滤条件的名称。取值:'."\n"
+ ."\n"
+ .'ProvisionedProductPlanName:按计划名称查找,完整匹配(忽略大小写)。'."\n"
+ .'ProvisionedProductPlanApprover:按审批人精确查找,格式为RamUser/RamRole:审批人名称,可多选。'."\n"
+ .'ProvisionedProductPlanApproverName:按审批人名称查找,直接输入审批人的RAM实体名称,可多选。'."\n"
+ .'ProvisionedProductPlanStatus:按计划状态查找,直接输入审批人的RAM实体名称,可多选。'."\n"
+ .'ProvisionedProductPlanOwnerUid:按计划归属云账号ID精确查找。'."\n"
+ .'FullTextSearch:全文检索,按计划名称查找,模糊匹配。',
+ 'description' => '过滤条件的名称。取值:'."\n"
."\n"
- .'关于变量描述的格式,请参见[Terraform代码开发方式和建议](~~322216~~)。',
+ .'- ProvisionedProductPlanName:按计划名称查找,完整匹配(忽略大小写)。'."\n"
+ .'- ProvisionedProductPlanApprover:按审批人精确查找,格式为`RamUser/RamRole:<审批人名称>`,可多选。'."\n"
+ .'- ProvisionedProductPlanApproverName:按审批人名称查找,直接输入审批人的RAM实体名称,可多选。'."\n"
+ .'- ProvisionedProductPlanStatus:按计划状态查找,直接输入计划状态,可多选。'."\n"
+ .'- ProvisionedProductPlanOwnerUid:按计划归属云账号ID精确查找。'."\n"
+ .'- FullTextSearch:全文检索,按计划名称查找,模糊匹配。',
'type' => 'string',
'required' => false,
- 'example' => '{'."\n"
- .' "Label": { "zh-cn": "实例规格", "en": "Instance Type" },'."\n"
- .' "AllowedValues": ['."\n"
- .' "ecs.s6-c1m1.small",'."\n"
- .' "ecs.s6-c1m2.large",'."\n"
- .' "ecs.s6-c1m2.xlarge"'."\n"
- .' ]'."\n"
- .'}'."\n",
+ 'enumValueTitles' => [],
+ 'example' => 'FullTextSearch',
],
+ 'Value' => ['title' => '过滤条件的值。'."\n"
+ ."\n", 'description' => '过滤条件的值。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'ECS'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
- 'maxItems' => 20,
+ 'maxItems' => 5,
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示实例创建时间。', 'description' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示计划创建时间。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
+ ],
+ [
+ 'name' => 'SortOrder',
+ 'in' => 'query',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'TemplateUrl' => [
- 'title' => '模板的OSS地址',
- 'description' => '模板的URL地址。',
- 'type' => 'string',
- 'example' => 'oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json',
- ],
- ],
+ 'title' => '排序方式。取值:'."\n"
+ ."\n"
+ .'Asc:正序。'."\n"
+ .'Desc:倒序。',
+ 'description' => '排序方式。取值:'."\n"
+ ."\n"
+ .'- Asc:正序。'."\n"
+ .'- Desc(默认值):倒序。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['Asc' => 'Asc', 'Desc' => 'Desc'],
+ 'example' => 'Desc',
],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TemplateUrl\\": \\"oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json\\"\\n}","type":"json"}]',
- 'title' => '创建模板',
- ],
- 'GetTemplate' => [
- 'summary' => '查询模板详情。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ProductId',
+ 'name' => 'AccessLevelFilter',
'in' => 'query',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'schema' => ['title' => '访问过滤器。取值:'."\n"
+ ."\n"
+ .'User(默认值):用户。'."\n"
+ .'Account:账号。'."\n"
+ .'ResourceDirectory:资源目录。', 'description' => '访问过滤器。取值:'."\n"
+ ."\n"
+ .'- User(默认值):用户。'."\n"
+ .'- Account:账号。'."\n"
+ .'- ResourceDirectory:资源目录。', 'type' => 'string', 'required' => false, 'example' => 'User'],
],
[
- 'name' => 'ProductVersionId',
+ 'name' => 'ApprovalFilter',
'in' => 'query',
- 'schema' => [
- 'title' => '产品版本ID',
- 'description' => '产品版本ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pv-bp15e79d26****',
- ],
+ 'schema' => ['title' => '审批维度访问过滤器。取值:'."\n"
+ ."\n"
+ .'ReceivedRequests:待审批的。'."\n"
+ .'ApprovalHistory:审批历史。'."\n"
+ .'AccountRequests:账号级别全部审批。'."\n"
+ .'ResourceDirectoryRequests:资源目录级别全部审批。', 'description' => '审批维度访问过滤器。取值:'."\n"
+ ."\n"
+ .'- ReceivedRequests:待我审批。'."\n"
+ .'- ApprovalHistory:审批历史。'."\n"
+ .'- AccountRequests:账号级别全部审批。'."\n"
+ .'- ResourceDirectoryRequests:资源目录级别全部审批。', 'type' => 'string', 'required' => false, 'example' => 'ReceivedRequests'],
+ ],
+ [
+ 'name' => 'ProvisionedProductId',
+ 'in' => 'query',
+ 'schema' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pp-bp1ddg1n2a****'],
],
],
'responses' => [
@@ -5903,250 +4333,368 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'TemplateBody' => [
- 'title' => '模板内容',
- 'description' => '模板内容。'."\n"
- ."\n"
- .'关于模板语法的详情,请参见[Terraform类型模板结构](~~184397~~)。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "ROSTemplateFormatVersion": "2015-09-01",'."\n"
- .' "Transform": "Aliyun::Terraform-v1.1",'."\n"
- .' "Workspace": {'."\n"
- .' "main.tf": "variable \\"name\\" { default = \\"auto_provisioning_group\\"}"'."\n"
- .' },'."\n"
- .' "Outputs": {}'."\n"
- .'}',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****'],
+ 'PlanDetails' => [
+ 'title' => '计划列表。'."\n",
+ 'description' => '计划列表。'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PlanId' => ['title' => '计划ID。', 'description' => '计划ID。', 'type' => 'string', 'example' => 'plan-bp18mmdh2u****'],
+ 'PlanName' => ['title' => '计划名称。'."\n", 'description' => '计划名称。'."\n", 'type' => 'string', 'example' => 'DEMO- create ECS-637****'],
+ 'PlanType' => ['title' => '计划类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'description' => '计划类型。'."\n"
+ ."\n"
+ .'取值为Ros,表示阿里云资源编排服务(ROS)。', 'type' => 'string', 'example' => 'Ros'],
+ 'PortfolioId' => ['title' => '产品组合ID。'."\n", 'description' => '产品组合ID。'."\n", 'type' => 'string', 'example' => 'port-bp1438kf2j****'],
+ 'ProductId' => ['title' => '产品ID。'."\n", 'description' => '产品ID。'."\n", 'type' => 'string', 'example' => 'prod-bp1rtrnh2c****'],
+ 'ProductVersionId' => ['title' => '产品版本ID。'."\n", 'description' => '产品版本ID。'."\n", 'type' => 'string', 'example' => 'pv-bp19udk22v****'],
+ 'ProvisionedProductId' => ['title' => '实例ID。'."\n", 'description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'pp-bp1c35162d****'],
+ 'Parameters' => [
+ 'title' => '用户输入的模板参数。'."\n",
+ 'description' => '用户输入的模板参数。'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterKey' => ['title' => '模板中定义的参数名称。'."\n", 'description' => '模板中定义的参数名称。'."\n", 'type' => 'string', 'example' => 'role_name'],
+ 'ParameterValue' => ['title' => '用户输入的模板参数值。'."\n", 'description' => '用户输入的模板参数值。'."\n", 'type' => 'string', 'example' => 'Test-8'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ProvisionedProductName' => ['title' => '实例名称。', 'description' => '实例名称。', 'type' => 'string', 'example' => 'rds-MYSQL-875****'],
+ 'StackId' => ['title' => '阿里云资源编排服务(ROS)资源栈ID。'."\n", 'description' => '阿里云资源编排服务(ROS)资源栈ID。'."\n", 'type' => 'string', 'example' => '2599090a-309e-4306-b989-17ba66a9****'],
+ 'StackRegionId' => ['title' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n", 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'Status' => ['title' => '计划状态。', 'description' => '计划状态。取值:'."\n"
+ .'- PreviewInProgress:预检中。'."\n"
+ .'- PreviewSuccess:预检成功。'."\n"
+ .'- PreviewFailed:预检失败。'."\n"
+ .'- ApplicationInProgress:审批中。'."\n"
+ .'- ApplicationApproved:审批通过。'."\n"
+ .'- ApplicationRejected:审批被拒绝。'."\n"
+ .'- ExecuteInProgress:执行中。'."\n"
+ .'- ExecuteSuccess:执行成功。'."\n"
+ .'- ExecuteFailed:执行失败。'."\n"
+ .'- Canceled:已取消。', 'type' => 'string', 'example' => 'PreviewSuccess'],
+ 'StatusMessage' => ['title' => '计划状态信息。', 'description' => '计划状态信息。'."\n"
+ ."\n"
+ .'> 仅在计划状态为PreviewFailed或ExecuteFailed时,返回该参数。', 'type' => 'string', 'example' => 'Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...'],
+ 'CreateTime' => ['title' => '计划创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'description' => '计划创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-09-13T02:01:22Z'],
+ 'UpdateTime' => ['title' => '计划最后更新时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'description' => '计划最后更新时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-07-18T06:02:35.075Z'],
+ 'Tags' => [
+ 'title' => '用户自定义标签列表。'."\n",
+ 'description' => '用户自定义标签列表。'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '用户自定义标签键。'."\n", 'description' => '用户自定义标签键。'."\n", 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['title' => '用户自定义标签值。'."\n", 'description' => '用户自定义标签值。'."\n", 'type' => 'string', 'example' => 'v1'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'OperationType' => ['title' => '计划操作类型,取值为All,TerminateProvisionedProduct,UpdateProvisionedProduct,LaunchProduct。', 'description' => '计划操作类型。取值:'."\n"
+ .'- LaunchProduct(默认):启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'example' => 'LaunchProduct'],
+ 'AssignedApprovers' => [
+ 'title' => '计划审批人列表。',
+ 'description' => '计划审批人列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PrincipalType' => ['title' => '计划审批人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'RamUser:RAM用户。'."\n"
+ .'RamRole:RAM角色。', 'description' => '计划审批人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'PrincipalName' => ['title' => '计划归属人的RAM实体名称。'."\n", 'description' => '计划审批人的RAM实体名称。', 'type' => 'string', 'example' => 'endUser'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ProductName' => ['title' => '产品名称。'."\n", 'description' => '产品名称。'."\n", 'type' => 'string', 'example' => 'Create ECS'],
+ 'Description' => ['title' => '计划描述。', 'description' => '计划描述。', 'type' => 'string', 'example' => 'Dev team usage'],
+ 'OwnerPrincipalType' => ['title' => '计划归属人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'RamUser:RAM用户。'."\n"
+ .'RamRole:RAM角色。', 'description' => '计划归属人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'OwnerPrincipalId' => ['title' => '计划归属人的RAM实体ID。'."\n", 'description' => '计划归属人的RAM实体ID。'."\n", 'type' => 'string', 'example' => '24477111603637****'."\n"],
+ 'OwnerPrincipalName' => ['title' => '计划归属人的RAM实体名称。', 'description' => '计划归属人的RAM实体名称。', 'type' => 'string', 'example' => 'enduser'],
+ 'Uid' => ['title' => '计划归属人的云账号ID。', 'description' => '计划归属人的云账号ID。', 'type' => 'string', 'example' => '146611588617****'],
+ ],
+ 'description' => '',
+ ],
],
+ 'TotalCount' => ['title' => '总记录数。', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
+ 'PageNumber' => ['title' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TemplateBody\\": \\"{\\\\n \\\\\\"ROSTemplateFormatVersion\\\\\\": \\\\\\"2015-09-01\\\\\\",\\\\n \\\\\\"Transform\\\\\\": \\\\\\"Aliyun::Terraform-v1.1\\\\\\",\\\\n \\\\\\"Workspace\\\\\\": {\\\\n \\\\\\"main.tf\\\\\\": \\\\\\"variable \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\" { default = \\\\\\\\\\\\\\"auto_provisioning_group\\\\\\\\\\\\\\"}\\\\\\"\\\\n },\\\\n \\\\\\"Outputs\\\\\\": {}\\\\n}\\"\\n}","type":"json"}]',
- 'title' => '查询模板详情',
- ],
- 'CreatePortfolio' => [
- 'summary' => '创建产品组合。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\",\\n \\"PlanDetails\\": [\\n {\\n \\"PlanId\\": \\"plan-bp18mmdh2u****\\",\\n \\"PlanName\\": \\"DEMO- create ECS-637****\\",\\n \\"PlanType\\": \\"Ros\\",\\n \\"PortfolioId\\": \\"port-bp1438kf2j****\\",\\n \\"ProductId\\": \\"prod-bp1rtrnh2c****\\",\\n \\"ProductVersionId\\": \\"pv-bp19udk22v****\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1c35162d****\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"role_name\\",\\n \\"ParameterValue\\": \\"Test-8\\"\\n }\\n ],\\n \\"ProvisionedProductName\\": \\"rds-MYSQL-875****\\",\\n \\"StackId\\": \\"2599090a-309e-4306-b989-17ba66a9****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"PreviewSuccess\\",\\n \\"StatusMessage\\": \\"Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-09-13T02:01:22Z\\",\\n \\"UpdateTime\\": \\"2022-07-18T06:02:35.075Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"OperationType\\": \\"LaunchProduct\\",\\n \\"AssignedApprovers\\": [\\n {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalName\\": \\"endUser\\"\\n }\\n ],\\n \\"ProductName\\": \\"Create ECS\\",\\n \\"Description\\": \\"Dev team usage\\",\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"24477111603637****\\\\n\\",\\n \\"OwnerPrincipalName\\": \\"enduser\\",\\n \\"Uid\\": \\"146611588617****\\"\\n }\\n ],\\n \\"TotalCount\\": 16,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
+ 'title' => '查询计划列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProvisionedProductPlans'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProvisionedProductPlans',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListProvisionedProducts' => [
+ 'summary' => '查询实例列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PortfolioName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合名称',
- 'description' => '产品组合名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => false,
- 'example' => 'DEMO-IT服务',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'formData',
+ 'name' => 'Filters',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '产品组合描述',
- 'description' => '产品组合描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
+ 'title' => '过滤条件',
+ 'description' => '过滤条件。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '过滤条件的名称', 'description' => '过滤条件的名称。取值:'."\n"
+ ."\n"
+ .'- ProvisionedProductName:按实例名称查找,完整匹配(忽略大小写)。'."\n"
+ .'- FullTextSearch:全文检索,按实例名称查找,模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'ProvisionedProductName'],
+ 'Value' => ['title' => '过滤条件的值', 'description' => '过滤条件的值。', 'type' => 'string', 'required' => false, 'example' => 'DEMO-ECS-Instance'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => '这是一个产品组合描述',
+ 'maxItems' => 5,
],
],
[
- 'name' => 'ProviderName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '提供者名称',
- 'description' => '产品组合提供者。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'IT团队',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- ],
- ],
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示实例创建时间。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ [
+ 'name' => 'SortOrder',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方式', 'description' => '排序方式。取值:'."\n"
+ ."\n"
+ .'- Asc:正序。'."\n"
+ .'- Desc(默认值):倒序。', 'type' => 'string', 'required' => false, 'example' => 'Desc'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\"\\n}","type":"json"}]',
- 'title' => '创建产品组合',
- ],
- 'AssociateProductWithPortfolio' => [
- 'summary' => '将产品加入产品组合。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
- 'parameters' => [
[
- 'name' => 'ProductId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'PortfolioId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'name' => 'AccessLevelFilter',
+ 'in' => 'query',
+ 'schema' => ['title' => '访问过滤器', 'description' => '访问过滤器。取值:'."\n"
+ ."\n"
+ .'- User(默认值):用户。'."\n"
+ .'- Account:账号。', 'type' => 'string', 'required' => false, 'example' => 'User'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
+ 'ProvisionedProductDetails' => [
+ 'title' => '实例列表',
+ 'description' => '实例列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'PortfolioItemType',
+ 'description' => '实例详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProvisionedProductName' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'DEMO-ECS-Instance'],
+ 'ProvisionedProductId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
+ 'ProvisionedProductArn' => ['title' => '实例ARN', 'description' => '实例ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名称', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。', 'type' => 'string', 'example' => '1.0'],
+ 'LastTaskId' => ['title' => '上一次执行的任务ID', 'description' => '上一次执行的任务ID。', 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'LastProvisioningTaskId' => ['title' => '上一次执行的实例操作任务ID', 'description' => '上一次执行的实例操作任务ID。'."\n"
+ ."\n"
+ .'实例操作包括:'."\n"
+ ."\n"
+ .'- LaunchProduct:启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'LastSuccessfulProvisioningTaskId' => ['title' => '上一次成功执行的实例操作任务ID', 'description' => '上一次成功执行的实例操作任务ID。'."\n"
+ ."\n"
+ .'实例操作包括:'."\n"
+ ."\n"
+ .'- LaunchProduct:启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'OwnerPrincipalType' => ['title' => '归属人的RAM实体类型', 'description' => '实例归属人的RAM实体类型。取值:'."\n"
+ ."\n"
+ .'- RamUser:RAM用户。'."\n"
+ .'- RamRole:RAM角色。', 'type' => 'string', 'example' => 'RamUser'],
+ 'OwnerPrincipalId' => ['title' => '归属人的RAM实体ID', 'description' => '实例归属人的RAM实体ID。', 'type' => 'string', 'example' => '24477111603637****'],
+ 'Status' => ['title' => '实例状态', 'description' => '实例状态。取值:'."\n"
+ ."\n"
+ .'- Available:可用。'."\n"
+ .'- UnderChange:变更中。'."\n"
+ .'- Error:异常。', 'type' => 'string', 'example' => 'Available'],
+ 'StatusMessage' => ['title' => '实例状态说明', 'description' => '实例状态说明。'."\n"
+ ."\n"
+ .'> 仅在实例状态为Error时,返回该参数。', 'type' => 'string', 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '实例创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-23T09:46:27Z'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'StackId' => ['title' => 'ROS资源栈的ID', 'description' => '阿里云资源编排服务(ROS)资源栈ID。', 'type' => 'string', 'example' => '137e31df-3754-40b4-be2f-c793ad84****'],
+ 'StackRegionId' => ['title' => 'ROS资源栈所属的地域ID', 'description' => '阿里云资源编排服务(ROS)资源栈所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'ProvisionedProductType' => ['description' => '实例类型。'."\n"
+ ."\n"
+ .'取值为RosStack,表示阿里云资源编排服务(ROS)的资源栈。', 'type' => 'string', 'example' => 'RosStack'],
+ ],
+ ],
],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页时每页显示的数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProvisionedProductDetails\\": [\\n {\\n \\"ProvisionedProductName\\": \\"DEMO-ECS-Instance\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-Create ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"LastTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"LastSuccessfulProvisioningTaskId\\": \\"task-bp1dmg242c****\\",\\n \\"OwnerPrincipalType\\": \\"RamUser\\",\\n \\"OwnerPrincipalId\\": \\"24477111603637****\\",\\n \\"Status\\": \\"Available\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"StackId\\": \\"137e31df-3754-40b4-be2f-c793ad84****\\",\\n \\"StackRegionId\\": \\"cn-hangzhou\\",\\n \\"ProvisionedProductType\\": \\"RosStack\\"\\n }\\n ],\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
+ 'title' => '查询实例列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-05-27T07:47:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2021-12-28T03:48:53.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProvisionedProducts',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '将产品加入产品组合',
],
- 'DeletePortfolio' => [
- 'summary' => '删除产品组合。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRegions' => [
+ 'summary' => '查询地域列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
- [
- 'name' => 'PortfolioId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
@@ -6154,11 +4702,20 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'Regions' => [
+ 'title' => '地域列表',
+ 'description' => '地域列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '地域信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['title' => '地域ID', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'RegionEndpoint' => ['title' => '地域接入地址', 'description' => '地域接入地址。', 'type' => 'string', 'example' => 'servicecatalog.cn-hangzhou.aliyuncs.com'],
+ 'LocalName' => ['title' => '地域名称', 'description' => '地域名称。', 'type' => 'string', 'example' => '华东1(杭州)'],
+ ],
+ ],
],
],
],
@@ -6166,56 +4723,59 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '删除产品组合',
- ],
- 'DisassociateProductFromPortfolio' => [
- 'summary' => '从产品组合中移除产品。',
- 'methods' => [
- 'post',
+ 'title' => '查询地域列表',
+ 'changeSet' => [
+ ['createdAt' => '2021-12-27T07:30:15.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionEndpoint\\": \\"servicecatalog.cn-hangzhou.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1(杭州)\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListResourcesForTagOption' => [
+ 'summary' => '查询标签选项关联的资源列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ProductId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'name' => 'TagOptionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '标签选项ID。', 'type' => 'string', 'required' => true, 'example' => 'tag-bp1u6mdf3d****'],
],
[
- 'name' => 'PortfolioId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '标签选项关联的资源类型。取值:'."\n"
+ ."\n"
+ .'- Product:产品。'."\n"
+ .'- Portfolio:产品组合。', 'type' => 'string', 'required' => true, 'example' => 'Product'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
@@ -6225,11 +4785,32 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E465F21C-8712-5794-A754-5E4D9152****'],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'ResourceDetails' => [
+ 'description' => '关联资源详情。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceArn' => ['description' => '资源ARN。', 'type' => 'string', 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'."\n"],
+ 'CreateTime' => ['description' => '资源创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-11-04T08:07:04.281986714Z'],
+ 'Description' => ['description' => '资源描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'example' => 'This is a product description.'],
+ 'ResourceId' => ['description' => '标签选项绑定的资源ID。', 'type' => 'string', 'example' => 'port-bp15p96922****'],
+ 'ResourceName' => ['description' => '资源名称。', 'type' => 'string', 'example' => 'DEMO-Create ECS'],
+ ],
+ 'description' => '',
+ ],
],
],
],
@@ -6237,278 +4818,177 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '从产品组合中移除产品',
- ],
- 'UpdatePortfolio' => [
- 'summary' => '更新产品组合。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E465F21C-8712-5794-A754-5E4D9152****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"ResourceDetails\\": [\\n {\\n \\"ResourceArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\\\n\\",\\n \\"CreateTime\\": \\"2022-11-04T08:07:04.281986714Z\\",\\n \\"Description\\": \\"This is a product description.\\",\\n \\"ResourceId\\": \\"port-bp15p96922****\\",\\n \\"ResourceName\\": \\"DEMO-Create ECS\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询标签选项关联的资源列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourcesForTagOption'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListResourcesForTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTagOptions' => [
+ 'summary' => '查询标签选项列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PortfolioId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
- ],
- [
- 'name' => 'PortfolioName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合名称',
- 'description' => '产品组合名称。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DEMO-IT',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合描述',
- 'description' => '产品组合描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a product portfolio description.',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'ProviderName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '提供者名称',
- 'description' => '产品组合提供者。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'IT team',
- 'maxLength' => 100,
- 'minLength' => 1,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
+ 'name' => 'Filters',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
+ 'description' => '过滤条件。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'Key' => ['description' => '标签选项键。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'Value' => ['description' => '标签选项值。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
+ 'Active' => ['description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'FullTextSearch' => ['description' => '全文搜索。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
],
+ 'required' => false,
],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['description' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示标签选项创建时间。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\"\\n}","type":"json"}]',
- 'title' => '更新产品组合',
- ],
- 'GetPortfolio' => [
- 'summary' => '查询产品组合信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'SortOrder',
+ 'in' => 'query',
+ 'schema' => ['description' => '排序方式。取值:'."\n"
+ ."\n"
+ .'- Asc:正序。'."\n"
+ .'- Desc(默认值):倒序。', 'type' => 'string', 'required' => false, 'example' => 'Desc'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'PortfolioId',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'PortfolioDetail' => [
- 'title' => '产品组合详情',
- 'description' => '产品组合详情。',
- 'type' => 'object',
- 'properties' => [
- 'PortfolioArn' => [
- 'title' => '产品组合ARN',
- 'description' => '产品组合ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****',
- ],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'Description' => [
- 'title' => '产品组合描述',
- 'description' => '产品组合描述。',
- 'type' => 'string',
- 'example' => '这是一个产品组合描述',
- ],
- 'CreateTime' => [
- 'title' => '产品组合创建时间',
- 'description' => '产品组合创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:11:12Z',
- ],
- 'PortfolioName' => [
- 'title' => '产品组合名称',
- 'description' => '产品组合名称。',
- 'type' => 'string',
- 'example' => 'DEMO-IT服务',
- ],
- 'ProviderName' => [
- 'title' => '提供者名称',
- 'description' => '产品组合提供者。',
- 'type' => 'string',
- 'example' => 'IT团队',
- ],
- ],
- ],
- 'TagOptions' => [
- 'description' => '产品组合关联的标签选项列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '37C9C1DF-EFFC-5D8A-80D0-8657B1F3****'],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TagOptionDetails' => [
+ 'description' => '标签选项详情列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Active' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TagOptionId' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'example' => 'tag-bp1q65xd3j****',
- ],
- 'Key' => [
- 'description' => '标签选项键。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '标签选项值。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Owner' => [
- 'description' => '标签选项归属人ID。',
- 'type' => 'string',
- 'example' => '133413081827****'."\n",
- ],
+ 'Active' => ['description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true:启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'TagOptionId' => ['description' => '标签选项ID。', 'type' => 'string', 'example' => 'tag-bp1r3mxq3t****'],
+ 'Key' => ['description' => '标签选项键。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '标签选项值。', 'type' => 'string', 'example' => 'v1'],
+ 'Owner' => ['description' => '标签选项归属人云账号ID。', 'type' => 'string', 'example' => '133413081827****'."\n"],
],
+ 'description' => '',
],
],
+ 'NextToken' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PortfolioDetail\\": {\\n \\"PortfolioArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"Description\\": \\"这是一个产品组合描述\\",\\n \\"CreateTime\\": \\"2022-04-12T06:11:12Z\\",\\n \\"PortfolioName\\": \\"DEMO-IT服务\\",\\n \\"ProviderName\\": \\"IT团队\\"\\n },\\n \\"TagOptions\\": [\\n {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1q65xd3j****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询产品组合信息',
- ],
- 'ListPortfolios' => [
- 'summary' => '查询产品组合列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询标签选项列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagOptions'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListTagOptions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"37C9C1DF-EFFC-5D8A-80D0-8657B1F3****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TagOptionDetails\\": [\\n {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1r3mxq3t****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\"\\n}","type":"json"}]',
+ ],
+ 'ListTasks' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6516,128 +4996,41 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ProductId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '产品ID',
- 'description' => '产品ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'prod-bp18r7q127****',
- ],
- ],
- [
- 'name' => 'Filters',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '过滤条件',
- 'description' => '过滤条件。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '过滤条件的名称',
- 'description' => '过滤条件的名称。取值:'."\n"
- ."\n"
- .'- PortfolioName:按产品组合名称查找,完整匹配(忽略大小写)。'."\n"
- .'- FullTextSearch:全文检索,按产品组合名称、产品组合提供者、产品组合描述查找,模糊匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PortfolioName',
- ],
- 'Value' => [
- 'title' => '过滤条件的值',
- 'description' => '过滤条件的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DEMO-IT',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 5,
- ],
- ],
- [
'name' => 'SortBy',
'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示产品组合创建时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
- ],
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段。'."\n"
+ ."\n"
+ .'取值为CreateTime,表示任务创建时间。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
],
[
'name' => 'SortOrder',
'in' => 'query',
- 'schema' => [
- 'title' => '排序方式',
- 'description' => '排序方式。取值:'."\n"
- ."\n"
- .'- Asc:正序。'."\n"
- .'- Desc:倒序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- ],
+ 'schema' => ['title' => '排序方式', 'description' => '排序方式。取值:'."\n"
+ ."\n"
+ .'- Asc:正序。'."\n"
+ .'- Desc:倒序。', 'type' => 'string', 'required' => false, 'example' => 'Desc'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '页码。'."\n"
+ ."\n"
+ .'起始值:1。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页时每页显示的数据行数。'."\n"
+ ."\n"
+ .'取值范围:1~100。起始值:1。默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'Scope',
+ 'name' => 'ProvisionedProductId',
'in' => 'query',
- 'schema' => [
- 'description' => '查询范围。取值:'."\n"
- ."\n"
- .'- Local(默认值):在当前账号中创建的产品组合。'."\n"
- .'- Import:从其他账号导入的产品组合。'."\n"
- .'- All:所有可以使用的产品组合。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Local',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pp-bp1ddg1n2a****'],
],
],
'responses' => [
@@ -6647,105 +5040,144 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'PortfolioDetails' => [
- 'title' => '产品组合列表',
- 'description' => '产品组合列表。',
+ 'TaskDetails' => [
+ 'title' => '实例列表',
+ 'description' => '任务列表。',
'type' => 'array',
'items' => [
'title' => 'PortfolioItemType',
- 'description' => '产品组合详情。',
+ 'description' => '任务详情。',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'title' => '产品组合描述',
- 'description' => '产品组合描述。',
- 'type' => 'string',
- 'example' => 'This is a product portfolio description.',
- ],
- 'PortfolioName' => [
- 'title' => '产品组合名称',
- 'description' => '产品组合名称。',
- 'type' => 'string',
- 'example' => 'DEMO-IT',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '产品组合创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:11:12Z',
- ],
- 'ProviderName' => [
- 'title' => '提供者名称',
- 'description' => '产品组合提供者。',
- 'type' => 'string',
- 'example' => 'IT team',
+ 'TaskId' => ['title' => '实例名称', 'description' => '任务ID。', 'type' => 'string', 'example' => 'task-bp1dmg242c****'],
+ 'TaskType' => ['title' => '实例ARN', 'description' => '任务类型。取值:'."\n"
+ ."\n"
+ .'- LaunchProduct:启动产品。'."\n"
+ .'- UpdateProvisionedProduct:更新实例。'."\n"
+ .'- TerminateProvisionedProduct:终止实例。', 'type' => 'string', 'example' => 'LaunchProduct'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
+ 'ProductName' => ['title' => '产品名称', 'description' => '产品名称。', 'type' => 'string', 'example' => 'DEMO-ECS'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
+ 'ProductVersionName' => ['title' => '产品版本名称', 'description' => '产品版本名称。', 'type' => 'string', 'example' => '1.0'],
+ 'ProvisionedProductId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
+ 'ProvisionedProductName' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'Test-ECS'],
+ 'Parameters' => [
+ 'description' => '用户输入的模板参数。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterKey' => ['description' => '模板中定义的参数名称。', 'type' => 'string', 'example' => 'instance_type'],
+ 'ParameterValue' => ['description' => '用户输入的模板参数值。', 'type' => 'string', 'example' => 'ecs.s6-c1m1.small'],
+ ],
+ 'description' => '',
+ ],
],
- 'PortfolioId' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
+ 'Outputs' => [
+ 'description' => '模板的输出值。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OutputKey' => ['description' => '模板中定义的输出值名称。', 'type' => 'string', 'example' => 'instance_id'],
+ 'OutputValue' => ['description' => '模板中定义的输出值的内容。', 'type' => 'string', 'example' => 'i-xxxxxx'],
+ 'Description' => ['description' => '模板中定义的输出值的描述。', 'type' => 'string', 'example' => 'The ECS instance ID.'],
+ ],
+ 'description' => '',
+ ],
],
- 'PortfolioArn' => [
- 'title' => '产品组合ARN',
- 'description' => '产品组合ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****',
+ 'Log' => [
+ 'description' => '实例相关输出日志。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TerraformLogs' => [
+ 'description' => 'Terraform输出日志。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Command' => ['description' => '执行的Terraform命令名称。取值:'."\n"
+ ."\n"
+ .'- apply'."\n"
+ .'- plan'."\n"
+ .'- destroy'."\n"
+ .'- version'."\n"
+ ."\n"
+ .'关于命令含义的更多信息,请参见[Command](https://www.terraform.io/cli/commands)。', 'type' => 'string', 'example' => 'apply'],
+ 'Stream' => ['description' => '输出流。取值:'."\n"
+ ."\n"
+ .'- stdout:标准输出。'."\n"
+ .'- stderr:标准错误输出。', 'type' => 'string', 'example' => 'stdout'],
+ 'Content' => ['description' => '当前命令在当前输出流中输出的内容。', 'type' => 'string', 'example' => 'Apply complete! Resources: 42 added, 0 changed, 0 destroyed.'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
+ 'Status' => ['title' => '实例状态', 'description' => '任务状态。取值:'."\n"
+ ."\n"
+ .'- Succeeded:成功。'."\n"
+ .'- InProgress:运行中。'."\n"
+ .'- Failed:失败。', 'type' => 'string', 'example' => 'Succeeded'],
+ 'StatusMessage' => ['title' => '实例状态说明', 'description' => '任务状态信息。'."\n"
+ ."\n"
+ .'> 仅在任务状态为Failed时,返回该参数。', 'type' => 'string', 'example' => 'Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '任务创建时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-23T09:46:27Z'],
+ 'UpdateTime' => ['description' => '任务最后更新时间。'."\n"
+ ."\n"
+ .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2022-05-26T03:28:45Z'],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页时每页显示的数据行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页时每页显示的数据行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '查询任务列表',
+ 'summary' => '查询任务列表。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T02:23:56.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-05-27T07:47:13.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T06:49:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PortfolioDetails\\": [\\n {\\n \\"Description\\": \\"This is a product portfolio description.\\",\\n \\"PortfolioName\\": \\"DEMO-IT\\",\\n \\"CreateTime\\": \\"2022-04-12T06:11:12Z\\",\\n \\"ProviderName\\": \\"IT team\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"PortfolioArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****\\"\\n }\\n ],\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- 'title' => '查询产品组合列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskDetails\\": [\\n {\\n \\"TaskId\\": \\"task-bp1dmg242c****\\",\\n \\"TaskType\\": \\"LaunchProduct\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ProductName\\": \\"DEMO-ECS\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\",\\n \\"ProductVersionName\\": \\"1.0\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\",\\n \\"ProvisionedProductName\\": \\"Test-ECS\\",\\n \\"Parameters\\": [\\n {\\n \\"ParameterKey\\": \\"instance_type\\",\\n \\"ParameterValue\\": \\"ecs.s6-c1m1.small\\"\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputKey\\": \\"instance_id\\",\\n \\"OutputValue\\": \\"i-xxxxxx\\",\\n \\"Description\\": \\"The ECS instance ID.\\"\\n }\\n ],\\n \\"Log\\": {\\n \\"TerraformLogs\\": [\\n {\\n \\"Command\\": \\"apply\\",\\n \\"Stream\\": \\"stdout\\",\\n \\"Content\\": \\"Apply complete! Resources: 42 added, 0 changed, 0 destroyed.\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"Succeeded\\",\\n \\"StatusMessage\\": \\"Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...\\",\\n \\"CreateTime\\": \\"2022-05-23T09:46:27Z\\",\\n \\"UpdateTime\\": \\"2022-05-26T03:28:45Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
],
- 'CreateConstraint' => [
- 'summary' => '创建约束。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'TerminateProvisionedProduct' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6753,70 +5185,88 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'ConstraintType',
+ 'name' => 'ProvisionedProductId',
'in' => 'formData',
+ 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pp-bp1ddg1n2a****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '约束类型',
- 'description' => '约束类型。'."\n"
- ."\n"
- .'取值为Launch,表示启动约束。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Launch',
+ 'title' => 'Schema of Response',
+ 'description' => '返回参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '终止实例',
+ 'summary' => '终止实例。',
+ 'description' => '终止实例后实例将从实例列表中删除,终端用户后续无法正常管理该实例的生命周期,请谨慎操作。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminateProvisionedProduct'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Config',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '约束配置',
- 'description' => '约束配置。'."\n"
- ."\n"
- .'格式:{ "LocalRoleName": "<role_name\\>" }',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{ "LocalRoleName": "TestRole" }',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:TerminateProvisionedProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateConstraint' => [
+ 'summary' => '更新约束。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Description',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'ConstraintId',
'in' => 'formData',
- 'schema' => [
- 'title' => '约束描述',
- 'description' => '约束描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Launch as local role TestRole',
- ],
+ 'schema' => ['title' => '约束ID', 'description' => '约束ID。', 'type' => 'string', 'required' => true, 'example' => 'cons-bp1yx7x42v****'],
],
[
- 'name' => 'PortfolioId',
+ 'name' => 'Config',
'in' => 'formData',
- 'schema' => [
- 'title' => '约束所属的产品组合ID',
- 'description' => '约束所属的产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'schema' => ['title' => '约束配置', 'description' => '约束配置。'."\n"
+ ."\n"
+ .'格式:{ "LocalRoleName": "<role_name\\>" }', 'type' => 'string', 'required' => true, 'example' => '{ "LocalRoleName": "TestRole" }'],
],
[
- 'name' => 'ProductId',
+ 'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '约束对应的产品ID',
- 'description' => '约束对应的产品ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp18r7q127****',
- ],
+ 'schema' => ['title' => '约束描述', 'description' => '约束描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'Launch as local role TestRole'],
],
],
'responses' => [
@@ -6826,42 +5276,41 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ConstraintId' => [
- 'title' => '约束ID',
- 'description' => '约束ID。',
- 'type' => 'string',
- 'example' => 'cons-bp1yx7x42v****',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ConstraintId' => ['title' => '约束ID', 'description' => '约束ID。', 'type' => 'string', 'example' => 'cons-bp1yx7x42v****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '更新约束',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ConstraintId\\": \\"cons-bp1yx7x42v****\\"\\n}","type":"json"}]',
- 'title' => '创建约束',
],
- 'DeleteConstraint' => [
- 'summary' => '删除约束。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdatePortfolio' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6869,20 +5318,33 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ConstraintId',
+ 'name' => 'PortfolioId',
'in' => 'formData',
- 'schema' => [
- 'title' => '约束ID',
- 'description' => '约束ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cons-bp1yx7x42v****',
- ],
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'required' => true, 'example' => 'port-bp1yt7582g****'],
+ ],
+ [
+ 'name' => 'PortfolioName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合名称', 'description' => '产品组合名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'DEMO-IT', 'maxLength' => 100, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品组合描述', 'description' => '产品组合描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a product portfolio description.'],
+ ],
+ [
+ 'name' => 'ProviderName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '提供者名称', 'description' => '产品组合提供者。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'IT team', 'maxLength' => 100, 'minLength' => 1],
],
],
'responses' => [
@@ -6892,36 +5354,42 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'PortfolioId' => ['title' => '产品组合ID', 'description' => '产品组合ID。', 'type' => 'string', 'example' => 'port-bp1yt7582g****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '更新产品组合',
+ 'summary' => '更新产品组合。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdatePortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '删除约束',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\"\\n}","type":"json"}]',
],
- 'UpdateConstraint' => [
- 'summary' => '更新约束。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateProduct' => [
+ 'summary' => '更新产品。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6929,46 +5397,33 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ConstraintId',
+ 'name' => 'ProductName',
'in' => 'formData',
- 'schema' => [
- 'title' => '约束ID',
- 'description' => '约束ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cons-bp1yx7x42v****',
- ],
+ 'schema' => ['title' => '产品名称', 'description' => '产品名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'Test-ECS', 'maxLength' => 100, 'minLength' => 1],
],
[
- 'name' => 'Config',
+ 'name' => 'ProductId',
'in' => 'formData',
- 'schema' => [
- 'title' => '约束配置',
- 'description' => '约束配置。'."\n"
- ."\n"
- .'格式:{ "LocalRoleName": "<role_name\\>" }',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{ "LocalRoleName": "TestRole" }',
- ],
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
[
'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '约束描述',
- 'description' => '约束描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Launch as local role TestRole',
- ],
+ 'schema' => ['title' => '产品描述', 'description' => '产品描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a product description.'],
+ ],
+ [
+ 'name' => 'ProviderName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '提供者名称', 'description' => '产品提供者。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => 'IT team', 'maxLength' => 100, 'minLength' => 1],
],
],
'responses' => [
@@ -6978,64 +5433,86 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ConstraintId' => [
- 'title' => '约束ID',
- 'description' => '约束ID。',
- 'type' => 'string',
- 'example' => 'cons-bp1yx7x42v****',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductId' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'example' => 'prod-bp18r7q127****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'title' => '更新产品',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ConstraintId\\": \\"cons-bp1yx7x42v****\\"\\n}","type":"json"}]',
- 'title' => '更新约束',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\"\\n}","type":"json"}]',
],
- 'GetConstraint' => [
- 'summary' => '查询约束信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateProductVersion' => [
+ 'summary' => '更新产品版本。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ConstraintId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '约束ID',
- 'description' => '约束ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cons-bp1yx7x42v****',
- ],
+ 'name' => 'ProductVersionId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'],
+ ],
+ [
+ 'name' => 'ProductVersionName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本名称', 'description' => '产品版本名称。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => true, 'example' => '1.0', 'maxLength' => 100, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本描述', 'description' => '产品版本描述。'."\n"
+ ."\n"
+ .'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a product version description.'],
+ ],
+ [
+ 'name' => 'Guidance',
+ 'in' => 'formData',
+ 'schema' => ['title' => '推荐信息', 'description' => '推荐信息。取值:'."\n"
+ ."\n"
+ .'- Default(默认值):无。'."\n"
+ .'- Recommended:稳定版。'."\n"
+ .'- Latest:最新版。'."\n"
+ .'- Deprecated:将废弃。', 'type' => 'string', 'required' => false, 'example' => 'Default'],
+ ],
+ [
+ 'name' => 'Active',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否启用', 'description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7045,96 +5522,41 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'ConstraintDetail' => [
- 'title' => '约束详情',
- 'description' => '约束详情。',
- 'type' => 'object',
- 'properties' => [
- 'Config' => [
- 'title' => '约束配置',
- 'description' => '约束配置。'."\n"
- ."\n"
- .'格式:{ "LocalRoleName": "<role_name\\>" }',
- 'type' => 'string',
- 'example' => '{ "LocalRoleName": "TestRole" }',
- ],
- 'Description' => [
- 'title' => '描述',
- 'description' => '约束描述。',
- 'type' => 'string',
- 'example' => 'Launch as local role TestRole',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '约束创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-04-12T06:11:26Z',
- ],
- 'ConstraintId' => [
- 'title' => '约束ID',
- 'description' => '约束ID。',
- 'type' => 'string',
- 'example' => 'cons-bp1yx7x42v****',
- ],
- 'PortfolioId' => [
- 'title' => '约束所属的产品组合ID',
- 'description' => '约束所属的产品组合ID。',
- 'type' => 'string',
- 'example' => 'port-bp1yt7582g****',
- ],
- 'ProductId' => [
- 'title' => '约束的产品ID',
- 'description' => '约束对应的产品ID。',
- 'type' => 'string',
- 'example' => 'prod-bp18r7q127****',
- ],
- 'ConstraintType' => [
- 'title' => '约束类型',
- 'description' => '约束类型。'."\n"
- ."\n"
- .'取值为Launch,表示启动约束。',
- 'type' => 'string',
- 'example' => 'Launch',
- ],
- 'ProductName' => [
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProductVersionId' => ['title' => '产品版本ID', 'description' => '产品版本ID。', 'type' => 'string', 'example' => 'pv-bp15e79d26****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProductVersionId\\": \\"pv-bp15e79d26****\\"\\n}","type":"json"}]',
+ 'title' => '更新产品版本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ConstraintDetail\\": {\\n \\"Config\\": \\"{ \\\\\\"LocalRoleName\\\\\\": \\\\\\"TestRole\\\\\\" }\\",\\n \\"Description\\": \\"Launch as local role TestRole\\",\\n \\"CreateTime\\": \\"2022-04-12T06:11:26Z\\",\\n \\"ConstraintId\\": \\"cons-bp1yx7x42v****\\",\\n \\"PortfolioId\\": \\"port-bp1yt7582g****\\",\\n \\"ProductId\\": \\"prod-bp18r7q127****\\",\\n \\"ConstraintType\\": \\"Launch\\",\\n \\"ProductName\\": \\"DEMO-创建ECS\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询约束信息',
],
- 'AssociatePrincipalWithPortfolio' => [
- 'summary' => '将产品组合授权给账号内的RAM用户或者RAM角色。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateProvisionedProduct' => [
+ 'summary' => '更新实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7142,64 +5564,84 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'PortfolioId',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'schema' => ['title' => '产品组合ID', 'description' => '产品组合ID。'."\n"
+ ."\n"
+ .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。', 'type' => 'string', 'required' => false, 'example' => 'port-bp1yt7582g****'],
],
[
- 'name' => 'PrincipalType',
+ 'name' => 'ProductId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'RAM实体类型,枚举值为RamUser、RamRole、RamPattern。填写RamUser和RamRole时,PrincipalId必填;填写RamPattern时,PrincipPattern必填。',
- 'description' => 'RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RamUser',
- ],
+ 'schema' => ['title' => '产品ID', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'],
],
[
- 'name' => 'PrincipalId',
+ 'name' => 'ProductVersionId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本ID', 'description' => '产品版本ID。'."\n"
+ ."\n"
+ .'> 当输入的ProductVersionId和Parameters与之前相比,两者都没有变化时,不允许更新实例。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'],
+ ],
+ [
+ 'name' => 'Parameters',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'RAM实体ID',
- 'description' => 'RAM实体ID。'."\n"
+ 'description' => '用户输入的模板参数。'."\n"
."\n"
- .'获取RAM用户ID的方法,请参见[GetUser](~~28681~~)。'."\n"
+ .'N最大值为200。'."\n"
."\n"
- .'获取RAM角色ID的方法,请参见[GetRole](~~28711~~)。',
- 'type' => 'string',
+ .'> - Parameters为可选参数。如果需要指定Parameters,则Parameters.N.ParameterKey和Parameters.N.ParameterValue必须同时指定。'."\n"
+ .'> - 当输入的ProductVersionId和Parameters与之前相比,两者都没有变化时,不允许更新实例。'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterKey' => ['description' => '模板中定义的参数名称。', 'type' => 'string', 'required' => false, 'example' => 'instance_type'],
+ 'ParameterValue' => ['description' => '用户输入的模板参数值。', 'type' => 'string', 'required' => false, 'example' => 'ecs.s6-c1m1.small'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => '24477111603637****',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'PrincipalPattern',
+ 'name' => 'ProvisionedProductId',
'in' => 'formData',
+ 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pp-bp1ddg1n2a****'],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'RAM实体名称规则,当PrincipalType填写RamPattern时生效。如需配置Ram用户名称规则,格式为user/${userName};如需配置Ram角色名称规则,格式为role/${roleName}。',
- 'description' => 'RAM实体名称规则,当PrincipalType填写RamPattern时生效。如需配置Ram用户名称规则,格式为user/${userName};如需配置Ram角色名称规则,格式为role/${roleName}。',
- 'type' => 'string',
+ 'description' => '用户输入的自定义标签。'."\n"
+ ."\n"
+ .'N最大值为20。'."\n"
+ ."\n"
+ .'> - Tags为可选参数。如果需要指定Tags,则Tags.N.Key和Tags.N.Value必须同时指定。'."\n"
+ .'> - 此标签会传递到资源栈中每个支持标签的资源中。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '用户输入的自定义标签键。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'Value' => ['description' => '用户输入的自定义标签值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => 'user/userName',
+ 'maxItems' => 20,
],
],
],
@@ -7210,36 +5652,49 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF'],
+ 'ProvisionedProductId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '创建产品组合授权',
- ],
- 'DisassociatePrincipalFromPortfolio' => [
- 'summary' => '删除产品组合授权。',
- 'methods' => [
- 'post',
+ 'title' => '更新实例',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-16T08:01:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-31T07:40:30.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-27T07:47:13.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProvisionedProduct'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProvisionedProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateProvisionedProductPlan' => [
+ 'summary' => '更新计划。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7248,130 +5703,170 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
+ 'abilityTreeNodes' => ['FEATUREgovernanceLSR8I4'],
],
'parameters' => [
[
+ 'name' => 'PlanId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '计划ID。', 'description' => '计划ID。', 'type' => 'string', 'required' => true, 'example' => 'plan-bp1jvmdk2k****'."\n"],
+ ],
+ [
'name' => 'PortfolioId',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'schema' => ['title' => '产品组合ID。', 'description' => '产品组合ID。'."\n"
+ .'> 存在默认启动选项时,无需填写PortfolioId。没有默认启动选项时,必须填写PortfolioId。获取PortfolioId的方法,请参见[ListLaunchOptions](~~ListLaunchOptions~~)。', 'type' => 'string', 'required' => false, 'example' => 'port-bp1yt7582g****'."\n"],
],
[
- 'name' => 'PrincipalType',
+ 'name' => 'ProductId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'RAM实体类型,枚举值为RamUser、RamRole、RamPattern。填写RamUser和RamRole时,PrincipalId必填;填写RamPattern时,PrincipPattern必填。',
- 'description' => 'RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RamUser',
- ],
+ 'schema' => ['title' => '产品ID。', 'description' => '产品ID。', 'type' => 'string', 'required' => true, 'example' => 'prod-bp18r7q127****'."\n"],
],
[
- 'name' => 'PrincipalId',
+ 'name' => 'ProductVersionId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品版本ID。', 'description' => '产品版本ID。', 'type' => 'string', 'required' => true, 'example' => 'pv-bp15e79d26****'."\n"],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '计划描述。', 'description' => '计划描述。', 'type' => 'string', 'required' => false, 'example' => 'Used for create ECS'],
+ ],
+ [
+ 'name' => 'Parameters',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'RAM实体ID',
- 'description' => 'RAM实体ID。'."\n"
+ 'title' => '用户输入的模板参数。'."\n",
+ 'description' => '用户输入的模板参数。'."\n"
."\n"
- .'获取RAM用户ID的方法,请参见[GetUser](~~28681~~)。'."\n"
+ .'N最大值为200。'."\n"
."\n"
- .'获取RAM角色ID的方法,请参见[GetRole](~~28711~~)。',
- 'type' => 'string',
+ .'> Parameters为可选参数。如果需要指定Parameters,则Parameters.N.ParameterKey和Parameters.N.ParameterValue必须同时指定。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterKey' => ['title' => '模板中定义的参数名称。'."\n", 'description' => '模板中定义的参数名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'instance_type'],
+ 'ParameterValue' => ['title' => '用户输入的模板参数值。'."\n", 'description' => '用户输入的模板参数值。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.s6-c1m1.small'."\n"],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => '24477111603637****',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'PrincipalPattern',
+ 'name' => 'Tags',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'RAM实体名称规则,当PrincipalType填写RamPattern时生效。如需配置Ram用户名称规则,格式为user/${userName};如需配置Ram角色名称规则,格式为role/${roleName}。',
- 'description' => 'RAM实体名称规则,当PrincipalType填写RamPattern时生效。如需配置Ram用户名称规则,格式为user/${userName};如需配置Ram角色名称规则,格式为role/${roleName}。',
- 'type' => 'string',
+ 'title' => '用户自定义标签列表。'."\n",
+ 'description' => '用户输入的自定义标签。'."\n"
+ ."\n"
+ .'N最大值为20。'."\n"
+ ."\n"
+ .'> - Tags为可选参数。如果需要指定Tags,则Tags.N.Key和Tags.N.Value必须同时指定。'."\n"
+ .'> - 此标签会传递到资源栈中每个支持标签的资源中。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '用户自定义标签键。'."\n", 'description' => '用户输入的自定义标签键。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'Value' => ['title' => '用户自定义标签值。'."\n", 'description' => '用户输入的自定义标签值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => 'user/userName',
+ 'maxItems' => 20,
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****'."\n"],
+ 'PlanId' => ['title' => '计划ID', 'description' => '计划ID。', 'type' => 'string', 'example' => 'plan-bp1jvmdk2k****'."\n"],
+ 'ProvisionedProductId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pp-bp1ddg1n2a****'."\n"],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\"\\n}","type":"json"}]',
- 'title' => '删除产品组合授权',
- ],
- 'ListPrincipals' => [
- 'summary' => '查询产品组合已授权的RAM用户和RAM角色列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\\\n\\",\\n \\"PlanId\\": \\"plan-bp1jvmdk2k****\\\\n\\",\\n \\"ProvisionedProductId\\": \\"pp-bp1ddg1n2a****\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '更新计划',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProvisionedProductPlan'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateTagOption' => [
+ 'summary' => '更新标签选项。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'PortfolioId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '产品组合ID',
- 'description' => '产品组合ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp1yt7582g****',
- ],
+ 'name' => 'TagOptionId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '标签选项ID。', 'type' => 'string', 'required' => true, 'example' => 'tag-bp1u6mdf3d****'],
+ ],
+ [
+ 'name' => 'Value',
+ 'in' => 'formData',
+ 'schema' => ['description' => '标签选项值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'v1', 'maxLength' => 128, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'Active',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7381,1078 +5876,1089 @@
'description' => '返回参数。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'Principals' => [
- 'title' => 'RAM实体列表',
- 'description' => 'RAM实体列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'RAM实体信息。',
- 'type' => 'object',
- 'properties' => [
- 'PrincipalType' => [
- 'title' => 'RAM实体类型',
- 'description' => 'RAM实体类型。取值:'."\n"
- ."\n"
- .'- RamUser:RAM用户。'."\n"
- .'- RamRole:RAM角色。',
- 'type' => 'string',
- 'example' => 'RamUser',
- ],
- 'PrincipalId' => [
- 'title' => 'RAM实体ID',
- 'description' => 'RAM实体ID。',
- 'type' => 'string',
- 'example' => '24477111603637****',
- ],
- 'PrincipalPattern' => [
- 'type' => 'string',
- ],
- ],
+ 'TagOptionDetail' => [
+ 'description' => '标签选项详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Active' => ['description' => '是否启用。取值:'."\n"
+ ."\n"
+ .'- true(默认值):启用。'."\n"
+ .'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
+ 'TagOptionId' => ['description' => '标签选项ID。', 'type' => 'string', 'example' => 'tag-bp1u6mdf3d****'],
+ 'Key' => ['description' => '用户输入的标签选项键。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '用户输入的标签选项值。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'example' => 'v1'],
+ 'Owner' => ['description' => '标签选项归属人云账号ID。', 'type' => 'string', 'example' => '133413081827****'],
],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => '内部错误。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"Principals\\": [\\n {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalId\\": \\"24477111603637****\\",\\n \\"PrincipalPattern\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询产品组合已授权的用户和角色列表',
- ],
- 'ListRegions' => [
- 'summary' => '查询地域列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新标签选项',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTagOption'],
+ ],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagOptionDetail\\": {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1u6mdf3d****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\"\\n },\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\"\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'servicecatalog.cn-hangzhou.aliyuncs.com', 'endpoint' => 'servicecatalog.cn-hangzhou.aliyuncs.com', 'vpc' => 'servicecatalog-vpc.cn-hangzhou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'CreateStackFailed', 'message' => 'Specified associated properties are not support in the region.', 'http_code' => 400, 'description' => '该地区不支持指定的相关属性。'],
+ ['code' => 'InternalError', 'message' => 'A system error occurred.', 'http_code' => 500, 'description' => '内部错误。'],
+ ['code' => 'InvalidTemplate.InvalidTemplateBody', 'message' => 'One of the input parameters TemplateBody,TemplateURL should be specified.', 'http_code' => 400, 'description' => '需要指定输入参数TemplateBody或TemplateURL。'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLaunchOptions'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateProductWithPortfolio'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProvisionedProductPlan'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePortfolio'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTagOption'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProvisionedProductPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchProduct'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConstraint'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminateProvisionedProduct'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProvisionedProductPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProvisionedProductPlanApprovers'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePortfolio'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociatePrincipalWithPortfolio'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisAssociateTagOptionFromResource'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProvisionedProductPlans'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApproveProvisionedProductPlan'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelProvisionedProductPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTagOption'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProvisionedProduct'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyProduct'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateTagOptionWithResource'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTagOption'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourcesForTagOption'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProvisionedProductPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProvisionedProduct'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagOptions'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteProvisionedProductPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTagOption'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'ServiceCatalog',
+ 'productName' => '云治理中心',
+ 'ramCodes' => ['servicecatalog'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [
+ [
+ 'name' => 'servicecatalog:UserLevel',
+ 'schema' => [
+ 'type' => 'String',
+ 'description' => '可以授权只允许访问当前用户自己的资源',
+ 'enums' => ['self'],
+ ],
+ ],
+ [
+ 'name' => 'servicecatalog:ApprovalActor',
+ 'schema' => [
+ 'type' => 'String',
+ 'description' => '可以授权只允许访问需要当前用户自己审批的资源',
+ 'enums' => ['approver'],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F81BF',
- ],
- 'Regions' => [
- 'title' => '地域列表',
- 'description' => '地域列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '地域信息。',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'title' => '地域ID',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'RegionEndpoint' => [
- 'title' => '地域接入地址',
- 'description' => '地域接入地址。',
- 'type' => 'string',
- 'example' => 'servicecatalog.cn-hangzhou.aliyuncs.com',
- ],
- 'LocalName' => [
- 'title' => '地域名称',
- 'description' => '地域名称。',
- 'type' => 'string',
- 'example' => '华东1(杭州)',
- ],
- ],
- ],
- ],
- ],
+ ],
+ 'ramActions' => [
+ [
+ 'apiName' => 'UpdateProvisionedProductPlan',
+ 'description' => '更新计划',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'UpdateConstraint',
+ 'description' => '更新约束',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F81BF\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionEndpoint\\": \\"servicecatalog.cn-hangzhou.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1(杭州)\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询地域列表',
- ],
- 'GetTagOption' => [
- 'summary' => '查询标签选项详情。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetAccountInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetProductAsEndUser',
+ 'description' => '终端用户查询产品信息',
'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProductAsEndUser',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'TagOptionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tag-bp1r3mxq3t****',
+ [
+ 'apiName' => 'GetProvisionedProductPlan',
+ 'description' => '查询计划信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'TagOptionDetail' => [
- 'description' => '标签选项详情。',
- 'type' => 'object',
- 'properties' => [
- 'Active' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true:启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TagOptionId' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'example' => 'tag-bp15qmwz3r****',
- ],
- 'Key' => [
- 'description' => '标签选项键。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '标签选项值。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Owner' => [
- 'description' => '标签选项归属人云账号ID。',
- 'type' => 'string',
- 'example' => '133413081827****',
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C1509725-055D-5C7B-9420-8B737DBD****',
- ],
- ],
+ [
+ 'apiName' => 'ImportTagOptions',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ImportTagOptions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'BatchAssociateProductWithPortfolio',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:BatchAssociateProductWithPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#portfolioId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#productId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'UpdateTagOption',
+ 'description' => '更新标签选项',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagOptionDetail\\": {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp15qmwz3r****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\"\\n },\\n \\"RequestId\\": \\"C1509725-055D-5C7B-9420-8B737DBD****\\"\\n}","type":"json"}]',
- 'title' => '查询标签选项信息',
- ],
- 'DisAssociateTagOptionFromResource' => [
- 'summary' => '取消标签选项与资源的关联。',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'CreateProvisionedProductPlan',
+ 'description' => '创建计划',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DeleteProductVersion',
+ 'description' => '删除产品版本',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'UpdateProvisionedProduct',
+ 'description' => '更新实例',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProvisionedProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListProductsAsAdmin',
+ 'description' => '管理员查询产品列表',
'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'ResourceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '标签选项绑定的资源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'prod-bp14katy3d****',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProductsAsAdmin',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/*'],
],
],
- [
- 'name' => 'TagOptionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tag-bp1u6mdf3d****',
+ ],
+ [
+ 'apiName' => 'TerminateProvisionedProduct',
+ 'description' => '终止实例',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:TerminateProvisionedProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7E23D1F3-4333-587B-909C-39EA4626****',
- ],
- ],
+ [
+ 'apiName' => 'CancelProvisionedProductPlan',
+ 'description' => '取消计划',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CancelProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'InitializeServiceCatalog',
+ 'description' => '',
+ 'operationType' => '',
+ 'additionalActions' => [
+ ['action' => 'ram:CreateServiceLinkedRole', 'validationType' => 'always'],
+ ],
+ 'ramAction' => [
+ 'action' => 'servicecatalog:InitializeServiceCatalog',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E23D1F3-4333-587B-909C-39EA4626****\\"\\n}","type":"json"}]',
- 'title' => '取消标签选项与资源的关联',
- ],
- 'ListResourcesForTagOption' => [
- 'summary' => '查询标签选项关联的资源列表。',
- 'methods' => [
- 'get',
+ [
+ 'apiName' => 'CreateProduct',
+ 'description' => '创建产品',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'GetTagOption',
+ 'description' => '查询标签选项信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeleteProvisionedProductPlan',
+ 'description' => '删除计划',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetConstraint',
+ 'description' => '查询约束信息',
'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'TagOptionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tag-bp1u6mdf3d****',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
- [
- 'name' => 'ResourceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '标签选项关联的资源类型。取值:'."\n"
- ."\n"
- .'- Product:产品。'."\n"
- .'- Portfolio:产品组合。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Product',
+ ],
+ [
+ 'apiName' => 'ListConstraints',
+ 'description' => '查询约束列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListConstraints',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ ],
+ [
+ 'apiName' => 'CreatePortfolio',
+ 'description' => '创建产品组合',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreatePortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/*'],
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ ],
+ [
+ 'apiName' => 'LaunchProduct',
+ 'description' => '启动产品',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:LaunchProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E465F21C-8712-5794-A754-5E4D9152****',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ResourceDetails' => [
- 'description' => '关联资源详情。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ResourceArn' => [
- 'description' => '资源ARN。',
- 'type' => 'string',
- 'example' => 'acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****'."\n",
- ],
- 'CreateTime' => [
- 'description' => '资源创建时间。'."\n"
- ."\n"
- .'按照ISO8601标准表示,使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2022-11-04T08:07:04.281986714Z',
- ],
- 'Description' => [
- 'description' => '资源描述。'."\n"
- ."\n"
- .'长度为1~128个字符。',
- 'type' => 'string',
- 'example' => '这是一个产品描述。'."\n",
- ],
- 'ResourceId' => [
- 'description' => '标签选项绑定的资源ID。',
- 'type' => 'string',
- 'example' => 'port-bp15p96922****',
- ],
- 'ResourceName' => [
- 'description' => '资源名称。',
- 'type' => 'string',
- 'example' => 'DEMO-创建ECS'."\n",
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'GetProvisionedProductParameters',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProvisionedProductParameters',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'UpdatePortfolio',
+ 'description' => '更新产品组合',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdatePortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'GetEnhancedTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetEnhancedTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#productId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E465F21C-8712-5794-A754-5E4D9152****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"ResourceDetails\\": [\\n {\\n \\"ResourceArn\\": \\"acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****\\\\n\\",\\n \\"CreateTime\\": \\"2022-11-04T08:07:04.281986714Z\\",\\n \\"Description\\": \\"这是一个产品描述。\\\\n\\",\\n \\"ResourceId\\": \\"port-bp15p96922****\\",\\n \\"ResourceName\\": \\"DEMO-创建ECS\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询标签选项关联的资源列表',
- ],
- 'UpdateTagOption' => [
- 'summary' => '更新标签选项。',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'CreateConstraint',
+ 'description' => '创建约束',
+ 'operationType' => 'create',
+ 'additionalActions' => [
+ ['action' => 'ram:PassRole', 'validationType' => 'always'],
+ ],
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListProductsAsEndUser',
+ 'description' => '终端用户查询产品列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProductsAsEndUser',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListProductVersions',
+ 'description' => '查询产品版本列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProductVersions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'TagOptionId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tag-bp1u6mdf3d****',
+ [
+ 'apiName' => 'AssociateTagOptionWithResource',
+ 'description' => '将标签选项关联到资源',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:AssociateTagOptionWithResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'Value',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '标签选项值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- 'maxLength' => 128,
- 'minLength' => 1,
+ ],
+ [
+ 'apiName' => 'GetGeneratedTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetGeneratedTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'Active',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'GetTemplate',
+ 'description' => '查询模板详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'TagOptionDetail' => [
- 'description' => '标签选项详情。',
- 'type' => 'object',
- 'properties' => [
- 'Active' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TagOptionId' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'example' => 'tag-bp1u6mdf3d****',
- ],
- 'Key' => [
- 'description' => '用户输入的标签选项键。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '用户输入的标签选项值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Owner' => [
- 'description' => '标签选项归属人云账号ID。',
- 'type' => 'string',
- 'example' => '133413081827****',
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****',
- ],
- ],
+ [
+ 'apiName' => 'GetPrincipalPortfolioAssociationForResourceSpec',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetPrincipalPortfolioAssociationForResourceSpec',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'DisassociateProductFromPortfolio',
+ 'description' => '从产品组合中移除产品',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DisassociateProductFromPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'DisAssociateTagOptionFromResource',
+ 'description' => '取消标签选项与资源的关联',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DisAssociateTagOptionFromResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'conditional', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#portfolioId}'],
+ ['validationType' => 'conditional', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#productId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagOptionDetail\\": {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1u6mdf3d****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\"\\n },\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\"\\n}","type":"json"}]',
- 'title' => '更新标签选项',
- ],
- 'ListTagOptions' => [
- 'summary' => '查询标签选项列表。',
- 'methods' => [
- 'get',
+ [
+ 'apiName' => 'DeletePortfolio',
+ 'description' => '删除产品组合',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeletePortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DeleteTagOption',
+ 'description' => '删除标签选项',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetTemplateDefinition',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetTemplateDefinition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListPortfolios',
+ 'description' => '查询产品组合列表',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListPortfolios',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/*'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。'."\n"
- ."\n"
- .'起始值:1。默认值:1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ [
+ 'apiName' => 'ListPrincipals',
+ 'description' => '查询产品组合已授权的用户和角色列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListPrincipals',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ ],
+ [
+ 'apiName' => 'CopyProduct',
+ 'description' => '复制产品',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CopyProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#productId}'],
],
],
- [
- 'name' => 'Filters',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '过滤条件。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签选项键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '标签选项值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
- 'Active' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'FullTextSearch' => [
- 'description' => '全文搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- ],
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'GetProvisionedProductForResourceSpec',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProvisionedProductForResourceSpec',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
],
],
- [
- 'name' => 'SortBy',
- 'in' => 'query',
- 'schema' => [
- 'description' => '排序字段。'."\n"
- ."\n"
- .'取值为CreateTime,表示标签选项创建时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
+ ],
+ [
+ 'apiName' => 'CreateTemplate',
+ 'description' => '创建模板',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'SortOrder',
- 'in' => 'query',
- 'schema' => [
- 'description' => '排序方式。取值:'."\n"
- ."\n"
- .'- Asc:正序。'."\n"
- .'- Desc(默认值):倒序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
+ ],
+ [
+ 'apiName' => 'GetProductPortfolioAssociationForResourceSpec',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProductPortfolioAssociationForResourceSpec',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'ListLaunchOptions',
+ 'description' => '查询启动选项列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListLaunchOptions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'DeleteProduct',
+ 'description' => '删除产品',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '37C9C1DF-EFFC-5D8A-80D0-8657B1F3****',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页时每页显示的数据行数。'."\n"
- ."\n"
- .'取值范围:1~100。起始值:1。默认值:10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TagOptionDetails' => [
- 'description' => '标签选项详情列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Active' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true:启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TagOptionId' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'example' => 'tag-bp1r3mxq3t****',
- ],
- 'Key' => [
- 'description' => '标签选项键。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '标签选项值。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Owner' => [
- 'description' => '标签选项归属人云账号ID。',
- 'type' => 'string',
- 'example' => '133413081827****'."\n",
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'type' => 'string',
- ],
- ],
+ [
+ 'apiName' => 'BatchDisassociateProductFromPortfolio',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:BatchDisassociateProductFromPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#portfolioId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'GetTask',
+ 'description' => '查询任务信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'ExecuteProvisionedProductPlan',
+ 'description' => '执行计划',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ExecuteProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"37C9C1DF-EFFC-5D8A-80D0-8657B1F3****\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TagOptionDetails\\": [\\n {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1r3mxq3t****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\"\\n}","type":"json"}]',
- 'title' => '查询标签选项列表',
- ],
- 'DeleteTagOption' => [
- 'summary' => '删除标签选项。',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'ListTasks',
+ 'description' => '查询任务列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DeleteConstraint',
+ 'description' => '删除约束',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DeleteConstraint',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetProvisionedProduct',
+ 'description' => '查询实例信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProvisionedProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'TagOptionId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tag-bp1u6mdf3d****',
+ [
+ 'apiName' => 'ListResourcesForTagOption',
+ 'description' => '查询标签选项关联的资源列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListResourcesForTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0FEEF92D-4052-5202-87D0-3D8EC16F****',
- ],
- ],
+ [
+ 'apiName' => 'CreateTagOption',
+ 'description' => '创建标签选项',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateTagOption',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'ListUserTypes',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListUserTypes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'AssociatePrincipalWithPortfolio',
+ 'description' => '创建产品组合授权',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:AssociatePrincipalWithPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEEF92D-4052-5202-87D0-3D8EC16F****\\"\\n}","type":"json"}]',
- 'title' => '删除标签选项',
- ],
- 'CreateTagOption' => [
- 'summary' => '创建标签选项。',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'ListProvisionedProductPlans',
+ 'description' => '查询计划列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProvisionedProductPlans',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListProvisionedProducts',
+ 'description' => '查询实例列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProvisionedProducts',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListProvisionedProductPlanApprovers',
+ 'description' => '查询计划审批人列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListProvisionedProductPlanApprovers',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:UserLevel', 'validationType' => 'always'],
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'CreateProductVersion',
+ 'description' => '创建产品版本',
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgovernanceLSR8I4',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:CreateProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'Key',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '用户输入的标签选项键。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'k1',
- 'maxLength' => 128,
- 'minLength' => 1,
+ [
+ 'apiName' => 'UpdateProduct',
+ 'description' => '更新产品',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProduct',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
- [
- 'name' => 'Value',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用户输入的标签选项值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v1',
- 'maxLength' => 128,
- 'minLength' => 1,
+ ],
+ [
+ 'apiName' => 'DisassociatePrincipalFromPortfolio',
+ 'description' => '删除产品组合授权',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:DisassociatePrincipalFromPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'TagOptionDetail' => [
- 'description' => '标签选项详情。',
- 'type' => 'object',
- 'properties' => [
- 'Active' => [
- 'description' => '是否启用。取值:'."\n"
- ."\n"
- .'- true(默认值):启用。'."\n"
- .'- false:禁用。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TagOptionId' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'example' => 'tag-bp1r3mxq3t****',
- ],
- 'Key' => [
- 'description' => '用户输入的标签选项键。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '用户输入的标签选项值。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Owner' => [
- 'description' => '标签选项归属人云账号ID。',
- 'type' => 'string',
- 'example' => '133413081827****'."\n",
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A48A5F12-6098-54A1-A389-6834AF27****',
- ],
- ],
+ [
+ 'apiName' => 'AssociateProductWithPortfolio',
+ 'description' => '将产品加入产品组合',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:AssociateProductWithPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'GetProvisioningParameters',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProvisioningParameters',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagOptionDetail\\": {\\n \\"Active\\": true,\\n \\"TagOptionId\\": \\"tag-bp1r3mxq3t****\\",\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\",\\n \\"Owner\\": \\"133413081827****\\\\n\\"\\n },\\n \\"RequestId\\": \\"A48A5F12-6098-54A1-A389-6834AF27****\\"\\n}","type":"json"}]',
- 'title' => '创建标签选项',
- ],
- 'AssociateTagOptionWithResource' => [
- 'summary' => '将标签选项关联到资源。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ApproveProvisionedProductPlan',
+ 'description' => '审批计划',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ApproveProvisionedProductPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'servicecatalog:ApprovalActor', 'validationType' => 'always'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetProductAsAdmin',
+ 'description' => '管理员查询产品信息',
'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'ResourceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '标签选项绑定的资源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'port-bp15p96922****',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProductAsAdmin',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
- [
- 'name' => 'TagOptionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '标签选项ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tag-bp1u6mdf3d****',
+ ],
+ [
+ 'apiName' => 'UpdateProductVersion',
+ 'description' => '更新产品版本',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:UpdateProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回参数。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DC833558-AFF4-5935-9AB6-8A12EE7D****',
- ],
- ],
+ [
+ 'apiName' => 'ListTagOptions',
+ 'description' => '查询标签选项列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:ListTagOptions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ [
+ 'apiName' => 'GetProductVersion',
+ 'description' => '查询产品版本信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetProductVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'GetPortfolio',
+ 'description' => '查询产品组合信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'servicecatalog:GetPortfolio',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ServiceCatalog', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC833558-AFF4-5935-9AB6-8A12EE7D****\\"\\n}","type":"json"}]',
- 'title' => '将标签选项关联到资源',
],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'servicecatalog.cn-hangzhou.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}'],
+ ['validationType' => 'always', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}'],
+ ['validationType' => 'always', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/{#PortfolioId}'],
+ ['validationType' => 'always', 'resourceType' => 'ProvisionedProduct', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*'],
+ ['validationType' => 'always', 'resourceType' => 'Product', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:product/*'],
+ ['validationType' => 'always', 'resourceType' => 'Portfolio', 'arn' => 'acs:servicecatalog:{#regionId}:{#accountId}:portfolio/*'],
],
],
];