华为云用户手册

  • 功能介绍 列举模板版本信息(ListTemplateVersions) 此API用于列举模板下所有的模板版本信息 默认按照生成时间降序排序,最新生成的模板排列在最前面 注意:目前返回全量模板版本信息,即不支持分页 如果没有任何模板版本,则返回空list template_id是模板的唯一Id。此Id由 资源编排 服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的模板,删除,再重新创建一个同名模板。对于团队并行开发,用户可能希望确保,当前我操作的模板就是我认为的那个,而不是其他队友删除后创建的同名模板。因此,使用ID就可以做到强匹配。资源编排服务保证每次创建的模板所对应的ID都不相同,更新不会影响ID。如果给予的template_id和当前模板管理的ID不一致,则返回400 如果模板不存在则返回404 ListTemplateVersions返回的信息只包含模板版本摘要信息(具体摘要信息见ListTemplateVersionsResponseBody),如果用户需要了解模板版本内容,请调用ShowTemplateVersionContent
  • URI GET /v1/{project_id}/templates/{template_name}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,可以从调用API处获取,也可以从控制台获取。 项目ID获取方式 template_name 是 String 用户希望创建的模板名称 表2 Query参数 参数 是否必选 参数类型 描述 template_id 否 String 模板的ID。当template_id存在时,模板服务会检查template_id是否和template_name匹配,不匹配会返回400
  • 响应示例 状态码:200 列举私有provider版本成功 { "versions" : [ { "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "provider_name" : "my-hello-world-provider-name", "provider_version" : "3.7.10", "version_description" : "my first hello world private provider version", "function_graph_urn" : "urn:fss:cn-north-7:b61dfe3154de4282787126568d5040f:function:default:myFG:latest", "create_time" : "2024-01-01T00:00:00.000Z" }, { "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "provider_name" : "my-hello-world-provider-name", "provider_version" : "3.7.10", "version_description" : "my first hello world private provider version", "function_graph_urn" : "urn:fss:cn-north-7:b61dfe3154de4282787126568d5040f:function:default:myFG:latest", "create_time" : "2023-01-01T00:00:00.000Z" } ], "page_info" : { "current_count" : 2, "next_marker" : null, "previous_marker" : "zxc1oHc08HcCmypYGTsOoRcvoHUvHRUAW5NOSnc1oHc08HcCPZrwP5NOeTlRiukJgtGxeujJeuGwGIihaIUCmypYGTsOtqvKPr2xmH8fPqpGWyQ0axGwGZp9aqvx8pQ7m5FvGTsJiKk7gtNFiuaxetdRCks=" } }
  • 请求示例 获取名为my-hello-world-provider-name的私有模块下的所有版本,以创建时间降序排序 GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions 获取名为my-hello-world-provider-name的私有模块下的所有版本,以创建时间升序排序 GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions?sort_key=create_time&sort_dir=asc 获取名为my-hello-world-provider-name的私有模块下的所有版本,并提供provider ID以校验是否与当前私有provider匹配,以创建时间升序排序 GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions?provider_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2&sort_key=create_time&sort_dir=asc
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 versions Array of PrivateProviderVersionSummary objects 私有provider版本的列表。默认以创建时间降序排序。 page_info PageInfo object 分页信息 表5 PrivateProviderVersionSummary 参数 参数类型 描述 provider_id String 私有provider(private-provider)的唯一Id。 此Id由资源编排服务在生成provider的时候生成,为UUID。 由于私有provider名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是其他队友删除后创建的同名私有provider。因此,使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有provider所对应的Id都不相同,更新不会影响Id。如果给予的provider_id和当前provider的Id不一致,则返回400 provider_name String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 按照HCL最佳实践,该名称推荐为在模板中定义的provider的本地名称(local_name)。 创建私有Provider(CreatePrivateProvider)API 还会以 “huawei.com/private-provider”为固定前缀,并以“huawei.com/private-provider/{provider_name}”的形式返回provider_source字段。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 provider_version String provider的版本号。版本号必须遵循语义化版本号(Semantic Version),为用户自定义 version_description String 私有provider版本(provider version)的描述。可用于客户识别并管理私有provider的版本。注意:provider版本为不可更新(immutable),所以该字段不可更新,如果需要更新,请删除后重建 function_graph_urn String FunctionGraph方法的统一资源标识,用于唯一标识的FunctionGraph方法。当前只支持和 RFS 同region的function_graph_urn,如果给予了关于其他region的,会报错400。 关于该参数的详细解释,请参考官方文档:https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0102.html create_time String 私有provider(private-provider)版本的生成时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 表6 PageInfo 参数 参数类型 描述 next_marker String 向后分页标识符。如果存在,则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中,在请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 previous_marker String 向前分页标识符。 current_count Integer 本页显示的条目数量。 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表8 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:401 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表10 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:403 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表12 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:404 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表14 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:429 表15 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表16 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:500 表17 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表18 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • URI GET /v1/private-providers/{provider_name}/versions 表1 路径参数 参数 是否必选 参数类型 描述 provider_name 是 String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 表2 Query参数 参数 是否必选 参数类型 描述 provider_id 否 String 私有provider的唯一Id,由资源编排服务随机生成,为UUID。 由于私有provider名称仅仅在同一时间下唯一,即用户允许先生成一个叫helloword的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是由其他队友删除后创建的同名私有provider。 因此,使用ID就可以做到强匹配。资源编排服务保证每次创建私有provider所对应的Id都不相同。 如果给予的provider_id和当前私有provider的Id不一致,则返回400。 sort_key 否 Array of strings 排序字段,仅支持给予create_time sort_dir 否 Array of strings 指定升序还是降序 asc - 升序 desc - 降序 marker 否 String 分页标记。当一页无法返回所有结果,上一次的请求将返回next_marker以指引还有更多页数,用户可以将next_marker中的值放到此处以查询下一页的信息。此marker只能用于与上一请求指定的相同参数的请求。不指定时默认从第一页开始查询。 limit 否 Integer 每页返回的最多结果数量
  • 功能介绍 列举私有provider版本(ListPrivateProviderVersions) 列举所选择的私有provider中所有的provider版本信息。 可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir数量须一致,否则返回400。如果未给予sort_key和sort_dir,则默认按照创建时间降序排序。 如果provider_name和provider_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。 如果provider下不存在provider版本,则返回空list。 如果provider不存在则返回404。 支持分页返回。如果响应中存在next_marker,则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中,在请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null
  • 请求示例 删除私有provider的指定版本 DELETE https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0 删除私有provider的指定版本,并提供provider id以校验是否与当前私有provider匹配 DELETE https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0?provider_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3
  • 响应参数 状态码:204 删除私有provider版本成功,无数据返回 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表5 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:404 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:429 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:500 表14 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • URI DELETE /v1/private-providers/{provider_name}/versions/{provider_version} 表1 路径参数 参数 是否必选 参数类型 描述 provider_name 是 String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 provider_version 是 String provider的版本号。版本号遵循语义化版本号(Semantic Version),为用户自定义 表2 Query参数 参数 是否必选 参数类型 描述 provider_id 否 String 私有provider的唯一Id,由资源编排服务随机生成,为UUID。 由于私有provider名称仅仅在同一时间下唯一,即用户允许先生成一个叫helloword的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是由其他队友删除后创建的同名私有provider。 因此,使用ID就可以做到强匹配。资源编排服务保证每次创建私有provider所对应的Id都不相同。 如果给予的provider_id和当前私有provider的Id不一致,则返回400。
  • 响应示例 状态码:200 列举私有provider成功 { "providers" : [ { "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "provider_name" : "my-hello-world-provider-name-1", "provider_description" : "my first hello world private provider", "provider_source" : "huawei.com/private-provider/my-hello-world-provider-name", "create_time" : "2024-01-01T00:00:00.000Z", "update_time" : "2024-01-01T00:00:00.000Z" }, { "provider_id" : "337cb9a1-6293-4f80-a903-66cd195283f7", "provider_name" : "my-hello-world-provider-name-2", "provider_description" : "my first hello world private provider", "provider_source" : "huawei.com/private-provider/my-hello-world-provider-name", "create_time" : "2023-01-01T00:00:00.000Z", "update_time" : "2023-01-01T00:00:00.000Z" } ], "page_info" : { "current_count" : 2, "next_marker" : null, "previous_marker" : "zxc1oHc08HcCmypYGTsOoRcvoHUvHRUAW5NOSnc1oHc08HcCPZrwP5NOeTlRiukJgtGxeujJeuGwGIihaIUCmypYGTsOtqvKPr2xmH8fPqpGWyQ0axGwGZp9aqvx8pQ7m5FvGTsJiKk7gtNFiuaxetdRCks=" } }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 providers Array of PrivateProviderSummary objects 私有provider的列表。默认以创建时间降序排序。 page_info PageInfo object 分页信息 表4 PrivateProviderSummary 参数 参数类型 描述 provider_id String 私有provider(private-provider)的唯一Id。 此Id由资源编排服务在生成provider的时候生成,为UUID。 由于私有provider名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是其他队友删除后创建的同名私有provider。因此,使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有provider所对应的Id都不相同,更新不会影响Id。如果给予的provider_id和当前provider的Id不一致,则返回400 provider_name String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 按照HCL最佳实践,该名称推荐为在模板中定义的provider的本地名称(local_name)。 创建私有Provider(CreatePrivateProvider)API 还会以 “huawei.com/private-provider”为固定前缀,并以“huawei.com/private-provider/{provider_name}”的形式返回provider_source字段。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 provider_description String 私有provider(private-provider)的描述。可用于客户识别被管理的私有provider。 provider_source String 用户使用私有provider,在Terraform模板中定义required_providers信息时,需要指明的source参数。 该参数按照“huawei.com/private-provider/{provider_name}”的形式拼接。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 provider_agency_urn String 自定义provider所绑定的 IAM 委托URN,provider_agency_name和provider_agency_urn最多只能提供一个。 provider_agency_name String 自定义provider所绑定的IAM委托名称,provider_agency_name和provider_agency_urn最多只能提供一个。 create_time String 私有provider(private-provider)的生成时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 update_time String 私有provider(private-provider)的更新时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 表5 PageInfo 参数 参数类型 描述 next_marker String 向后分页标识符。如果存在,则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中,在请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 previous_marker String 向前分页标识符。 current_count Integer 本页显示的条目数量。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:401 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:403 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:429 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:500 表14 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • 功能介绍 列举私有provider(ListPrivateProviders) 列举当前局点下用户所有的私有provider。 可以使用sort_key和sort_dir两个关键字对返回结果按创建时间(create_time)进行排序。给予的sort_key和sort_dir数量须一致,否则返回400。如果未给予sort_key和sort_dir,则默认按照创建时间降序排序。 如果当前用户下没有任何私有provider,则返回空list。 如果需要某个provider的所有版本信息,可以调用ListPrivateProviderVersions。 支持分页返回。如果响应中存在next_marker,则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中,在请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null
  • URI GET /v1/private-providers 表1 Query参数 参数 是否必选 参数类型 描述 sort_key 否 Array of strings 排序字段,仅支持给予create_time sort_dir 否 Array of strings 指定升序还是降序 asc - 升序 desc - 降序 marker 否 String 分页标记。当一页无法返回所有结果,上一次的请求将返回next_marker以指引还有更多页数,用户可以将next_marker中的值放到此处以查询下一页的信息。此marker只能用于与上一请求指定的相同参数的请求。不指定时默认从第一页开始查询。 limit 否 Integer 每页返回的最多结果数量
  • 请求示例 获取私有provider元数据 GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name 获取私有provider元数据,并提供provider ID以校验是否与当前私有provider匹配 GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name?provider_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2
  • 响应示例 状态码:200 获取私有provider元数据成功 { "provider_name" : "my-hello-world-provider-name", "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "provider_source" : "huawei.com/private-provider/my-hello-world-provider-name", "provider_description" : "my first hello world private provider", "create_time" : "1970-01-01T00:00:00.000Z", "update_time" : "1970-01-01T00:00:00.000Z" }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 provider_id String 私有provider(private-provider)的唯一Id。 此Id由资源编排服务在生成provider的时候生成,为UUID。 由于私有provider名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是其他队友删除后创建的同名私有provider。因此,使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有provider所对应的Id都不相同,更新不会影响Id。如果给予的provider_id和当前provider的Id不一致,则返回400 provider_name String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 按照HCL最佳实践,该名称推荐为在模板中定义的provider的本地名称(local_name)。 创建私有Provider(CreatePrivateProvider)API 还会以 “huawei.com/private-provider”为固定前缀,并以“huawei.com/private-provider/{provider_name}”的形式返回provider_source字段。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 provider_description String 私有provider(private-provider)的描述。可用于客户识别被管理的私有provider。 provider_source String 用户使用私有provider,在Terraform模板中定义required_providers信息时,需要指明的source参数。 该参数按照“huawei.com/private-provider/{provider_name}”的形式拼接。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 provider_agency_urn String 自定义provider所绑定的IAM委托URN,provider_agency_name和provider_agency_urn最多只能提供一个。 provider_agency_name String 自定义provider所绑定的IAM委托名称,provider_agency_name和provider_agency_urn最多只能提供一个。 create_time String 私有provider(private-provider)的生成时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 update_time String 私有provider(private-provider)的更新时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表6 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表8 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:403 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表10 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:404 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表12 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:429 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表14 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:500 表15 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表16 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • 功能介绍 获取私有provider元数据(ShowPrivateProviderMetadata) 获取某个私有provider的元数据信息 具体返回的信息见ShowPrivateProviderMetadataResponseBody,如果想查看私有provider下全部provider版本,请调用ListPrivateProviderVersions。 如果provider_name和provider_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。
  • URI GET /v1/private-providers/{provider_name}/metadata 表1 路径参数 参数 是否必选 参数类型 描述 provider_name 是 String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 表2 Query参数 参数 是否必选 参数类型 描述 provider_id 否 String 私有provider的唯一Id,由资源编排服务随机生成,为UUID。 由于私有provider名称仅仅在同一时间下唯一,即用户允许先生成一个叫helloword的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是由其他队友删除后创建的同名私有provider。 因此,使用ID就可以做到强匹配。资源编排服务保证每次创建私有provider所对应的Id都不相同。 如果给予的provider_id和当前私有provider的Id不一致,则返回400。
  • 请求示例 删除私有provider及私有provider下的所有provider版本 DELETE https://{endpoint}/v1/private-providers/my-hello-world-provider-name 删除私有provider及私有provider下的所有provider版本,并提供provider ID以校验是否与当前私有provider匹配 DELETE https://{endpoint}/v1/private-providers/my-hello-world-provider-name?provider_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2
  • 响应参数 状态码:204 删除私有provider成功,无数据返回 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表5 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:404 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:429 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:500 表14 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • URI DELETE /v1/private-providers/{provider_name} 表1 路径参数 参数 是否必选 参数类型 描述 provider_name 是 String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 表2 Query参数 参数 是否必选 参数类型 描述 provider_id 否 String 私有provider的唯一Id,由资源编排服务随机生成,为UUID。 由于私有provider名称仅仅在同一时间下唯一,即用户允许先生成一个叫helloword的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是由其他队友删除后创建的同名私有provider。 因此,使用ID就可以做到强匹配。资源编排服务保证每次创建私有provider所对应的Id都不相同。 如果给予的provider_id和当前私有provider的Id不一致,则返回400。
  • 功能介绍 创建模板版本(CreateTemplateVersion) 此API用于创建新的模板版本 请求中必须包括template_uri或template_body。前者为模板内容obs链接,后者为模板内容 新创建的模板版本版本ID会自动在当前最大模板版本ID的基础上加1 创建模板版本需要的具体信息详见:CreateTemplateVersionRequestBody template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的模板,删除,再重新创建一个同名模板。对于团队并行开发,用户可能希望确保,当前我操作的模板就是我认为的那个,而不是其他队友删除后创建的同名模板。因此,使用ID就可以做到强匹配。资源编排服务保证每次创建的模板所对应的ID都不相同,更新不会影响ID。如果给予的template_id和当前模板管理的ID不一致,则返回400
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 version_id String 模板模板版本ID 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:429 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:500 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表17 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • URI POST /v1/{project_id}/templates/{template_name}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,可以从调用API处获取,也可以从控制台获取。 项目ID获取方式 template_name 是 String 用户希望创建的模板名称 表2 Query参数 参数 是否必选 参数类型 描述 template_id 否 String 模板的ID。当template_id存在时,模板服务会检查template_id是否和template_name匹配,不匹配会返回400
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Client-Request-Id 是 String 用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID 表4 请求Body参数 参数 是否必选 参数类型 描述 version_description 否 String 模板版本的描述。可用于客户识别自己的模板版本 template_body 否 String HCL模板,描述了模板中使用的资源 template_body 和 template_uri 有且仅有一个存在 template_uri 否 String HCL模板的obs链接,该模板描述了资源的目标状态 对应的文件应该是纯tf文件或zip压缩包 纯tf文件需要以.tf或者.tf.json结尾,并遵守hcl语法 压缩包目前只支持zip格式,文件需要以".zip"结尾。解压后的文件不得包含".tfvars"文件 template_body 和 template_uri 有且仅有一个存在
  • 请求示例 获取私有provider指定版本的元数据信息 GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0/metadata 获取私有provider指定版本的元数据信息,并提供provider id以校验是否与当前私有provider匹配 GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0/metadata?provider_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3
  • 响应示例 状态码:200 获取私有provider版本元数据成功 { "provider_name" : "my-hello-world-provider-name", "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "provider_version" : "3.7.10", "version_description" : "my first hello world private provider version", "create_time" : "1970-01-01T00:00:00.000Z", "function_graph_urn" : "urn:fss:cn-north-7:b61dfe3154de4282787126568d5040f:function:default:myFG:latest", "provider_source" : "huawei.com/private-provider/my-hello-world-provider-name" }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 provider_id String 私有provider(private-provider)的唯一Id。 此Id由资源编排服务在生成provider的时候生成,为UUID。 由于私有provider名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是其他队友删除后创建的同名私有provider。因此,使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有provider所对应的Id都不相同,更新不会影响Id。如果给予的provider_id和当前provider的Id不一致,则返回400 provider_name String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 按照HCL最佳实践,该名称推荐为在模板中定义的provider的本地名称(local_name)。 创建私有Provider(CreatePrivateProvider)API 还会以 “huawei.com/private-provider”为固定前缀,并以“huawei.com/private-provider/{provider_name}”的形式返回provider_source字段。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 provider_version String provider的版本号。版本号必须遵循语义化版本号(Semantic Version),为用户自定义 version_description String 私有provider版本(provider version)的描述。可用于客户识别并管理私有provider的版本。注意:provider版本为不可更新(immutable),所以该字段不可更新,如果需要更新,请删除后重建 function_graph_urn String FunctionGraph方法的统一资源标识,用于唯一标识的FunctionGraph方法。当前只支持和RFS同region的function_graph_urn,如果给予了关于其他region的,会报错400。 关于该参数的详细解释,请参考官方文档:https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0102.html create_time String 私有provider(private-provider)版本的生成时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 provider_source String 用户使用私有provider,在Terraform模板中定义required_providers信息时,需要指明的source参数。 该参数按照“huawei.com/private-provider/{provider_name}”的形式拼接。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表6 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表8 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:403 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表10 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:404 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表12 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:429 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表14 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码:500 表15 响应Body参数 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表16 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • URI GET /v1/private-providers/{provider_name}/versions/{provider_version}/metadata 表1 路径参数 参数 是否必选 参数类型 描述 provider_name 是 String 私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 provider_version 是 String provider的版本号。版本号遵循语义化版本号(Semantic Version),为用户自定义 表2 Query参数 参数 是否必选 参数类型 描述 provider_id 否 String 私有provider的唯一Id,由资源编排服务随机生成,为UUID。 由于私有provider名称仅仅在同一时间下唯一,即用户允许先生成一个叫helloword的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是由其他队友删除后创建的同名私有provider。 因此,使用ID就可以做到强匹配。资源编排服务保证每次创建私有provider所对应的Id都不相同。 如果给予的provider_id和当前私有provider的Id不一致,则返回400。
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全