华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 certificate_id String 证书id。 最小长度:16 最大长度:16 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 正常返回。 { "certificate_id" : "scs1600313391074" } 状态码: 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 请求示例 { "name" : "test_cert", "certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----", "private_key" : "-----BEGIN RSA PRIVATE KEY-----*********-----END RSA PRIVATE KEY-----" }
  • 响应示例 状态码: 200 正常返回。 { "entire_certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE---******----END CERTIFICATE-----", "certificate" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----", "certificate_chain" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----", "private_key" : "-----BEGIN RSA PRIVATE KEY-----******-----END RSA PRIVATE KEY-----" } 状态码: 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 entire_certificate String 证书及证书链。 最小长度:1 最大长度:12288 certificate String 证书内容,不包含证书链。 最小长度:1 最大长度:4096 certificate_chain String 证书链。 最小长度:1 最大长度:8192 private_key String 证书私钥。 最小长度:1 最大长度:4096 enc_certificate String 国密证书返回,加密证书内容。 最小长度:1 最大长度:4096 enc_private_key String 国密证书返回,加密证书私钥。 最小长度:1 最大长度:4096 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 正常返回。 { "failure_list" : [ { "resource" : "982b8a6a6ebc43809d82a46ca99aaeb7", "failure_info" : "ELB.8904:certificate 982b8a6a6ebc43809d82a46ca99aaeb7 does not exist" } ] } 状态码: 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 适用于日志和监控的最佳实践 该示例模板包含以下合规规则: alarm-action-enabled-check apig-instances-execution-logging-enabled as-group-elb-healthcheck-required cts-kms-encrypted-check cts-lts-enable cts-obs-bucket-track cts-support-validate-check cts-tracker-exists dws-enable-log-dump function-graph-concurrency-check multi-region-cts-tracker-exists rds-instance-logging-enabled vpc-flow-logs-enabled
  • 华为云架构可靠性最佳实践 该示例模板包含以下合规规则: apig-instances-execution-logging-enabled as-group-elb-healthcheck-required cts-lts-enable cts-obs-bucket-track cts-obs-bucket-track cts-tracker-exists dws-enable-kms ecs-instance-in-vpc function-graph-concurrency-check gaussdb-nosql-enable-disk-encryption kms-not-scheduled-for-deletion multi-region-cts-tracker-exists rds-instance-enable-backup rds-instance-multi-az-support rds-instances-enable-kms sfsturbo-encrypted-check volumes-encrypted-check vpc-flow-logs-enabled vpn-connections-active-for-ipsec-site-connections vpn-connections-active-for-vpnConnections
  • 适用于空闲资产管理的最佳实践 该示例模板包含以下合规规则: stopped-ecs-date-diff eip-use-in-specified-days evs-use-in-specified-days eip-unbound-check iam-group-has-users-check iam-user-last-login-check volume-unused-check vpc-acl-unused-check cce-cluster-end-of-maintenance-version
  • 资源开启公网访问最佳实践 该示例模板包含以下合规规则: css-cluster-in-vpc drs-data-guard-job-not-public drs-migration-job-not-public drs-synchronization-job-not-public ecs-instance-in-vpc ecs-instance-no-public-ip function-graph-inside-vpc function-graph-public-access-prohibited mrs-cluster-no-public-ip rds-instance-no-public-ip
  • 华为云网络安全最佳实践 该示例模板包含以下合规规则: access-keys-rotated alarm-kms-disable-or-delete-key alarm-obs-bucket-policy-change alarm-vpc-change css-cluster-https-required css-cluster-in-vpc cts-kms-encrypted-check cts-lts-enable cts-obs-bucket-track cts-support-validate-check cts-tracker-exists ecs-instance-in-vpc ecs-instance-no-public-ip eip-unbound-check elb-tls-https-listeners-only iam-group-has-users-check iam-password-policy iam-root-access-key-check iam-user-console-and-api-access-at-creation iam-user-group-membership-check iam-user-last-login-check iam-user-mfa-enabled iam-user-single-access-key mfa-enabled-for-iam-console-access mrs-cluster-kerberos-enabled mrs-cluster-no-public-ip private-nat-gateway-authorized-vpc-only rds-instance-multi-az-support rds-instance-no-public-ip root-account-mfa-enabled stopped-ecs-date-diff volume-unused-check volumes-encrypted-check vpn-connections-active (vpnaas.vpnConnections) vpn-connections-active (vpnaas.ipsec-site-connections)
  • 适用于计算服务的最佳实践 该示例模板包含以下合规规则: as-capacity-rebalancing as-group-elb-healthcheck-required as-multiple-az ecs-instance-key-pair-login ecs-instance-no-public-ip ecs-multiple-public-ip-check eip-bandwidth-limit function-graph-concurrency-check function-graph-public-access-prohibited stopped-ecs-date-diff volume-unused-check volumes-encrypted-check
  • 适用于自动驾驶场景的最佳实践 该示例模板包含以下合规规则: css-cluster-disk-encryption-check css-cluster-no-public-zone css-cluster-security-mode-enable css-cluster-https-required cts-obs-bucket-track cts-support-validate-check cts-tracker-exists cts-kms-encrypted-check ecs-instance-no-public-ip elb-loadbalancers-no-public-ip elb-tls-https-listeners-only iam-password-policy iam-user-last-login-check iam-user-mfa-enabled rds-instance-no-public-ip root-account-mfa-enabled volumes-encrypted-check vpc-flow-logs-enabled vpc-sg-ports-check dcs-redis-no-public-ip dcs-redis-password-access
  • 适用于 统一身份认证 服务的最佳实践 该示例模板包含以下合规规则: access-keys-rotated iam-group-has-users-check iam-password-policy iam-root-access-key-check iam-user-console-and-api-access-at-creation iam-user-group-membership-check iam-user-last-login-check iam-user-mfa-enabled iam-user-single-access-key mfa-enabled-for-iam-console-access root-account-mfa-enabled
  • 适用于金融行业的最佳实践 该示例模板包含以下合规规则: access-keys-rotated as-group-elb-healthcheck-required css-cluster-https-required css-cluster-in-vpc cts-kms-encrypted-check cts-lts-enable cts-obs-bucket-track cts-support-validate-check cts-tracker-exists ecs-instance-in-vpc ecs-instance-no-public-ip eip-unbound-check elb-tls-https-listeners-only function-graph-concurrency-check iam-group-has-users-check iam-password-policy iam-root-access-key-check iam-user-group-membership-check iam-user-last-login-check iam-user-mfa-enabled kms-rotation-enabled mfa-enabled-for-iam-console-access mrs-cluster-in-vpc mrs-cluster-kerberos-enabled mrs-cluster-no-public-ip private-nat-gateway-authorized-vpc-only rds-instance-multi-az-support rds-instance-no-public-ip root-account-mfa-enabled stopped-ecs-date-diff volume-unused-check volumes-encrypted-check vpc-acl-unused-check vpc-flow-logs-enabled vpc-sg-ports-check vpn-connections-active (vpnaas.vpnConnections) vpn-connections-active (vpnaas.ipsec-site-connections) waf-instance-policy-not-empty
  • 适用于管理与监管服务的最佳实践 该示例模板包含以下合规规则: alarm-action-enabled-check alarm-kms-disable-or-delete-key alarm-obs-bucket-policy-change alarm-vpc-change tracker-config-enabled-check cts-kms-encrypted-check cts-lts-enable cts-support-validate-check cts-tracker-exists
  • 等保三级2.0规范检查的最佳实践 该示例模板包含以下合规规则: cts-tracker-exists dcs-redis-in-vpc dds-instance-in-vpc ecs-instance-in-vpc ecs-instance-no-public-ip eip-bandwidth-limit elb-loadbalancers-no-public-ip elb-tls-https-listeners-only iam-user-mfa-enabled rds-instance-multi-az-support rds-instance-no-public-ip rds-instances-in-vpc volumes-encrypted-check
  • 适用于人工智能与机器学习场景的最佳实践 该示例模板包含以下合规规则: cce-cluster-end-of-maintenance-version cce-cluster-oldest-supported-version cce-endpoint-public-access cts-obs-bucket-track mrs-cluster-kerberos-enabled mrs-cluster-no-public-ip sfsturbo-encrypted-check
  • 响应示例 { "is_success": true, "message": "", "connections": [ { "is_success": true, "message": "", "connection_id": "75419c22-7a31-42e4-a3f3-102f6e6895c9", "destination": "cloudtable-c172-zk3-WBFt4fr2.mycloudtable.com:2181,cloudtable-c172-zk2-LHZEWNau.mycloudtable.com:2181,cloudtable-c172-zk1-cvwY6lMh.mycloudtable.com:2181", "state": "DELETED", "process": 0, "name": "test", "connection_url": "", "cluster_name": "", "service": "CloudTable", "create_time": 1549092947256 } ] }
  • 响应消息 表2 响应参数 参数名称 是否必选 参数类型 说明 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息,执行成功时,信息可能为空。 connections 否 Array of Objects 跨源连接信息列表,详细信息请参考表3。 count 否 Integer 跨源连接数量。 表3 connections参数 参数名称 是否必选 参数类型 说明 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息,执行成功时,信息为空。 connection_id 否 String 连接ID,用于标识跨源连接的UUID。 destination 否 String 创建连接时,用户填写的队列的访问地址。 state 否 String 连接状态,具体状态请参见表4。 process 否 Double 正在创建的跨源连接进度,显示0.0至1.0代表0%至100%。 name 否 String 创建连接时,用户自定义的连接名称。 connection_url 否 String 用于建立跨源关联表时,需要使用到的连接url。 cluster_name 否 String Serverless Spark队列名称。SQL队列模式下建立的跨源连接,该字段为空。 service 否 String 创建连接时,用户指定的对端服务(CloudTable/CloudTable.OpenTSDB/ MRS .OpenTSDB/DWS/RDS/ CSS )。 create_time 否 Long 创建连接的时间。为UTC的时间戳。 queue_list 否 Array of Strings 经典跨源绑定的队列信息。 表4 连接状态 名称 含义 说明 CREATING 创建中 跨源连接正在创建中。 ACTIVE 已激活 跨源连接创建成功,与目的地址连接正常。 FAILED 已失败 跨源连接创建失败。 DELETED 已删除 跨源连接已被删除。
  • 响应消息 表3 响应参数说明 参数名称 是否必选 参数类型 说明 resources 否 Array of Objects 已上传的用户资源名列表, 资源详情请参见表4。 modules 否 Array of Objects 系统内置资源模块列表,模块详情请参考表5。 groups 否 Array of Objects 已上传的用户分组资源。 total 是 Integer 资源包返回总数。 表4 resources参数 参数名称 是否必选 参数类型 说明 create_time 否 Long 资源包上传的unix时间戳。 update_time 否 Long 更新已上传资源包的unix时间戳。 resource_type 否 String 资源类型。 resource_name 否 String 资源名。 status 否 String "UPLOADING"表示正在上传。 "READY"表示资源包已上传 。 "FAILED"表示资源包上传失败。 underlying_name 否 String 资源包在队列中的名字。 owner 否 String 资源包拥有者。 表5 modules参数 参数名称 是否必选 参数类型 说明 module_name 否 String 模块名。 module_type 否 String 模块类型。 status 否 String "UPLOADING"表示正在上传。 "READY"表示模块包已上传,。 "FAILED"表示模块包上传失败。 resources 否 Array of Strings 该模块包含的资源包名列表。 description 否 String 模块描述。 create_time 否 Long 模块上传的unix时间戳。 update_time 否 Long 模块更新的unix时间戳。
  • 响应示例 { "resources": [ { "create_time": 1521532893736, "update_time": 1521552364503, "resource_type": "jar", "resource_name": "luxor-router-1.1.1.jar", "status": "READY", "underlying_name": "3efffb4f-40e9-455e-8b5a-a23b4d355e46_luxor-router-1.1.1.jar" } ], "groups": [ { "group_name": "groupTest", "status": "READY", "resources": [ "part-00000-9dfc17b1-2feb-45c5-b81d-bff533d6ed13.csv.gz", "person.csv" ], "details": [ { "create_time": 1547090015132, "update_time": 1547090015132, "resource_type": "jar", "resource_name": "part-00000-9dfc17b1-2feb-45c5-b81d-bff533d6ed13.csv.gz", "status": "READY", "underlying_name": "db50c4dc-7187-4eb9-a5d0-73ba8102ea5e_part-00000-9dfc17b1-2feb-45c5-b81d-bff533d6ed13.csv.gz" }, { "create_time": 1547091098668, "update_time": 1547091098668, "resource_type": "file", "resource_name": "person.csv", "status": "READY", "underlying_name": "a4243a8c-bca6-4e77-a968-1f3b00217474_person.csv" } ], "create_time": 1547090015131, "update_time": 1547091098666 } ], "modules": [ { "module_name": "gatk", "status": "READY", "resources": [ "gatk.jar", "tika-core-1.18.jar", "s3fs-2.2.2.jar" ], "create_time": 1521532893736, "update_time": 1521552364503 } ] }
  • URI URI格式: GET /v2.0/{project_id}/resources 参数说明 表1 URI参数说明 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方式请参考获取项目ID。 表2 query参数说明 参数名称 是否必选 参数类型 说明 kind 否 String 指定文件类型。包括以下文件类型: jar:用户jar文件。 pyFile:用户python文件。 file:用户文件。 modelFile:用户AI模型文件。 tags 否 String 指定标签过滤。
  • URI URI格式: GET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id} 参数说明 表1 URI参数 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方式请参考获取项目ID。 queue_name 是 String 队列名称。 task_id 是 String 任务ID。该参数为创建指定地址连通性测试请求接口获取。
  • 请求示例 修改弹性资源池关联队列的扩缩容策略。 { "queue_scaling_policies" : [ { "priority" : 100, "impact_start_time" : "10:00", "impact_stop_time" : "22:00", "min_cu":"64", "max_cu":"752" }, { "priority" : 50, "impact_start_time" : "22:00", "impact_stop_time" : "10:00", "min_cu":"64", "max_cu":"752" } ] }
  • 请求消息 表2 请求参数说明 参数 是否必选 参数类型 描述 queue_scaling_policies 是 Array of objects 该队列在该弹性资源池下的扩缩容策略信息。单条策略信息包含时间段、优先级和CU范围。每个队列至少要配置一条时间段为[00:00, 24:00]的默认扩缩容策略。详细参数说明请参考表3。 表3 queue_scaling_policies 参数 是否必选 参数类型 描述 impact_start_time 是 String 生效开始时间。 impact_stop_time 是 String 生效结束时间。 priority 是 Integer 优先级。 min_cu 是 Integer 最小CU数量。 max_cu 是 Integer 最大CU数量。
  • URI URI格式 PUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues/{queue_name} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 elastic_resource_pool_name 是 String 弹性资源池名称。 project_id 是 String 项目编号,用于资源隔离。获取方式请参考获取项目ID。 queue_name 是 String 绑定的队列名称。
  • URI URI格式: GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview 参数说明 表1 URI 参数 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方式请参考获取项目ID。 database_name 是 String 待预览的表所在的数据库名称。 table_name 是 String 待预览的表名称。 表2 query参数 参数名称 是否必选 参数类型 说明 mode 否 String 预览表的模式,取值为““SYNC””或者““ASYNC””默认值为:“SYNC”。 带入query参数的URL示例如下: GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview?mode={previewMode}
  • 响应示例 同步请求成功响应样例: { "is_success": true, "message": "", "schema": [ { "id": "int" }, { "name": "string" }, { "address": "string" } ], "rows": [ [ "1", "John", "xxx" ], [ "2", "Lily", "xxx" ] ] } 如果为异步请求模式,则返回一个job ID,用户可再根据job ID获取预览信息。
  • 请求示例 生成Flink SQL作业的静态流图,流图的类型为静态流图。 { "cu_number": 4, "manager_cu_number": 1, "parallel_number": 4, "tm_cus": 1, "tm_slot_num": 1, "sql_body": "", "operator_config": "", "static_estimator": true, "job_type": "flink_opensource_sql_job", "graph_type": "job_graph" }
共100000条