Khắc phục sự cố thời gian chạy của chính sách Xác thực thông báo SOAP

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

SourceMessageNotAvailable

Mã lỗi

steps.messagevalidation.SourceMessageNotAvailable

Nội dung phản hồi lỗi

{
  "fault": {
    "faultstring": "source_var_name message is not
     available for[policy_name]",
    "detail": {
      "Errorcode":
       "steps.messagevalidation.SourceMessageNotAvailable"
     }
  }
}

Ví dụ về nội dung phản hồi Lỗi

{
  "fault": {
    "faultstring": "request message is not available for MessageValidation: SOAP-Message-Validation-1",
    "detail": {
      "errorcode": "steps.messagevalidation.SourceMessageNotAvailable"
    }
  }
}

Nguyên nhân

Lỗi này xảy ra nếu biến message được chỉ định trong phần tử <Source> của chính sách SOAPMessageValidation là:

  • Ngoài phạm vi (không có trong quy trình cụ thể nơi chính sách đang được thực thi) hoặc
  • không thể phân giải (chưa được xác định)

Ví dụ: lỗi này xảy ra nếu phần tử <Source> trong chính sách SOAPMessageValidation được đặt thành một biến không tồn tại trong luồng mà chính sách được thực thi.

Chẩn đoán

  1. Xác định tên chính sách SOAPMessageValidation nơi xảy ra lỗi và tên của biến source từ chuỗi lỗi. Ví dụ: trong chuỗi lỗi sau, tên chính sách SOAPMessageValidation là SOAP-Message-Validation-1 và biến source là request:

    "faultstring": "request message is not available for MessageValidation: SOAP-Message-Validation-1"

  2. Trong XML chính sách SOAPMessageValidation không thành công, hãy xác minh rằng tên của biến được đặt trong phần tử <Source> khớp với tên biến được xác định trong chuỗi lỗi (Bước 1 ở trên).

    Ví dụ: chính sách SOAPMessageValidation sau đây chỉ định một biến có tên là request trong phần tử <Source>, khớp với nội dung trong chuỗi lỗi:

    <MessageValidation async="false" continueOnError="false" enabled="true" name="SOAP-Message-Validation-1">
    <DisplayName>SOAP Message Validation-1</DisplayName>
    <Properties/>
    <Element namespace="http://schemas.xmlsoap.org/soap/prices">GetPriceResponse</Element>
    <SOAPMessage/>
    <Source>request</Source>
    <ResourceURL>xsd://Script-1.xsd</ResourceURL>
</MessageValidation>

  3. Xác định xem biến được dùng trong phần tử <Source> có được xác định và có sẵn trong luồng mà chính sách SOAPMessageValidation đang được thực thi hay không.

    Nếu biến là một trong hai trường hợp sau:

    • nằm ngoài phạm vi (không có trong quy trình cụ thể mà chính sách đang được thực thi) hoặc
    • không thể phân giải (chưa được xác định)

    thì đó là nguyên nhân gây ra lỗi.

    Ví dụ: giả sử chính sách SOAPMessageValidation nêu trên thực thi trong luồng phản hồi. Tuy nhiên, biến request được dùng trong ví dụ về phần tử <Source> ở trên chỉ có trong luồng yêu cầu.

    Vì biến request không tồn tại trong luồng phản hồi, nên bạn sẽ gặp lỗi sau:

    "faultstring": "request message is not available for MessageValidation: SOAP-Message-Validation-1"

Độ phân giải

Đảm bảo rằng biến được đặt trong phần tử <Source> của chính sách SOAPMessageValidation không thành công được xác định và tồn tại trong luồng mà chính sách thực thi.

Để sửa ví dụ nêu trên, bạn có thể sửa đổi phần tử <Source> để sử dụng biến response. Biến này có trong luồng phản hồi:

<MessageValidation async="false" continueOnError="false" enabled="true" name="SOAP-Message-Validation-1">
    <DisplayName>SOAP Message Validation-1</DisplayName>
    <Properties/>
    <Element namespace="http://schemas.xmlsoap.org/soap/prices">GetPriceResponse</Element>
    <SOAPMessage/>
    <Source>response</Source>
    <ResourceURL>xsd://Script-1.xsd</ResourceURL>
</MessageValidation>

NonMessageVariable

Mã lỗi

steps.messagevalidation.NonMessageVariable

Nội dung phản hồi lỗi

{
  "fault": {
    "faultstring": "Variable var_name does not resolve to a Message"
    "detail": {
      "errorcode": "steps.messagevalidation.NonMessageVariable"
    }
  }
}

Ví dụ về nội dung phản hồi Lỗi

{
  "fault": {
    "faultstring": "Variable message.content does not resolve to a Message",
    "detail": {
      "errorcode": "steps.messagevalidation.NonMessageVariable"
    }
  }
}

Nguyên nhân

Lỗi này xảy ra nếu phần tử <Source> trong chính sách SOAPMessageValidation được đặt thành một biến không thuộc loại Message.

Các biến thuộc loại thông báo đại diện cho toàn bộ yêu cầu và phản hồi HTTP. Các biến luồng Apigee Edge tích hợp sẵn request, response và message thuộc loại Thông báo. Để tìm hiểu thêm về các biến thông báo, hãy xem phần Tài liệu tham khảo về biến.

Chẩn đoán

  1. Xác định tên của biến không phân giải thành loại Thông báo từ chuỗi lỗi. Ví dụ: trong chuỗi lỗi sau đây, tên của biến là message.content:

    "faultstring": "Variable message.content does not resolve to a Message"

  2. Kiểm tra tất cả các chính sách SOAPMessageValidation trong API Proxy cụ thể nơi xảy ra lỗi. Có thể có một hoặc nhiều chính sách SOAPMessageValidation. Xác định (các) chính sách SOAPMessageValidation cụ thể mà trong đó biến được chỉ định trong phần tử <Source> khớp với tên biến được xác định trong chuỗi lỗi (Bước 1 ở trên).

    Ví dụ: chính sách sau đây đặt phần tử <Source> thành một biến có tên là message.content, khớp với nội dung trong chuỗi lỗi:

    <MessageValidation async="false" continueOnError="false" enabled="true" name="SOAP-Message-Validation-1">
    <DisplayName>SOAP Message Validation-1</DisplayName>
    <Properties/>
    <Element namespace="http://schemas.xmlsoap.org/soap/prices">GetPriceResponse</Element>
    <SOAPMessage/>
    <Source>message.content</Source>
    <ResourceURL>xsd://Script-1.xsd</ResourceURL>
</MessageValidation>

    Vì biến message.content không thuộc loại Message, nên bạn sẽ gặp lỗi:

    "faultstring": "Variable message.content does not resolve to a Message"

Độ phân giải

Đảm bảo rằng phần tử <Source> trong chính sách SOAPMessageValidation không thành công được đặt thành một biến thuộc loại Message có trong luồng mà chính sách thực thi.

Để sửa chính sách này, bạn có thể sửa đổi phần tử <Source> để chỉ định một biến thuộc loại Message. Ví dụ: trong chính sách SOAPMessageValidation không thành công, bạn có thể chỉ định phần tử <Source> là request:

<MessageValidation async="false" continueOnError="false" enabled="true" name="SOAP-Message-Validation-1">
    <DisplayName>SOAP Message Validation-1</DisplayName>
    <Properties/>
    <Element namespace="http://sample.com"> sampleObject</Element>
    <SOAPMessage/>
    <Source>request</Source>
    <ResourceURL>xsd://Script-1.xsd</ResourceURL>
</MessageValidation>

Không thành công

Mã lỗi

steps.messagevalidation.Failed

Nội dung phản hồi lỗi

{
  "fault": {
    "faultstring": "Variable var_name failed with reason: \"reason [Line varline_num
    "detail": {
      "errorcode": "steps.messagevalidation.Failed"
    }
  }
}

Ví dụ về nội dung phản hồi Lỗi

{
  "fault": {
    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Expecting a child element but found none [Line 9]\"",
    "detail": {
      "errorcode": "steps.messagevalidation.Failed"
    }
  }
}

Nguyên nhân

Lỗi này xảy ra nếu chính sách SOAPMessageValidation không xác thực được tải trọng thông báo đầu vào dựa trên lược đồ XSD hoặc định nghĩa WSDL. Lỗi này cũng sẽ xảy ra nếu có JSON hoặc XML không hợp lệ trong thông báo tải trọng.

Sau đây là một số nguyên nhân có thể dẫn đến lỗi này:

Nguyên nhân Mô tả
Tải trọng XML không khớp Tải trọng XML đầu vào không tuân thủ lược đồ XSD được chỉ định trong chính sách SoapMessageValidation.
Tải trọng SOAP không khớp Tải trọng SOAP đầu vào không tuân thủ định nghĩa WSDL được chỉ định trong chính sách SoapMessageValidation.
JSON hoặc XML không hợp lệ Tải trọng SOAP đầu vào không chứa XML hoặc JSON được định dạng đúng.

Nguyên nhân: Trọng tải XML không khớp

Lỗi này xảy ra nếu tải trọng XML đầu vào không tuân thủ giản đồ XSD được chỉ định trong phần tử <ResourceURL> của chính sách SoapMessageValidation.

Thông báo lỗi mẫu

{
  "fault": {
    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Expecting a child element but found none [Line 9]\"",
    "detail": {
      "errorcode": "steps.messagevalidation.Failed"
    }
  }
}

Chẩn đoán

  1. Xác định tên chính sách SOAPMessageValidation, lý do thất bại và số dòng mà tải trọng XML không khớp với giản đồ XSD. Tất cả thông tin này đều nằm trong chuỗi lỗi. Ví dụ: trong chuỗi lỗi sau, tên chính sách SOAPMessageValidation là SOAP-Message-Validation-1,, lý do gây ra lỗi là Expecting a child element but found none [Line 9] và số dòng là 9.

    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Expecting a child element but found none [Line 9]\""

  2. Kiểm tra chính sách SOAPMessageValidation và xác nhận rằng chính sách này sử dụng tệp định nghĩa lược đồ XSD để xác thực thông báo. Ví dụ: chính sách SOAPMessageValidation sau đây có một tệp tài nguyên XSD trong phần tử <ResourceURL>:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MessageValidation async="false" continueOnError="false" enabled="true" name="SOAP-Message-Validation-1">
    <DisplayName>SOAP Message Validation-1</DisplayName>
    <Properties/>
    <SOAPMessage/>
    <Source>request</Source>
    <ResourceURL>xsd://Script-1.xsd</ResourceURL>
</MessageValidation>

  3. Kiểm tra tải trọng đầu vào trên số dòng được xác định ở Bước 1 ở trên để tìm hiểu nguyên nhân gây ra lỗi.

    Tải trọng XML đầu vào mẫu

    <?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
<soap:Body>
    <shipOrder
    xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance">
    <shipTo>
        <name>Karl Kalckstein</name>
    </shipTo>
    <items>
        <item>
            <title>I love APIs</title>
            <quantity>1</quantity>
            <price>2.90</price>
        </item>
    </items>
</shipOrder>
</soap:Body>
</soap:Envelope>

    Trong ví dụ minh hoạ ở trên, dòng 9 có thẻ kết thúc </shipTo>.

  4. Kiểm tra tệp định nghĩa giản đồ XML, Script-1.xsd, được dùng trong chính sách SOAPMessageValidation để xem phần tử <shipTo> sẽ có dạng như thế nào:

    ...
<xsd:element name="shipTo" type="shipAddress"/>
...
<xsd:complexType name="shipAddress">
<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="street" type="xsd:string"/>
<xsd:element name="address" type="xsd:string"/>
<xsd:element name="country" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
...

    Theo XSD mẫu dùng để xác thực, phần tử <shipTo> phải có các phần tử con <name>, <street>, <address> và <country>. Tuy nhiên, tải trọng XML đầu vào chỉ có một phần tử con là <name>. Do đó, bạn sẽ gặp lỗi:

    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Expecting a child element but found none [Line 9]\""

Độ phân giải

Có 2 cách để giải quyết lỗi xác thực này:

Giải pháp 1

Nếu xác định rằng định nghĩa giản đồ XSD áp đặt những hạn chế không cần thiết và chỉ có phần tử con <name> là bắt buộc trong phần tử <shipTo>, thì bạn có thể sửa đổi Script-1.xsd được dùng trong chính sách SOAPMessageValidation. Để xác thực ví dụ về tải trọng ở trên, bạn có thể sửa đổi tệp XSD như sau:

...
<xsd:element name="shipTo" type="shipAddress"/>
...
<xsd:complexType name="shipAddress">
<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>

Giải pháp 2

Nếu tệp định nghĩa XSD chính xác, bạn có thể thay đổi tải trọng XML đầu vào để khớp với xsd. Ví dụ: bạn có thể sửa đổi tải trọng để tuân thủ xsd như sau:

<?xml version="1.0">
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
<soap:Body>
    <shipOrder xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance">
    <shipTo>
        <name>Karl Kalckstein</name>
        <street>1020 Parkway</street>
        <address>Mountain View, CA 94043</address>
        <country>USA</country>
    </shipTo>
    <items>
        <item>
            <title>I love APIs</title>
            <quantity>1</quantity>
            <price>2.90</price>
        </item>
    </items>
</shipOrder>
</soap:Body>
</soap:Envelope>

Nguyên nhân: Tải trọng SOAP không khớp

Lỗi này xảy ra nếu tải trọng SOAP đầu vào không tuân thủ định nghĩa WSDL được chỉ định trong phần tử <ResourceURL> của chính sách SoapMessageValidation.

Thông báo lỗi mẫu

{
  "fault": {
    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Element name mismatch. Wildcard? [Line 11]\"",
    "detail": {
      "errorcode": "steps.messagevalidation.Failed"
    }
  }
}

Chẩn đoán

  1. Xác định tên chính sách SOAPMessageValidation, lý do thất bại và số dòng mà tải trọng SOAP không khớp với định nghĩa WSDL. Bạn có thể tìm thấy tất cả thông tin này trong chuỗi lỗi. Ví dụ: trong chuỗi lỗi sau đây, tên chính sách SOAPMessageValidation là SOAP-Message-Validation-1, lý do gây ra lỗi là \"Element name mismatch. Wildcard? [Line 11]\"" và số dòng là 11:

    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Element name mismatch. Wildcard? [Line 11]\""

  2. Kiểm tra chính sách SOAPMessageValidation và xác nhận rằng chính sách này sử dụng lược đồ wsdl để xác thực thông báo. Ví dụ: chính sách SOAPMessageValidation sau đây có tệp tài nguyên wsdl trong phần tử <ResourceURL>:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MessageValidation async="false" continueOnError="false" enabled="true" name="SOAP-Message-Validation-1">
    <DisplayName>SOAP Message Validation-1</DisplayName>
    <Properties/>
    <SOAPMessage/>
    <Source>request</Source>
 <ResourceURL>wsdl://SOAP-Message-Validation-1.wsdl</ResourceURL>
</MessageValidation>

  3. Kiểm tra tải trọng đầu vào trên số dòng được xác định ở Bước 1 để tìm hiểu nguyên nhân gây ra lỗi.

    Tải trọng SOAP đầu vào mẫu

    <?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
<soap:Body>
<shipOrder
xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance">
  <shipTo>
    <name>Karl Kalckstein</name>
    <street>1020 Parkway</street>
    <address>Mountain View, CA 94043</address>
    <country>USA</country>
  </shipTo>
  <items>
    <item>
      <title>I love APIs</title>
      <quantity>1</quantity>
      <price>2.90</price>
    </item>
  </items>

    Trong ví dụ minh hoạ ở trên, dòng 11 có phần tử con <country> trong phần tử <shipTo>.

  4. Kiểm tra tệp Định nghĩa WSDL, SOAP-Message-Validation-1.wsdl, được dùng trong chính sách SOAPMessageValidation để xem có thể có vấn đề gì với phần tử con <country> trong phần tử <shipTo>:

    <?xml version="1.0" encoding="ISO-8859-1"?>
<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
    <wsdl:types>
      <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="shipOrder" type="order"/>
<xsd:complexType name="order">
<xsd:sequence>
<xsd:element name="shipTo" type="shipAddress"/>
<xsd:element name="items" type="cdItems"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="shipAddress">
<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="street" type="xsd:string"/>
<xsd:element name="address" type="xsd:string"/>
</xsd:sequence>
...

    Theo định nghĩa WSDL dùng để xác thực, phần tử <shipTo> không có phần tử con <country>. Do đó, bạn sẽ gặp lỗi:

    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Element name mismatch. Wildcard? [Line 11]\""

Độ phân giải

Có 2 cách để giải quyết lỗi xác thực này:

Giải pháp 1

Nếu xác định rằng định nghĩa WSDL được dùng là không chính xác, bạn có thể thay đổi SOAP-Message-Validation-1.wsdl được dùng trong chính sách SOAPMessageValidation. Để xác thực ví dụ về tải trọng ở trên, bạn có thể sửa đổi tệp như sau:

...
<xsd:complexType name="shipAddress">`
...
<sequence>
    <element name="name" type="xsd:string"/>
    <element name="street" type="xsd:string"/>
    <element name="address" type="xsd:string"/>
    <element name="country" type="xsd:string"/>
</sequence>

Giải pháp 2

Nếu định nghĩa WSDL là chính xác, thì bạn có thể thay đổi tải trọng SOAP đầu vào cho phù hợp với định nghĩa WSDL.

Ví dụ: bạn có thể sửa đổi tải trọng SOAP đầu vào như sau:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
<soap:Body>
<shipOrder xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance">
    <shipTo>
        <name>Karl Kalckstein</name>
        <street>1020 Parkway</street>
        <address>Mountain View, CA 94043</address>
    </shipTo>
    <items>
        <item>
            <title>I love APIs</title>
            <quantity>1</quantity>
            <price>2.90</price>
        </item>
    </items>

Nguyên nhân: JSON hoặc XML không hợp lệ

Lỗi này xảy ra nếu tải trọng SOAP đầu vào không tuân thủ định nghĩa WSDL được chỉ định trong phần tử <ResourceURL> của chính sách SoapMessageValidation.

Thông báo lỗi mẫu

{
  "fault": {
    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Expected <\/title> at line 15(possibly  around char 420)\"",
    "detail": {
      "errorcode": "steps.messagevalidation.Failed"
    }
  }
}

Chẩn đoán

  1. Xác định tên chính sách SOAPMessageValidation, lý do thất bại và số dòng của tải trọng XML không khớp với định nghĩa WSDL. Bạn có thể tìm thấy tất cả thông tin này trong chuỗi lỗi. Ví dụ: trong chuỗi lỗi sau, tên chính sách SOAPMessageValidation là SOAP-Message-Validation-1, lý do gây ra lỗi là Expected </title> at line 15(possibly around char 420): và số dòng là 15.

    "faultstring": "SOAP-Message-Validation-1 failed with reason: \"Expected </title> at line 15(possibly  around char 420)\""

  2. Kiểm tra tải trọng đầu vào trên số dòng được xác định ở Bước 1 ở trên để tìm hiểu nguyên nhân gây ra lỗi.

    Tải trọng SOAP đầu vào mẫu

    <?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
<soap:Body>
<shipOrder xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance">
  <shipTo>
    <name>Karl Kalckstein</name>
    <street>1020 Parkway</street>
    <address>Mountain View, CA 94043</address>
    <country>USA</country>
  </shipTo>
  <items>
    <item>
      <title>I love APIs</titles>
      <quantity>1</quantity>
      <price>2.90</price>
    </item>
  </items>
</shipOrder>
</soap:Body>
</soap:Envelope>

    Trong ví dụ minh hoạ ở trên, dòng 15 của XML đầu vào có phần tử <title> nhưng không được đóng bằng thẻ kết thúc </title>.

Độ phân giải

Để giải quyết lỗi này, hãy đảm bảo rằng tải trọng đầu vào hợp lệ và được tạo đúng cách.

Ví dụ: bạn có thể sửa đổi tải trọng XML đầu vào như sau:

...
</shipTo>
<items>
  <item>
    <title>I love APIs</title>
    <quantity>1</quantity>
    <price>2.90</price>
  </item>
</items>
...