云服务器内容精选

  • 请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 x-environment 否 String 指定查询配置的environment,取值包括:development、testing、acceptance、production。其他值均被作为空值处理。 Authorization 是 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。
  • URI GET /v3/{project_id}/configuration/items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 表2 Query参数 参数 是否必选 参数类型 描述 dimensionsInfo 是 String 服务信息,为服务名、应用、版本的拼接(服务名、应用必填,版本选填),拼接格式为(请注意“@”和“#”添加到http url时需转义,“@”转义为“%40”,“#”转义为“%23”): {serviceName}@{appId}#{version} 或{serviceName}@{appId} 不能包含$%^&+/\特殊字符和空格。 keyFilter 否 String key的筛选条件, 支持正则表达式。涉及特殊字符的正则表达式需要自行转义。 revision 否 String 配置项版本。用于判断本地缓存配置和配置管理中心的配置差异。 首次传值0。 若传入的revision值与当前配置的revision一致,则返回304状态码,无body体返回;若不一致,则返回当前配置和revision信息。 下次请求若需要传入revision,则该值为当前返回body体中的revision中的version的值 。
  • 响应示例 { "authorizations": [ { "name": "test", "repo_type": "github", "repo_host": "https://api.github.com", "repo_home": "https://github.com/tom-repo", "repo_user": "tom-repo", "avartar": "https://avatars.githubusercontent.com/u/73919200?v=4", "token_type": "oauth", "create_time": 1649731565642, "update_time": 1649731565642, "tag": null, "status": 0 } ], "count": 1 }
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 Authorization:签名认证信息,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参见AK/SK认证。 X-Sdk-Date:请求发送的时间,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参见AK/SK认证。 X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 X-Project-ID:子项目ID,可选,在多项目场景中使用。如果云服务资源创建在子项目中,AK/SK认证方式下,操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID:账号ID,可选。AK/SK认证方式下,全局服务的接口调用时,需在请求消息头中携带X-Domain-ID。 对于管理员创建 IAM 用户接口,使用AK/SK方式认证时,添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则Content-type中需声明字符编码方式为UTF-8。例如,Content-Type: application/json; charset=utf-8。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 ********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就齐全了,您可以使用curl、postman或直接编写代码等方式发送请求调用API。
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint:指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点处获取。例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“管理员创建IAM用户”API的resource-path为“/v3.0/OS-USER/users”。 query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”。例如“limit=10”,表示查询不超过10条数据。 例如您需要获取创建IAM用户,由于IAM为全局服务。则使用任一区域的Endpoint(比如“华北-北京四”区域的Endpoint:iam.cn-north-4.myhuaweicloud.com),并在管理员创建IAM用户的URI部分找到resource-path(/v3.0/OS-USER/users),拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),表示服务正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users
  • 响应示例 { "versions": [ { "status": "CURRENT", "id": "v2.0", "links": [ { "href": "https://{Endpoint}/v2.0", "rel": "self" } ] } ] }
  • 响应参数 表1 响应参数 参数名称 类型 说明 versions Array of version objects API版本列表,请参见表2。 表2 version对象 参数名称 类型 说明 status String API版本的状态: CURRENT(当前版本) STABLE(稳定版本) DEPRECATED(废弃版本) id String API版本。 links Array of link objects 链接列表,请参见表3。 表3 link对象 参数名称 类型 说明 href String API链接。 rel String API链接与该API版本的关系。
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于统一认证获取access_token接口,返回如下消息体。 { "access_token": "eyJraWQiOiJjZjE0Y2EzZi1lZTM3LTRhYWItYWY5ZS1kMjJiYzY5NDZkZDIiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIxMjMwNDAwMDAxNyIsImF1ZCI6ImFpLXNoZW5nc2ktY2xpZW50LWlkIiwibmJmIjoxNjkyNzc0MTUyLCJzY29wZSI6WyJwcm9maWxlIl0sImlzcyI6Imh0dHA6XC9cLzEwLjI0Ny4xMzMuNTg6ODAwMyIsImV4cCI6MTY5Mjc3NTk1MiwiaWF0IjoxNjkyNzc0MTUyLCJhdXRob3JpdGllcyI6IlBFUk1JU1NJT05fQUxMIn0.fqWdl18V0tUNeR6QXdRJj8ZaQ5cG_JXx1ZYaMfJhOQfcIS_L1qYdOz44T88KbWvvF-gzbY0zAiNAYomglK6eGwfFmc38Gfkga-T9AtIqE_4yQlN-1nH IDT 2irn_CLhCPVH2ZpI-GtVUbWHstk-IlSsrznbVv9QLByS45JgBzcXtI8Nb0v2AehqPpDXxCLr0F_PUg58ldLKZtC6MFN_AcFfCWE9V_h6P8B9x3aUKJnOjAhx9Hmt52DbWeeZBTPq6VD1dqffORrP28d6nwac0bgLmfJUB9Y0S9otSoWFBryE-vY1TXtd1nYBfcKkGXlsWyepocfvE4aJdJikd95Rr9tI_kR50z7KqC9_nmtMt2v9UpN100W5lY9GRkhurwaMziKEe0v9mkjAROliiX5N5JuQQ4If3Nx_BGJL-OEy6tQiqdOE0dGxDz9KtWSVIp_UlY9eb8GCQszXZa9-jYJhPPpgixLA5ZEWh_KUHkctZ7877VMDLJrFI-D964XqNkXTUk", "refresh_token": "Y1DyiJFg6KaBi-q0xgiqNQM5QrhoGOI-lgTpihU5xl18eiuSP95kSHz_YBCB7pL_wlj9-6Cun97JLxvv9GfSTzMhxvdFGmsvb3EbphPu-zKqVMWrbmPbw5ghXiFPcuav", "scope": "profile", "token_type": "Bearer", "expires_in": 1800 } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "code": 61010202, "data": "invalid_grant", "message": "无效的code" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 请求消息头 添加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”。 Authorization:请求消息中可带的签名信息,必选,AK/SK认证的详细说明请参见:AK/SK认证。 X-Sdk-Date:请求发送的时间,必选,例如:20221107T020014Z。 Host:表明主机地址,必选,如identitycenter.myhuaweicloud.com。 API支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见:AK/SK认证。 对于列出实例接口,请求如下所示。 GET https://identitycenter.myhuaweicloud.com/v1/instances content-type: application/json X-Sdk-Date: 20230330T021902Z host: identitycenter.myhuaweicloud.com Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URL 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP,不同服务在不同区域,Endpoint不同,可以从地区和终端节点处获取。例如IAM身份中心服务的Endpoint为identitycenter.myhuaweicloud.com。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“列出实例”API的resource-path为“/v1/instances”。 query-string 查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM身份中心的实例信息,则需使用IAM身份中心的Endpoint(identitycenter.myhuaweicloud.com),并在列出实例的URI部分找到resource-path(/v1/instances),拼接起来如下所示。 1 https://identitycenter.myhuaweicloud.com/v1/instances 为查看方便,每个具体API的URI,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在列出实例的URI部分,您可以看到其请求方法为“GET”,则其请求为: GET https://identitycenter.myhuaweicloud.com/v1/instances
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM获取的用户Token,获取方式请参见:获取用户Token。 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 log_time_ns 是 Long 日志数据上报时间,UTC时间(纳秒)。 说明: 通过接口上报日志到LTS的时间相距当前时间不超过2天,否则上报日志会被LTS删除。 contents 是 Array of String 日志内容。 labels 是 Object 用户自定义label。 说明: 请不要将字段名称设置为内置保留字段,否则可能会造成字段名称重复、查询不精确等问题。 tenant_project_id 否 String 租户项目ID,获取方式请参见:获取账号ID、项目ID、日志组ID、日志流ID。
  • 请求示例 POST https://{接入点IP:8102}/v2/{project_id}/lts/groups/{log_group_id}/streams/{log_stream_id}/tenant/contents { "log_time_ns": 1586850540000000000, "contents": [ "Fri Feb 1 07:48:04 UTC 2019 0\n", "Sat Apri 18 16:04:04 UTC 2019" ], "labels": { "user_tag": "string" } }