检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请
APIG.API 模型说明 API提供方把API接口配置在API网关中,开放后端能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API;第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
API 如何调用API 资源栈 执行计划 模板分析 模板管理 资源栈集 自定义provider管理 资源编排-Hook 权限和授权项
如何调用API 构造请求 认证鉴权 返回结果 父主题: API
APIG.BackendApi 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 后端API的描述 取值说明:字符长度不超过255 取值约束:长度不超过255 使用建议:无 urlDomain 是 string 访问域名 取值说明:由后端服务地址和端口组成,总长度不超过255
APIG.ApiGroup 模型说明 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 remark 否 API分组描述 参数类型:string 取值说明:长度最大不超过255个字符
获取资源栈集元数据 功能介绍 获取资源栈集元数据(ShowStackSetMetadata) 用户可以使用此API获取资源栈集的元数据 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户To
获取资源栈实例 功能介绍 获取资源栈实例(ShowStackInstance) 用户可以使用此API获取资源栈实例的详细信息,包括关联资源栈名称与id,创建时间,参数覆盖等 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
获取模板版本内容 功能介绍 获取模板版本内容(ShowTemplateVersionContent) 此API用于获取用户的模板版本内容 template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成
获取模板元数据 功能介绍 获取模板元数据(ShowTemplateMetadata) 此API用于获取当前模板的元数据信息 具体信息见ShowTemplateMetadataResponseBody,如果想查看模板下全部模板版本,请调用ListTemplateVersions。
获取资源栈模板 功能介绍 获取资源栈模板(GetStackTemplate) 此API用于获取资源栈最近一次部署终态使用的模板。 注: 当资源栈状态处于非终态(即以IN_PROGRESS结尾,详细见下方)状态时,资源栈处于转变阶段,此API获取资源栈上一次部署使用的模板。 只有当
),如果用户需要了解模板版本内容,请调用ShowTemplateVersionContent 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{pro
若hook_name和hook_id同时存在,则资源编排服务会检查两个是否匹配,如果不匹配则会返回400。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/priv
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET ht
获取执行计划 功能介绍 获取执行计划(GetExecutionPlan) 此API用于获取指定执行计划的详细内容(即执行计划项目),用户可通过此API得知指定执行计划在执行后,资源栈中的资源会发生何种变化 如果执行计划状态为CREATION_IN_PROGRESS或CREATIO
如果hook_name和hook_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/priv
获取资源栈元数据 功能介绍 获取资源栈元数据(GetStackMetadata) 此API用于获取指定资源栈的元数据,包括资源栈ID、资源栈名称、资源栈描述、创建时间、更新时间、资源栈状态、委托授权等信息。 具体信息见GetStackMetadataResponseBody。 注:
具体信息见GetExecutionPlanMetadataResponseBody。 如果需要获取执行计划的具体内容,请调用GetExecutionPlan。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。