华为云用户手册

  • 请求示例 https://bcs.cn-north-7.ulanqab.huawei.com/v1/c11f04753f2442db8b5c54080f6c607f/tdis/firm-did{ "service" : [ { "credential_apply_schema" : { "name" : "LegalCitizen", "description" : "Certified Chinese citizens", "attributes" : [ { "name" : "name", "description" : "Identity number", "type" : "someType" } ], "type" : "LegalCitizen" }, "service_endpoint" : "https://xdi.example.com/8377464", "type" : "LegalCitizenAMService" } ]}
  • 响应示例 状态码: 200 分布式身份标识 { "did" : "did:hwid:WiWqmx6UMuZGFLcTQcf1ov"} 状态码: 400 请求错误 { "error_code" : "APAAS.40000002", "error_msg" : "Unexpected end of JSON input."} 状态码: 500 内部错误 { "error_code" : "TDIS.50000000", "error_msg" : "Internal error. Please contact the service provider."}
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 did String 分布式身份标识 最小长度:20 最大长度:100 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 service 是 Array of ServiceLatest objects 服务列表 表4 ServiceLatest 参数 是否必选 参数类型 描述 type 是 String 服务类型 最小长度:1 最大长度:100 credential_apply_schema 是 CredentialApplySchema object 申请凭证所需数据的Schema service_endpoint 是 String 服务介绍网址 最小长度:10 最大长度:1000 表5 CredentialApplySchema 参数 是否必选 参数类型 描述 type 否 String 类型 最小长度:0 最大长度:100 name 否 String 名称 最小长度:0 最大长度:100 description 否 String 描述信息 最小长度:0 最大长度:200 attributes 否 Array of Attribute objects 属性列表 表6 Attribute 参数 是否必选 参数类型 描述 name 否 String 名称 最小长度:0 最大长度:100 type 否 String 类型 最小长度:0 最大长度:100 description 否 String 描述信息 最小长度:0 最大长度:200
  • 响应示例 状态码: 400 请求错误 { "error_code" : "APAAS.40000002", "error_msg" : "Unexpected end of JSON input."} 状态码: 500 内部错误 { "error_code" : "TDIS.50000000", "error_msg" : "Internal error. Please contact the service provider."}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 context String 内容 最小长度:1 最大长度:8192 sequence String 颁发机构对应凭证的序列号 最小长度:1 最大长度:128 type Array of strings 可验证凭证类型 最小长度:1 最大长度:128 issuer String 签发者身份标识 最小长度:20 最大长度:100 issuance_date String 签发日期 最小长度:10 最大长度:10 expiration_date String 凭证有效期 最小长度:10 最大长度:10 credential_subject CredentialSubject object 凭证主题 revocation Revocation object 撤销 表4 CredentialSubject 参数 参数类型 描述 owner String 申请者的身份标识 最小长度:20 最大长度:100 type String 凭证类型 最小长度:1 最大长度:20 schema_id String schema ID 最小长度:63 最大长度:63 data_uri String 数据URI 最小长度:1 最大长度:128 encrypted_aes_key String 加密对称密钥 最小长度:1 最大长度:8192 uri_type String 数据索引类型 最小长度:1 最大长度:128 data_hash String 数据hash值 最小长度:1 最大长度:8192 表5 Revocation 参数 参数类型 描述 id String 撤销API或者撤销列表的url 最小长度:1 最大长度:128 type String 撤销类型 最小长度:1 最大长度:20 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 did String 分布式身份标识 最小长度:20 最大长度:100 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535
  • 响应示例 状态码: 200 分布式身份标识 { "did" : "did:hwid:KqCp8aSgMHW8vmsjeKQ1yz"} 状态码: 400 请求错误 { "error_code" : "APAAS.40000002", "error_msg" : "Unexpected end of JSON input."} 状态码: 500 内部错误 { "error_code" : "TDIS.50000000", "error_msg" : "Internal error. Please contact the service provider."}
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 schema_index String 模板存储在链上的索引 最小长度:22 最大长度:151 credential_schema CredentialSchema object CredentialSchema 表6 CredentialSchema 参数 参数类型 描述 creator String 创建者身份标识 最小长度:20 最大长度:100 title String 名称 最小长度:1 最大长度:50 identifier String 凭证模板标识 最小长度:1 最大长度:50 attributes Array of Attribute objects 属性信息 version Integer 版本 最小值:1 最大值:2147483647 表7 Attribute 参数 参数类型 描述 name String 名称 最小长度:0 最大长度:100 type String 类型 最小长度:0 最大长度:100 description String 描述信息 最小长度:0 最大长度:200 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535
  • 响应示例 状态码: 200 可验证凭证模板 { "schema_index" : "did:hwid:JwMoBoTYTK9qSoanwKgQxo_did:hwid:JwMoBoTYTK9qSoanwKgQxo", "credential_schema" : { "creator" : "did:hwid:JwMoBoTYTK9qSoanwKgQxo", "title" : "电子身份证", "identifier" : "did:hwid:JwMoBoTYTK9qSoanwKgQxo", "attributes" : [ { "type" : "someType", "name" : "name", "description" : "Identity number" } ], "version" : 1 }} 状态码: 400 请求错误 { "error_code" : "APAAS.40000002", "error_msg" : "Unexpected end of JSON input."} 状态码: 500 内部错误 { "error_code" : "TDIS.50000000", "error_msg" : "Internal error. Please contact the service provider."}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 title 是 String 名称 最小长度:1 最大长度:50 identifier 是 String 标识 最小长度:1 最大长度:50 attributes 否 Array of Attribute objects 属性信息 issuer 是 String 签发者身份标识 最小长度:20 最大长度:100 表4 Attribute 参数 是否必选 参数类型 描述 name 否 String 名称 最小长度:0 最大长度:100 type 否 String 类型 最小长度:0 最大长度:100 description 否 String 描述信息 最小长度:0 最大长度:200
  • 请求示例 { "identifier" : "电子身份证模板", "attributes" : [ { "name" : "name", "description" : "Identity number", "type" : "someType" } ], "title" : "电子身份证", "issuer" : "did:hwid:JwMoBoTYTK9qSoanwKgQxo"}
  • 响应消息体 响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 1 2 3 4 5 6 7 8 9101112 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01",...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_code": "AS.0001" "error_msg": "The format of message is error", } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 creator String 创建者身份标识 最小长度:20 最大长度:100 title String 名称 最小长度:1 最大长度:50 identifier String 凭证模板标识 最小长度:1 最大长度:50 attributes Array of Attribute objects 属性信息 version Integer 版本 最小值:1 最大值:2147483647 表4 Attribute 参数 参数类型 描述 name String 名称 最小长度:0 最大长度:100 type String 类型 最小长度:0 最大长度:100 description String 描述信息 最小长度:0 最大长度:200 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:13 最大长度:13 error_msg String 错误信息 最小长度:1 最大长度:65535
  • 响应示例 状态码: 400 请求错误 { "error_code" : "APAAS.40000002", "error_msg" : "Unexpected end of JSON input."} 状态码: 500 内部错误 { "error_code" : "TDIS.50000000", "error_msg" : "Internal error. Please contact the service provider."}
  • SDK列表 表1提供了CDN服务支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 参考文档 Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导 .NET huaweicloud-sdk-net-v3 .Net SDK使用指导 PHP huaweicloud-sdk-php-v3 PHP SDK使用指导 Node.js huaweicloud-sdk-nodejs-v3 Node.js SDK使用指导 C++ huaweicloud-sdk-cpp-v3 C++ SDK使用指导
  • 参数说明 表1 RunDevstarTemplateJob 参数说明 参数名称 是否必选 参数描述 application_name 是 应用名称。 template_id 是 DevStar 模板 ID。 repo_type 是 应用代码生成后的地址类型,目前支持 : 1:压缩包下载地址。 表2 ShowJobDetail 参数说明 参数名称 是否必选 参数描述 job_id 是 任务 ID。 表3 DownloadApplicationCode 参数说明 参数名称 是否必选 参数描述 job_id 是 任务 ID。
  • 使用示例 执行如下命令,生成代码。 hcloud DevStar RunDevstarTemplateJob --cli-region="cn-north-1" --repo_type=1 --application_name="spring" --template_id="0ae4cf82f4f3402bb6b7f1fbac6ed4dd" 示例执行成功结果如下。 { "job_id": "ACVhBgLx" ... 获取到任务 ID 后使用如下命令查询任务的运行状态。 hcloud DevStar ShowJobDetail --cli-region="cn-north-1" --job_id="ACVhBgLx" 显示如下则任务成功。 { "id": "ACVhBgLx", "name": null, "job_status": { "initRepository": { "name": "生成代码", "displayName": null, "status": "success", "context": { "status": null, "project_uuid": null, "repository_uuid": null, "repository_id": null, "repository_name": null, "https_url": null, "ssh_url": null, "web_url": null, "failure_reason": null }, "elapsedTime": 4, "createTime": 1655033046368, "startTime": 1655033047705, "endTime": 1655033052106, "logs": [] } }, "job_result": "success", "show_type": null} 任务执行成功后,输入下载代码命令将生成的代码下载到本地(默认下载到命令行工具安装目录)。 hcloud DevStar DownloadApplicationCode --cli-region="cn-north-1" --job_id="ACVhBgLx"
  • 使用示例 执行如下命令,查看模板名称里包含“spring”的模板。 hcloud DevStar ListTemplates --cli-region="cn-north-1" --keyword="springboot" 示例执行成功结果如下: "count": 3, "invalid_count": null, "templates": [ { "id": "0ae4cf82f4f3402bb6b7f1fbac6ed4dd", "title": "XXX", "description": "XXX" ...
  • 参数说明 表1 请求参数说明 参数名称 是否必选 参数描述 template_name 否 模板名称。程序会根据输入的模板名称模糊匹配当前可以使用的DevStar模板。仅支持字母、数字、下划线和空格。 表2 响应参数说明 参数名称 参数类型 参数描述 count integer 返回模板的数量。 invalid_count integer 返回关联了失效资源的模板数量。 templates Array of TemplateInfo objects 返回模板的列表。 表3 TemplateInfo 参数 名称 参数类型 描述 id string 模板id。 title string 模板名。 description string 模板描述。 productshorts Array of strings 模板关联的所有云服务(产品名称缩写)。 products Array of TemplateProductExt objects 模板关联的云产品。 topic Array of TopicCategory objects 模板标签。 creator_id string 模板创建者id。 creator string 模板创建者,有别名返回别名。 nickname string 模板创建者,有别名返回别名。 score integer 模板评分(点赞数)。 label string 模板标签(new、hot等)。 store integer 代码存储位置。 store_info string 获取代码模版所需的信息。 status integer 模板状态: 0:审核中 1:已上架 2:未上架(已下架) 3:未上架(合规检查不通过) 4:未上架(待上架) 5:已删除 view_count integer 访问量。 usage_count integer 引用量。 created_at string 创建时间。 updated_at string 更新时间。 published_at string 模板上架时间。 favorite_state integer 点赞状态: 1:点赞 0:未点赞 tags Array of TagInfo objects 模板标签。 type integer 模板类型: 0:doc 1:code 2:pipeline 3:devops is_static integer 动、静态代码模板标识: 0:动态模板codetemplate 1:静态模板codesample maintainers Array of strings 模板相关联的所有维护人账号名称。 pipeline_template PipelineTemplateInfo object 流水线模板。 platform_source integer 平台来源: 0:codelabs 1:devstar references Array of Reference objects 相关文档,示例,帖子。 properties properties object 模板自定义参数列表。 dependencies Array of dependencies objects dependency信息。 dependency_type string dependency类型。 forum_id integer 关联论坛板块id。 file_size integer 模板文件解压缩之后的大小(单位:KB)。 deployment deployment object 部署信息。 update_id string 模板关联更新态Id。 is_support_cloudide boolean 是否支持使用CloudIDE运行源码。 has_notices boolean 是否有消息。 dependents Array of Dependent objects 模板部署方式依赖信息。 dependent_services string 模板关联云服务。
  • Metadata说明 Metadata是Terraform支持的内置元参数,可以在 provider,resource,data块中使用。本章节主要介绍 resource块支持的元参数,主要包括: depends_on:用于指定资源的依赖项 count:用于创建多个相同配置的资源 for_each:用于根据映射、字符串集合创建多个资源 provider:用于选择非默认的 provider lifecycle:用于定制资源的生命周期 父主题: Metadata
  • terraform plan terraform plan 命令用于创建执行前的计划,是 terraform apply 执行前的一个预览方式,可以检查当前的变更是否符合预期。terraform plan 命令将检测云上资源的属性和状态文件是否存在差异,如果不一致,Terraform 会将差异结果显示在命令下方: $ terraform planRefreshing Terraform state in-memory prior to plan...The refreshed state will be used to calculate this plan, but will not bepersisted to local or state storage....Plan: 1 to add, 0 to change, 1 to destroy.... 如果 Terraform 未检测到资源或根模块的更改,则 terraform plan 会输出如下提示: $ terraform plan...No changes. Infrastructure is up-to-date.This means that Terraform did not detect ant differences between yourconfiguration and real physical resources that exist. As a result, noactions need to be performed. 默认情况下,terraform plan 命令首先会从远端更新资源的属性。在管理资源较多的情况下,该操作会耗时较长,我们可以使用 "-refresh=false" 选项来禁止更新。
  • lifecycle 每个资源实例都具有创建 、更新和销毁三个阶段,在一个资源实例的生命周期过程中都会经历其中的2至3个阶段。通过元参数 lifecycle 可以对资源实例的生命周期过程进行改变,lifecycle 支持以下参数: create_before_destroy 默认情况下,当我们需要改变资源中不支持更新的参数时,Terraform会先销毁已有实例,再使用新配置的参数创建新的对象进行替换。当我们将 create_before_destroy 参数设置为 true 时,Terraform将先创建新的实例,再销毁之前的实例。这个参数可以适用于保持业务连续的场景,由于新旧实例会同时存在,需要提前确认资源实例是否有唯一的名称要求或其他约束。 lifecycle { create_before_destroy = true} prevent_destroy 当我们将 prevent_destroy 参数设置为true时,Terraform将会阻止对此资源的删除操作并返回错误。这个元参数可以作为一种防止因意外操作而重新创建成本较高实例的安全措施,例如数据库实例。如果要删除此资源,需要将这个配置删除后再执行 destroy 操作。 lifecycle { prevent_destroy = true} ignore_changes 默认情况下,Terraform plan/apply 操作将检测云上资源的属性和本地资源块中的差异,如果不一致将会调用更新或者重建操作来匹配配置。我们可以用 ignore_changes 来忽略某些参数不进行更新或重建。ignore_changes 的值可以是属性的相对地址列表,对于 Map 和 List 类型,可以使用索引表示法引用,如 tags["Name"],list[0] 等。 resource "huaweicloud_rds_instance" "myinstance" { ... lifecycle { ignore_changes = [ name, ] }} 此时,Terraform 将会忽略对 name 参数的修改。除了列表之外,我们也可以使用关键字 all 忽略所有属性的更新。 resource "huaweicloud_rds_instance" "myinstance" { ... lifecycle { ignore_changes = all }} 父主题: Metadata
  • terraform apply terraform apply 命令用于执行资源的创建或变更。在操作执行前会进行一次人机交互,用于对资源创建和变更的确认。我们也可以使用 "-auto-approve" 选项跳过人机交互直接执行。 $ terraform applyAn execution plan has been generated and is shown below.Resource actions are indicated with the following symbols:Terraform will perform the following action:...Plan: 1 to add, 0 to change, 1 to destroy.Do you want to perform these actions? Terraform will perform the actions described above. Only 'yes' will be accepted to approve. Enter a value: terraform apply 的执行结果会保存在状态文件 (terraform.tfstate) 中,并且会显示定义的输出变量值。 Apply complete! Resources: 1 to add, 0 to change, 1 to destroy.Outputs:vpc_id = df507d37-bce2-4750-8873-f62abb3b085c
  • 样式约定 Terraform约定了一些惯用的风格样式,以确保不同团队编写的文件和模块的风格一致性。建议用户遵循这些约定,推荐的样式约定如下: 对于每个嵌套级别,缩进两个空格。 当多个单行的参数在同一嵌套级别连续出现时,建议将等号对齐。 name = "myinstance"security_groups = ["default", "internal"] 使用空行分隔块中的逻辑参数组。 当块主体同时包含参数和块时,建议将所有参数放在顶部,嵌套块放在参数的下方并使用空行隔开。 将元参数(meta-arguments) 放在块主体的顶部,并使用空行与其它参数隔开;将元参数块(meta-argument blocks) 放在块主体的最后,并用空行与其他块隔开。 resource "huaweicloud_obs_bucket" "demo" { count = 1 bucket = "bucket_demo" acl = "public-read" tags = { foo = "bar" env = "test" } lifecycle { create_before_destroy = true }} 顶层块之间使用空行将彼此隔开。 建议将相同类型的嵌套块放在一起,不同类型的嵌套块使用空行隔开。
  • 块 (Block) 块将多个参数聚合在一起,并支持嵌套。块由块类型、块标签和块主体构成,格式如下: resource "huaweicloud_compute_instance" "myinstance" { name = "myinstance" ...... network { uuid = "55534eaa-533a-419d-9b40-ec427ea7195a" }}
  • depends_on 在同一个 Terraform 配置文件中可以包含多个资源。通过在资源中引用其他资源的属性值,Terraform可以自动推断出资源的依赖关系。然而,某些资源的依赖关系对于Terraform是不可见的,这就需要使用 depends_on 来创建显式依赖。我们可以使用 depends_on 来更改资源的创建顺序或执行顺序,使其在所依赖资源之后处理。depends_on 的表达式是依赖资源的地址列表。例如我们在远程操作一台E CS 服务器之前,需要为其绑定EIP或配置NAT规则。 resource "huaweicloud_compute_instance" "myinstance" { ...}resource "huaweicloud_vpc_eip" "myeip" { ...}resource "huaweicloud_compute_eip_associate" "associated" { public_ip = huaweicloud_vpc_eip.myeip.address instance_id = huaweicloud_compute_instance.myinstance.id}resource "null_resource" "provision" { depends_on = [huaweicloud_compute_eip_associate.associated] provisioner "remote-exec" { connection { # 通过公网地址访问 ECS host = huaweicloud_vpc_eip.myeip.address ... } inline = [ ... ] }} 父主题: Metadata
  • 变量定义优先级 我们可以自由组合使用上述设置变量的方式。对于复合类型的变量,为了提高可读性并避免转义带来的问题,建议使用变量定义文件来设置。如果我们为同一个变量分配了多个值,Terraform 将使用最后一个值进行覆盖。Terraform 根据以下顺序加载变量 (根据顺序,后面的源优于前面的源): 环境变量 terraform.tfvars 或 terraform.tfvars.json 文件 *.auto.tfvars 或 *.auto.tfvars.json 文件 命令行中的 -var 和 -var-file 选项
  • Polycom终端注册到华为云 WeLink 会议平台 1. Polycom终端连接网络,确保网络可以访问互联网 用户可将连接终端网络接入PC,查看PC使用华为云WeLink会议客户端是否正常来确认网络。 2. 登录Polycom终端web页面配置SIP参数 Polycom Group 550终端上配置SIP参数,如下图所示: Polycom HDX 6000/7000终端上配置SIP参数,如下图所示: 父主题: 第三方友商会议终端接入华为云WeLink会议(Polycom、Cisco为例说明)
  • 第三方终端支持现状和支持的硬件推荐 华为云WeLink会议充分考虑客户对于设备利旧及成本预算的需求,支持第三方会议终端的接入,目前支持市场主流的 Cisco SX10、 Cisco SX20、 Cisco SX80、 Polycom Group 550、 Polycom HDX 4500、 Polycom HDX 6000、 Polycom HDX 8000, 都可以轻松接入,实现高清视频会议,支持型号及版本可参考官网说明。 对于不支持SIP协议的第三方友商会议终端不支持接入;支持SIP协议,实验室未对接测试过的也默认对外不支持,可根据用户意愿配合进行测试,实际以测试效果为准。 父主题: 商用环境第三方会议终端支持现状
共99354条