Obtaining the Rule List by Page
Function
This API is used to obtain the rule list by page.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{domain_id}/rules/query
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Tenant ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cloud_project_id |
No |
String |
Project ID. |
offset |
Yes |
Integer |
Offset, which is the position where the query starts. The value must be no less than 0. |
limit |
Yes |
Integer |
Number of records displayed on each page. |
type |
No |
String |
Type |
name |
No |
String |
Rule name, which can be used for fuzzy search. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
Array of Rule objects |
Static rule list. |
total |
Integer |
Total number. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
type |
String |
Rule type. |
name |
String |
Rule name. |
version |
String |
Rule version. |
operator |
String |
Latest operator. |
operate_time |
Long |
Latest operation time. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/query?cloud_project_id=&type=&name=&limit=10&offset=20
Example Responses
Status code: 200
Request succeeded.
{ "data" : [ { "id" : "425eba0deaf04596a74cf7967d7fc04d", "type" : "Test", "name" : "New Rule-20230919104204", "version" : "07ef68721822485dba6c326829567095", "operator" : "SectestB", "operate_time" : 1695091381000 }, { "id" : "35a14c7a215745999cd579cfd862982e", "type" : "Gate", "name" : "0919-0919", "version" : "318e271a3fb24a888d5f484244ee994d", "operator" : "SectestB", "operate_time" : 1695091297000 }, { "id" : "fddb790b7b024c6aa8d53e50577b1464", "type" : "Gate", "name" : "New Rule 0919", "version" : "185537e4a10e418ba5f8ad424fabbb7e", "operator" : "SectestB", "operate_time" : 1695091251000 }, { "id" : "062f3ca8f9b14eb79af09069a227fc8c", "type" : "Gate", "name" : "Creating a Rule iam", "version" : "c12fb9341230457890993533e03ab374", "operator" : "testqxy", "operate_time" : 1695072045000 }, { "id" : "b3def7ae86d844718de5eb248c1271d3", "type" : "Gate", "name" : "Creating rule iam0023", "version" : "58a0ee7673924a1dadcf6ec28d23864c", "operator" : "SectestB", "operate_time" : 1694682961000 }, { "id" : "ce74e818321d4d40b5235c0309fd8cda", "type" : "Gate", "name" : "apitest-create-1694588962601-QsaY", "version" : "d65df316e067454db9467736412db418", "operator" : "xxx", "operate_time" : 1694588963000 }, { "id" : "22973b3a02fe439ea8b642b3a6e23e02", "type" : "Gate", "name" : "Check", "version" : "14cb09a530c744418013cf254e7dd262", "operator" : "testjyw", "operate_time" : 1694500871000 }, { "id" : "a440107f12ea40439abf7203c0b3c264", "type" : "Build", "name" : "New Rule-20230912144025", "version" : "1e99dbd87183453e9c719ded49cd3f9d", "operator" : "testjyw", "operate_time" : 1694500845000 }, { "id" : "590700d339d44fb9beee87366332509b", "type" : "Gate", "name" : "New rule-20230912140536", "version" : "a35c74fc13ea4cdfa32ca541b3b92b2d", "operator" : "xxx", "operate_time" : 1694498754000 }, { "id" : "defe9a17d6ae468cb7224b080fe418a3", "type" : "Gate", "name" : "New Rule-20230911100734-chq", "version" : "dbd00db8d87747fda87eb0b9a0a4d3ac", "operator" : "xxx", "operate_time" : 1694398087000 } ], "total" : 379 }
SDK Sample Code
The SDK sample code is as follows.
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 |
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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; public class ListRuleSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>")) .build(); ListRuleRequest request = new ListRuleRequest(); request.withCloudProjectId("<cloud_project_id>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withType("<type>"); request.withName("<name>"); try { ListRuleResponse response = client.listRule(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.v2 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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListRuleRequest() request.cloud_project_id = "<cloud_project_id>" request.offset = <offset> request.limit = <limit> request.type = "<type>" request.name = "<name>" response = client.list_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/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 := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListRuleRequest{} cloudProjectIdRequest:= "<cloud_project_id>" request.CloudProjectId = &cloudProjectIdRequest request.Offset = int32(<offset>) request.Limit = int32(<limit>) typeRequest:= "<type>" request.Type = &typeRequest nameRequest:= "<name>" request.Name = &nameRequest response, err := client.ListRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Request failed. |
401 |
Authentication failed. |
403 |
No permission. |
404 |
Resource not found. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot