检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG.API 模型说明 API提供方把API接口配置在API网关中,开放后端能力。
父主题: 如何调用API
错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 SVCSTG.AOS.4000007 Bad Request, request route not found.
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
更新模板元数据 功能介绍 更新模板元数据(UpdateTemplateMetadata) 此API用于更新模板元数据 此api只支持更新模板描述 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
删除执行计划 功能介绍 删除执行计划(DeleteExecutionPlan) 删除指定的执行计划 如果执行计划状态处于CREATION_IN_PROGRESS、APPLY_IN_PROGRESS状态时,则不允许删除并返回403 调试 您可以在API Explorer中调试该接口,
参数预加载 参数预加载支持输入参数时请求云服务api获取预加载选项,当前支持以下六种api接口: 表1 支持的api接口说明 属性 描述 hwc:ecs:flavors ECS的Flavor hwc:vpc:myVpcs VPC列表 hwc:vpc:mySubnets Subnet
获取资源栈实例 功能介绍 获取资源栈实例(ShowStackInstance) 用户可以使用此API获取资源栈实例的详细信息,包括关联资源栈名称与id,创建时间,参数覆盖等 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
则不返回执行计划项目列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
获取资源栈集元数据 功能介绍 获取资源栈集元数据(ShowStackSetMetadata) 用户可以使用此API获取资源栈集的元数据 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
创建资源栈集 功能介绍 创建资源栈集(CreateStackSet) 此API为同步API,用于生成一个空资源栈集,即不包含任何一个资源栈实例,并返回资源栈集ID(stack_set_id) 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
AOS控制台不支持编排包周期的资源,并且API接口也不支持。 父主题: 应用编排
对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 父主题: 如何调用API
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面查看账号ID。 图1 获取账号ID 父主题: 附录
帐号具备所有接口的调用权限,如果使用帐号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。
如果给予的template_id和当前模板管理的ID不一致,则返回400 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
请谨慎操作 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
模板服务不允许存在没有模板版本的模板 请谨慎操作 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。