云服务器内容精选

  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 success Array of 表7 objects 操作成功列表。 failure Array of 表8 objects 操作失败列表。 表7 MetadataEntitySimpleRespone 参数 参数类型 描述 entity_urn String 实体urn。 entity_name String 实体名称。 entity_type String 实体类别。 表8 MetadataEntityFailureResp 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 entity_name String 实体名称。 entity_type String 实体类别。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 请求示例 POST https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/entities { "entities": [ { "package_id": "Metamodel3", "entity_name": "q8", "entity_type": "Metamodel3-SubjectArea", "entity_attributes": [ { "attribute_id": "Metamodel3-SubjectArea-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-PermissionCode", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-OrderNumber", "attribute_value": "" }, { "attribute_id": "entity_name", "attribute_value": "q8" } ], "signatures": [ { "signature_name": "", "signature_type": "Metamodel3-descriptionInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-descriptionInfo-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-description", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameEn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameCn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-dataAssetNumber", "attribute_value": "" } ] }, { "signature_name": "", "signature_type": "Metamodel3-maintenanceInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-maintenanceInfo-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createdBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updatedBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updateTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-creatorAccount", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updaterAccount", "attribute_value": "" } ] } ] } ] }
  • 响应示例 状态码: 200 successful operation { "msg": null, "success": [ { "entity_type": "Metamodel3-SubjectArea", "entity_urn": "urn:abm:Metamodel3-SubjectArea:b2570da68c011fbf7bf8e784e9cd2c", "entity_name": "q8" } ], "failure": [] }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 entities 否 Array of 表3 objects 实体请求列表,最大个数不超过200个。 表3 MetadataEntityRequest 参数 是否必选 参数类型 描述 package_id 否 String 模型包ID。 entity_name 否 String 实体名称。 entity_type 否 String 实体类型。 entity_attributes 否 Array of 表5 objects 实体属性。 signatures 否 Array of 表4 objects 特征。 表4 MetadataSignature 参数 是否必选 参数类型 描述 signature_type 否 String 特征类型。 signature_name 否 String 特征名称。 signature_attributes 否 Array of 表5 objects 特征属性。 表5 MetadataAttributeRequest 参数 是否必选 参数类型 描述 attribute_id 否 String 属性ID。 attribute_value 否 String 属性值。
  • URI PUT /v2/{project_id}/edge-nodes/{edge_node_id}/externals/{external_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 external_id 是 String 外部实体ID 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 protocol 是 String 连接外部实体的协议类型 connection_type 是 String 连接类型 mqtt_connection_info 否 MqttConnectionInfo object mqtt连接信息 表4 MqttConnectionInfo 参数 是否必选 参数类型 描述 server_address 否 String 采用cleint方式连接时,mqtt服务器地址 最小长度:4 最大长度:128 client_id 否 String mqtt连接时,client_id 最小长度:4 最大长度:256 auth_type 否 String 鉴权类型。支持密钥认证接入(SECRET)和证书认证接入(CERTIFICATES)两种方式。使用密钥认证接入方式(SECRET)填写user_name和user_name字段,使用证书认证接入方式(CERTIFICATES)填写privateKey和certificate字段 private_key 否 String 证书秘钥 最小长度:4 最大长度:20000 certificate 否 String 证书 最小长度:4 最大长度:20000 user_name 否 String 用户名 最小长度:4 最大长度:256 password 否 String 密码 最小长度:4 最大长度:256 qos 否 Integer 服务质量,默认为0,表示最多一次的传输,1表示至少一次,2表示仅一次. 缺省值:0 最小长度:1 最大长度:1
  • 请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/externals/{external_id} { "protocol" : "MQTT", "connection_type" : "CLIENT", "mqtt_connection_info" : { "server_address" : "ssl://127.0.0.1:88883", "client_id" : "client_id", "auth_type" : "SECRET", "private_key" : "MIIGsDCCBJigAwIBAgIIdrfb4YBBxtQwDQYJKoZIhvcNAQELBQAwgZIxCzAJBgNV", "certificate" : "MIIGsDCCBJigAwIBAgIIdrfb4YBBxtQwDQYJKoZIhvcNAQELBQAwgZIxCzAJBgNV", "user_name" : "user_name", "password" : "password", "qos" : 0 } }
  • 响应示例 状态码: 200 OK { "node_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "external_id" : "string", "protocol" : "string", "connection_type" : "string", "create_time" : "string", "last_modify_time" : "string" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 node_id String 节点ID 最小长度:1 最大长度:64 space_id String 资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下,否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. 最小长度:1 最大长度:36 external_id String 外部实体ID 最小长度:1 最大长度:64 protocol String 接入协议类型:MQTT,HTTP。 connection_type String 连接类型(client和server) create_time String 创建时间 最小长度:0 最大长度:256 last_modify_time String 最后修改时间 最小长度:0 最大长度:256