脚本查询
功能介绍
该接口是脚本主页查询,可指定脚本名称和脚本创建人进行精确查询,返回包含脚本基本信息的列表数据。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/cms/script/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id。 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 最小长度:1 最大长度:40960 |
Content-Type |
是 |
String |
指定类型为application/json。 最小长度:1 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
查询接收的参数,版本管理时,name为脚本名称(版本管理查询时name不能为空),脚本管理页面查询时,name为接收模糊查询的参数,name是null,表示查询所有默认脚本。 最小长度:0 最大长度:128 |
is_default |
否 |
String |
查询规则,如果是类型为default,则为模糊查询和脚本管理主页展示,no_default为版本管理。 最小长度:0 最大长度:16 |
create_by |
否 |
String |
创建人,默认按照创建人搜索脚本。 最小长度:1 最大长度:64 |
script_id |
是 |
String |
版本管理时需要查询的脚本id。 最小长度:1 最大长度:64 |
page_num |
否 |
Integer |
page_num为正整数。 最小值:1 最大值:100 |
page_size |
否 |
Integer |
每页显示的条数,默认值是10。 最小值:1 最大值:1000 |
project_id |
否 |
String |
项目id。 最小长度:32 最大长度:32 |
order_by_column |
是 |
String |
需要排序的字段(默认为更新时间),支持字段有name,create_time和update_time。 最小长度:1 最大长度:16 |
sort_order |
是 |
String |
排序规则(默认降序) 传入升序或降序,升序:ASC,降序:DESC。 最小长度:1 最大长度:16 |
enterprise_project_id |
否 |
String |
企业项目id,根据企业项目id搜索。 最小长度:1 最大长度:64 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
elements |
Array of Script objects |
查询结果集合。 数组长度:0 - 9999999 |
total_elements |
Integer |
查询到的结果数量。 最小值:0 最大值:99999999 |
参数 |
参数类型 |
描述 |
---|---|---|
approve_info |
ApproveInfo object |
审批信息 |
create_by |
String |
创建人,比如为:张三 最小长度:1 最大长度:64 |
create_time |
Long |
创建时间 最小值:0 最大值:9999999999999 |
description |
String |
脚本描述,脚本描述,对脚本进行描述,最大长度为1000 最小长度:0 最大长度:1000 |
enterprise_project_id |
String |
企业项目id 最小长度:1 最大长度:64 |
id |
String |
脚本id,根据UUID.randomUUID生成。 最小长度:1 最大长度:64 |
name |
String |
脚本名称,支持数字,下划线,大小写字母 ,中文 最小长度:1 最大长度:64 |
online_exist_status |
Boolean |
脚本中是否有已上线的版本,true表示有已上线的版本,false表示没有已上线的版本 |
online_id |
String |
已上线版本id 最小长度:1 最大长度:64 |
project_id |
String |
租户从IAM申请到的projectid,一般为32位字符串 最小长度:32 最大长度:32 |
rate_control |
RateControl object |
执行策略 |
script_language |
String |
脚本语言,目前支持四种,分别是:SHELL BAT PYTHON POWER_SHELL 最小长度:1 最大长度:16 |
update_by |
String |
修改人 最小长度:1 最大长度:64 |
update_time |
Long |
实体的最后更新时间戳。 注意:执行创建/修改/删除操作时,update_time将更新。 最小值:0 最大值:9999999999999 |
参数 |
参数类型 |
描述 |
---|---|---|
topic_selected |
String |
审批人主题选择。 最小长度:1 最大长度:2048 |
need_approve |
Boolean |
是否审核,默认是不审核,true,false。 |
smn_urn_list |
String |
审批主题urn集合。 最小长度:1 最大长度:2048 |
参数 |
参数类型 |
描述 |
---|---|---|
have_rate_control |
Boolean |
是否分批发布,默认值是false。 |
time_delay |
Integer |
每批间隔。 最小值:1 最大值:60 |
max |
Integer |
每批支持的最大实例数。 最小值:0 最大值:100 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:1 最大长度:32 |
error_msg |
String |
调用失败响应信息描述。 最小长度:1 最大长度:1024 |
http_code |
Integer |
Http返回码 最小值:1 最大值:999 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:1 最大长度:32 |
error_msg |
String |
调用失败响应信息描述。 最小长度:1 最大长度:1024 |
http_code |
Integer |
Http返回码 最小值:1 最大值:999 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:1 最大长度:32 |
error_msg |
String |
调用失败响应信息描述。 最小长度:1 最大长度:1024 |
http_code |
Integer |
Http返回码 最小值:1 最大值:999 |
请求示例
获取指定名称为“xxx”,排序为"DESC"的脚本列表。
https://{endpoint}/v1/{project_id}/cms/script/list { "name" : "xxx", "create_by" : "user1", "enterprise_project_id" : "", "page_num" : 1, "page_size" : 10, "is_default" : "default", "order_by_column" : "create_time", "sort_order" : "DESC", "script_id" : "" }
响应示例
状态码: 200
请求响应成功,返回脚本基本信息列表。
{ "elements" : [ { "approve_info" : { "need_approve" : false }, "create_by" : "chenkaiyuan", "create_time" : 1600076223389, "description" : "fassfa", "enterprise_project_id" : "0", "id" : "xxxxxxxxxxxxxxxxxxx", "name" : "awffawsafws", "online_exist_status" : false, "project_id" : "xxxxxxxxxxxxxxxxxxx", "rate_control" : { "have_rate_control" : false, "max" : 0, "time_delay" : 0 }, "script_language" : "SHELL", "update_by" : "xxxx", "update_time" : 1600076223389 } ], "total_elements" : 1 }
状态码: 400
BadRequest。非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.31002002", "error_message" : "Invalid script parameter.", "http_code" : 400 }
状态码: 401
Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
{ "error_code" : "AOM.31009011", "error_msg" : "auth failed.", "http_code" : 401 }
状态码: 500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "error_code" : "AOM.31002005", "error_msg" : "script internal server error.", "http_code" : 500 }
SDK代码示例
SDK代码示例如下。
获取指定名称为“xxx”,排序为"DESC"的脚本列表。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v1.region.AomRegion; import com.huaweicloud.sdk.aom.v1.*; import com.huaweicloud.sdk.aom.v1.model.*; public class ListAllScriptByNameSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListAllScriptByNameRequest request = new ListAllScriptByNameRequest(); SearchScriptsRequestBody body = new SearchScriptsRequestBody(); body.withEnterpriseProjectId(""); body.withSortOrder("DESC"); body.withOrderByColumn("create_time"); body.withPageSize(10); body.withPageNum(1); body.withScriptId(""); body.withCreateBy("user1"); body.withIsDefault("default"); body.withName("xxx"); request.withBody(body); try { ListAllScriptByNameResponse response = client.listAllScriptByName(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
获取指定名称为“xxx”,排序为"DESC"的脚本列表。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v1.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAllScriptByNameRequest() request.body = SearchScriptsRequestBody( enterprise_project_id="", sort_order="DESC", order_by_column="create_time", page_size=10, page_num=1, script_id="", create_by="user1", is_default="default", name="xxx" ) response = client.list_all_script_by_name(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
获取指定名称为“xxx”,排序为"DESC"的脚本列表。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAllScriptByNameRequest{} enterpriseProjectIdSearchScriptsRequestBody:= "" pageSizeSearchScriptsRequestBody:= int32(10) pageNumSearchScriptsRequestBody:= int32(1) createBySearchScriptsRequestBody:= "user1" isDefaultSearchScriptsRequestBody:= "default" nameSearchScriptsRequestBody:= "xxx" request.Body = &model.SearchScriptsRequestBody{ EnterpriseProjectId: &enterpriseProjectIdSearchScriptsRequestBody, SortOrder: "DESC", OrderByColumn: "create_time", PageSize: &pageSizeSearchScriptsRequestBody, PageNum: &pageNumSearchScriptsRequestBody, ScriptId: "", CreateBy: &createBySearchScriptsRequestBody, IsDefault: &isDefaultSearchScriptsRequestBody, Name: &nameSearchScriptsRequestBody, } response, err := client.ListAllScriptByName(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功,返回脚本基本信息列表。 |
400 |
BadRequest。非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
错误码
请参见错误码。